ladybug-tools / ladybug-geometry / 259

96%

master: 93%

Build Type

push

travis-ci

Committed by Chris Mackey

Commit Message

feat(hash): Add __hash__ methods that agree with __eq__ to all objects

I realized that we were overwriting the __eq__ method on a number of objects without overwriting the __hash__ method, which I have come to realize is strongly discouraged in Python. So this commit fixes this by adding hash methods that agree with the __eq__ operator.  This should also allow us to create sets of these geometry objects if we so desire.

The only thing I didn't implement that _might_ be worthwhile to implement in the future is that I am not caching the hash value once it is calculated, which is something that we could do given that all of the geometry objects are immutable. This will allow for quicker hashing if we plan to hash the object multiple times but it also uses up a little more memory per object to store the hash. Right now, we really don't end up hashing the object multiple times in any of our typical workflows such that I think the trade-off isn't worth it. However, we should reconsider this if we find cases in the future where we are hashing the objects multiple times.

Run Details

334 of 334 new or added lines in 35 files covered. (100.0%)

8314 of 8621 relevant lines covered (96.44%)

1.93 hits per line