Add typing annotations #112
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
* Add typing-extensions * Fix assignment * Add GHA mypy
* `IComparator` is explicitly inherited
`* One of the comparators has a different `__init__` function
signature so `IComparator` can't be a protocol if it were to
represent all the comparators.
* Added `ConfigGetValue` and `NameFactory` protocols here which is used
by other files.
* ValueToken is an extension of ValueProxy
* Guard circular dependency with `staticconf/config` with
`TYPE_CHECKING`.
* `ConfigNamespace` and `ValueProxy` refer to each other
|
Ping @benbariteau @matthewess |
|
Ping @dnephin. Final commit marks the package as typed. |
sloane-shark
approved these changes
Sep 21, 2022
This was referenced Oct 7, 2022
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.
Following mypy output, I typed each file until no errors were left.
Additionally added GHA for
tox -e mypyto prevent regressions in PRs.Notes
There's a circular type dependency between
config.py(ConfigNamespace) andproxy.py(ValueProxy) which is guarded byTYPE_CHECKING.While I don't explicitly test for py3.10,
Protocolwas moved fromtyping-extensionstotypingso there's a version guard for theProtocolimport.In
statticonfig/loader, there are manyComparators using theIComparatorinterface. Normally, I would turnIComparatorinto aProtocol, but one of the classes adds a default keyword arg to__init__which makes it different. To facilitate typing, I opted to make the inheritance explicit instead.Closes #108