Skip to content

Utils

datamate.utils

Utility functions for Directory objects.

check_size

check_size(
    path, warning_at=20 * 1024**3, print_size=False
)

Check and optionally print directory size, warning if it exceeds threshold.

Parameters:

Name Type Description Default
path Path

Directory path to check.

required
warning_at int

Size threshold in bytes to trigger warning.

20 * 1024 ** 3
print_size bool

Whether to print the directory size.

False

Returns:

Name Type Description
int int

Size of directory in bytes.

Raises:

Type Description
FileNotFoundError

If path doesn’t exist.

Source code in datamate/utils.py
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
def check_size(
    path: Path, warning_at: int = 20 * 1024**3, print_size: bool = False
) -> int:
    """Check and optionally print directory size, warning if it exceeds threshold.

    Args:
        path: Directory path to check.
        warning_at: Size threshold in bytes to trigger warning.
        print_size: Whether to print the directory size.

    Returns:
        int: Size of directory in bytes.

    Raises:
        FileNotFoundError: If path doesn't exist.
    """

    def sizeof_fmt(num: float, suffix: str = "B") -> str:
        for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
            if abs(num) < 1024.0:
                return f"{num:3.1f}{unit}{suffix}"
            num /= 1024.0
        return f"{num:.1f}Yi{suffix}"

    def get_size(start_path: Path) -> int:
        total_size = 0
        for dirpath, _, filenames in os.walk(start_path):
            for f in filenames:
                fp = os.path.join(dirpath, f)
                if not os.path.islink(fp):
                    with contextlib.suppress(FileNotFoundError):
                        total_size += os.path.getsize(fp)
        return total_size

    size_in_bytes = get_size(path)
    if print_size:
        print(f"{sizeof_fmt(size_in_bytes)}")
    if size_in_bytes >= warning_at:
        with warnings.catch_warnings():
            warnings.simplefilter("always")
            warnings.warn(
                f"This directory {path.name} occupies {sizeof_fmt(size_in_bytes)} "
                + "of disk space.",
                ResourceWarning,
                stacklevel=2,
            )
    return size_in_bytes

tree

tree(
    dir_path,
    level=-1,
    limit_to_directories=False,
    length_limit=1000,
    last_modified=False,
    not_exists_message="path does not exist",
    permission_denied_message="permission denied",
    verbose=True,
)

Generate a visual tree structure of a directory.

Parameters:

Name Type Description Default
dir_path Path

Root directory to start tree from.

required
level int

Maximum depth to traverse (-1 for unlimited).

-1
limit_to_directories bool

Only show directories, not files.

False
length_limit int

Maximum number of lines to output.

1000
last_modified bool

Show last modification time of root directory.

False
not_exists_message str

Message to show when path doesn’t exist.

'path does not exist'
permission_denied_message str

Message to show when permission is denied.

'permission denied'
verbose bool

Include summary statistics in output.

True

Returns:

Name Type Description
str str

Formatted tree structure as string.

Example
print(tree(Path("./my_directory"), level=2))

Based on: https://stackoverflow.com/a/59109706

