diff options
| author |  Ionite <[email protected]> | 2023-03-16 00:33:05 -0400 |
|---|---|---|
| committer | Ionite <[email protected]> | 2023-03-16 00:33:05 -0400 |
| commit | 64417197b58e3945f0b857c7fa648dcbe28254c4 (patch) | |
| tree | fc4c8f11e7a9e9263a7fb81a74ed0bc1fa506106 | |
| parent | Rename `count` variable (diff) | |
Include TimeoutError in raises docstring field
| -rw-r--r-- | snekbox/memfs.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/snekbox/memfs.py b/snekbox/memfs.py index c340146..991766b 100644 --- a/snekbox/memfs.py +++ b/snekbox/memfs.py @@ -138,8 +138,9 @@ class MemFS: exclude_files: A dict of Paths and last modified times. Files will be excluded if their last modified time is equal to the provided value. - timeout: The maximum time for the file parsing. If exceeded, - a TimeoutError will be raised. + timeout: Maximum time in seconds for file parsing. + Raises: + TimeoutError: If file parsing exceeds timeout. """ start_time = time.monotonic() count = 0 @@ -184,10 +185,11 @@ class MemFS: Files will be excluded if their last modified time is equal to the provided value. preload_dict: Whether to preload as_dict property data. - timeout: The maximum time for the file parsing. If exceeded, - a TimeoutError will be raised. + timeout: Maximum time in seconds for file parsing. Returns: List of FileAttachments sorted lexically by path name. + Raises: + TimeoutError: If file parsing exceeds timeout. """ start_time = time.monotonic() res = sorted( |