aboutsummaryrefslogtreecommitdiffstats
path: root/fg21sim/utils/hashutil.py
blob: 394ef04e08cf071441595331dc491ffcf4964542 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Copyright (c) 2016 Weitian LI <liweitianux@live.com>
# MIT license

"""
Hash utilities.

md5 :
    Calculate the MD5 checksum of the file.
"""

import hashlib


def md5(filepath, blocksize=65536):
    """
    Calculate the MD5 checksum/digest of the file data.

    Parameters
    ----------
    filepath : str
        The path to the file
    blocksize : int, optional
        The block size (bytes) of chunks when read the file.

    Returns
    -------
    digest : str
        The checksum/digest of the file data, containing only hexadecimal
        digits.

    Credits
    -------
    - Stackoverflow: Generating an MD5 checksum of a file
      https://stackoverflow.com/a/3431838/4856091
    """
    hasher = hashlib.md5()
    with open(filepath, "rb") as f:
        for chunk in iter(lambda: f.read(blocksize), b""):
            hasher.update(chunk)
    return hasher.hexdigest()