Skip to content

filesystem

django_spire.core.management.commands.spire_startapp_pkg.filesystem

FileSystem

Implementation of file system operations for app generation.

This class provides concrete implementations of file system operations needed to create directories, copy templates, and manage files.

copy_tree

Copies an entire directory tree from source to destination.

Ignores Python cache directories and compiled files during the copy.

Parameters:

  • src (Path) –

    Source directory path to copy from.

  • dst (Path) –

    Destination directory path to copy to.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def copy_tree(self, src: Path, dst: Path) -> None:
    """
    Copies an entire directory tree from source to destination.

    Ignores Python cache directories and compiled files during the copy.

    :param src: Source directory path to copy from.
    :param dst: Destination directory path to copy to.
    """

    shutil.copytree(
        src,
        dst,
        dirs_exist_ok=True,
        ignore=shutil.ignore_patterns('__pycache__', '*.pyc')
    )

create_directory

Creates a directory and all necessary parent directories.

Parameters:

  • path (Path) –

    Directory path to create.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
37
38
39
40
41
42
43
44
def create_directory(self, path: Path) -> None:
    """
    Creates a directory and all necessary parent directories.

    :param path: Directory path to create.
    """

    path.mkdir(parents=True, exist_ok=True)

exists

Checks if a path exists on the file system.

Parameters:

  • path (Path) –

    Path to check for existence.

Returns:

  • bool –

    True if the path exists, False otherwise.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
46
47
48
49
50
51
52
53
54
def exists(self, path: Path) -> bool:
    """
    Checks if a path exists on the file system.

    :param path: Path to check for existence.
    :return: True if the path exists, False otherwise.
    """

    return path.exists()

has_content

Checks if a directory exists and contains any files or subdirectories.

Parameters:

  • path (Path) –

    Directory path to check.

Returns:

  • bool –

    True if the directory exists and has content, False otherwise.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
56
57
58
59
60
61
62
63
64
def has_content(self, path: Path) -> bool:
    """
    Checks if a directory exists and contains any files or subdirectories.

    :param path: Directory path to check.
    :return: True if the directory exists and has content, False otherwise.
    """

    return self.exists(path) and any(path.iterdir())

iterate_files

Recursively finds all files matching a pattern in a directory.

Parameters:

  • path (Path) –

    Directory path to search within.

  • pattern (str) –

    Glob pattern to match files (e.g., '.py', '.template').

Returns:

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
66
67
68
69
70
71
72
73
74
75
def iterate_files(self, path: Path, pattern: str) -> Iterator[Path]:
    """
    Recursively finds all files matching a pattern in a directory.

    :param path: Directory path to search within.
    :param pattern: Glob pattern to match files (e.g., '*.py', '*.template').
    :return: Iterator of matching file paths.
    """

    return path.rglob(pattern)

read_file

Reads the entire contents of a text file.

Parameters:

  • path (Path) –

    File path to read.

Returns:

  • str –

    File contents as a string.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
77
78
79
80
81
82
83
84
85
86
def read_file(self, path: Path) -> str:
    """
    Reads the entire contents of a text file.

    :param path: File path to read.
    :return: File contents as a string.
    """

    with open(path, 'r', encoding='utf-8') as handle:
        return handle.read()

rename

Renames a file or directory.

Parameters:

  • old (Path) –

    Current path of the file or directory.

  • new (Path) –

    New path for the file or directory.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
88
89
90
91
92
93
94
95
96
def rename(self, old: Path, new: Path) -> None:
    """
    Renames a file or directory.

    :param old: Current path of the file or directory.
    :param new: New path for the file or directory.
    """

    old.rename(new)

write_file

Writes content to a text file.

Parameters:

  • path (Path) –

    File path to write to.

  • content (str) –

    String content to write to the file.

Source code in django_spire/core/management/commands/spire_startapp_pkg/filesystem.py 
 98
 99
100
101
102
103
104
105
106
107
def write_file(self, path: Path, content: str) -> None:
    """
    Writes content to a text file.

    :param path: File path to write to.
    :param content: String content to write to the file.
    """

    with open(path, 'w', encoding='utf-8') as handle:
        handle.write(content)