Skip to content

utils

dandy.file.utils

append_to_file

Source code in dandy/file/utils.py 
12
13
14
15
16
17
18
def append_to_file(file_path: Path | str, content: str):
    if file_exists(file_path):
        with open(file_path, 'a', encoding='utf-8') as f:
            f.write(content)

    else:
        write_to_file(file_path, content)

clean_file_extensions

Source code in dandy/file/utils.py 
21
22
def clean_file_extensions(file_extensions: Sequence[str]) -> Sequence[str]:
    return [ext if ext[0:1] == '.' else f'.{ext}' for ext in file_extensions]

encode_file_to_base64

Source code in dandy/file/utils.py 
25
26
27
28
29
30
31
def encode_file_to_base64(file_path: str | Path) -> str:
    if not Path(file_path).is_file():
        message = f'File "{file_path}" does not exist'
        raise FileCriticalError(message)

    with open(file_path, 'rb') as f:
        return base64.b64encode(f.read()).decode('utf-8')

file_exists

Source code in dandy/file/utils.py 
34
35
def file_exists(file_path: Path | str) -> bool:
    return Path(file_path).exists()

get_file_path_or_exception

Source code in dandy/file/utils.py 
38
39
40
41
42
43
44
45
46
47
48
def get_file_path_or_exception(
    file_path: str | Path,
) -> Path:
    if Path(file_path).is_file():
        return Path(file_path)

    if Path(settings.BASE_PATH, file_path).is_file():
        return Path(settings.BASE_PATH, file_path)

    message = f'File "{file_path}" does not exist'
    raise FileCriticalError(message)

get_directory_path_or_exception

Source code in dandy/file/utils.py 
51
52
53
54
55
56
57
58
59
60
61
def get_directory_path_or_exception(
    dir_path: str | Path,
) -> Path:
    if Path(dir_path).is_dir():
        return Path(dir_path)

    if Path(settings.BASE_PATH, dir_path).is_dir():
        return Path(settings.BASE_PATH, dir_path)

    message = f'Directory "{dir_path}" does not exist'
    raise FileCriticalError(message)

get_directory_listing

Source code in dandy/file/utils.py 
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
89
90
91
92
93
def get_directory_listing(
    dir_path: str | Path,
    max_depth: int | None = None,
    file_extensions: Sequence[str] | None = None,
    _current_depth: int = 0,
) -> list[str]:
    if _current_depth == 0 and file_extensions is not None:
        file_extensions = clean_file_extensions(file_extensions)

    items = []

    try:
        for path in dir_path.iterdir():
            if file_extensions is not None:
                if path.suffix in file_extensions:
                    items.append(str(path))
            else:
                items.append(str(path))

            if path.is_dir() and (max_depth is None or _current_depth < max_depth):
                items.extend(
                    get_directory_listing(
                        path, max_depth, file_extensions, _current_depth + 1
                    )
                )

    except PermissionError:
        pass

    return items

get_file_extension_from_url_string

Source code in dandy/file/utils.py 
96
97
98
99
def get_file_extension_from_url_string(url: str) -> str:
    parsed_url = urlparse(url)

    return Path(parsed_url.path).suffix.lower()[1:]

make_directory

Source code in dandy/file/utils.py 
102
103
104
105
106
107
def make_directory(directory_path: Path | str):
    Path(directory_path).mkdir(parents=True, exist_ok=True)

    if not Path(directory_path).is_dir():
        message = f'Failed to create directory "{directory_path}"'
        raise FileRecoverableError(message)

read_from_file

Source code in dandy/file/utils.py 
110
111
112
113
114
def read_from_file(file_path: Path | str) -> str:
    get_file_path_or_exception(file_path=file_path)

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

remove_directory

Source code in dandy/file/utils.py 
117
118
119
120
121
122
def remove_directory(directory_path: Path | str):
    Path(directory_path).rmdir()

    if Path(directory_path).is_dir():
        message = f'Failed to remove directory "{directory_path}"'
        raise FileRecoverableError(message)

remove_file

Source code in dandy/file/utils.py 
125
126
127
128
129
130
def remove_file(file_path: Path | str):
    Path(file_path).unlink(missing_ok=True)

    if Path(file_path).exists():
        message = f'Failed to remove file "{file_path}"'
        raise FileRecoverableError(message)

write_to_file

Source code in dandy/file/utils.py 
133
134
135
136
137
138
139
def write_to_file(file_path: Path | str, content: str):
    file_path = Path(file_path)

    make_directory(file_path.parent)

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