Consider __doc__ always Optional. Fixes issues surfaced with python/mypy#2380. #641
Conversation
This file contains hidden or 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
gvanrossum
requested changes
Oct 30, 2016
| @@ -23,7 +23,7 @@ The below is an excerpt from the types for the `datetime` module. | |||
| ``` | |||
| MAXYEAR = ... # type: int | |||
| MINYEAR = ... # type: int | |||
| __doc__ = ... # type: str | |||
| __doc__ = ... # type: Optional[str] | |||
There was a problem hiding this comment.
Honestly I would remove all the dunder variables from the example, they don't add any clarity (and they're not in that file anyway).
| @@ -12,7 +12,7 @@ def abstractmethod(funcobj: Any) -> Any: ... | |||
| class ABCMeta(type): | |||
| # TODO: FrozenSet | |||
| __abstractmethods__ = ... # type: Set[Any] | |||
| __doc__ = ... # type: str | |||
| __doc__ = ... # type: Optional[str] | |||
There was a problem hiding this comment.
No class other than object actually needs to declare __doc__ at all. They just inherit it from object. I think the stubs have it because the stub generator puts it in.
gvanrossum
approved these changes
Oct 30, 2016
|
Amazing! |
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.
python/mypy#2380 showed a discrepancy between
objectandFunctionTypein stdlib2. The first defined__doc__to bestr, the secondOptional[str]. AsFunctionTypedepends onobject, this is no longer valid.As suggested by @gvanrossum in python/mypy#2380, all
__doc__should be considered Optional.