Fix deep_iterable, deep_mapping validator type stubs #533
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
Use bound type variables for iterables and mappings of the validated item types, so mypy does not erroneously require both the iterable attribute validated by deep_iterable and the item type validated by the first argument of deep_iterable to have the same type. Do not require optional arguments in type stubs.
|
The stub changes make sense to me. Thanks for doing them! |
|
Can you review and merge please? I’m traveling and I was gonna ping you anyways. :) |
euresti
requested changes
May 24, 2019
src/attr/validators.pyi
Outdated
| @@ -14,11 +29,11 @@ def in_(options: Container[_T]) -> _ValidatorType[_T]: ... | |||
| def and_(*validators: _ValidatorType[_T]) -> _ValidatorType[_T]: ... | |||
| def deep_iterable( | |||
| member_validator: _ValidatorType[_T], | |||
| iterable_validator: Optional[_ValidatorType[_T]], | |||
| ) -> _ValidatorType[_T]: ... | |||
| iterable_validator: Optional[_ValidatorType[_I]] = None, | |||
There was a problem hiding this comment.
I know the default value is actually None but in stubs you usually just write = ...
src/attr/validators.pyi
Outdated
| ) -> _ValidatorType[_T]: ... | ||
| key_validator: _ValidatorType[_K], | ||
| value_validator: _ValidatorType[_V], | ||
| mapping_validator: Optional[_ValidatorType[_M]] = None, |
|
Thanks for the fix! |
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.
Use bound type variables for iterables and mappings of the validated item types, so mypy does not erroneously require
both the iterable attribute validated by deep_iterable and the item type validated by the first argument of
deep_iterable to have the same type. This fixes #531.
Do not require optional arguments in type stubs.
Pull Request Check List
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
.pyi).tests/typing_example.py.docs/api.rstby hand.@attr.s()have to be added by hand too.versionadded,versionchanged, ordeprecateddirectives..rstfiles is written using semantic newlines.changelog.d.If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!