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 |
|
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 |
|
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 |
|