capsys for capturing output in PyTest - Build an Automation Script

Capture and verify printed output using capsys in pytest

Preconditions (2)

Step 1: Write a Python function that prints 'Hello, world!'

Step 2: Write a pytest test function that calls the print function

Step 3: Use the capsys fixture to capture the printed output

Step 4: Assert that the captured output matches 'Hello, world!\n'

✅ Expected Result: The test passes confirming the printed output is correctly captured and matches the expected string

Automation Requirements - pytest

Assertions Needed:

Assert captured stdout equals 'Hello, world!\n'

Best Practices:

Use the capsys fixture parameter in the test function

Call the function that prints output inside the test

Use capsys.readouterr() to capture stdout and stderr

Assert only the needed output, avoid hardcoding unrelated text

Automated Solution

PyTest

import pytest

def greet():
    print("Hello, world!")


def test_greet_output(capsys):
    greet()
    captured = capsys.readouterr()
    assert captured.out == "Hello, world!\n"

The greet function prints the string 'Hello, world!'.

The test function test_greet_output uses the capsys fixture provided by pytest to capture output printed to the console.

Inside the test, we call greet() which prints the message. Then capsys.readouterr() captures the output streams.

We assert that captured.out (standard output) exactly matches the expected string including the newline character.

This confirms the printed output is correctly captured and verified.

Common Mistakes - 3 Pitfalls

Not using the capsys fixture parameter in the test function

Calling capsys.readouterr() before the function that prints output

{'mistake': 'Asserting captured.out without considering the newline character', 'why_bad': 'Print adds a newline, so missing it in the assertion causes false failures.', 'correct_approach': "Include the newline character '\\n' in the expected string when asserting captured output."}

Bonus Challenge

Now add data-driven testing to capture and verify output for three different greetings: 'Hello, world!', 'Hi there!', and 'Good morning!'

Show Hint

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