Skip to content

Build: Initial mypy integration #1395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 1, 2021
Merged

Build: Initial mypy integration #1395

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1b9aec2
Metadata API: Use TYPE_CHECKING for cyclic import
May 10, 2021
f4d008c
Metadata API: Improve type hint for _signed_type
May 10, 2021
fe23a95
Metadata API: Mark Signed as Abstract Base Class
May 10, 2021
dfe6a66
Metadata API: Type hint signed in Metadata.from_dict()
May 10, 2021
43f13a0
Metadata: _common_fields_from_dict() should return Tuple
May 10, 2021
ca5f2dd
Add initial mypy configuration
May 10, 2021
510f224
tox: Run pylint in parallel
May 10, 2021
2e3eb40
Metadata API: Fix DelegatedRole.from_dict() return type
May 17, 2021
b643e5b
Metadata API: Add type annotation to help mypy
May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tuf/api/serialization/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@

"""
import abc
from typing import TYPE_CHECKING

if TYPE_CHECKING:
# pylint: disable=cyclic-import
from tuf.api.metadata import Metadata, Signed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So mypy recognizes that the quoted strings "Metadata" and "Signed" are the classes in this import?
Cool trick!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, AFAIK for mypy the type-names-as-string are just as valid.



# TODO: Should these be in tuf.exceptions or inherit from tuf.exceptions.Error?
Expand Down