capsys for capturing output in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is capsys in pytest?

capsys is a pytest fixture that captures output sent to stdout and stderr during test execution. It helps you check what your code prints.

beginner

How do you access captured output using capsys?

Use capsys.readouterr() which returns a namedtuple with out (standard output) and err (standard error) strings.

beginner

Why is capturing output useful in testing?

It lets you verify that your program prints the correct messages, like logs or errors, without showing them on the screen during tests.

beginner

Show a simple pytest test function using capsys to check printed output.

def test_greet(capsys):
    print('Hello')
    captured = capsys.readouterr()
    assert captured.out == 'Hello\n'

intermediate

What happens if you call capsys.readouterr() multiple times in one test?

Each call returns the output captured since the last call and clears the buffer. So, output is reset after reading.

What does capsys.readouterr() return?

A A namedtuple with <code>out</code> and <code>err</code> strings

B Only the standard output string

C Only the standard error string

D A boolean indicating if output was captured

capsys.readouterr() returns a namedtuple with two strings: out for standard output and err for standard error.

Which pytest fixture is used to capture printed output?

A capout

B stdout

C capsys

D capture

capsys is the built-in pytest fixture for capturing output.

If your code prints 'Hi' and you want to test it, what assertion checks the output correctly?

A assert captured.out == 'Hi'

B assert captured.out == 'Hi\n'

C assert captured.err == 'Hi\n'

D assert captured.out == 'hi\n'

Print adds a newline, so output ends with '\n'. The check must include it exactly.

What happens to the captured output after calling capsys.readouterr()?

A It remains unchanged

B It is saved to a file

C It doubles

D It is cleared/reset

Calling readouterr() clears the captured output buffer.

Which output streams does capsys capture?

A Both standard output and standard error

B Only standard error

C Only standard output

D Neither

capsys captures both stdout and stderr.

Explain how to use capsys in a pytest test to verify printed output.

Think about how you capture and check what print shows.

Why is it important to include the newline character when asserting printed output captured by capsys?

Remember how print behaves in Python.

Practice

1. What is the main purpose of using capsys in pytest tests?

easy

A. To generate test reports with screenshots

B. To speed up test execution by skipping print statements

C. To automatically fix syntax errors in print statements

D. To capture and check printed output during test execution

Solution

1. Step 1: Understand capsys role in pytest

   capsys is a pytest feature that captures output sent to stdout and stderr during tests.

2. Step 2: Identify what capsys helps verify

   It helps verify printed messages, ensuring the program outputs expected text.

3. Final Answer:

   To capture and check printed output during test execution -> Option D

4. Quick Check:

   capsys captures output = A [OK]

Hint: Remember: capsys catches print output for checking [OK]

Common Mistakes:

• Thinking capsys speeds up tests
• Believing capsys fixes code errors
• Confusing capsys with report generation

2. Which of the following is the correct way to capture output using capsys in a pytest test function?

easy

A. output = capsys.readouterr()

B. output = capsys.capture()

C. output = capsys.getoutput()

D. output = capsys.print()

Solution

1. Step 1: Recall capsys method to get output

   The correct method to retrieve captured output is capsys.readouterr().

2. Step 2: Check other options for correctness

   Other methods like capture(), getoutput(), or print() do not exist on capsys.

3. Final Answer:

   output = capsys.readouterr() -> Option A

4. Quick Check:

   capsys.readouterr() reads output = B [OK]

Hint: Use readouterr() to get captured stdout and stderr [OK]

Common Mistakes:

• Using non-existent capsys methods
• Trying to capture output without readouterr()
• Confusing capsys with other pytest fixtures

3. What will be the output of the following pytest test using capsys?

def greet():
    print('Hello, Tester!')

def test_greet(capsys):
    greet()
    captured = capsys.readouterr()
    assert captured.out == 'Hello, Tester!\n'

medium

A. Test passes because output matches exactly

B. Test fails because captured.out is empty

C. Test fails due to missing newline in assertion

D. Test raises an exception due to wrong capsys usage

Solution

1. Step 1: Understand what greet() prints

   The function prints 'Hello, Tester!' followed by a newline.

2. Step 2: Check assertion against captured output

   capsys.readouterr() captures stdout including newline, so captured.out equals 'Hello, Tester!\n'.

3. Final Answer:

   Test passes because output matches exactly -> Option A

4. Quick Check:

   captured.out == 'Hello, Tester!\n' = C [OK]

Hint: Remember print adds newline, so include \n in assertion [OK]

Common Mistakes:

• Forgetting newline in expected output
• Assuming captured.out excludes newlines
• Misusing capsys.readouterr() causing errors

4. Identify the error in this pytest test using capsys:

def test_error(capsys):
    print('Start')
    captured = capsys.readouterr
    assert captured.out == 'Start\n'

medium

A. capsys fixture is not passed as argument

B. Incorrect assertion comparing to 'Start' without newline

C. Missing parentheses when calling capsys.readouterr

D. print statement should be inside a function

Solution

1. Step 1: Check how capsys.readouterr is used

   capsys.readouterr is a method and must be called with parentheses: capsys.readouterr()

2. Step 2: Verify assertion and other code parts

   The assertion correctly expects 'Start\n', print is inside the test function, and capsys is passed as argument.

3. Final Answer:

   Missing parentheses when calling capsys.readouterr -> Option C

4. Quick Check:

   Method call needs () = D [OK]

Hint: Always call readouterr() with parentheses [OK]

Common Mistakes:

• Forgetting () after readouterr
• Ignoring newline in output assertion
• Not passing capsys fixture to test

5. You want to test a function that prints multiple lines and errors. How do you use capsys to verify both stdout and stderr outputs correctly?

hard

A. Call capsys.readouterr() twice, once for stdout and once for stderr separately

B. Call capsys.readouterr() once and check both captured.out and captured.err

C. Use capsys.readouterr() only for stdout and ignore stderr

D. Use print statements to manually check outputs instead of capsys

Solution

1. Step 1: Understand capsys.readouterr() output

   It returns a namedtuple with two attributes: out (stdout) and err (stderr).

2. Step 2: Verify how to check both outputs

   Calling readouterr() once captures both streams; check captured.out and captured.err separately.

3. Final Answer:

   Call capsys.readouterr() once and check both captured.out and captured.err -> Option B

4. Quick Check:

   One readouterr() call captures both streams = A [OK]

Hint: One readouterr() call captures stdout and stderr together [OK]

Common Mistakes:

• Calling readouterr() multiple times expecting separate streams
• Ignoring stderr output in tests
• Using print instead of capsys for output verification