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

Update check.mdx to include # pants: no-infer-dep #21685

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

Conversation

jasonwbarnett
Copy link
Contributor

@jasonwbarnett jasonwbarnett commented Nov 22, 2024

I think this example may be missing the # pants: no-infer-dep

@jasonwbarnett jasonwbarnett changed the title Update check.mdx Update check.mdx to include # pants: no-infer-dep Nov 22, 2024
@huonw huonw added the release-notes:not-required PR doesn't require mention in release notes label Nov 25, 2024
@@ -244,7 +244,7 @@ from mypy_boto3_ec2 import EC2Client

if TYPE_CHECKING:
# Safe, but will be flagged as a warning
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for taking the time to contribute. I think this code is already intended to be written along the lines of "you might need to add the pragma... or maybe use the better solution of having them as normal deps".

So, given that I think if we're making this change, we'll need to rewrite this comment, and also the text below:

Alternatively, you can set # pants: no-infer-dep on the lines of type-stub imports "guarded" by a check of if TYPE_CHECKING.

An alternative to adding pants: no-infer-dep here would be leaving it as, but rephrasing the rest of the text if there's a way to make it clearer to you?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I see your point—thanks for bringing that up! I’ll take another pass at clarifying this by editing the comment above.

It might be helpful to provide separate advice depending on whether unowned_dependency_behavior is set to "error" or "warning". For our use case, we have unowned_dependency_behavior set to "error", so it was absolutely necessary. Even with it set to "warning", I feel it’s not ideal to have warnings consistently showing up. That could be especially confusing for users who struggle to determine whether a warning is safe to ignore or something that needs immediate attention. I’ll work on making that distinction clearer.

[python-infer]
unowned_dependency_behavior = "error"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes:not-required PR doesn't require mention in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants