Test modules in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a test module in pytest?

A test module is a Python file that contains test functions or classes. Pytest automatically finds and runs tests inside these modules.

beginner

How should you name a test module for pytest to recognize it automatically?

Name the file starting with test_ or ending with _test.py. For example, test_example.py or example_test.py.

beginner

Why is it important to keep test modules separate from application code?

Separating test modules helps keep code organized, makes tests easier to find, and prevents accidental execution of tests in production.

intermediate

What is the role of __init__.py in test directories?

In pytest, __init__.py files are optional. They can make test directories into packages but are not required for pytest to discover tests.

beginner

How can you run tests from a specific test module using pytest?

Use the command pytest path/to/test_module.py. This runs all tests inside that module only.

Which file name will pytest automatically recognize as a test module?

A mytests.py

B math_tested.py

C example.py

D test_math.py

Pytest recognizes files starting with 'test_' or ending with '_test.py'. 'test_math.py' fits this pattern.

What does pytest look for inside a test module to run tests?

A Functions ending with '_check'

B Any function with a docstring

C Functions or classes starting with 'test'

D Only classes named 'Test'

Pytest runs functions or methods whose names start with 'test' inside test modules.

If you want to run tests only from a single test module, what command do you use?

A pytest test_module.py

B pytest -m test_module

C pytest --module test_module

D pytest run test_module

Running 'pytest test_module.py' runs tests only from that file.

Is it necessary to have an __init__.py file in a test directory for pytest to find tests?

A No, pytest can find tests without it

B Yes, always required

C Only if tests are in subdirectories

D Only for Python versions below 3.6

Pytest can discover tests without __init__.py files in test directories.

Why should test modules be kept separate from application code?

A To reduce file size

B To organize code and avoid running tests in production

C To make tests run faster

D To prevent syntax errors

Separating test modules helps keep code organized and prevents accidental test runs in production.

Explain how pytest discovers and runs tests inside test modules.

Think about file names, function names, and how pytest finds tests.

Describe best practices for organizing test modules in a Python project using pytest.

Consider how to keep tests easy to find and run.

Practice

1. What is the correct way to name a Python file so that pytest recognizes it as a test module?

easy

A. The file name can be anything as long as it contains tests.

B. The file name should start with check_.

C. The file name should be pytest_module.py.

D. The file name should start with test_ or end with _test.py.

Solution

1. Step 1: Understand pytest file naming conventions

   pytest automatically discovers test files if their names start with test_ or end with _test.py.

2. Step 2: Evaluate each option

   Only The file name should start with test_ or end with _test.py. matches the correct naming pattern for pytest to find test modules automatically.

3. Final Answer:

   The file name should start with test_ or end with _test.py. -> Option D

4. Quick Check:

   pytest test file naming = start with test_ or end with _test.py [OK]

Hint: Remember test files start with test_ or end with _test.py [OK]

Common Mistakes:

• Assuming any file with tests is recognized
• Using incorrect prefixes like check_
• Naming files without .py extension

2. Which of the following is the correct syntax for a test function inside a pytest test module?

easy

A. def test_function():

B. def check_function():

C. def function_test():

D. def testing_function():

Solution

1. Step 1: Recall pytest test function naming rules

   pytest runs functions that start with test_ automatically as tests.

2. Step 2: Match options with naming rule

   Only def test_function(): defines a function starting with test_, so pytest will recognize it as a test.

3. Final Answer:

   def test_function(): -> Option A

4. Quick Check:

   Test functions start with test_ [OK]

Hint: Test functions must start with test_ to run automatically [OK]

Common Mistakes:

• Naming test functions without test_ prefix
• Using other prefixes like check_ or testing_
• Forgetting to define functions with def

3. Given the following test module test_sample.py with these functions:

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

def add():
    return 1 + 1

def test_subtract():
    assert 2 - 1 == 1

Which functions will pytest run as tests?

medium

A. All three functions

B. Only add

C. test_add and test_subtract

D. Only test_add

Solution

1. Step 1: Identify pytest test function naming

   pytest runs functions starting with test_ automatically as tests.

2. Step 2: Check each function name

   test_add and test_subtract start with test_, so pytest runs them. add does not start with test_, so it is ignored.

3. Final Answer:

   test_add and test_subtract -> Option C

4. Quick Check:

   Functions starting with test_ run as tests [OK]

Hint: Only functions starting with test_ run as tests [OK]

Common Mistakes:

• Thinking all functions in test file run as tests
• Confusing helper functions with test functions
• Ignoring function name prefixes

4. You have a test module named test_math.py with this code:

def test_multiply():
    assert 2 * 3 == 5

When you run pytest, what will happen?

medium

A. The test will fail because the assertion is incorrect.

B. pytest will not find any tests to run.

C. pytest will skip the test because of a syntax error.

D. The test will pass because 2 * 3 equals 6.

Solution

1. Step 1: Analyze the assertion in test_multiply

   The assertion checks if 2 * 3 == 5, which is false because 2 * 3 equals 6.

2. Step 2: Understand pytest test result

   pytest runs the test and finds the assertion false, so the test fails.

3. Final Answer:

   The test will fail because the assertion is incorrect. -> Option A

4. Quick Check:

   False assertion causes test failure [OK]

Hint: Check if assertion condition is true or false [OK]

Common Mistakes:

• Assuming test passes despite wrong assertion
• Confusing syntax errors with assertion failures
• Thinking pytest skips failing tests

5. You want to organize tests for a calculator app. You create two files: test_add.py and test_subtract.py. Each file has multiple test functions starting with test_. How does pytest handle these test modules when you run pytest in the folder?

hard

A. pytest requires you to specify each test module to run tests.

B. pytest runs all test functions from both modules automatically.

C. pytest runs only tests from the first module alphabetically.

D. pytest runs tests only if you import modules manually.

Solution

1. Step 1: Understand pytest test discovery

   pytest automatically finds all test modules named with test_ prefix and runs all test functions inside them.

2. Step 2: Apply to multiple test modules

   When running pytest in the folder, it collects tests from both test_add.py and test_subtract.py and runs all test functions starting with test_.

3. Final Answer:

   pytest runs all test functions from both modules automatically. -> Option B

4. Quick Check:

   pytest auto-discovers all test modules and functions [OK]

Hint: pytest runs all test_ modules and functions in folder automatically [OK]

Common Mistakes:

• Thinking pytest runs only one module at a time
• Believing manual imports are needed for tests
• Assuming tests must be specified explicitly