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.

Sign up for GitHub

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
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/python/goals/check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

from mypy_boto3_ec2 import EC2ServiceResource
from mypy_boto3_ec2 import EC2ServiceResource # pants: no-infer-dep
```

For these reasons, it's recommended to load any type-stub libraries that require explicit imports as part of your normal [third-party dependencies](../overview/third-party-dependencies.mdx). Alternatively, you can set `# pants: no-infer-dep` on the lines of type-stub imports "guarded" by a check of `if TYPE_CHECKING`.
Expand Down
Loading