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.