Skip to content
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.

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

Type hints & PEP 561 packaging #278

Open
tuukkamustonen opened this issue May 7, 2021 · 0 comments
Open

Type hints & PEP 561 packaging #278

tuukkamustonen opened this issue May 7, 2021 · 0 comments
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue

Comments

@tuukkamustonen
Copy link

Add type hints to all (at least public API) code make the distribution PEP 561 compliant. This allows mypy (and other tools?) to find the type hints and use them in linting.

In practice, add an empty awscrt/py.typed file, and include it in the package:

setup(
    package_data={'awscrt': ['py.typed']},
    zip_safe=False,  # not needed with wheels, AFAIK
)

PEP 561: https://www.python.org/dev/peps/pep-0561/

@yasminetalby yasminetalby added feature-request A feature should be added or improved. p3 This is a minor priority issue labels Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants