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

chore: create py.typed #722

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Lunarmagpie
Copy link

Add py.typed file. This allows typecheckers to be used with the library. I looked at the code and it looks typed so I'm pretty sure this is a useful change here.

Fixes

A short description of what this PR does.

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

@Lunarmagpie Lunarmagpie changed the title Create py.typed chore: create py.typed Sep 9, 2023
@tiwarishubham635
Copy link
Contributor

Hi @Lunarmagpie! Can you share how this can we use this?

@tiwarishubham635 tiwarishubham635 added the status: waiting for feedback waiting for feedback from the submitter label Apr 4, 2024
@Lunarmagpie
Copy link
Author

Hi @Lunarmagpie! Can you share how this can we use this?

Hello. all you need to do for py.typed is add it as an extra file for the packaging system that is used with this project. Once people download it as a dependency, pyright and mypy won't give the missing types error when you typecheck a package using this library.

@Lunarmagpie
Copy link
Author

I remembered there is a PEP for this
https://peps.python.org/pep-0561/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for feedback waiting for feedback from the submitter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants