This repository has been archived by the owner on Nov 17, 2022. It is now read-only.
Fix Codelist hashing #247
Merged
Fix Codelist hashing #247
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Until this point, this is merely tested indirectly. These tests ensure that the equality checks work as expected
Hash functions are dependent on the order of input. Codes in Codelists are stored in a set. This does not have a fixed order. As such, it is necessary to sort the output before hashing. This adds tests that Codelists hash correctly, and fixes the hashing.
Codelist hashing has been fixed
hayfield
added
bug-fixes
|
Need to add |
The attribute was added in #45, though the equality and hash checks weren't updated
|
Failing test - |
A Code with no value isn't very useful.It also confuses use since it cannot be assumed that the value will be a string.
hayfield
added
complete
hayfield
added
incomplete
|
Equality needs checking in both directions |
The __eq__ function takes self and other, with each being handled differently. As such, tests need performing in both directions encase there is an implementation that works one way but not the other.
hayfield
added
complete
allthatilk
previously requested changes
Nov 17, 2017
iati/tests/test_codelists.py
Outdated
|
|
||
| @pytest.mark.parametrize('codelist', iati.default.codelists('2.02').values()) | ||
| def test_codelist_diff_completeness_not_equal(self, codelist, cmp_func_different): | ||
| """Check that two Codelist with the same codes but different completeness are not deemed to be equal.""" |
iati/tests/test_codelists.py
Outdated
|
|
||
| @pytest.mark.parametrize('codelist', iati.default.codelists('2.02').values()) | ||
| def test_codelist_diff_num_codes_not_equal(self, codelist, cmp_func_different): | ||
| """Check that two Codelist with the same name but different codes are not deemed to be equal.""" |
iati/tests/test_codelists.py
Outdated
|
|
||
| @pytest.mark.parametrize('codelist', iati.default.codelists('2.02').values()) | ||
| def test_codelist_diff_code_name_not_equal(self, codelist): | ||
| """Check that two Codelist with the same name but a Code with a different name are not deemed to be equal.""" |
There was a problem hiding this comment.
Also needs rephrasing as not clear to read.
iati/tests/test_codelists.py
Outdated
|
|
||
| @pytest.mark.parametrize('codelist', iati.default.codelists('2.02').values()) | ||
| def test_codelist_diff_code_name_same_hash(self, codelist): | ||
| """Check that two Codelist with the same name but a Code with a different name have the same hash.""" |
There was a problem hiding this comment.
Codelist -> Codelists + rephrasing
iati/tests/test_codelists.py
Outdated
|
|
||
| @pytest.mark.parametrize('codelist', iati.default.codelists('2.02').values()) | ||
| def test_codelist_diff_code_value_not_equal(self, codelist, cmp_func_different): | ||
| """Check that two Codelist with the same name but a Code with a different value are not deemed to be equal.""" |
There was a problem hiding this comment.
Codelist -> Codelists + rephrasing
|
@dalepotter @allthatilk Any suggestions on how to rephrase the docstrings? |
hayfield
added
incomplete
This is in response to a review of #247
hayfield
added
complete
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Codelists contain Codes within a set. This means that they are in no particular order. Hash functions require input in the same order to produce the same output.
This sorts the Codes in a Codelist before hashing so that Codelists with the same Codes hash the same no matter which order the set provides them in.