Improve docutils.parsers
#14191
Improve docutils.parsers
#14191
Conversation
This comment has been minimized.
This comment has been minimized.
| class Parser(Component): | ||
| settings_spec: ClassVar[tuple[Any, ...]] |
There was a problem hiding this comment.
What's Any here? Most Anys need a comment explaining their use.
There was a problem hiding this comment.
I decided to remove this line because this attribute is already described in the parent class, and I added comment there:
# Mixed tuple structure; uses Any for flexibility in nested option definitions
| __docformat__: Final = "reStructuredText" | ||
|
|
||
| class BasePseudoSection(Directive): | ||
| option_spec: ClassVar[dict[str, Callable[[str], Any]]] |
There was a problem hiding this comment.
See above. More instances below. Maybe use a TypeAlias, so you only need to explain Any once?
There was a problem hiding this comment.
actually, it comes from the parent Directive class whose argument has already been defined using Any, I just wanted to show that dict value can't be None (only Callable)
but I sent this PR not to fix errors, but to add missing objects, trying not to leave Incomplete
There was a problem hiding this comment.
thanks to you I noticed this and now I have shown that argument of Callable can be str | None, and the result str | list[str] and most of the similar functions are taken from docutils/parsers/rst/directives/__init__.py module
in particular, this is why we got more effects from mypy_primer
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Semyon Moroz <[email protected]>
This comment has been minimized.
This comment has been minimized.
| @@ -27,22 +30,23 @@ class Directive: | |||
| required_arguments: ClassVar[int] | |||
| optional_arguments: ClassVar[int] | |||
| final_argument_whitespace: ClassVar[bool] | |||
| option_spec: ClassVar[dict[str, Callable[[str], Any]] | None] | |||
| option_spec: ClassVar[dict[str, Callable[[str | None], Incomplete]] | None] | |||
There was a problem hiding this comment.
I think most of the primer hits are due to the changed option_spec definition. I would suggest to create a type alias and use it here in other places where option_spec is defined, but use the old definition for now. (Except for Any -> Incomplete.) Then we can look at this problem in depth in a separate PR if necessary.
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
- sphinx/directives/other.py:10: note: In module imported here:
+ sphinx/util/docutils.py: note: In member "get_source_info" of class "SphinxDirective":
+ sphinx/util/docutils.py:488:16: error: Incompatible return value type (got "tuple[str, int] | tuple[None, None]", expected "tuple[str, int]") [return-value]
+ sphinx/directives/__init__.py: note: In member "run" of class "DefaultRole":
+ sphinx/directives/__init__.py:332:24: error: Argument 2 to "role" has incompatible type "_RstLanguageModule"; expected "_LanguageModule" [arg-type]
+ sphinx/directives/patches.py:33: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/directives/patches.py: note: In member "run" of class "Figure":
+ sphinx/directives/patches.py:42:20: error: Incompatible return value type (got "Sequence[Node]", expected "list[Node]") [return-value]
+ sphinx/directives/patches.py: note: At top level:
+ sphinx/directives/patches.py:59: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/directives/patches.py: note: In member "run" of class "CSVTable":
+ sphinx/directives/patches.py:82:16: error: Call to untyped function "run" in typed context [no-untyped-call]
+ sphinx/directives/other.py: note: In member "run" of class "Include":
+ sphinx/directives/other.py:409:13: error: Cannot assign to a method [method-assign]
+ sphinx/directives/other.py:409:47: error: Incompatible types in assignment (expression has type "Callable[[list[str], str], None]", variable has type "Callable[[list[str] | StringList, str], None]") [assignment]
+ sphinx/directives/code.py: note: In member "run" of class "CodeBlock":
+ sphinx/directives/code.py:146:74: error: Argument "location" to "dedent_lines" has incompatible type "tuple[str, int] | tuple[None, None]"; expected "tuple[str, int] | None" [arg-type]
+ sphinx/directives/code.py: note: In member "run" of class "LiteralInclude":
+ sphinx/directives/code.py:462:48: error: Argument "location" to "read" of "LiteralIncludeReader" has incompatible type "tuple[str, int] | tuple[None, None]"; expected "tuple[str, int] | None" [arg-type]
bokeh (https://github.com/bokeh/bokeh)
- src/bokeh/sphinxext/bokeh_palette_group.py:53: note: In module imported here:
alectryon (https://github.com/cpitclaudel/alectryon)
+ alectryon/docutils.py:818: error: Dict entry 1 has incompatible type "str": "Callable[[str], int]"; expected "str": "Callable[[str], str | list[str]]" [dict-item]
+ alectryon/docutils.py:819: error: Dict entry 2 has incompatible type "str": "Callable[[str | None], None]"; expected "str": "Callable[[str], str | list[str]]" [dict-item]
- alectryon/docutils.py:1534: error: Unused "type: ignore" comment [unused-ignore]
|
|
The new alectryon primer hit is due to a previously untyped module. The sphinx errors are a mixture, but mostly errors or problems on sphinx's side as far as I can see. |
Co-authored-by: Semyon Moroz <[email protected]>
No description provided.