Add visit_* and depart_* methods to docutils visitor classes
#13928
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
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/writers/html5.py: note: In member "depart_number_reference" of class "HTML5Translator":
+ sphinx/writers/html5.py:361:31: error: Argument 1 to "depart_reference" of "NodeVisitor" has incompatible type "Element"; expected "reference" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_bullet_list" of class "HTML5Translator":
+ sphinx/writers/html5.py:458:35: error: Argument 1 to "visit_bullet_list" of "NodeVisitor" has incompatible type "Element"; expected "bullet_list" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_title" of class "HTML5Translator":
+ sphinx/writers/html5.py:521:33: error: Argument 1 to "visit_title" of "NodeVisitor" has incompatible type "Element"; expected "title" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_title" of class "HTML5Translator":
+ sphinx/writers/html5.py:562:30: error: Argument 1 to "depart_title" of "NodeVisitor" has incompatible type "Element"; expected "title" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_literal_block" of class "HTML5Translator":
+ sphinx/writers/html5.py:592:48: error: Argument 1 to "visit_literal_block" of "NodeVisitor" has incompatible type "Element"; expected "literal_block" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_caption" of class "HTML5Translator":
+ sphinx/writers/html5.py:624:35: error: Argument 1 to "visit_caption" of "NodeVisitor" has incompatible type "Element"; expected "caption" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_caption" of class "HTML5Translator":
+ sphinx/writers/html5.py:648:36: error: Argument 1 to "depart_caption" of "NodeVisitor" has incompatible type "Element"; expected "caption" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_figure" of class "HTML5Translator":
+ sphinx/writers/html5.py:747:37: error: Argument 1 to "visit_figure" of "NodeVisitor" has incompatible type "Element"; expected "figure" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_image" of class "HTML5Translator":
+ sphinx/writers/html5.py:775:29: error: Argument 1 to "visit_image" of "NodeVisitor" has incompatible type "Element"; expected "image" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_image" of class "HTML5Translator":
+ sphinx/writers/html5.py:782:34: error: Argument 1 to "depart_image" of "NodeVisitor" has incompatible type "Element"; expected "image" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_literal_emphasis" of class "HTML5Translator":
+ sphinx/writers/html5.py:896:36: error: Argument 1 to "visit_emphasis" of "NodeVisitor" has incompatible type "Element"; expected "emphasis" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_literal_emphasis" of class "HTML5Translator":
+ sphinx/writers/html5.py:899:37: error: Argument 1 to "depart_emphasis" of "NodeVisitor" has incompatible type "Element"; expected "emphasis" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_literal_strong" of class "HTML5Translator":
+ sphinx/writers/html5.py:902:34: error: Argument 1 to "visit_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_literal_strong" of class "HTML5Translator":
+ sphinx/writers/html5.py:905:35: error: Argument 1 to "depart_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_table" of class "HTML5Translator":
+ sphinx/writers/html5.py:941:30: error: Argument 1 to "depart_table" of "NodeVisitor" has incompatible type "Element"; expected "table" [arg-type]
+ sphinx/writers/html5.py: note: In member "visit_field_list" of class "HTML5Translator":
+ sphinx/writers/html5.py:954:41: error: Argument 1 to "visit_field_list" of "NodeVisitor" has incompatible type "Element"; expected "field_list" [arg-type]
+ sphinx/writers/html5.py: note: In member "depart_field_list" of class "HTML5Translator":
+ sphinx/writers/html5.py:958:42: error: Argument 1 to "depart_field_list" of "NodeVisitor" has incompatible type "Element"; expected "field_list" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_desc" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:134:36: error: Argument 1 to "visit_definition_list" of "NodeVisitor" has incompatible type "Element"; expected "definition_list" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_desc" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:137:37: error: Argument 1 to "depart_definition_list" of "NodeVisitor" has incompatible type "Element"; expected "definition_list" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_desc_signature" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:140:41: error: Argument 1 to "visit_definition_list_item" of "NodeVisitor" has incompatible type "Element"; expected "definition_list_item" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_desc_signature" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:144:26: error: Argument 1 to "depart_term" of "NodeVisitor" has incompatible type "Element"; expected "term" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_desc_content" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:153:31: error: Argument 1 to "visit_definition" of "NodeVisitor" has incompatible type "Element"; expected "definition" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_desc_content" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:156:32: error: Argument 1 to "depart_definition" of "NodeVisitor" has incompatible type "Element"; expected "definition" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_versionmodified" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:235:30: error: Argument 1 to "visit_paragraph" of "NodeVisitor" has incompatible type "Element"; expected "paragraph" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_versionmodified" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:238:31: error: Argument 1 to "depart_paragraph" of "NodeVisitor" has incompatible type "Element"; expected "paragraph" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_term" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:245:32: error: Argument 1 to "visit_term" of "NodeVisitor" has incompatible type "Element"; expected "term" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_footnote" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:254:32: error: Argument 1 to "visit_footnote" of "NodeVisitor" has incompatible type "Element"; expected "footnote" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_seealso" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:268:9: error: Too many arguments for "visit_admonition" of "NodeVisitor" [call-arg]
+ sphinx/writers/manpage.py:268:31: error: Argument 1 to "visit_admonition" of "NodeVisitor" has incompatible type "Element"; expected "admonition" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_seealso" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:271:32: error: Argument 1 to "depart_admonition" of "NodeVisitor" has incompatible type "Element"; expected "admonition" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_reference" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:304:25: error: Argument 1 to "visit_Text" of "NodeVisitor" has incompatible type "Element"; expected "Text" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_hlist" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:373:32: error: Argument 1 to "visit_bullet_list" of "NodeVisitor" has incompatible type "Element"; expected "bullet_list" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_hlist" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:376:33: error: Argument 1 to "depart_bullet_list" of "NodeVisitor" has incompatible type "Element"; expected "bullet_list" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_literal_emphasis" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:385:36: error: Argument 1 to "visit_emphasis" of "NodeVisitor" has incompatible type "Element"; expected "emphasis" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_literal_emphasis" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:388:37: error: Argument 1 to "depart_emphasis" of "NodeVisitor" has incompatible type "Element"; expected "emphasis" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_literal_strong" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:391:34: error: Argument 1 to "visit_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_literal_strong" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:394:35: error: Argument 1 to "depart_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_manpage" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:403:34: error: Argument 1 to "visit_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_manpage" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:406:35: error: Argument 1 to "depart_strong" of "NodeVisitor" has incompatible type "Element"; expected "strong" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_caption" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:416:35: error: Argument 1 to "visit_caption" of "NodeVisitor" has incompatible type "Element"; expected "caption" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_caption" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:425:36: error: Argument 1 to "depart_caption" of "NodeVisitor" has incompatible type "Element"; expected "caption" [arg-type]
+ sphinx/writers/manpage.py: note: In member "visit_title" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:439:36: error: Argument 1 to "visit_title" of "NodeVisitor" has incompatible type "Element"; expected "title" [arg-type]
+ sphinx/writers/manpage.py: note: In member "depart_title" of class "ManualPageTranslator":
+ sphinx/writers/manpage.py:445:37: error: Argument 1 to "depart_title" of "NodeVisitor" has incompatible type "Element"; expected "title" [arg-type]
|
|
All of these are true positives. Most of these are due to the A few items to note:
|
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.
Adds the
visit_*anddepart_*methods for each node class todocutils.nodes.NodeVisitor. Node classes known todocutilsare kept in the listdocutils.nodes.node_class_names.The motivation and implementation is similar to #3796, which does this for the standard library's
ast.NodeVisitor. The difference is thatdocutils.nodes.NodeVisitoritself does not have a fallback if a method is not defined for a node, and will fail at runtime. This is documented in the runtime class, but I added a short comment to the stubs about this as well.The subclasses
SparseNodeVisitorand the more commonGenericNodeVisitordo actually have these methods at runtime (they are added dynamically to the class), but to aid discoverability of these methods todocutils.nodes.NodeVisitor(and to avoid repeating the same set of methods 2 more times) I only added them to the baseNodeVisitorclass.I did not make the node argument to the visit methods positional-only, even though the node dispatch methods only use a positional-only API. This is because, after a quick browse through visitor method overrides in
docutilsandsphinx, I didn't find anyone else implementing positional-only overrides, so having positional-only signatures may cause a lot of issues downstream.