improve type annotations in 'docutils.nodes.Element'

[danieleades]

No description provided.

[danieleades]

could really use your eyes on this one @picnixz!

[picnixz]

For this one I'll need my computer because I don't think a review from my phone would be precise enough. Thus, I'll do it next week.

[picnixz]

Check if childclass also allow unions and union types

[JelleZijlstra]

Could you fix the merge conflict?

[danieleades]

+ sphinx/environment/collectors/metadata.py:32:56: error: Argument 1 to "first_child_not_matching_class" of "Element" has incompatible type "type[PreBibliographic]"; expected "Union[type[Node], tuple[type[Node], ...]]"  [arg-type]

@JelleZijlstra this is an interesting one. It seems not all Nodes subclass Node...

PreBibliographic has no base class

[srittau]

See below for some notes. Also, why did you remove child_text_separator from some of the classes?

[srittau]

I wonder whether it's better to just return bool here, as this is clearly how it's intended to be used. Using Literal[0, 1] will prevent the return value from being used as a bool, which works at runtime.

[danieleades]

why did you remove child_text_separator from some of the classes?

because this is inherited from the Element base class and doesn't need to be redefined

[github-actions]

Diff from mypy_primer, showing the effect of this PR on open source code:

sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/addnodes.py: note: In member "preserve_original_messages" of class "toctree":
+ sphinx/addnodes.py:91:22: error: Need type annotation for "rawentries"  [var-annotated]
- sphinx/util/nodes.py: note: In function "_copy_except__document":
- sphinx/util/nodes.py:658:5: error: "Element" has no attribute "tagname"  [attr-defined]
- sphinx/util/nodes.py:660:5: error: "Element" has no attribute "attributes"  [attr-defined]
+ sphinx/directives/__init__.py: note: In member "run" of class "ObjectDescription":
+ sphinx/directives/__init__.py:299:28: error: Need type annotation for "node_id"  [var-annotated]
+ sphinx/domains/std/__init__.py: note: In member "add_target_and_index" of class "Cmdoption":
+ sphinx/domains/std/__init__.py:209:9: error: Need type annotation for "optname"  [var-annotated]
+ sphinx/domains/std/__init__.py:231:9: error: Need type annotation for "option"  [var-annotated]
+ sphinx/transforms/i18n.py: note: In member "update_title_mapping" of class "_NodeUpdater":
+ sphinx/transforms/i18n.py:140:25: error: Need type annotation for "names"  [var-annotated]
+ sphinx/transforms/i18n.py: note: In member "apply" of class "AddTranslationClasses":
+ sphinx/transforms/i18n.py:590:59: error: Argument 1 to "append" of "list" has incompatible type "str"; expected Never  [arg-type]
+ sphinx/transforms/i18n.py:593:59: error: Argument 1 to "append" of "list" has incompatible type "str"; expected Never  [arg-type]
+ sphinx/writers/latex.py: note: In member "visit_inline" of class "LaTeXTranslator":
+ sphinx/writers/latex.py:2124:9: error: Need type annotation for "classes" (hint: "classes: List[<type>] = ...")  [var-annotated]
+ sphinx/writers/latex.py: note: In member "visit_container" of class "LaTeXTranslator":
+ sphinx/writers/latex.py:2156:9: error: Need type annotation for "classes" (hint: "classes: List[<type>] = ...")  [var-annotated]
+ sphinx/writers/latex.py: note: In member "depart_container" of class "LaTeXTranslator":
+ sphinx/writers/latex.py:2161:9: error: Need type annotation for "classes" (hint: "classes: List[<type>] = ...")  [var-annotated]
- sphinx/environment/collectors/metadata.py:37: error: Unused "type: ignore" comment  [unused-ignore]
+ sphinx/environment/collectors/metadata.py: note: In member "process_doc" of class "MetadataCollector":
+ sphinx/environment/collectors/metadata.py:32:56: error: Argument 1 to "first_child_not_matching_class" of "Element" has incompatible type "type[PreBibliographic]"; expected "Union[type[Node], tuple[type[Node], ...]]"  [arg-type]