stubtest: Support type_check_only decorator
#15146
Labels
Comments
|
Could I get the |
2 tasks
sobolevn
added a commit
that referenced
this issue
Nov 11, 2023
There are several `TODO` items for the future (not in this PR): - [ ] Add an error code to disallow importing things that are decorated with `@type_check_only` - [ ] Support `@overload`ed functions. But, how? There are two options: we can treat individual overload cases as `@type_check_only` or we can treat the whole func. Since `typeshed` does not have any examples of this, I prefer to defer this discussion to somewhere else and support this when we decide Refs #15146 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Alex Waygood <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Feature
I would like stubtest to support checking the
type_check_onlydecorator.This means something marked with
type_check_onlythat DOES exist at runtime is an error.And something that DOES NOT exist at runtime, and is marked with
type_check_onlyshould pass.Pitch
Instead of marking stub-only classes and methods as private in typeshed, they can be marked with
@type_check_only, which is designed for that exact purpose. Private may or may not be found at runtime, and users sometimes don't have a choice to use them, and basically have to guess whether they need to wrap the import inTYPE_CHECK_ONLYor not.This would also promote marking as
type_check_onlyspecial methods that don't exist at runtime, but are added to support some typechecker features, in typeshed.Related: #9531
The text was updated successfully, but these errors were encountered: