Why Custom markers in PyTest? - Purpose & Use Cases

The Big Idea

What if you could run just the tests you want with a simple tag?

The Scenario

Imagine you have a big set of tests for your app. You want to run only the tests that check login features today, but you have to open each test file and find those tests manually.

The Problem

This manual way is slow and tiring. You might miss some tests or run the wrong ones. It's easy to make mistakes and waste time running tests you don't need right now.

The Solution

Custom markers let you tag tests with labels like 'login' or 'slow'. Then you can tell pytest to run only tests with those tags. This saves time and keeps your testing organized.

Before vs After

✗ Before

def test_login_valid():
    # test code

def test_profile_update():
    # test code

# Manually run tests by picking them one by one

✓ After

import pytest

@pytest.mark.login
def test_login_valid():
    # test code

@pytest.mark.profile
def test_profile_update():
    # test code

# Run tests with 'login' marker using: pytest -m login

What It Enables

You can quickly run focused groups of tests, making your testing faster and smarter.

Real Life Example

A developer fixes a bug in the payment system and runs only tests marked 'payment' to check the fix without waiting for unrelated tests.

Key Takeaways

Manual test selection is slow and error-prone.

Custom markers tag tests for easy grouping.

Run only needed tests quickly with markers.

Practice

1. What is the main purpose of using custom markers in pytest?

easy

A. To generate test data automatically

B. To change the Python interpreter version

C. To automatically fix test failures

D. To label tests for grouping and selective running

Solution

1. Step 1: Understand what custom markers do

   Custom markers in pytest are used to tag tests with labels for easier management.

2. Step 2: Identify the purpose of these labels

   These labels help run specific groups of tests selectively using the marker name.

3. Final Answer:

   To label tests for grouping and selective running -> Option D

4. Quick Check:

   Custom markers = test grouping [OK]

Hint: Markers tag tests to run groups easily [OK]

Common Mistakes:

• Thinking markers change Python version
• Assuming markers fix test errors automatically
• Confusing markers with test data generation

2. Which of the following is the correct syntax to mark a test with a custom marker named slow?

easy

A. @pytest.mark.slow\ndef test_example(): pass

B. @pytest.slow.mark\ndef test_example(): pass

C. @pytest.mark[slow]\ndef test_example(): pass

D. @pytest.mark('slow')\ndef test_example(): pass

Solution

1. Step 1: Recall pytest marker syntax

   Custom markers use dot notation: @pytest.mark.markername before the test function.

2. Step 2: Match the correct syntax

   @pytest.mark.slow is the correct way to apply the 'slow' marker.

3. Final Answer:

   @pytest.mark.slow\ndef test_example(): pass -> Option A

4. Quick Check:

   Marker syntax = @pytest.mark.name [OK]

Hint: Use dot notation: @pytest.mark.name [OK]

Common Mistakes:

• Using parentheses instead of dot notation
• Using square brackets instead of dot notation
• Placing marker after function name

3. Given the following test file, what will be the output when running pytest -m slow?

import pytest

@pytest.mark.slow
def test_a():
    assert True

def test_b():
    assert True

@pytest.mark.slow
def test_c():
    assert False

medium

A. Runs all tests; test_c fails

B. Runs only test_b; all pass

C. Runs test_a and test_c; test_c fails, test_a passes

D. Runs test_a and test_b; all pass

Solution

1. Step 1: Understand what pytest -m slow does

   This command runs only tests marked with the 'slow' marker.

2. Step 2: Identify marked tests in the code

   test_a and test_c have @pytest.mark.slow, so only these run.

3. Step 3: Check test results

   test_a passes (assert True), test_c fails (assert False).

4. Final Answer:

   Runs test_a and test_c; test_c fails, test_a passes -> Option C

5. Quick Check:

   pytest -m slow runs marked tests only [OK]

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

Common Mistakes:

• Assuming all tests run with -m option
• Ignoring test failures in marked tests
• Running unmarked tests by mistake

4. What is wrong with this pytest marker usage?

import pytest

@pytest.mark.slow()
def test_example():
    assert True

medium

A. Markers should not have parentheses unless parameters are used

B. Marker name must be uppercase

C. The test function must have parameters

D. pytest.mark cannot be used on test functions

Solution

1. Step 1: Check marker syntax

   Markers without parameters should not have parentheses; @pytest.mark.slow() is incorrect.

2. Step 2: Correct usage

   Use @pytest.mark.slow without parentheses for simple markers.

3. Final Answer:

   Markers should not have parentheses unless parameters are used -> Option A

4. Quick Check:

   Use parentheses only with marker args [OK]

Hint: No parentheses for simple markers [OK]

Common Mistakes:

• Adding empty parentheses to markers
• Using uppercase marker names incorrectly
• Thinking markers require function parameters

5. You want to run tests marked as database but exclude those also marked as slow. Which pytest command achieves this?

hard

A. pytest -m "database or slow"

B. pytest -m "database and not slow"

C. pytest -m "not database and slow"

D. pytest -m "database and slow"

Solution

1. Step 1: Understand marker expressions

   pytest supports boolean expressions with markers: and, or, not.

2. Step 2: Formulate the correct expression

   To run tests marked 'database' but exclude 'slow', use "database and not slow".

3. Final Answer:

   pytest -m "database and not slow" -> Option B

4. Quick Check:

   Use boolean logic in -m to include/exclude markers [OK]

Hint: Use boolean logic: -m "marker and not other" [OK]

Common Mistakes:

• Using 'or' instead of 'and not' to exclude
• Misplacing 'not' before the first marker
• Combining markers without quotes