Fix: explicitly re-export public API via __all__ - #42
Open
RafaelWO wants to merge 1 commit into
Open
Conversation
Consumers running `mypy --strict` on `from deepmerge import Merger` got:
error: Module "deepmerge" does not explicitly export attribute "Merger"
[attr-defined]
Under `--no-implicit-reexport` (implied by `--strict`), names imported into
`__init__.py` are not considered part of the public API unless listed in
`__all__`. Add `__all__` covering `Merger`, `STRATEGY_END`, the standard
merger instances and `DEFAULT_TYPE_SPECIFIC_MERGE_STRATEGIES`.
The `# noqa` on the `STRATEGY_END` import is now redundant, since `__all__`
marks it as intentionally re-exported.
Mirrors the same fix applied to `deepmerge.strategy` in db7c653.
This file contains hidden or 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
1 participant
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.
Consumers running
mypy --strictonfrom deepmerge import Mergergot:Under
--no-implicit-reexport(implied by--strict), names imported into__init__.pyare not considered part of the public API unless listed in__all__. Add__all__coveringMerger,STRATEGY_END, the standard merger instances andDEFAULT_TYPE_SPECIFIC_MERGE_STRATEGIES.The
# noqaon theSTRATEGY_ENDimport is now redundant, since__all__marks it as intentionally re-exported.Mirrors the same fix applied to
deepmerge.strategyin db7c653.P.S. I was not fully sure if
DEFAULT_TYPE_SPECIFIC_MERGE_STRATEGIESshould be exposed as well. I can remove it from__all__if it should not be part of the public API, of course 🙂