maci.createfilehash

hash a file and store hash to file

Creates a hash of any file, and stores the hash data to a newly created file. Always returns a string of the file hash. Useful to use alongside its partner function as mentioned below.

maci.createfilehash -> str

Basic Example of hashing a file and storing its hash using default positional parameters

maci.createfilehash(src_file, dst_file)

In this example, we simply input the source file to hash and the destination file to store the hash data using the createfilehash function and pass the file locations as arguments to the function, and the hashed data is then stored to the destination file.

This tool is encouraged to be used alongside its partner function comparefilehash, which will automatically handle comparing the hash data stored against the source file hashed and return a Trur/False if they match.

disable creating destination file

createfilehash always returns the hash of the source file to a string if needing to store it in code whether you create a destination file or not. However, you may also disable the need for a destination file to store the hash by setting the file_to_store_hash parameter to None.

Example disabling creating a destination file and just collecting the hash

data = maci.createfilehash(src_file, None)

partner functions

Functions that are related for createfilehash

maci.comparefilehash -> Compares previously created file with stored hash with the source file hash

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.

file_to_store_hash: str | Path | None

Second required positional argument. Accepts strings, Path objects, and None

Use this parameter to point to your destination filepath to store hash of the source file. Set to None if you do not want a file created to store hash.

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 destination file 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.