File system testing with tmp_path in PyTest - Framework Patterns

Framework Mode - File system testing with tmp_path

Folder Structure

tests/
├── test_filesystem.py       # Tests using tmp_path fixture
├── conftest.py              # Shared fixtures and hooks
utils/
├── file_helpers.py          # Helper functions for file operations
pytest.ini                  # Pytest configuration file

Test Framework Layers

• Tests Layer: Contains test cases using tmp_path to create temporary files and directories safely.
• Utilities Layer: Helper functions for file creation, reading, and cleanup to keep tests clean and reusable.
• Fixtures Layer: tmp_path is a built-in pytest fixture providing an isolated temporary directory for each test.
• Configuration Layer: pytest.ini or conftest.py to configure test runs and share fixtures.

Configuration Patterns

• Use pytest.ini to set default options like test paths and markers.
• Use conftest.py to define shared fixtures or customize tmp_path behavior if needed.
• Isolate file system tests by always using tmp_path to avoid side effects on real files.
• Parameterize tests with different file contents or names using pytest's @pytest.mark.parametrize.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting to show passed/failed tests clearly.
• Generate detailed reports with plugins like pytest-html for easy review.
• Integrate tests into CI/CD pipelines (GitHub Actions, Jenkins) to run on every commit.
• Ensure temporary files created by tmp_path are cleaned automatically after each test run.

Best Practices

• Always use tmp_path fixture for file system tests to keep tests isolated and repeatable.
• Write small, focused tests that create only the files/directories needed for that test.
• Use helper functions in utilities to reduce code duplication for file operations.
• Clean up is automatic with tmp_path, so avoid manual deletion to prevent errors.
• Use descriptive test names to clarify what file system behavior is being tested.

Self Check

Where in this framework structure would you add a helper function to create a sample text file for multiple tests?

Key Result

Use pytest's tmp_path fixture to isolate file system tests with clean temporary directories.

Practice

1. What is the main purpose of using tmp_path in pytest tests?

easy

A. To mock file system calls without creating real files

B. To permanently store test files for later use

C. To speed up test execution by caching files

D. To create a temporary directory unique to each test for safe file operations

Solution

1. Step 1: Understand tmp_path functionality

   tmp_path provides a temporary directory unique to each test run.

2. Step 2: Identify its purpose in tests

   This temporary directory allows safe creation, reading, and deletion of files without affecting the real file system.

3. Final Answer:

   To create a temporary directory unique to each test for safe file operations -> Option D

4. Quick Check:

   tmp_path = safe temp folder [OK]

Hint: Remember tmp_path is a safe temp folder for each test [OK]

Common Mistakes:

• Thinking tmp_path stores files permanently
• Confusing tmp_path with mocking file calls
• Assuming tmp_path speeds up tests by caching

2. Which of the following is the correct way to create a new file named test.txt inside the tmp_path directory in pytest?

easy

A. (tmp_path / 'test.txt').write_text('Hello')

B. tmp_path / 'test.txt'.write_text('Hello')

C. tmp_path.write_text('test.txt', 'Hello')

D. tmp_path.write('test.txt', 'Hello')

Solution

1. Step 1: Understand tmp_path usage

   tmp_path is a pathlib.Path object, so to create a file, you combine paths with / operator.

2. Step 2: Correct syntax for writing text

   Use parentheses to combine path and then call write_text() on the file path: (tmp_path / 'test.txt').write_text('Hello').

3. Final Answer:

   (tmp_path / 'test.txt').write_text('Hello') -> Option A

4. Quick Check:

   Use (tmp_path / filename).write_text() [OK]

Hint: Use parentheses to combine path before write_text() [OK]

Common Mistakes:

• Calling write_text directly on tmp_path
• Missing parentheses around path combination
• Using incorrect method names like write()

3. Given the following pytest test code using tmp_path:

def test_write_and_read(tmp_path):
    file = tmp_path / 'data.txt'
    file.write_text('pytest rocks')
    content = file.read_text()
    assert content == 'pytest rocks'

What will be the result of running this test?

medium

A. Test passes because the file content matches the assertion

B. Test fails because the file is not created

C. Test fails because read_text() returns bytes, not string

D. Test raises a syntax error

Solution

1. Step 1: Analyze file creation and writing

   The code creates a file named 'data.txt' in tmp_path and writes the string 'pytest rocks' correctly.

2. Step 2: Analyze reading and assertion

   Reading the file with read_text() returns the string 'pytest rocks', which matches the assertion exactly.

3. Final Answer:

   Test passes because the file content matches the assertion -> Option A

4. Quick Check:

   write_text + read_text = matching string [OK]

Hint: write_text and read_text use strings, so assertion matches [OK]

Common Mistakes:

• Thinking read_text returns bytes instead of string
• Assuming file is not created automatically
• Confusing syntax errors with runtime behavior

4. Identify the error in this pytest test using tmp_path:

def test_file_creation(tmp_path):
    file = tmp_path / 'log.txt'
    file.write('Log entry')
    assert file.read_text() == 'Log entry'

medium

A. Missing parentheses around tmp_path / 'log.txt'

B. The assertion compares bytes to string causing failure

C. Using write() instead of write_text() causes an AttributeError

D. The test will pass without errors

Solution

1. Step 1: Check method used to write file

   Path objects do not have a write() method; the correct method to write text is write_text().

2. Step 2: Understand error caused

   Calling write() will raise an AttributeError because it does not exist on the Path object.

3. Final Answer:

   Using write() instead of write_text() causes an AttributeError -> Option C

4. Quick Check:

   Use write_text() to write strings to files [OK]

Hint: Use write_text() for writing strings to files [OK]

Common Mistakes:

• Confusing write() with write_text()
• Ignoring method errors and expecting test pass
• Assuming parentheses are missing around path

5. You want to test a function that creates multiple files inside a directory using pytest's tmp_path. Which approach correctly verifies that exactly three files named a.txt, b.txt, and c.txt exist in the temporary directory after the function runs?

hard

A. Use assert tmp_path.read_text() == 'a.txtb.txtc.txt'

B. Use assert set(f.name for f in tmp_path.iterdir()) == {'a.txt', 'b.txt', 'c.txt'}

C. Use assert tmp_path.glob('*.txt') == ['a.txt', 'b.txt', 'c.txt']

D. Use assert tmp_path.exists('a.txt') and tmp_path.exists('b.txt') and tmp_path.exists('c.txt')

Solution

1. Step 1: Understand how to list files in tmp_path

   tmp_path.iterdir() returns an iterator of Path objects for all entries in the directory.

2. Step 2: Verify file names correctly

   Extract file names with f.name and compare as a set to ensure exactly the three expected files exist.

3. Final Answer:

   Use assert set(f.name for f in tmp_path.iterdir()) == {'a.txt', 'b.txt', 'c.txt'} -> Option B

4. Quick Check:

   Use iterdir() and set comparison for exact files [OK]

Hint: Use set of filenames from iterdir() to check exact files [OK]

Common Mistakes:

• Using glob() without converting to list or set
• Trying to read tmp_path as a file
• Using exists() incorrectly on tmp_path object