LargeFile#
For more details about using LargeFiles, check out the how to guide.
LargeFileLocal
#
Bases: LargeFileBase
LargeFile implementation using local filesystem as a backend.
Store large files remotely using the familiar API of open()
. With built-in
versioning, pruning and local cache.
IMPORTANT: If LargeFileLocal.max_cache_size is too small, it won't be enough to store all your files and they can end up deleted.
See parent for more details.
Examples:
Source code in great_ai/large_file/large_file/large_file_local.py
LargeFileS3
#
Bases: LargeFileBase
LargeFile implementation using S3-compatible storage as a backend.
Store large files remotely using the familiar API of open()
. With built-in
versioning, pruning and local cache.
See parent for more details.
Source code in great_ai/large_file/large_file/large_file_s3.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 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 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 |
|
LargeFileMongo
#
Bases: LargeFileBase
LargeFile implementation using GridFS (MongoDB) as a backend.
Store large files remotely using the familiar API of open()
. With built-in
versioning, pruning and local cache.
See parent for more details.
Source code in great_ai/large_file/large_file/large_file_mongo.py
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 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 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 |
|
LargeFileBase
#
Bases: ABC
Base for LargeFile implementations with different backends.
Store large files remotely using the familiar API of open()
. With built-in
versioning, pruning and local cache.
By default, files are stored in the ".cache" folder and the least recently used is deleted after the overall size reaches 30 GBs.
Examples:
Attributes:
Name | Type | Description |
---|---|---|
initialized |
Tell whether |
|
cache_path |
Storage location for cached files. |
|
max_cache_size |
Optional[str]
|
Delete files until the folder at |
Source code in great_ai/large_file/large_file/large_file_base.py
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 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 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 165 166 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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
|
version: int
property
#
Numeric version of the file proxied by this LargeFile instance.
versions_pretty: str
property
#
Formatted string of all available versions.
clean_up()
#
Delete local and remote versions according to currently set cache and retention policy.
configure_credentials(**kwargs)
classmethod
#
configure_credentials_from_file(secrets)
classmethod
#
Load file and feed its content to configure_credentials
.
Extra keys are ignored.
Source code in great_ai/large_file/large_file/large_file_base.py
delete()
#
get(hide_progress=False)
cached
#
Return path to the proxy of a file (or directory).
If not available in the local cache, an attempt is made to download it.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hide_progress |
bool
|
Do not show a progress update after each 10% of progress. |
False
|
Source code in great_ai/large_file/large_file/large_file_base.py
push(path, hide_progress=False)
#
Upload a file (or directory) as a new version of key
.
The file/directory is compressed before upload.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hide_progress |
bool
|
Do not show a progress update after each 10% of progress. |
False
|