2.18.0 adding code hash sum

[herbberg]

Adding hash of source and VHDL templates as additional meta tag.

[arnobaer]

This is a significant change, consider incrementing the minor version for this feature, e.g. 2.18.0, see also https://semver.org/

[arnobaer]

A proper version would be 2.18.0 as this is a new feature and not a bug fix.

[herbberg]

changed

[arnobaer]

Calculating the software hash is not part of the resource distribution, consider moving this into module vhdlproducer or __main__.

[herbberg]

moved get_files_hash_value to constants.py to avoid circular references

[arnobaer]

The constants module is not ideal, I moved the code to the __main__ module (entry point for hash calculation).

[arnobaer]

Try to avoid calculating the hash multiple times, this gives potential for discrepancies and introduces an overhead. Try to calculate the hash once in __main__ and pass it like the __version__ variable.

[herbberg]

done

[arnobaer]

There is no need for a range iterator.

for filename in filenames:
    with open(filename, "rb") as f:
        ...

[herbberg]

done

[arnobaer]

filenames = [](plural for lists)

[herbberg]

done

[arnobaer]

h = hashlib.sha256() or sha256_hash = hashlib.sha256() would increase code readability (note hash is a built in function, so try to avoid hash = hashlib.sha256()).

[herbberg]

I do not understand! Why is "h" better than "x"?

[arnobaer]

h for hash. While x is a perfectly valid variable name, it is quite generic and provides no hints about the variable's intended use. In contrast, h or sha256_hash offers immediate context. See also the Zen of Python's "Explicit is better than implicit" principle (PEP 20), https://peps.python.org/pep-0020/

[arnobaer]

To enhance the hash calculation I moved the calculation to the __main__ module and calculate the actual hash only once in the main entry point, passing down the value to the VHDLProducer, MenuHelper and InfoHelper classes.

To provide a flexible solution the value is passed in form of a generic config dict, so additional values can be inserted with ease.

tm-vhdlproducer/tmVhdlProducer/__main__.py

Lines 234 to 235 in 30593ef

	producer = VhdlProducer(template_dir)
	producer.config.update({"sw_hash": sw_hash})