Expose __all__ to avoid type checking errors #87
Merged
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
oschwald
reviewed
Sep 20, 2021
| "MODE_MMAP", | ||
| "MODE_MMAP_EXT", | ||
| "PyReader", # Exposed for type checking b/c return type of open_database() | ||
| "Reader", |
There was a problem hiding this comment.
Rather than including these, perhaps we could export a particular type, e.g.:
ReaderTypes = Union[PyReader, "maxminddb.extension.Reader"]
I am not sure what the best naming would be here.
There was a problem hiding this comment.
i think it's best to expose a real base type. generally speaking, union return types are bad.
i suggest merging this as-is to simply establish the status quo, and cleaning up some things in another pull request.
for instance, maybe the oddly named Reader compat helper may be ditched in favour of something that can act as a proper type, and it may even be possible to do so without breaking API. i'll think about it some more
Mypy reports attr-defined errors (via no_implicit_reexport) because the ‘maxminddb’ module uses implicit re-exports. Adding __all__ makes the exported API surface explicit, which avoids the type checking errors.
wbolster
force-pushed
the
dunder-all
branch
from
903d537 to
c31141d
Compare
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.
Mypy reports attr-defined errors (via no_implicit_reexport) because the
‘maxminddb’ module uses implicit re-exports. Adding
__all__makes theexported API surface explicit, which avoids the type checking errors.