add type annotations to docutils.writers #12420
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
This comment has been minimized.
This comment has been minimized.
0c44974
to
447a252
Compare
|
there's definitely there's definitely some issues with these stubs. can i get your insight? |
picnixz
reviewed
Jul 27, 2024
There was a problem hiding this comment.
For the mypy errors:
- Missing generics are normal, since we didn't specify one.
- Errors on the reader should not be error but it's because the typings are incorrect (there shouldn't be a bound for this type variable).
+ sphinx/builders/latex/__init__.py:281:28: error: Argument "components" to "OptionParser" has incompatible type "tuple[LaTeXWriter]"; expected "Iterable[type[Parser]]" [arg-type]: the error is in the stub, it should not beIterable[type[Parser]]butIterable[Component](I don't know why it's typed like that and I don't know when it was typed like that).- Concerning the fact that
Nonehas no attributewalkabout, this is because the variables are set at runtime when callingwrite()but this is impossible to indicate as a typing intent I think... unless you useAny(but it defeats the purpose ..., though this is what's being done for `docutils.parsers.
I'll review other errors after you changed the Reader class and remove ClassVars.
447a252
to
633c048
Compare
This comment has been minimized.
This comment has been minimized.
|
The only relevant error is now:
and
|
This comment has been minimized.
This comment has been minimized.
picnixz
approved these changes
Jul 27, 2024
There was a problem hiding this comment.
Surprisingly, we have no additional issue. So, the remaining issues in Sphinx are real issues IMO:
Cannot override class variable (previously declared on base class "SettingsSpec") with instance variable
We write
settings_spec: tuple[str, Any, tuple[tuple[str, list[str], dict[str, str]], ...]]but this should be a class var (we can even omit it after this PR is merged). As for the second error, we do self.document.walkabout(visitor) so we should have some assert just before the call to help mypy (or just type-ignore it). Finally, for
- sphinx/builders/text.py:74:27: error: Argument 1 to "write" of "Writer" has incompatible type "Node"; expected "document" [arg-type]
It's because we have an incorrect signature:
def write_doc(self, docname: str, doctree: Node) -> None: ...It should be doctree: nodes.document instead. Now, we just need to add the generic types now in Sphinx but AFAIK, we only use strings and not bytes.
@AA-Turner do you want to have a look here?
jayaddison
reviewed
Jul 28, 2024
Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com>
JelleZijlstra
approved these changes
Oct 3, 2024
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/io.py:146: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/io.py:146:25: error: Missing type parameters for generic type "UnfilteredWriter" [type-arg]
+ sphinx/io.py:146:25: note: Error code "type-arg" not covered by "type: ignore" comment
+ sphinx/writers/latex.py:68: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/writers/latex.py:68:19: error: Missing type parameters for generic type "Writer" [type-arg]
+ sphinx/writers/latex.py:68:19: note: Error code "type-arg" not covered by "type: ignore" comment
+ sphinx/writers/latex.py: note: In class "LaTeXWriter":
+ sphinx/writers/latex.py:77:5: error: Cannot override class variable (previously declared on base class "SettingsSpec") with instance variable [misc]
+ sphinx/writers/latex.py: note: In member "translate" of class "LaTeXWriter":
+ sphinx/writers/latex.py:87:9: error: Item "None" of "document | None" has no attribute "walkabout" [union-attr]
+ sphinx/writers/text.py:359: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/writers/text.py:359:18: error: Missing type parameters for generic type "Writer" [type-arg]
+ sphinx/writers/text.py:359:18: note: Error code "type-arg" not covered by "type: ignore" comment
+ sphinx/writers/text.py: note: In class "TextWriter":
+ sphinx/writers/text.py:362:5: error: Cannot override class variable (previously declared on base class "SettingsSpec") with instance variable [misc]
+ sphinx/writers/text.py: note: In member "translate" of class "TextWriter":
+ sphinx/writers/text.py:372:9: error: Item "None" of "document | None" has no attribute "walkabout" [union-attr]
+ sphinx/writers/texinfo.py:107: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/writers/texinfo.py:107:21: error: Missing type parameters for generic type "Writer" [type-arg]
+ sphinx/writers/texinfo.py:107:21: note: Error code "type-arg" not covered by "type: ignore" comment
+ sphinx/writers/texinfo.py: note: In class "TexinfoWriter":
+ sphinx/writers/texinfo.py:112:5: error: Cannot override class variable (previously declared on base class "SettingsSpec") with instance variable [misc]
+ sphinx/writers/texinfo.py:120:5: error: Cannot override class variable (previously declared on base class "SettingsSpec") with instance variable [misc]
+ sphinx/writers/texinfo.py: note: In member "translate" of class "TexinfoWriter":
+ sphinx/writers/texinfo.py:133:9: error: Item "None" of "document | None" has no attribute "walkabout" [union-attr]
|
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.