Content-based file test fixtures.
Fixtures for creating files with specific content types like text, binary,
CSV, JSON, and other structured data.
Functions
temp_binary_file() -> (
Generator[Callable[..., Path], None, None]
)
Create temporary binary files.
Returns:
| Type |
Description |
None
|
Function that creates binary files.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_binary_file() -> Generator[Callable[..., Path], None, None]:
"""
Create temporary binary files.
Returns:
Function that creates binary files.
"""
created_files: list[Path] = []
def _make_binary(size: int = 1024, pattern: bytes | None = None, suffix: str = ".bin") -> Path:
"""
Create a temporary binary file.
Args:
size: File size in bytes
pattern: Optional byte pattern to repeat
suffix: File suffix
Returns:
Path to created binary file
"""
if pattern is None:
# Create pseudo-random binary data
content = bytes(random.randint(0, 255) for _ in range(size))
else:
# Repeat pattern to reach size
repetitions = size // len(pattern) + 1
content = (pattern * repetitions)[:size]
with foundation_temp_file(suffix=suffix, text=False, cleanup=False) as path:
path.write_bytes(content)
created_files.append(path)
return path
yield _make_binary
# Cleanup
for path in created_files:
safe_delete(path, missing_ok=True)
|
temp_csv_file() -> (
Generator[Callable[..., Path], None, None]
)
Create temporary CSV files for testing.
Returns:
| Type |
Description |
None
|
Function that creates CSV files.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_csv_file() -> Generator[Callable[..., Path], None, None]:
"""
Create temporary CSV files for testing.
Returns:
Function that creates CSV files.
"""
created_files: list[Path] = []
def _make_csv(
headers: Sequence[str],
rows: Sequence[Sequence[Any]],
suffix: str = ".csv",
) -> Path:
"""
Create a temporary CSV file.
Args:
headers: Column headers
rows: Data rows
suffix: File suffix
Returns:
Path to created CSV file
"""
with (
foundation_temp_file(suffix=suffix, text=True, cleanup=False) as path,
path.open("w", newline="") as f,
):
writer = csv.writer(f)
writer.writerow(headers)
writer.writerows(rows)
created_files.append(path)
return path
yield _make_csv
# Cleanup
for path in created_files:
safe_delete(path, missing_ok=True)
|
temp_file() -> Generator[Callable[..., Path], None, None]
Create a temporary file factory with optional content.
Returns:
| Type |
Description |
None
|
A function that creates temporary files with specified content and suffix.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_file() -> Generator[Callable[..., Path], None, None]:
"""
Create a temporary file factory with optional content.
Returns:
A function that creates temporary files with specified content and suffix.
"""
created_files: list[Path] = []
def _make_temp_file(content: str = "test content", suffix: str = ".txt") -> Path:
"""
Create a temporary file.
Args:
content: Content to write to the file
suffix: File suffix/extension
Returns:
Path to the created temporary file
"""
with foundation_temp_file(suffix=suffix, text=True, cleanup=False) as path:
path.write_text(content)
created_files.append(path)
return path
yield _make_temp_file
# Cleanup all created files
for path in created_files:
safe_delete(path, missing_ok=True)
|
temp_file_with_content() -> (
Generator[Callable[..., Path], None, None]
)
Create temporary files with specific content.
Returns:
| Type |
Description |
None
|
Function that creates files with content.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_file_with_content() -> Generator[Callable[..., Path], None, None]:
"""
Create temporary files with specific content.
Returns:
Function that creates files with content.
"""
created_files: list[Path] = []
def _make_file(content: str | bytes, suffix: str = ".txt", encoding: str = "utf-8") -> Path:
"""
Create a temporary file with content.
Args:
content: Content to write
suffix: File suffix
encoding: Text encoding (for str content)
Returns:
Path to created file
"""
# Use Foundation's temp_file
with foundation_temp_file(suffix=suffix, text=not isinstance(content, bytes), cleanup=False) as path:
if isinstance(content, bytes):
path.write_bytes(content)
else:
path.write_text(content, encoding=encoding)
created_files.append(path)
return path
yield _make_file
# Cleanup
for path in created_files:
safe_delete(path, missing_ok=True)
|
temp_json_file() -> (
Generator[Callable[..., Path], None, None]
)
Create temporary JSON files for testing.
Returns:
| Type |
Description |
None
|
Function that creates JSON files.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_json_file() -> Generator[Callable[..., Path], None, None]:
"""
Create temporary JSON files for testing.
Returns:
Function that creates JSON files.
"""
created_files: list[Path] = []
def _make_json(data: dict[str, Any] | list[Any], suffix: str = ".json", indent: int = 2) -> Path:
"""
Create a temporary JSON file.
Args:
data: JSON data to write
suffix: File suffix
indent: JSON indentation
Returns:
Path to created JSON file
"""
with foundation_temp_file(suffix=suffix, text=True, cleanup=False) as path, path.open("w") as f:
json.dump(data, f, indent=indent)
created_files.append(path)
return path
yield _make_json
# Cleanup
for path in created_files:
safe_delete(path, missing_ok=True)
|
temp_named_file() -> (
Generator[Callable[..., Path], None, None]
)
Create a named temporary file factory.
Returns:
| Type |
Description |
None
|
Function that creates named temporary files.
|
Source code in provide/testkit/file/content_fixtures.py
| @pytest.fixture
def temp_named_file() -> Generator[Callable[..., Path], None, None]:
"""
Create a named temporary file factory.
Returns:
Function that creates named temporary files.
"""
created_files: list[Path] = []
def _make_named_file(
content: str | bytes | None = None,
suffix: str = "",
prefix: str = "tmp",
dir: Path | str | None = None,
mode: str = "w+b",
delete: bool = False,
) -> Path:
"""
Create a named temporary file.
Args:
content: Optional content to write
suffix: File suffix
prefix: File prefix
dir: Directory for the file
mode: File mode
delete: Whether to delete on close
Returns:
Path to the created file
"""
if isinstance(dir, Path):
dir = str(dir)
# Use Foundation's temp_file with cleanup=False since we manage cleanup
with foundation_temp_file(
suffix=suffix, prefix=prefix, dir=dir, text="b" not in mode, cleanup=False
) as path:
if content is not None:
if isinstance(content, str):
if "b" in mode:
path.write_bytes(content.encode())
else:
path.write_text(content)
else:
path.write_bytes(content)
if not delete:
created_files.append(path)
return path
yield _make_named_file
# Cleanup
for path in created_files:
safe_delete(path, missing_ok=True)
|