voussoir/voussoirkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve consistency of callback_permission_denied, hash_progress.

Browse source
This commit is contained in:
voussoir 2021-01-25 14:48:15 -08:00
parent 2bb71c6ac2
commit c893a21e14
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
voussoirkit/spinal.py
View file

@ -345,7 +345,7 @@ def copy_file(
callback_permission_denied: callback_permission_denied:
If provided, this function will be called when a source file denies If provided, this function will be called when a source file denies
read access, with the file path and the exception object as parameters. read access, with the exception object as the only argument.
THE OPERATION WILL RETURN NORMALLY. THE OPERATION WILL RETURN NORMALLY.
If not provided, the PermissionError is raised. If not provided, the PermissionError is raised.
@ -363,8 +363,8 @@ def copy_file(
the Path object being copied, number of bytes written so far, the Path object being copied, number of bytes written so far,
total number of bytes needed. total number of bytes needed.
callback_validate_hash: callback_hash_progress:
Passed directly into `verify_hash` Passed into `hash_file` as callback_progress when validating the hash.
dry_run: dry_run:
Do everything except the actual file copying. Do everything except the actual file copying.
@ -448,7 +448,7 @@ def copy_file(
return handle return handle
except PermissionError as exception: except PermissionError as exception:
if callback_permission_denied is not None: if callback_permission_denied is not None:
callback_permission_denied(path, exception) callback_permission_denied(exception)
return None return None
else: else:
raise raise
@ -476,10 +476,11 @@ def copy_file(
data_chunk = source_handle.read(chunk_size) data_chunk = source_handle.read(chunk_size)
except PermissionError as exception: except PermissionError as exception:
if callback_permission_denied is not None: if callback_permission_denied is not None:
callback_permission_denied(source, exception) callback_permission_denied(exception)
return results return results
else: else:
raise raise
data_bytes = len(data_chunk) data_bytes = len(data_chunk)
if data_bytes == 0: if data_bytes == 0:
break break
@ -510,7 +511,7 @@ def copy_file(
if validate_hash: if validate_hash:
verify_hash( verify_hash(
destination, destination,
callback_progress=callback_validate_hash, callback_progress=callback_hash_progress,
hash_class=hash_class, hash_class=hash_class,
known_hash=results.hash.hexdigest(), known_hash=results.hash.hexdigest(),
known_size=source_bytes, known_size=source_bytes,
@ -654,6 +655,10 @@ def walk_generator(
''' '''
Yield Path objects for files in the file tree, similar to os.walk. Yield Path objects for files in the file tree, similar to os.walk.
callback_permission_denied:
Passed directly into os.walk as onerror. If OSErrors (Permission Denied)
occur when trying to list a directory, your function will be called with
the exception object as the only argument.
exclude_filenames: exclude_filenames:
A set of filenames that will not be copied. Entries can be absolute A set of filenames that will not be copied. Entries can be absolute
paths to exclude that particular file, or plain names to exclude paths to exclude that particular file, or plain names to exclude
@ -693,9 +698,6 @@ def walk_generator(
exclude_filenames = set() exclude_filenames = set()
callback_permission_denied = callback_permission_denied or do_nothing callback_permission_denied = callback_permission_denied or do_nothing
_callback_permission_denied = callback_permission_denied
def callback_permission_denied(error):
return _callback_permission_denied(error.filename, error)
exclude_filenames = {normalize(f) for f in exclude_filenames} exclude_filenames = {normalize(f) for f in exclude_filenames}
exclude_directories = {normalize(f) for f in exclude_directories} exclude_directories = {normalize(f) for f in exclude_directories}