cornsnake.util_dir

74def delete_dirs(temp_dirs_to_delete: str) -> None:
75    """
76    Delete directories and their contents.
77    - Python holds on to some paths - so delete as much as we can
78
79    Args:
80    temp_dirs_to_delete (list): A list of directory paths to be deleted.
81    """
82    dirs_with_locked_items = []
83    # faster delete:
84    for temp_dir in temp_dirs_to_delete:
85        try:
86            _rmrf(temp_dir)
87        except FileNotFoundError:
88            dirs_with_locked_items.append(temp_dir)
89            # Intentionally NOT passing exception onwards
90        except PermissionError:
91            dirs_with_locked_items.append(temp_dir)
92            # Intentionally NOT passing exception onwards
93
94    # slower, more robust delete:
95    for temp_dir in dirs_with_locked_items:
96        _delete_dir_contents(temp_dir)

22def copy_directory(from_path: str, to_path: str) -> None:
23    """
24    Copy a directory from one location to another.
25
26    Args:
27    from_path (str): The path of the directory to copy from.
28    to_path (str): The path of the directory to copy to.
29    """
30    shutil.copytree(from_path, to_path)

33def ensure_dir_exists(target_dir: str) -> None:
34    """
35    Ensure that a directory exists, creating it if necessary.
36
37    Args:
38    target_dir (str): The path of the directory to ensure existence of.
39    """
40    if not os.path.exists(target_dir):
41        os.makedirs(target_dir)

44def find_files_by_extension(dir_path: str, extension: str) -> list[str]:
45    """
46    Find files in a directory by a specific file extension.
47
48    Args:
49    dir_path (str): The path of the directory to search for files.
50    extension (str): The file extension to search for.
51
52    Example: ('c:\\temp\\x', '.json') -> ['c:\\temp\\x\\1.json', 'c:\\temp\\x\\2.json']
53
54    Returns:
55    list: A list of file paths with the specified extension.
56    """
57    found_files = []
58    contents = os.listdir(dir_path)
59    for content in contents:
60        path_to_sub = os.path.join(dir_path, content)
61        if os.path.isfile(path_to_sub) and path_to_sub.endswith(extension):
62            found_files.append(path_to_sub)
63    return found_files

66def find_files(dir_path: str) -> list[str]:
67    """Find all files in the given directory."""
68    found_files = []
69    contents = os.listdir(dir_path)
70    for content in contents:
71        path_to_sub = os.path.join(dir_path, content)
72        if os.path.isfile(path_to_sub):
73            found_files.append(path_to_sub)
74    return found_files

77def find_files_recursively(dir_path: str, extension: str = ".*") -> list[str]:
78    result = [
79        y for x in os.walk(dir_path) for y in glob(os.path.join(x[0], f"*{extension}"))
80    ]
81    return result

84def get_dir_parts(path_to_file: str) -> list[str]:
85    """
86    Get the directory components of the given file path.
87
88    Example: 'c:\\temp\\x\\my-file.txt' -> ['c','temp','x']
89    """
90    path_to_dir = os.path.dirname(path_to_file)
91    path = os.path.normpath(path_to_dir)
92    return path.split(os.sep)

 95def get_directory_of_this_script(____file__: str) -> str:
 96    """
 97    Get the directory that contains this script.
 98
 99    Args:
100    __file__ (str): The path to this Python script file.
101    Returns:
102    The absolute path to directory containing your Python script file.
103    """
104    return os.path.dirname(os.path.realpath(____file__))

107def get_parent_dir(my_path: str) -> str:
108    """Get the absolute path of the parent directory of the given directory."""
109    return str(Path(my_path).parent.absolute())

112def get_total_dir_size_in_bytes(start_path: str) -> int:
113    total_size = 0
114    for dirpath, _dirnames, filenames in os.walk(start_path):
115        for f in filenames:
116            fp = os.path.join(dirpath, f)
117            # skip if it is symbolic link
118            if not os.path.islink(fp):
119                fp_allow_long_path = "\\\\?\\" + fp if util_os.is_windows() else fp
120                total_size += os.path.getsize(fp_allow_long_path)
121
122    return total_size

125def get_total_dir_size_in_gigabytes(start_path: str) -> float:
126    """Calculate the total size of a directory in gigabytes.
127    Args:
128    start_path (str): The path of the directory to calculate size of.
129    Returns:
130    float: The total size of the directory in gigabytes."""
131    return get_total_dir_size_in_bytes(start_path) / TOTAL_BYTES_IN_GIGABYTE

134def get_unique_dirpath(path_to_dir: str) -> str:
135    """
136    Get a unique directory path similar to the given path.
137    """
138
139    def _ends_with_hyphen_number(path: str) -> bool:
140        m = re.search(r"-\d+$", path)
141        return m is not None
142
143    # Avoid appending like x-01-02-03
144    if _ends_with_hyphen_number(path_to_dir):
145        path_to_dir = path_to_dir[:-3]
146
147    suffix = 2
148    path_to_dir_new = path_to_dir
149    while os.path.exists(path_to_dir_new):
150        path_to_dir_new = f"{path_to_dir}-{suffix:02}"
151        suffix += 1
152    return path_to_dir_new

155def is_empty_directory(path_to_file: str) -> bool:
156    """Check if a directory is empty.
157    Args:
158    path_to_file (str): The path of the directory to check.
159    Returns:
160    bool: True if the directory is empty, False otherwise."""
161    if os.path.isfile(path_to_file):
162        return False
163    contents = os.listdir(path_to_file)
164    return len(contents) == 0

167def is_empty_directory_only_subdirectories(path_to_file: str) -> bool:
168    """Check if a directory is empty by inspecting subdirectories.
169    Args:
170    path_to_file (str): The path of the directory to check.
171    Returns:
172    bool: True if the directory is empty or only contains empty subdirectories, False otherwise.
173    """
174    if os.path.isfile(path_to_file):
175        return False
176    contents = os.listdir(path_to_file)
177    for content in contents:
178        path_to_sub = os.path.join(path_to_file, content)
179        if os.path.isfile(path_to_sub):
180            return False
181        if not os.path.isfile(path_to_sub):
182            is_empty = is_empty_directory_only_subdirectories(path_to_sub)
183            if not is_empty:
184                return False
185    return True

188def move_directory(path_to_dir: str, path_to_dir_renamed: str) -> None:
189    shutil.move(path_to_dir, path_to_dir_renamed)