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

Add docstrings to all functions.

Browse source
This commit is contained in:
Ethan Dalool 2020-09-09 14:40:37 -07:00
parent 331de6eaec
commit 5510d94054
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
voussoirkit/quickid.py
View file

@ -18,6 +18,9 @@ HASH_CLASSES = {
} }
def equal_handle(handle1, handle2, *args, **kwargs): def equal_handle(handle1, handle2, *args, **kwargs):
'''
Given two handles, return True if they have the same quickid hash.
'''
size1 = handle1.seek(0, SEEK_END) size1 = handle1.seek(0, SEEK_END)
size2 = handle2.seek(0, SEEK_END) size2 = handle2.seek(0, SEEK_END)
handle1.seek(0) handle1.seek(0)
@ -30,6 +33,9 @@ def equal_handle(handle1, handle2, *args, **kwargs):
return id1 == id2 return id1 == id2
def equal_file(filename1, filename2, *args, **kwargs): def equal_file(filename1, filename2, *args, **kwargs):
'''
Given two files, return True if they have the same quickid hash.
'''
filename1 = pathclass.Path(filename1).absolute_path filename1 = pathclass.Path(filename1).absolute_path
filename2 = pathclass.Path(filename2).absolute_path filename2 = pathclass.Path(filename2).absolute_path
if os.path.getsize(filename1) != os.path.getsize(filename2): if os.path.getsize(filename1) != os.path.getsize(filename2):
@ -38,6 +44,10 @@ def equal_file(filename1, filename2, *args, **kwargs):
return equal_handle(handle1, handle2, *args, **kwargs) return equal_handle(handle1, handle2, *args, **kwargs)
def matches_handle(handle, other_id): def matches_handle(handle, other_id):
'''
Given a handle and a quickid hash, return True if the handle matches
that hash.
'''
(other_size, hashtype, chunk_size, other_hash) = other_id.split('_') (other_size, hashtype, chunk_size, other_hash) = other_id.split('_')
other_size = int(other_size) other_size = int(other_size)
chunk_size = int(chunk_size) chunk_size = int(chunk_size)
@ -51,11 +61,18 @@ def matches_handle(handle, other_id):
return this_id == other_id return this_id == other_id
def matches_file(filename, other_id): def matches_file(filename, other_id):
'''
Given a file and a quickid hash, return True if the file matches
that hash.
'''
filename = pathclass.Path(filename).absolute_path filename = pathclass.Path(filename).absolute_path
with open(filename, 'rb') as handle: with open(filename, 'rb') as handle:
return matches_handle(handle, other_id) return matches_handle(handle, other_id)
def quickid_handle(handle, hashtype='md5', chunk_size=CHUNK_SIZE): def quickid_handle(handle, hashtype='md5', chunk_size=CHUNK_SIZE):
'''
Return the quickid hash for this handle.
'''
hasher = HASH_CLASSES[hashtype]() hasher = HASH_CLASSES[hashtype]()
size = handle.seek(0, SEEK_END) size = handle.seek(0, SEEK_END)
handle.seek(0) handle.seek(0)
@ -76,6 +93,9 @@ def quickid_handle(handle, hashtype='md5', chunk_size=CHUNK_SIZE):
return output return output
def quickid_file(filename, *args, **kwargs): def quickid_file(filename, *args, **kwargs):
'''
Return the quickid hash for this file.
'''
filename = pathclass.Path(filename).absolute_path filename = pathclass.Path(filename).absolute_path
with open(filename, 'rb') as handle: with open(filename, 'rb') as handle:
return quickid_handle(handle, *args, **kwargs) return quickid_handle(handle, *args, **kwargs)