Why @pytest.mark.skip with reason? - Purpose & Use Cases

The Big Idea

What if you could skip tests with a clear reason and never forget why again?

The Scenario

Imagine you have many tests to run, but some tests are not ready or depend on features still being built. You try to remember which tests to ignore by commenting them out or manually skipping them each time.

The Problem

This manual skipping is slow and error-prone. You might forget to skip a test, or accidentally run broken tests. It's hard to explain why a test was skipped, and your test reports become confusing.

The Solution

The @pytest.mark.skip decorator with a reason lets you easily mark tests to skip with a clear explanation. This keeps your test suite clean, your reports clear, and saves time by not running tests that shouldn't run yet.

Before vs After

✗ Before

def test_feature():
    # temporarily disabled
    pass

✓ After

@pytest.mark.skip(reason="Feature not implemented yet")
def test_feature():
    pass

What It Enables

You can clearly communicate why tests are skipped, keeping your test runs efficient and your team informed.

Real Life Example

When a new login feature is under development, you skip its tests with a reason so the test suite runs smoothly without false failures.

Key Takeaways

Manually skipping tests is confusing and error-prone.

@pytest.mark.skip cleanly skips tests with explanations.

Improves test reports and team communication.

Practice

1. What does the decorator @pytest.mark.skip(reason="some reason") do in a pytest test function?

easy

A. It skips the test and shows the given reason in the test report.

B. It runs the test but logs the reason as a warning.

C. It marks the test to run only if the reason is true.

D. It deletes the test from the test suite.

Solution

1. Step 1: Understand the purpose of @pytest.mark.skip

   This decorator tells pytest to skip running the test function it decorates.

2. Step 2: Reason parameter usage

   The reason string is shown in the test report to explain why the test was skipped.

3. Final Answer:

   It skips the test and shows the given reason in the test report. -> Option A

4. Quick Check:

   @pytest.mark.skip(reason=...) skips test with reason [OK]

Hint: Skip tests with reason to explain why [OK]

Common Mistakes:

• Thinking it runs the test but logs reason
• Confusing skip with conditional run
• Assuming it deletes the test

2. Which of the following is the correct syntax to skip a test using the named argument `reason="Not implemented yet"` using pytest?

easy

A. @pytest.mark.skip_test(reason="Not implemented yet")

B. @pytest.mark.skip("Not implemented yet")

C. @pytest.skip(reason="Not implemented yet")

D. @pytest.mark.skip(reason="Not implemented yet")

Solution

1. Step 1: Recall correct decorator syntax

   The correct decorator is @pytest.mark.skip with a named argument reason="...".

2. Step 2: Check each option

   @pytest.mark.skip(reason="Not implemented yet") uses the correct decorator and named argument syntax. Others are either missing the named argument or use incorrect decorator names.

3. Final Answer:

   @pytest.mark.skip(reason="Not implemented yet") -> Option D

4. Quick Check:

   Use @pytest.mark.skip(reason=...) syntax [OK]

Hint: Use named argument reason="..." with @pytest.mark.skip [OK]

Common Mistakes:

• Passing reason as positional argument
• Using @pytest.skip instead of @pytest.mark.skip
• Using wrong decorator names

3. What will be the output when running this pytest code?

import pytest

@pytest.mark.skip(reason="Feature not ready")
def test_feature():
    assert 1 == 1


def test_other():
    assert 2 == 2

medium

A. Both tests run and pass.

B. test_feature is skipped with reason; test_other runs and passes.

C. Both tests are skipped.

D. test_feature fails; test_other passes.

Solution

1. Step 1: Identify skipped test

   The decorator skips test_feature with the given reason, so it does not run.

2. Step 2: Check other test behavior

   test_other has no skip decorator, so it runs and passes.

3. Final Answer:

   test_feature is skipped with reason; test_other runs and passes. -> Option B

4. Quick Check:

   Skipped test does not run; others run normally [OK]

Hint: Skipped tests do not run but appear in reports [OK]

Common Mistakes:

• Assuming skipped tests run
• Thinking all tests skip if one is skipped
• Confusing skip with fail

4. Identify the error in this pytest code snippet:

import pytest

@pytest.mark.skip "Not ready"
def test_example():
    assert True

medium

A. Missing parentheses after @pytest.mark.skip

B. Reason should be passed as a named argument, not positional.

C. The test function must have parameters to use skip.

D. The assert statement is incorrect.

Solution

1. Step 1: Check decorator syntax

   The decorator is written as @pytest.mark.skip "Not ready" without parentheses around the argument, causing a syntax error.

2. Step 2: Correct usage

   Valid syntax is @pytest.mark.skip("Not ready") or @pytest.mark.skip(reason="Not ready").

3. Final Answer:

   Missing parentheses after @pytest.mark.skip -> Option A

4. Quick Check:

   Always use parentheses for decorator arguments [OK]

Hint: Always use reason= keyword with @pytest.mark.skip [OK]

Common Mistakes:

• Missing parentheses after @pytest.mark.skip
• Passing reason as positional argument
• Misusing decorator syntax

5. You want to skip a test only if a certain environment variable SKIP_TEST is set to "true", and provide the reason "Skipped due to env setting". Which pytest code correctly implements this?

hard

A. import os
import pytest

if os.getenv('SKIP_TEST') == 'true':
@pytest.mark.skip(reason="Skipped due to env setting")
def test_conditional():
assert True

B. import os
import pytest

@pytest.mark.skip(reason="Skipped due to env setting")
def test_conditional():
assert True

C. import os
import pytest

@pytest.mark.skipif(os.getenv('SKIP_TEST') == 'true', reason="Skipped due to env setting")
def test_conditional():
assert True

D. import os
import pytest

@pytest.skipif(reason="Skipped due to env setting")
def test_conditional():
assert True

Solution

1. Step 1: Understand conditional skipping

   To skip a test based on a condition, use @pytest.mark.skipif(condition, reason=...).

2. Step 2: Check each option

   import os import pytest @pytest.mark.skipif(os.getenv('SKIP_TEST') == 'true', reason="Skipped due to env setting") def test_conditional(): assert True correctly uses skipif with the environment variable condition and reason. import os import pytest @pytest.mark.skip(reason="Skipped due to env setting") def test_conditional(): assert True always skips. import os import pytest if os.getenv('SKIP_TEST') == 'true': @pytest.mark.skip(reason="Skipped due to env setting") def test_conditional(): assert True tries to conditionally decorate but syntax is invalid. import os import pytest @pytest.skipif(reason="Skipped due to env setting") def test_conditional(): assert True uses wrong decorator name.

3. Final Answer:

   Use @pytest.mark.skipif with condition and reason. -> Option C

4. Quick Check:

   Use skipif(condition, reason=...) for conditional skip [OK]

Hint: Use @pytest.mark.skipif for conditional skipping [OK]

Common Mistakes:

• Using skip instead of skipif for conditions
• Incorrect decorator syntax
• Trying to conditionally decorate inside if-block