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

Make package PEP 561 compliant by including py.typed file #170

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

Conversation

jonded94
Copy link

@jonded94 jonded94 commented Aug 6, 2024

Description

Using this package in a codebase with mypy unfortunately leads to errors like these:

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

This is because this package is not properly PEP 561 compliant.

The solution

Adding a py.typed file since this package already large has type hints, it just wasn't marked as being typed.

@jonded94 jonded94 changed the title Make package PEP 561 by including py.typed file Make package PEP 561 compliant by including py.typed file Aug 6, 2024
Copy link

sourcery-ai bot commented Aug 6, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

@jonded94 jonded94 force-pushed the make-package-pep-561-compliant branch from 49edbf8 to e9e203a Compare August 6, 2024 13:36
@jonded94
Copy link
Author

@isidore any updates on this? This should be a very small, unproblematic change. Let me know what you think.

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.

1 participant