pyxx.files.compute_file_hash#

pyxx.files.compute_file_hash(file: str | Path, hash_function: str = 'sha256') → Tuple[str, str]#

Computes a file hash

Computes and returns the hash of a file on the disk. Users can select the hash function from those supported by hashlib.

Parameters:

  • file (str or pathlib.Path) – File whose hash is to be computed

  • hash_function (str, optional) – Hash function, selected from the options described in the “Notes” section (default is 'sha256')

Returns:

  • str – Name of hash function (in the format used by hashlib) which was computed

  • str – Hash of file as computed by the hash function specified by hash_function

Notes

Any hash function included in Python’s hashlib module can be used, as described here: https://docs.python.org/3/library/hashlib.html.

Inputs for the hash_function argument are not case-sensitive, and dashes (-) and underscores (_) can be used interchangeably, or omitted. Thus, to use the SHA-256 hash function, any of the following are valid inputs: 'sha256', 'SHA-256', 'sha_256'.