improve type annotations in 'docutils.core' #11559
Draft
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
danieleades
force-pushed
the
docutils.core
branch
from
080fa76
to
760a829
Compare
This comment has been minimized.
This comment has been minimized.
| parser: Parser | None = None, | ||
| writer: Writer | None = None, | ||
| source: Input[_S] | None = None, | ||
| source_class: type[Input[_S]] = io.FileInput, |
There was a problem hiding this comment.
There's some mypy errors about this. It's probably difficult to get this right without overloads.
danieleades
force-pushed
the
docutils.core
branch
from
760a829
to
bdc8857
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
srittau
requested changes
Mar 14, 2024
| writer_name: str = "pseudoxml", | ||
| settings: Values | None = None, | ||
| settings_spec: SettingsSpec | None = None, | ||
| settings_overrides: Any | None = None, |
There was a problem hiding this comment.
Could probably be typed. Docstring says:
settings_overrides: A dictionary containing application-specific settings defaults that override the defaults of other components. [...]
Without looking at the source, this this probably a dict, Mapping, or one of the protocols from _typeshed. It's okay to leave it as Incomplete now, though.
Applies to all the functions below as well.
| argv: list[str] | None = None, | ||
| usage: str = default_usage, | ||
| description: str = default_description, | ||
| ) -> Any: ... |
There was a problem hiding this comment.
I'd add a comment to this and the other return types below that this is either str or bytes.
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
This comment has been minimized.
This comment has been minimized.
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/builders/html/__init__.py:21: note: In module imported here:
+ sphinx/io.py:161:53: error: Missing type parameters for generic type "Publisher" [type-arg]
+ sphinx/builders/__init__.py: note: In member "read_doc" of class "Builder":
+ sphinx/builders/__init__.py:491:9: error: Item "None" of "Optional[Values]" has no attribute "record_dependencies" [union-attr]
+ sphinx/builders/__init__.py:508:37: error: Argument 2 to "write_doctree" of "Builder" has incompatible type "Optional[document]"; expected "document" [arg-type]
+ sphinx/builders/__init__.py: note: At top level:
- sphinx/builders/html/__init__.py:439: error: Unused "type: ignore" comment [unused-ignore]
cwltool (https://github.com/common-workflow-language/cwltool)
+ note: In module imported here,
+ note: ... from here,
+ note: ... from here,
+ cwltool/software_requirements.py:32: note: ... from here:
|
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.
No description provided.