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

Added py.typed to signal this project uses type declarations #246

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

Conversation

juanjosegarciaripoll
Copy link

Description

When using opt_einsum in other projects, mypy complains that opt_einsum cannot be type checked. The reason is that for an installed library to be considered by mypy, a file py.typed must be installed in the root directory of the module.

Status

  • Ready to go

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.63%. Comparing base (384bb5a) to head (6aaf482).

Additional details and impacted files

Copy link
Owner

@dgasmith dgasmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to merge this and push out a release. Before I do, can you manually insert a py.typed stub into an install and see how the typing goes?

I was slightly hesitant to add as I did not have a widely understood base of practice.

@dgasmith dgasmith mentioned this pull request Feb 7, 2025
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.

2 participants