Typing-only Mixin Class for Type Checking #2015
Open
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
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.
What does this change
While debugging a typing-related bug in my tests I created a small mixin of some Faker providers for mypy type checking, unfortunately when I added all of them for the future checks I noticed a type/name conflict between address and bank/date_time providers.
What was wrong
As Faker proxy is dynamically gathering methods from locals, mypy cannot determine the correct types.
How this fixes it
This PR adds a typing-only class that is a mixture of all available providers thus giving mypy and IDEs enough information for type checking/completion (potentially fixing #1604).
Problems
As some providers have common attributes with different datatypes direct mixing was not possible which makes this change backward incompatible. I would love to hear your thoughts on this approach. Thanks.