maci.comparefilehash

compare hash of file to stored hash

Compares a hash of the source file against the previously created file with the stored hash data, from using the createfilehash partner function, and returns a boolean if the hashes match.

maci.comparefilehash -> bool

Basic Example of comparing hash of a file against the stored hash using default positional parameters

result = maci.comparefilehash(src_file, dst_file)

In this example, we simply input the source file to hash and the destination file with the stored hash data using the comparefilehash function and pass the file locations as arguments to the function, the hashed data is then compared against the source file, and assign the returned result to a variable.

To create the initial stored hashed data, see the partner function createfilehash. This tool is designed to dependently work with its partner function.

partner functions

Functions that are related for comparefilehash

maci.createfilehash -> Creates hash of a file, and stores the hash data to a newly created file

parameters & arguments

Describes all parameter functionality and accepted data types

file_to_hash: str | Path

First required positional argument. Accepts strings and Path objects

Use this parameter to point to your source filepath to get the hash.

stored_hash_file: str | Path

Second required positional argument. Accepts strings and Path objects

Use this parameter to point to your destination filepath of the file with the stored hash data.

hash_algorithm: str

Optional parameter. Accepts strings. Default = 'sha256'

Use this parameter to set the hash algorithm used for the hash. Default is sha256, which is a current common industry standard.

All options available: 'sha256', 'sha512', 'sha384', 'sha1', 'md5'

encoding: str | None

Optional parameter. Accepts strings or None. Default = None

Use this parameter to set the source file hashed data and the destination file containing the hashed data with the desired codec if needed. The default uses the default of python, so you don't have to use this, but you can if the data needs to be written with a specific codec.