Autouse fixtures in PyTest

Introduction

Autouse fixtures run automatically without needing to be mentioned in tests. This helps set up or clean up things quietly behind the scenes.

When you want to prepare a database connection before every test without adding it to each test function.

When you need to reset some settings before each test automatically.

When you want to clean up temporary files after tests without calling cleanup explicitly.

When you want to apply a common setup step to many tests without changing their code.

Syntax

PyTest

import pytest

@pytest.fixture(autouse=True)
def setup_function():
    # setup code here
    yield
    # teardown code here

The autouse=True makes the fixture run automatically for all tests in the scope.

You don't need to add the fixture name to test function parameters.

Examples

This fixture prints messages before and after the test runs automatically.

PyTest

import pytest

@pytest.fixture(autouse=True)
def print_hello():
    print('Hello before test')
    yield
    print('Goodbye after test')

def test_example():
    print('Running test')

This fixture runs once before and after all tests in the module.

PyTest

import pytest

@pytest.fixture(autouse=True, scope='module')
def setup_module():
    print('Setup module')
    yield
    print('Teardown module')

def test_one():
    pass

def test_two():
    pass

Sample Program

This example shows an autouse fixture that runs setup and teardown prints automatically for each test.

PyTest

import pytest

@pytest.fixture(autouse=True)
def setup():
    print('Setup before test')
    yield
    print('Teardown after test')

def test_addition():
    assert 1 + 1 == 2

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

Important Notes

Autouse fixtures can slow tests if they do heavy work and run too often.

You can control how often autouse fixtures run with the scope parameter (function, module, session).

Use autouse fixtures only when you want to avoid repeating fixture names in many tests.

Summary

Autouse fixtures run automatically for tests without being listed in test parameters.

They help with common setup and cleanup tasks across many tests.

Control their frequency with the scope option.

Practice

1. What is the main purpose of an autouse fixture in pytest?

easy

A. To run the fixture automatically for all tests without explicitly adding it as a parameter

B. To skip the fixture during test execution

C. To run the fixture only when explicitly requested in the test

D. To disable all fixtures in the test file

Solution

1. Step 1: Understand what autouse means in pytest

   An autouse fixture runs automatically for every test in its scope without needing to be listed as a parameter.

2. Step 2: Compare options with this behavior

   Only To run the fixture automatically for all tests without explicitly adding it as a parameter describes this automatic running behavior correctly.

3. Final Answer:

   To run the fixture automatically for all tests without explicitly adding it as a parameter -> Option A

4. Quick Check:

   Autouse = automatic run without listing [OK]

Hint: Autouse means automatic use without listing in test [OK]

Common Mistakes:

• Thinking autouse disables the fixture
• Believing autouse requires explicit test parameters
• Confusing autouse with skipping tests

2. Which of the following is the correct way to declare an autouse fixture in pytest?

easy

A. @pytest.fixture(auto=True)
def setup():
pass

B. @pytest.fixture(autouse=True)
def setup():
pass

C. @pytest.autouse()
def setup():
pass

D. @pytest.usefixture(autouse=True)
def setup():
pass

Solution

1. Step 1: Recall correct syntax for autouse fixture

   The correct decorator is @pytest.fixture with the argument autouse=True.

2. Step 2: Check each option's syntax

   Only @pytest.fixture(autouse=True) def setup(): pass uses @pytest.fixture(autouse=True) correctly. Others use invalid decorators or wrong argument names.

3. Final Answer:

   @pytest.fixture(autouse=True) def setup(): pass -> Option B

4. Quick Check:

   Use @pytest.fixture(autouse=True) for autouse [OK]

Hint: Remember: autouse is a parameter in @pytest.fixture [OK]

Common Mistakes:

• Using @pytest.autouse decorator which does not exist
• Writing autouse as auto=True
• Using @pytest.usefixture instead of @pytest.fixture

3. Given the code below, what will be the output when running pytest?

import pytest

@pytest.fixture(autouse=True)
def setup():
    print('Setup runs')


def test_one():
    print('Test one running')


def test_two():
    print('Test two running')

medium

A. Test one running\nTest two running

B. Setup runs\nSetup runs\nTest one running\nTest two running

C. Setup runs\nTest one running\nSetup runs\nTest two running

D. Setup runs\nTest one running\nTest two running

Solution

1. Step 1: Understand autouse fixture behavior

   The autouse fixture runs automatically before each test function in the module.

2. Step 2: Trace the print statements during test runs

   For test_one: 'Setup runs' then 'Test one running'. For test_two: 'Setup runs' then 'Test two running'.

3. Final Answer:

   Setup runs\nTest one running\nSetup runs\nTest two running -> Option C

4. Quick Check:

   Autouse runs before each test = output B [OK]

Hint: Autouse fixture runs before every test automatically [OK]

Common Mistakes:

• Assuming fixture runs only once
• Ignoring print inside fixture
• Thinking tests run without setup prints

4. What is wrong with the following autouse fixture code?

import pytest

@pytest.fixture(autouse=True)
def setup():
    print('Setup')

@pytest.fixture
def test_data():
    return 42


def test_example(test_data):
    assert test_data == 42

medium

A. There is no error; the code works correctly

B. The test_data fixture cannot be used with autouse fixtures

C. The autouse fixture setup() does not yield or return, so cleanup is impossible

D. The autouse fixture setup() must accept a parameter

Solution

1. Step 1: Review fixture definitions and usage

   setup() is an autouse fixture that runs automatically and prints 'Setup'. test_data() is a normal fixture returning 42.

2. Step 2: Check if any syntax or usage errors exist

   Both fixtures are valid. Autouse fixtures do not need parameters or yield unless cleanup is needed. test_example uses test_data correctly.

3. Final Answer:

   There is no error; the code works correctly -> Option A

4. Quick Check:

   Autouse fixture without yield is valid [OK]

Hint: Autouse fixtures can be simple setup without yield [OK]

Common Mistakes:

• Expecting autouse fixtures must yield for cleanup
• Thinking autouse conflicts with other fixtures
• Assuming autouse fixtures need parameters

5. You want an autouse fixture to run once per test class, not before every test method. Which scope value should you use with @pytest.fixture(autouse=True)?

hard

A. "session"

B. "module"

C. "function"

D. "class"

Solution

1. Step 1: Understand pytest fixture scopes

   Scope "function" runs before each test function, "class" runs once per test class, "module" once per module, "session" once per test session.

2. Step 2: Match desired behavior to scope

   To run once per test class, use scope="class" with autouse=True.

3. Final Answer:

   "class" -> Option D

4. Quick Check:

   Scope "class" runs once per test class [OK]

Hint: Use scope='class' for autouse fixture once per test class [OK]

Common Mistakes:

• Using default scope 'function' which runs before every test
• Confusing 'module' with 'class' scope
• Using 'session' which runs too broadly