Skip to content

Type hints & PEP 561 packagingΒ #278

Open
@tuukkamustonen

Description

@tuukkamustonen

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature-requestA feature should be added or improved.p3This is a minor priority issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions