setup.cfg configuration in PyTest

Introduction

The setup.cfg file helps you set options for pytest in one place. It makes running tests easier and consistent.

You want to set test options without typing them every time in the command line.

You want to ignore certain files or folders during testing.

You want to add markers to organize tests.

You want to change the default test discovery rules.

You want to configure plugins or test output formats.

Syntax

PyTest

[pytest]
addopts = <options>
markers =
    <marker1>: <description>
    <marker2>: <description>
python_files = <pattern>
python_classes = <pattern>
python_functions = <pattern>

# Example:
# [pytest]
# addopts = -v --maxfail=2
# markers =
#     slow: marks tests as slow
# python_files = test_*.py

The section header [pytest] tells pytest to read these settings.

Indent marker descriptions for clarity.

Examples

This example sets verbose output, stops after 1 failure, looks for files starting with test_, and defines two markers.

PyTest

[pytest]
addopts = -v --maxfail=1
python_files = test_*.py
markers =
    smoke: quick smoke tests
    regression: full regression tests

This example changes traceback style to short and sets class and function name patterns for test discovery.

PyTest

[pytest]
addopts = --tb=short
python_classes = Test*
python_functions = test_*

Sample Program

This setup.cfg file adds verbose output and defines a marker named example. The test file has two tests, one marked with example.

PyTest

# Directory structure:
# project/
# ├── setup.cfg
# └── test_sample.py

# Content of setup.cfg:
# [pytest]
# addopts = -v
# markers =
#     example: marks example tests

# Content of test_sample.py:
import pytest

@pytest.mark.example
def test_addition():
    assert 1 + 1 == 2

def test_subtraction():
    assert 5 - 3 == 2

Important Notes

Use pytest --markers to see all markers available.

Keep setup.cfg in your project root for pytest to find it automatically.

Indentation and spacing matter in setup.cfg for readability but not strict syntax.

Summary

setup.cfg stores pytest settings in one file.

It helps run tests with consistent options without typing commands each time.

You can define markers, test file patterns, and other options easily.

Practice

1. What is the main purpose of the setup.cfg file in pytest?

easy

A. To store pytest configuration settings in one place

B. To write test functions

C. To install pytest package

D. To run tests manually from the command line

Solution

1. Step 1: Understand pytest configuration

   The setup.cfg file is used to keep pytest settings centralized.

2. Step 2: Differentiate from other tasks

   Writing tests or installing packages are not roles of setup.cfg.

3. Final Answer:

   To store pytest configuration settings in one place -> Option A

4. Quick Check:

   setup.cfg centralizes pytest settings [OK]

Hint: Remember setup.cfg holds config, not test code [OK]

Common Mistakes:

• Confusing setup.cfg with test files
• Thinking setup.cfg runs tests
• Assuming setup.cfg installs packages

2. Which of the following is the correct way to specify the test file pattern in setup.cfg?

easy

A. [pytest]\ntestpaths = tests

B. [pytest]\npython_files = test_*.py

C. [tool:pytest]\npython_files = *.txt

D. [pytest]\nmarkers = test_*.py

Solution

1. Step 1: Identify correct section and key

   pytest settings go under [pytest] and python_files sets test file patterns.

2. Step 2: Check pattern correctness

   python_files = test_*.py matches typical test files.

3. Final Answer:

   [pytest]\npython_files = test_*.py -> Option B

4. Quick Check:

   python_files sets test file pattern [OK]

Hint: Use python_files to set test file patterns [OK]

Common Mistakes:

• Using wrong section header like [tool:pytest]
• Confusing markers with file patterns
• Setting testpaths instead of python_files for file pattern

3. Given this setup.cfg snippet:

[pytest]
markers = slow: marks tests as slow
python_files = test_*.py

What happens when you run pytest -m slow?

medium

A. Tests in files not matching test_*.py run

B. All tests run ignoring markers

C. Tests with names containing 'slow' run

D. Only tests marked with @pytest.mark.slow run

Solution

1. Step 1: Understand marker definition

   The marker slow is defined to label slow tests.

2. Step 2: Effect of -m slow option

   Running pytest -m slow runs only tests marked with @pytest.mark.slow.

3. Final Answer:

   Only tests marked with @pytest.mark.slow run -> Option D

4. Quick Check:

   -m runs tests with matching marker [OK]

Hint: -m runs tests with matching marker only [OK]

Common Mistakes:

• Thinking -m filters by test name
• Assuming all tests run ignoring markers
• Confusing file pattern with marker filtering

4. You added this to setup.cfg:

[pytest]
markers = slow: marks slow tests
python_files = test_*.py
python_classes = Test*
python_functions = test_*

But pytest gives a warning about unknown markers. What is the likely cause?

medium

A. Markers need to be registered with full description and no typos

B. Missing a blank line after [pytest] section

C. Markers must be listed under [tool:pytest] section

D. python_files setting conflicts with markers

Solution

1. Step 1: Check marker registration format

   Markers must be registered exactly with correct spelling and description.

2. Step 2: Understand warning cause

   Warnings usually occur if marker name is misspelled or description is missing.

3. Final Answer:

   Markers need to be registered with full description and no typos -> Option A

4. Quick Check:

   Correct marker registration avoids warnings [OK]

Hint: Check marker spelling and description carefully [OK]

Common Mistakes:

• Placing markers under wrong section
• Forgetting marker description after colon
• Assuming python_files affects markers

5. You want pytest to automatically ignore tests in the legacy_tests folder without typing command line options. How do you configure setup.cfg to do this?

hard

A. [pytest]
markers = ignore: skip legacy tests

B. [pytest]
python_files = test_*.py
ignore = legacy_tests

C. [pytest]
addopts = --ignore=legacy_tests

D. [pytest]
filterwarnings = ignore::legacy_tests

Solution

1. Step 1: Identify option to ignore folders

   The --ignore=folder option tells pytest to skip that folder.

2. Step 2: Set addopts in setup.cfg

   Adding addopts = --ignore=legacy_tests runs pytest with this option automatically.

3. Final Answer:

   [pytest]\naddopts = --ignore=legacy_tests -> Option C

4. Quick Check:

   addopts sets default command line options [OK]

Hint: Use addopts to add default command line options [OK]

Common Mistakes:

• Using ignore key instead of addopts
• Confusing markers with ignore settings
• Using filterwarnings incorrectly for ignoring tests