pytest-timeout for time limits

Introduction

Sometimes tests take too long and slow down your work. pytest-timeout helps stop tests that run longer than you want.

You want to stop a test if it runs more than 5 seconds to save time.

You have a test that might get stuck in a loop and never finish.

You want to make sure your code runs fast enough by setting a max time.

You run many tests and want to avoid waiting too long for one slow test.

Syntax

PyTest

import pytest

@pytest.mark.timeout(seconds)
def test_function():
    # test code here

Use @pytest.mark.timeout(seconds) above your test function to set a time limit.

The seconds value is how many seconds the test can run before stopping.

Examples

This test must finish in 3 seconds or pytest will stop it.

PyTest

import pytest

@pytest.mark.timeout(3)
def test_fast():
    assert 1 + 1 == 2

This test will fail because it sleeps for 2 seconds but timeout is 1 second.

PyTest

import pytest

@pytest.mark.timeout(1)
def test_slow():
    import time
    time.sleep(2)
    assert True

Sample Program

The first test sleeps 1 second and passes because it is under the 2-second limit.

The second test sleeps 3 seconds but has a 1-second limit, so pytest stops it and marks it as failed due to timeout.

PyTest

import pytest
import time

@pytest.mark.timeout(2)
def test_quick():
    time.sleep(1)
    assert True

@pytest.mark.timeout(1)
def test_too_slow():
    time.sleep(3)
    assert True

Important Notes

Make sure to install pytest-timeout plugin with pip install pytest-timeout before using it.

You can set timeout globally in pytest config or per test with the decorator.

Timeout helps catch infinite loops or very slow tests early.

Summary

pytest-timeout stops tests that run longer than a set time.

Use @pytest.mark.timeout(seconds) to add a time limit to tests.

This keeps your test runs fast and avoids waiting on stuck tests.

Practice

1. What is the main purpose of using pytest-timeout in test cases?

easy

A. To stop tests that run longer than a specified time limit

B. To increase the speed of test execution by skipping tests

C. To automatically retry failed tests

D. To generate detailed test coverage reports

Solution

1. Step 1: Understand pytest-timeout functionality

   pytest-timeout is designed to stop tests that exceed a time limit to prevent long waits.

2. Step 2: Compare options with pytest-timeout purpose

   Only To stop tests that run longer than a specified time limit matches this purpose; others describe different pytest features.

3. Final Answer:

   To stop tests that run longer than a specified time limit -> Option A

4. Quick Check:

   pytest-timeout stops long tests = C [OK]

Hint: Remember: pytest-timeout stops tests running too long [OK]

Common Mistakes:

• Confusing timeout with test retries
• Thinking it speeds up tests by skipping
• Mixing it with coverage reporting

2. Which of the following is the correct way to set a 5-second timeout for a test function using pytest-timeout?

easy

A. @pytest.mark.timeout(seconds=5)
def test_example(): pass

B. @pytest.timeout(5)
def test_example(): pass

C. @pytest.mark.timeout(5)
def test_example(): pass

D. @pytest.timeout(seconds=5)
def test_example(): pass

Solution

1. Step 1: Recall correct pytest-timeout decorator syntax

   The correct decorator is @pytest.mark.timeout(5) using a positional argument.

2. Step 2: Check each option's syntax

   @pytest.mark.timeout(5) def test_example(): pass uses correct syntax with positional argument 5. @pytest.mark.timeout(seconds=5) def test_example(): pass incorrectly uses keyword argument 'seconds=5'. The options using @pytest.timeout use wrong decorator names.

3. Final Answer:

   @pytest.mark.timeout(5) def test_example(): pass -> Option C

4. Quick Check:

   Use @pytest.mark.timeout(5) = A [OK]

Hint: Use @pytest.mark.timeout(5) to set 5 seconds [OK]

Common Mistakes:

• Using @pytest.timeout instead of @pytest.mark.timeout
• Passing seconds as a keyword argument
• Missing the @pytest.mark prefix

3. Given the following test code, what will happen when running pytest?

@pytest.mark.timeout(2)
def test_sleep():
    import time
    time.sleep(3)

medium

A. The test will pass because sleep is allowed

B. The test will raise a syntax error

C. The test will be skipped automatically

D. The test will fail due to exceeding the 2-second timeout

Solution

1. Step 1: Analyze the timeout and sleep duration

   The test has a 2-second timeout but sleeps for 3 seconds, exceeding the limit.

2. Step 2: Understand pytest-timeout behavior on timeout

   pytest-timeout stops the test and marks it as failed if it runs longer than the timeout.

3. Final Answer:

   The test will fail due to exceeding the 2-second timeout -> Option D

4. Quick Check:

   Sleep 3s > timeout 2s = fail [OK]

Hint: If test runs longer than timeout, it fails [OK]

Common Mistakes:

• Assuming test passes despite timeout
• Thinking test is skipped automatically
• Confusing timeout with syntax errors

4. Identify the error in the following pytest test using pytest-timeout:

@pytest.mark.timeout(3)
def test_loop():
    for i in range(5):
        time.sleep(1)

medium

A. Timeout value is too low for the loop

B. Missing import of the time module

C. Incorrect decorator syntax

D. The test will pass without errors

Solution

1. Step 1: Check for missing imports

   The test uses time.sleep(1) but does not import the time module.

2. Step 2: Verify other aspects

   The timeout and decorator syntax are correct. The missing import will cause a NameError.

3. Final Answer:

   Missing import of the time module -> Option B

4. Quick Check:

   Using time.sleep without import = error [OK]

Hint: Always import modules before using their functions [OK]

Common Mistakes:

• Ignoring missing imports
• Assuming timeout causes error instead
• Thinking decorator syntax is wrong

5. You want to apply a 10-second timeout to all tests in a pytest file without adding @pytest.mark.timeout to each test. Which is the best way to do this?

hard

A. Add pytestmark = pytest.mark.timeout(10) at the top of the test file

B. Set timeout=10 in pytest.ini configuration file

C. Use @pytest.mark.timeout(10) on a dummy test and inherit it

D. Add timeout=10 as a command line argument every time

Solution

1. Step 1: Understand pytestmark usage

   Setting pytestmark = pytest.mark.timeout(10) applies the timeout decorator to all tests in the file automatically.

2. Step 2: Evaluate other options

   Adding timeout as a command line argument requires specifying --timeout=10 every time pytest is run; setting timeout in pytest.ini applies it globally to all tests in the project; using a dummy test for inheritance is not a valid pytest feature. pytestmark is best for this specific file.

3. Final Answer:

   Add pytestmark = pytest.mark.timeout(10) at the top of the test file -> Option A

4. Quick Check:

   pytestmark applies decorator to all tests [OK]

Hint: Use pytestmark variable to apply timeout to all tests [OK]

Common Mistakes:

• Trying to set timeout in pytest.ini (global, not file-specific)
• Using dummy test inheritance (not valid)
• Relying on command line timeout argument (inconvenient)