Temporary directory management in PyTest - Build an Automation Script

Verify temporary directory creation and cleanup using pytest tmp_path fixture

Preconditions (2)

Step 1: Use pytest tmp_path fixture to create a temporary directory

Step 2: Inside the test, create a new file named 'testfile.txt' in the temporary directory

Step 3: Write the text 'Hello, pytest!' into the file

Step 4: Read the file content and verify it matches 'Hello, pytest!'

Step 5: After the test finishes, verify that the temporary directory and its contents are deleted automatically

✅ Expected Result: The file 'testfile.txt' is created with correct content during the test, and the temporary directory is removed after test completion

Automation Requirements - pytest

Assertions Needed:

Assert that the file 'testfile.txt' exists in the temporary directory

Assert that the file content equals 'Hello, pytest!'

Best Practices:

Use pytest tmp_path fixture for temporary directory management

Avoid hardcoding paths; use pathlib.Path methods

Do not manually delete temporary files or directories; rely on pytest cleanup

Keep tests isolated and independent

Automated Solution

PyTest

import pytest


def test_temporary_directory(tmp_path):
    # Create a file path in the temporary directory
    file_path = tmp_path / "testfile.txt"
    # Write text to the file
    file_path.write_text("Hello, pytest!")
    # Read the text back
    content = file_path.read_text()
    # Assert the file exists
    assert file_path.exists(), f"File {file_path} should exist"
    # Assert the content is correct
    assert content == "Hello, pytest!", f"File content should be 'Hello, pytest!' but was '{content}'"

# Note: pytest automatically cleans up tmp_path after test execution

This test uses the tmp_path fixture provided by pytest to create a temporary directory unique to the test run.

We create a file testfile.txt inside this directory and write the string 'Hello, pytest!' to it.

Then, we read the file content and assert that the file exists and the content matches what we wrote.

We rely on pytest to automatically delete the temporary directory and its contents after the test finishes, so no manual cleanup is needed.

This approach keeps tests isolated and avoids side effects on the real file system.

Common Mistakes - 3 Pitfalls

Hardcoding file paths instead of using tmp_path fixture

Manually deleting temporary files or directories in the test

Not asserting file existence before reading content

Bonus Challenge

Now add data-driven testing to create multiple files with different names and contents using pytest parametrize

Show Hint

Practice

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

easy

A. To create a temporary directory for test files that is cleaned up automatically

B. To permanently store test results on disk

C. To speed up test execution by caching files

D. To replace the need for writing assertions in tests

Solution

1. Step 1: Understand the role of tmp_path in pytest

   The tmp_path fixture provides a temporary directory unique to each test run.

2. Step 2: Recognize the cleanup behavior

   Files created in this directory are removed after the test finishes, keeping tests clean and isolated.

3. Final Answer:

   To create a temporary directory for test files that is cleaned up automatically -> Option A

4. Quick Check:

   Temporary directory = safe test files [OK]

Hint: Remember tmp_path auto-cleans test files after each test [OK]

Common Mistakes:

• Thinking tmp_path stores files permanently
• Confusing tmp_path with caching mechanisms
• Believing tmp_path replaces assertions

2. Which of the following is the correct way to use the tmp_path fixture in a pytest test function?

easy

A. def test_example():\n file = tmp_path / 'test.txt'\n file.write_text('hello')

B. def test_example(tmp_path):\n file = tmp_path / 'test.txt'\n file.write_text('hello')

C. def test_example(tmp_path):\n file = open('test.txt', 'w')\n file.write('hello')

D. def test_example():\n tmp_path = '/tmp/test'\n file = tmp_path + '/test.txt'\n write(file, 'hello')

Solution

1. Step 1: Identify correct fixture usage

   pytest injects tmp_path as a function argument automatically.

2. Step 2: Check file creation syntax

   Using tmp_path / 'filename' creates a Path object; write_text() writes content correctly.

