Skip to content

Directory fixtures

provide.testkit.file.directory_fixtures

Directory-specific test fixtures.

Fixtures for creating temporary directories, nested structures, and standard test directory layouts.

Functions

empty_directory 

empty_directory() -> Generator[Path, None, None]

Create an empty temporary directory.

Yields:

Type Description
Path

Path to an empty directory.
Source code in provide/testkit/file/directory_fixtures.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@pytest.fixture
def empty_directory() -> Generator[Path, None, None]:
    """
    Create an empty temporary directory.

    Yields:
        Path to an empty directory.
    """
    with foundation_temp_dir() as temp_dir:
        yield temp_dir

nested_directory_structure 

nested_directory_structure() -> Generator[Path, None, None]

Create a deeply nested directory structure for testing.

Creates
  • level1/
    • level2/
      • level3/
        • deep_file.txt
    • file_l2.txt
  • file_l1.txt

Yields:

Type Description
Path

Path to the root of the structure.
Source code in provide/testkit/file/directory_fixtures.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@pytest.fixture
def nested_directory_structure() -> Generator[Path, None, None]:
    """
    Create a deeply nested directory structure for testing.

    Creates:
        - level1/
            - level2/
                - level3/
                    - deep_file.txt
            - file_l2.txt
        - file_l1.txt

    Yields:
        Path to the root of the structure.
    """
    with foundation_temp_dir() as root:
        # Create nested structure
        deep_dir = root / "level1" / "level2" / "level3"
        deep_dir.mkdir(parents=True)

        # Add files at different levels
        (root / "file_l1.txt").write_text("Level 1 file")
        (root / "level1" / "file_l2.txt").write_text("Level 2 file")
        (deep_dir / "deep_file.txt").write_text("Deep file")

        yield root

temp_directory 

temp_directory() -> Generator[Path, None, None]

Create a temporary directory that's cleaned up after test.

Yields:

Type Description
Path

Path to the temporary directory.
Source code in provide/testkit/file/directory_fixtures.py 
19
20
21
22
23
24
25
26
27
28
@pytest.fixture
def temp_directory() -> Generator[Path, None, None]:
    """
    Create a temporary directory that's cleaned up after test.

    Yields:
        Path to the temporary directory.
    """
    with foundation_temp_dir() as temp_dir:
        yield temp_dir

test_files_structure 

test_files_structure() -> (
    Generator[tuple[Path, Path], None, None]
)

Create standard test file structure with files and subdirectories.

Creates
  • source/
    • file1.txt (contains "Content 1")
    • file2.txt (contains "Content 2")
    • subdir/
      • file3.txt (contains "Content 3")

Yields:

Type Description
tuple[Path, Path]

Tuple of (temp_path, source_path)
Source code in provide/testkit/file/directory_fixtures.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@pytest.fixture
def test_files_structure() -> Generator[tuple[Path, Path], None, None]:
    """
    Create standard test file structure with files and subdirectories.

    Creates:
        - source/
            - file1.txt (contains "Content 1")
            - file2.txt (contains "Content 2")
            - subdir/
                - file3.txt (contains "Content 3")

    Yields:
        Tuple of (temp_path, source_path)
    """
    with foundation_temp_dir() as path:
        source = path / "source"
        source.mkdir()

        # Create test files
        (source / "file1.txt").write_text("Content 1")
        (source / "file2.txt").write_text("Content 2")

        # Create subdirectory with files
        subdir = source / "subdir"
        subdir.mkdir()
        (subdir / "file3.txt").write_text("Content 3")

        yield path, source