Source code in datamate/utils.py
 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
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
def tree(
    dir_path: Path,
    level: int = -1,
    limit_to_directories: bool = False,
    length_limit: int = 1000,
    last_modified: bool = False,
    not_exists_message: str = "path does not exist",
    permission_denied_message: str = "permission denied",
    verbose: bool = True,
) -> str:
    """Generate a visual tree structure of a directory.

    Args:
        dir_path: Root directory to start tree from.
        level: Maximum depth to traverse (-1 for unlimited).
        limit_to_directories: Only show directories, not files.
        length_limit: Maximum number of lines to output.
        last_modified: Show last modification time of root directory.
        not_exists_message: Message to show when path doesn't exist.
        permission_denied_message: Message to show when permission is denied.
        verbose: Include summary statistics in output.

    Returns:
        str: Formatted tree structure as string.

    Example:
        ```python
        print(tree(Path("./my_directory"), level=2))
        ```

    Based on: https://stackoverflow.com/a/59109706
    """
    # prefix components:
    space = "    "
    branch = "│   "
    # pointers:
    tee = "├── "
    last = "└── "

    tree_string = ""

    dir_path = Path(dir_path)  # accept string coerceable to Path
    files = 0
    directories = 1

    def inner(dir_path: Path, prefix: str = "", level=-1):
        nonlocal files, directories
        if not level:
            yield prefix + "..."
            return  # 0, stop iterating
        try:
            if limit_to_directories:
                contents = sorted([d for d in dir_path.iterdir() if d.is_dir()])
            else:
                contents = sorted(dir_path.iterdir())
        except PermissionError as e:
            if "[Errno 1]" in str(e):
                contents = [f"({permission_denied_message})"]

        pointers = [tee] * (len(contents) - 1) + [last]
        for pointer, path in zip(pointers, contents):
            if isinstance(path, Path):
                if path.is_dir():
                    yield prefix + pointer + path.name + "/"
                    directories += 1
                    extension = branch if pointer == tee else space
                    yield from inner(path, prefix=prefix + extension, level=level - 1)
                elif not limit_to_directories:
                    yield prefix + pointer + path.name
                    files += 1
            else:
                assert path == f"({permission_denied_message})"
                yield prefix + pointer + path

    tree_string += dir_path.name + "/"

    if not dir_path.exists():
        tree_string += f"\n{space}({not_exists_message})"
        return tree_string

    if last_modified:
        timestamp = datetime.datetime.fromtimestamp(dir_path.stat().st_mtime)
        mtime = " - Last modified: {}".format(timestamp.strftime("%B %d, %Y %H:%M:%S"))
        tree_string += mtime
    tree_string += "\n"
    iterator = inner(dir_path, level=level)
    for line in itertools.islice(iterator, length_limit):
        tree_string += line + "\n"

    if verbose:
        if next(iterator, None):
            tree_string += f"... length_limit, {length_limit}, reached,"
        tree_string += (
            f"\ndisplaying: {directories} {'directory' if directories == 1 else 'directories'}"  # noqa: E501
            + (f", {files} files" if files else "")
            + (f", {level} levels." if level >= 1 else "")
        )

    return tree_string

byte_to_str

byte_to_str(obj)

Convert byte elements to string types recursively.

Parameters:

Name Type Description Default
obj Union[Mapping, ndarray, list, tuple, bytes, str, Number]

Object to convert, can be nested structure containing bytes.

required

Returns:

Type Description
Union[Mapping, ndarray, list, tuple, str, Number]

Converted object with bytes decoded to strings.

Raises:

Type Description
TypeError

If object type cannot be converted.

Note

Function recursively processes nested lists and tuples.

Source code in datamate/utils.py
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def byte_to_str(
    obj: Union[Mapping, np.ndarray, list, tuple, bytes, str, Number],
) -> Union[Mapping, np.ndarray, list, tuple, str, Number]:
    """Convert byte elements to string types recursively.

    Args:
        obj: Object to convert, can be nested structure containing bytes.

    Returns:
        Converted object with bytes decoded to strings.

    Raises:
        TypeError: If object type cannot be converted.

    Note:
        Function recursively processes nested lists and tuples.
    """
    if isinstance(obj, Mapping):
        return type(obj)({k: byte_to_str(v) for k, v in obj.items()})
    elif isinstance(obj, np.ndarray):
        if np.issubdtype(obj.dtype, np.dtype("S")):
            return obj.astype("U")
        return obj
    elif isinstance(obj, list):
        return [byte_to_str(item) for item in obj]
    elif isinstance(obj, tuple):
        return tuple(byte_to_str(item) for item in obj)
    elif isinstance(obj, bytes):
        return obj.decode()
    elif isinstance(obj, (str, Number)):
        return obj
    else:
        raise TypeError(f"can't cast {obj} of type {type(obj)} to str")