3. Final Answer:

   def test_example(tmp_path):\n file = tmp_path / 'test.txt'\n file.write_text('hello') -> Option B

4. Quick Check:

   Fixture as argument + Path write = correct [OK]

Hint: Always accept tmp_path as a test function argument [OK]

Common Mistakes:

• Assigning tmp_path manually instead of using fixture
• Using open() without tmp_path directory
• Not passing tmp_path as a parameter

3. What will be the output of the following pytest test code snippet?

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

medium

A. Runtime error because file is not created

B. Test fails due to assertion error

C. Syntax error in test code

D. Test passes successfully

Solution

1. Step 1: Analyze file writing and reading

   The code writes 'pytest' to a file in tmp_path, then reads it back correctly.

2. Step 2: Check assertion correctness

   The read content matches the written string 'pytest', so assertion passes.

3. Final Answer:

   Test passes successfully -> Option D

4. Quick Check:

   Write then read same text = pass [OK]

Hint: Write and read text in tmp_path matches, so assert passes [OK]

Common Mistakes:

• Assuming file is not created automatically
• Confusing assertion logic
• Thinking tmp_path is a string path, not Path object

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

def test_error(tmp_path):
    file = tmp_path + '/file.txt'
    file.write_text('error')

medium

A. File write_text method does not exist

B. Missing assertion statement causes test failure

C. Using + operator to join paths causes a TypeError

D. tmp_path fixture is not passed as argument

Solution

1. Step 1: Check path joining method

   tmp_path is a Path object; using + with string causes TypeError.

2. Step 2: Correct path joining

   Use tmp_path / 'file.txt' to join paths properly.

3. Final Answer:

   Using + operator to join paths causes a TypeError -> Option C

4. Quick Check:

   Path + string = error; use / operator [OK]

Hint: Join paths with / operator, not + [OK]

Common Mistakes:

• Using + to join Path and string
• Forgetting to pass tmp_path as parameter
• Assuming write_text is invalid method

5. You want to create a nested directory structure inside tmp_path and write a file in the deepest folder. Which code snippet correctly does this in pytest?

hard

A. def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n nested_dir.mkdir(parents=True)\n file = nested_dir / 'file.txt'\n file.write_text('nested')

B. def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n nested_dir.mkdir()\n file = nested_dir / 'file.txt'\n file.write_text('nested')

C. def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n file = nested_dir / 'file.txt'\n file.write_text('nested')

D. def test_nested(tmp_path):\n nested_dir = tmp_path + '/a/b/c'\n nested_dir.mkdir(parents=True)\n file = nested_dir / 'file.txt'\n file.write_text('nested')

Solution

1. Step 1: Understand nested directory creation

   To create nested folders, mkdir(parents=True) is needed to create all missing parents.

2. Step 2: Check path joining and file writing

   Using / operator joins paths correctly; writing text to file is valid.

3. Step 3: Identify errors in other options

   def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n nested_dir.mkdir()\n file = nested_dir / 'file.txt'\n file.write_text('nested') misses parents=True, so mkdir fails if parents missing. def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n file = nested_dir / 'file.txt'\n file.write_text('nested') does not create directories before writing file. def test_nested(tmp_path):\n nested_dir = tmp_path + '/a/b/c'\n nested_dir.mkdir(parents=True)\n file = nested_dir / 'file.txt'\n file.write_text('nested') uses + operator incorrectly for paths.

4. Final Answer:

   def test_nested(tmp_path):\n nested_dir = tmp_path / 'a' / 'b' / 'c'\n nested_dir.mkdir(parents=True)\n file = nested_dir / 'file.txt'\n file.write_text('nested') -> Option A

5. Quick Check:

   mkdir(parents=True) + / operator = correct [OK]

Hint: Use mkdir(parents=True) to create nested folders [OK]

Common Mistakes:

• Not using parents=True for nested mkdir
• Using + operator to join paths
• Writing file before creating directories