Add docs for --local-partial-types option #8201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JukkaL
reviewed
Jan 9, 2020
JukkaL
reviewed
Jan 13, 2020
docs/source/command_line.rst
Outdated
| @@ -482,6 +482,32 @@ of the above sections. | |||
| # 'items' now has type List[List[str]] | |||
| ... | |||
|
|
|||
| .. option:: --local-partial-types | |||
|
|
|||
| By default, mypy won't check partial types spanning module top level or class top level. | |||
There was a problem hiding this comment.
This sentence is pretty vague. It would be better to also introduce the concept "partial types" before discussing it.
This is an important case where this option makes a difference:
class A:
x = None # Need type annotation here if using --local-partial-types
def __init__(self) -> None:
self.x = 1
reveal_type(A().x) # Union[int, None] without --local-partial-typesThis example also makes it easier to see why this is called "local partial types" -- it disallows inferring variable type from two assignments in different scopes (for example, in class body and inside a method).
docs/source/command_line.rst
Outdated
| l2 = [] # type: List[int] | ||
|
|
||
| class Foo: | ||
| bar = None # error |
There was a problem hiding this comment.
Similar to above -- --local-partial-types causes this to be an error.
JukkaL
approved these changes
Jan 17, 2020
|
Thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves #8046, document the
--local-partial-typescommand line option