capsys for capturing output in PyTest - Framework Patterns

Framework Mode - capsys for capturing output

Folder Structure

project-root/
├── tests/
│   ├── test_example.py
│   ├── test_output_capture.py
│   └── conftest.py
├── src/
│   └── app.py
├── pytest.ini
└── requirements.txt
    

This structure keeps tests separate from source code. tests/ holds all test files including those using capsys.

Test Framework Layers

• Test Layer: Contains test functions using capsys to capture and assert printed output.
• Application Layer: Source code that produces output to stdout or stderr.
• Fixtures & Utilities: conftest.py for shared fixtures; capsys is a built-in pytest fixture injected automatically.
• Configuration: pytest.ini to configure pytest behavior.

Configuration Patterns

Use pytest.ini to set default options like verbosity or markers.

[pytest]
addopts = -v
    

capsys requires no special config; it is available by default as a pytest fixture.

For environment-specific output tests, use environment variables or pytest markers to run conditionally.

Test Reporting and CI/CD Integration

Pytest outputs test results including capsys captured output assertions.

Use --capture=no option to see live output during test runs if needed.

Integrate pytest with CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.

Test reports show pass/fail status of output capture assertions clearly.

Best Practices

• Use capsys to capture stdout and stderr output cleanly without modifying application code.
• Assert on captured output strings to verify correct messages or logs are printed.
• Keep tests small and focused on one output behavior per test function.
• Use capsys.readouterr() only once per test to avoid missing output.
• Combine capsys with parameterized tests for multiple output scenarios.

Self Check

Where in this folder structure would you add a new test that verifies the output of a function printing a welcome message using capsys?

Key Result

Use pytest's built-in capsys fixture in the tests/ folder to capture and assert printed output cleanly.

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