diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-12-29 23:56:30 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-12-30 17:22:56 +0900 |
commit | ab184ac20d82d0546c21f33d2fdfbfb324078d56 (patch) | |
tree | 225b6c5f9904d8699332add3cb0939fb8be68ef2 /sphinx/transforms | |
parent | 7a4bbf372a470700a1dfd96dd57054bb96b92fd3 (diff) | |
download | sphinx-git-ab184ac20d82d0546c21f33d2fdfbfb324078d56.tar.gz |
mypy: Enable disallow_incomplete_defs flag for type checking
Diffstat (limited to 'sphinx/transforms')
-rw-r--r-- | sphinx/transforms/__init__.py | 30 | ||||
-rw-r--r-- | sphinx/transforms/compact_bullet_list.py | 2 | ||||
-rw-r--r-- | sphinx/transforms/i18n.py | 6 | ||||
-rw-r--r-- | sphinx/transforms/post_transforms/__init__.py | 8 | ||||
-rw-r--r-- | sphinx/transforms/post_transforms/code.py | 4 | ||||
-rw-r--r-- | sphinx/transforms/post_transforms/compat.py | 2 | ||||
-rw-r--r-- | sphinx/transforms/post_transforms/images.py | 2 | ||||
-rw-r--r-- | sphinx/transforms/references.py | 6 |
8 files changed, 30 insertions, 30 deletions
diff --git a/sphinx/transforms/__init__.py b/sphinx/transforms/__init__.py index df94aca49..58121bf59 100644 --- a/sphinx/transforms/__init__.py +++ b/sphinx/transforms/__init__.py @@ -104,7 +104,7 @@ class DefaultSubstitutions(SphinxTransform): # run before the default Substitutions default_priority = 210 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: # only handle those not otherwise defined in the document to_handle = default_substitutions - set(self.document.substitution_defs) for ref in self.document.traverse(nodes.substitution_reference): @@ -127,7 +127,7 @@ class MoveModuleTargets(SphinxTransform): """ default_priority = 210 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(nodes.target): if not node['ids']: continue @@ -145,7 +145,7 @@ class HandleCodeBlocks(SphinxTransform): """ default_priority = 210 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: # move doctest blocks out of blockquotes for node in self.document.traverse(nodes.block_quote): if all(isinstance(child, nodes.doctest_block) for child @@ -169,7 +169,7 @@ class AutoNumbering(SphinxTransform): """ default_priority = 210 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: domain = self.env.get_domain('std') # type: StandardDomain for node in self.document.traverse(nodes.Element): @@ -183,7 +183,7 @@ class SortIds(SphinxTransform): """ default_priority = 261 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(nodes.section): if len(node['ids']) > 1 and node['ids'][0].startswith('id'): node['ids'] = node['ids'][1:] + [node['ids'][0]] @@ -204,7 +204,7 @@ class ApplySourceWorkaround(SphinxTransform): """ default_priority = 10 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(): # type: Node if isinstance(node, (nodes.TextElement, nodes.image)): apply_source_workaround(node) @@ -216,7 +216,7 @@ class AutoIndexUpgrader(SphinxTransform): """ default_priority = 210 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(addnodes.index): if 'entries' in node and any(len(entry) == 4 for entry in node['entries']): msg = __('4 column based index found. ' @@ -233,7 +233,7 @@ class ExtraTranslatableNodes(SphinxTransform): """ default_priority = 10 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: targets = self.config.gettext_additional_targets target_nodes = [v for k, v in TRANSLATABLE_NODES.items() if k in targets] if not target_nodes: @@ -252,7 +252,7 @@ class UnreferencedFootnotesDetector(SphinxTransform): """ default_priority = 200 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.footnotes: if node['names'] == []: # footnote having duplicated number. It is already warned at parser. @@ -273,7 +273,7 @@ class DoctestTransform(SphinxTransform): """Set "doctest" style to each doctest_block node""" default_priority = 500 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(nodes.doctest_block): node['classes'].append('doctest') @@ -284,7 +284,7 @@ class FigureAligner(SphinxTransform): """ default_priority = 700 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: matcher = NodeMatcher(nodes.table, nodes.figure) for node in self.document.traverse(matcher): # type: Element node.setdefault('align', 'default') @@ -294,7 +294,7 @@ class FilterSystemMessages(SphinxTransform): """Filter system messages from a doctree.""" default_priority = 999 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: filterlevel = 2 if self.config.keep_warnings else 5 for node in self.document.traverse(nodes.system_message): if node['level'] < filterlevel: @@ -321,7 +321,7 @@ class SphinxSmartQuotes(SmartQuotes, SphinxTransform): """ default_priority = 750 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: if not self.is_available(): return @@ -370,7 +370,7 @@ class DoctreeReadEvent(SphinxTransform): """Emit :event:`doctree-read` event.""" default_priority = 880 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: self.app.emit('doctree-read', self.document) @@ -378,7 +378,7 @@ class ManpageLink(SphinxTransform): """Find manpage section numbers and names""" default_priority = 999 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(addnodes.manpage): manpage = ' '.join([str(x) for x in node.children if isinstance(x, nodes.Text)]) diff --git a/sphinx/transforms/compact_bullet_list.py b/sphinx/transforms/compact_bullet_list.py index 09274cd5f..a1a95003c 100644 --- a/sphinx/transforms/compact_bullet_list.py +++ b/sphinx/transforms/compact_bullet_list.py @@ -61,7 +61,7 @@ class RefOnlyBulletListTransform(SphinxTransform): """ default_priority = 100 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: if self.config.html_compact_lists: return diff --git a/sphinx/transforms/i18n.py b/sphinx/transforms/i18n.py index d1c125a7e..e6870e6ca 100644 --- a/sphinx/transforms/i18n.py +++ b/sphinx/transforms/i18n.py @@ -84,7 +84,7 @@ class PreserveTranslatableMessages(SphinxTransform): """ default_priority = 10 # this MUST be invoked before Locale transform - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(addnodes.translatable): node.preserve_original_messages() @@ -95,7 +95,7 @@ class Locale(SphinxTransform): """ default_priority = 20 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: settings, source = self.document.settings, self.document['source'] msgstr = '' @@ -480,7 +480,7 @@ class RemoveTranslatableInline(SphinxTransform): """ default_priority = 999 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: from sphinx.builders.gettext import MessageCatalogBuilder if isinstance(self.app.builder, MessageCatalogBuilder): return diff --git a/sphinx/transforms/post_transforms/__init__.py b/sphinx/transforms/post_transforms/__init__.py index 9cb7add44..c7d521bca 100644 --- a/sphinx/transforms/post_transforms/__init__.py +++ b/sphinx/transforms/post_transforms/__init__.py @@ -38,7 +38,7 @@ class SphinxPostTransform(SphinxTransform): builders = () # type: Tuple[str, ...] formats = () # type: Tuple[str, ...] - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: if self.is_supported(): self.run(**kwargs) @@ -51,7 +51,7 @@ class SphinxPostTransform(SphinxTransform): return True - def run(self, **kwargs) -> None: + def run(self, **kwargs: Any) -> None: """main method of post transforms. Subclasses should override this method instead of ``apply()``. @@ -66,7 +66,7 @@ class ReferencesResolver(SphinxPostTransform): default_priority = 10 - def run(self, **kwargs) -> None: + def run(self, **kwargs: Any) -> None: for node in self.document.traverse(addnodes.pending_xref): contnode = cast(nodes.TextElement, node[0].deepcopy()) newnode = None @@ -178,7 +178,7 @@ class ReferencesResolver(SphinxPostTransform): class OnlyNodeTransform(SphinxPostTransform): default_priority = 50 - def run(self, **kwargs) -> None: + def run(self, **kwargs: Any) -> None: # A comment on the comment() nodes being inserted: replacing by [] would # result in a "Losing ids" exception if there is a target node before # the only node, so we make sure docutils can transfer the id to diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index 0707b85a8..06f687ea1 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -36,7 +36,7 @@ class HighlightLanguageTransform(SphinxTransform): """ default_priority = 400 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: visitor = HighlightLanguageVisitor(self.document, self.config.highlight_language) self.document.walkabout(visitor) @@ -92,7 +92,7 @@ class TrimDoctestFlagsTransform(SphinxTransform): """ default_priority = HighlightLanguageTransform.default_priority + 1 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: if not self.config.trim_doctest_flags: return diff --git a/sphinx/transforms/post_transforms/compat.py b/sphinx/transforms/post_transforms/compat.py index 4520cf4fc..e12923e79 100644 --- a/sphinx/transforms/post_transforms/compat.py +++ b/sphinx/transforms/post_transforms/compat.py @@ -33,7 +33,7 @@ class MathNodeMigrator(SphinxTransform): """ default_priority = 999 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for math_node in self.document.traverse(nodes.math): # case: old styled ``math`` node generated by old extensions if len(math_node) == 0: diff --git a/sphinx/transforms/post_transforms/images.py b/sphinx/transforms/post_transforms/images.py index 69a939731..10463bcac 100644 --- a/sphinx/transforms/post_transforms/images.py +++ b/sphinx/transforms/post_transforms/images.py @@ -183,7 +183,7 @@ class ImageConverter(BaseImageConverter): #: ] conversion_rules = [] # type: List[Tuple[str, str]] - def __init__(self, *args, **kwargs) -> None: + def __init__(self, *args: Any, **kwargs: Any) -> None: self.available = None # type: bool # the converter is available or not. # Will be checked at first conversion diff --git a/sphinx/transforms/references.py b/sphinx/transforms/references.py index 79b439f4b..4b89e104d 100644 --- a/sphinx/transforms/references.py +++ b/sphinx/transforms/references.py @@ -26,7 +26,7 @@ class SubstitutionDefinitionsRemover(SphinxTransform): # should be invoked after Substitutions process default_priority = Substitutions.default_priority + 1 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for node in self.document.traverse(nodes.substitution_definition): node.parent.remove(node) @@ -34,7 +34,7 @@ class SubstitutionDefinitionsRemover(SphinxTransform): class SphinxDanglingReferences(DanglingReferences): """DanglingReferences transform which does not output info messages.""" - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: try: reporter = self.document.reporter report_level = reporter.report_level @@ -50,7 +50,7 @@ class SphinxDomains(SphinxTransform): """Collect objects to Sphinx domains for cross references.""" default_priority = 850 - def apply(self, **kwargs) -> None: + def apply(self, **kwargs: Any) -> None: for domain in self.env.domains.values(): domain.process_doc(self.env, self.env.docname, self.document) |