Add EnsureHashAlgorithm constraint (draft) #357
Closed
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
This adds EnsureHashAlgorithm constraint which checks whether the given algorith name is contained in hashlib's algorithms_guaranteed set. It derives from EnsureChoice without further customization. Using `algorithms_guaranteed` covers algorithms that have named constructors in hashlib, i.e. accessible through getattr(hashlib, name) - that's the current usage in MultiHash. Future expansion could see us move to algorithms_available - these will be recognized when passed to (slower) hashlib.new(), but have no named constructors. For details, see: https://docs.python.org/3.11/library/hashlib.html
The EnsureHash algorithm now calls its super.__init__ correctly.
We use EnsureHashAlgorithm() | EnsureListOf(...) in ls_file_colelction
now. This correctly handles incoming values, which are always a list
in CLI (argparse behaviour with --append) and can be str or list in
Python API. At least when they are OK.
When input is not OK, two things are suboptimal:
- an incorrect hash (str) proceeds to EnsureListOf, which tries to go
letter by letter, failing on first
- a hash (list) with an incorrect value would first fail on
EnsureHashAlgorithm(list), proceed to EnsureListOf, and fail on
EnsureHashAlgorithm(str)
As a conequence, in both cases the error message would say "does not
match any of 2 alternatives" and print EnsureChoice message ("is not
one of ...") twice.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #357 +/- ##
=======================================
Coverage 92.25% 92.25%
=======================================
Files 95 95
Lines 7747 7751 +4
=======================================
+ Hits 7147 7151 +4
Misses 600 600
☔ View full report in Codecov by Sentry. |
|
I am using However, I got stupidly locked on how validation errors are reported with this constraint pattern: #346 (comment) I would appreciate suggestions (@mih maybe you have a comment) for what would be the most logical solution:
|
|
This PR has been in draft mode for a long time. I am closing it now as part of a cleanup run. Feel free to reopen once work on it restarts. Sorry. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
EnsureHashAlgorithm | EnsureListOf(EnsureHashAlgorithm)AddEnsureHashAlgorithm#346 (comment)Addresses #346