Skip to content

advertize type annotations #1633

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

Jump to bottom
Closed
jku opened this issue Oct 24, 2021 · 0 comments · Fixed by #1677
Closed

advertize type annotations #1633

jku opened this issue Oct 24, 2021 · 0 comments · Fixed by #1677
Assignees
@jku
Labels
backlog Issues to address with priority for current development goals enhancement
Milestone
Sprint 12

Comments

@jku
Copy link
Member

jku commented Oct 24, 2021

Using mypy in code that imports python-tuf does not work yet. We probably need to ship a py.typed file (but this need to be tested: I am not sure how this works)

https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages
@jku jku mentioned this issue Oct 26, 2021
Closed
@sechkova sechkova added the backlog Issues to address with priority for current development goals label Oct 27, 2021
@jku jku mentioned this issue Nov 9, 2021
Closed
4 tasks
@sechkova sechkova added this to the Sprint 12 milestone Nov 10, 2021
jku pushed a commit to jku/python-tuf that referenced this issue Nov 11, 2021
Advertize type annotations with py.typed
7951ed2 
Existence of py.typed in the top-level package tells users of the
packages that the packages are annotated.

This should fix mypy errors like this in downstream projects:
  error: Skipping analyzing "tuf.api.metadata":
  found module but no type hints or library stubs

Fixes theupdateframework#1633

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
@jku jku mentioned this issue Nov 15, 2021
Merged
@jku jku closed this as completed in #1677 Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jku jku

Labels
backlog Issues to address with priority for current development goals enhancement
Projects
None yet
Milestone
Sprint 12
Development

Successfully merging a pull request may close this issue.

Advertize type annotations with py.typed jku/python-tuf
2 participants
@jku @sechkova