Skip to content

testing

Useful downstream testing utilities.

TmpFileManager()

A context manager for managing temporary files and directories.

Usage: with TmpFileManager() as manager: file_path = manager.tmpfile(content="Hello, temporary file!") dir_path = manager.tmp_dir()

Source code in py/bitbazaar/testing/_tmp_file_manager.py 
22
23
def __init__(self):
    self.root_dir = tempfile.mkdtemp()

cleanup()

Clean up created temporary files and directories.

Source code in py/bitbazaar/testing/_tmp_file_manager.py 
89
90
91
def cleanup(self):
    """Clean up created temporary files and directories."""
    shutil.rmtree(self.root_dir)

tmpdir(parent=None, name=None)

Create a temporary directory.

Parameters: - parent: Optional directory to create the temporary directory in. Otherwise will be placed in root.

Returns: - The path to the created temporary directory.

Source code in py/bitbazaar/testing/_tmp_file_manager.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def tmpdir(
    self, parent: tp.Optional[str] = None, name: tp.Optional[str] = None
) -> pathlib.Path:
    """Create a temporary directory.

    Parameters:
    - parent: Optional directory to create the temporary directory in. Otherwise will be placed in root.

    Returns:
    - The path to the created temporary directory.
    """
    if parent is None:
        parent = self.root_dir

    final_path = pathlib.Path(os.path.join(parent, str(uuid.uuid4()) if name is None else name))
    os.mkdir(final_path)

    self.dirs_created += 1
    return final_path

tmpfile(content, suffix=None, parent=None, full_name=None)

Create a temporary file.

Parameters: - content: The content to write to the temporary file. - suffix: Optional suffix to append to the temporary file. Otherwise will be created with tempfile. - parent: Optional directory to create the temporary file in. Otherwise will be placed in root. - full_name: Optional full name of the temporary file, overrides suffix. Otherwise will be created with tempfile.

Returns: - The path to the created temporary file.

Source code in py/bitbazaar/testing/_tmp_file_manager.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
60
61
62
63
64
65
66
67
def tmpfile(
    self,
    content: str,
    suffix: tp.Optional[str] = None,
    parent: tp.Optional[tp.Union[str, pathlib.Path]] = None,
    full_name: tp.Optional[str] = None,
) -> pathlib.Path:
    """Create a temporary file.

    Parameters:
    - content: The content to write to the temporary file.
    - suffix: Optional suffix to append to the temporary file. Otherwise will be created with tempfile.
    - parent: Optional directory to create the temporary file in. Otherwise will be placed in root.
    - full_name: Optional full name of the temporary file, overrides suffix. Otherwise will be created with tempfile.

    Returns:
    - The path to the created temporary file.
    """
    if parent is None:
        parent = self.root_dir

    filename: str
    if full_name is not None:
        filename = full_name
    elif suffix is not None:
        filename = str(uuid.uuid4()) + suffix
    else:
        filename = str(uuid.uuid4())

    final_path = pathlib.Path(os.path.join(parent, filename))

    with open(final_path, "w") as file:
        file.write(content)

    self.files_created += 1

    return final_path
Last update: August 7, 2024
Created: August 7, 2024