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

Add py.typed to setup.cfg #566

Open
wants to merge 2 commits into
base: v3
Choose a base branch
from
Open

Add py.typed to setup.cfg #566

wants to merge 2 commits into from

Conversation

navignaw
Copy link

@navignaw navignaw commented May 7, 2024

Q A
Bug fix? no
New feature? yes
BC breaks? no
Related Issue Fix #533
Need Doc update yes

Describe your change

According to PEP 561 python packages need to include a py.typed file in the distributed package so that downstream clients can leverage its type annotations.

What problem is this fixing?

By adding a py.typed file, this fixes an issue when running mypy in a downstream client:

algolia_search_service.py:4: error: Skipping analyzing "algoliasearch.search_client": module is installed, but missing library stubs or py.typed marker  [import-untyped]

@navignaw
Copy link
Author

navignaw commented May 7, 2024

Getting some strange test failures that seem to be completely unrelated to this PR. @shortcuts do you mind taking a look (or routing to the correct person?) Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Distribute type hints (PEP 561)
1 participant