Build: Initial mypy integration #1395
Conversation
jku
force-pushed
the
initial-mypy-integration
branch
from
98c6f43 to
116047a
Compare
|
rebased on develop |
The import is useful for mypy so it can check the types. Add a pylint disable just like json.py does in the same situation. Signed-off-by: Jussi Kukkonen <[email protected]>
Use ClassVar for extra protection, set default value to a string so type checking is ok with it Signed-off-by: Jussi Kukkonen <[email protected]>
Also define from_dict()/to_dict() as abstract: this helps mypy keep track of things. Rename derived argument *_dict in the derived classes to keep the linter happy. Signed-off-by: Jussi Kukkonen <[email protected]>
Signed-off-by: Jussi Kukkonen <[email protected]>
This allows mypy to track the argument types through the constructor calls. Signed-off-by: Jussi Kukkonen <[email protected]>
This is an initial setup: By default check only tuf/api/,
and ignore securesystemslib imports.
Change lint working directory to source root: This saves repeating a lot
of {toxinidir} in the command lines.
Signed-off-by: Jussi Kukkonen <[email protected]>
pylint on the legacy code is by far the slowest part of linting (to the extent that parallelizing the tox env itself doesn't really help): pylint can fortunately parallelize itself. Signed-off-by: Jussi Kukkonen <[email protected]>
Also mark the argument as Dict as we will pop() it. Signed-off-by: Jussi Kukkonen <[email protected]>
Without this mypy figures the dict is Dict[str, str] and then promptly fails when int value is inserted Signed-off-by: Jussi Kukkonen <[email protected]>
jku
force-pushed
the
initial-mypy-integration
branch
from
116047a to
b643e5b
Compare
|
rebased on develop, added fix for an issue in new code |
There was a problem hiding this comment.
Do you think stricter options should be tried next? For example "disallow-untyped-defs" on api/metadata.py.
I see that now this results to errors coming from formats.py and exceptions.py.
Or maybe this is too strict and we can add type annotations to the coding guidelines for now?
|
|
||
| if TYPE_CHECKING: | ||
| # pylint: disable=cyclic-import | ||
| from tuf.api.metadata import Metadata, Signed |
There was a problem hiding this comment.
So mypy recognizes that the quoted strings "Metadata" and "Signed" are the classes in this import?
Cool trick!
There was a problem hiding this comment.
Yes, AFAIK for mypy the type-names-as-string are just as valid.
We probably should start experimenting with stricter options: once it's all set up I imagine it's not hard to maintain... But probably the most valuable improvement would be to gradually start supporting securesystemslib modules. On the specific cases you mentioned: formats.py should go IMO: #1384. Fixing exceptions.py should be a few minutes job. |
Goal is to start using mypy to statically check our source code:
tuf/api, and ignoring securesystemslib importsHow mypy is used after this PR:
tox -e lintor justmypyFixes #1335