IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Migrate to py3 style type annotation: sphinx.directives.patches

Browse Source
This commit is contained in:
Takeshi KOMIYA 2019-06-08 19:44:09 +09:00
parent e14c76d942
commit 4db7a81528
1 changed files with 13 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
sphinx/directives/patches.py
View File

@ -6,10 +6,11 @@
:license: BSD, see LICENSE for details. :license: BSD, see LICENSE for details.
""" """
from typing import Any, Dict, List, Tuple
from typing import cast from typing import cast
from docutils import nodes from docutils import nodes
from docutils.nodes import make_id from docutils.nodes import Node, make_id, system_message
from docutils.parsers.rst import directives from docutils.parsers.rst import directives
from docutils.parsers.rst.directives import images, html, tables from docutils.parsers.rst.directives import images, html, tables
@ -20,8 +21,7 @@ from sphinx.util.nodes import set_source_info
if False: if False:
# For type annotation # For type annotation
from typing import Dict, List, Tuple # NOQA from sphinx.application import Sphinx
from sphinx.application import Sphinx # NOQA
class Figure(images.Figure): class Figure(images.Figure):
@ -29,8 +29,7 @@ class Figure(images.Figure):
instead of the image node. instead of the image node.
""" """
def run(self): def run(self) -> List[Node]:
# type: () -> List[nodes.Node]
name = self.options.pop('name', None) name = self.options.pop('name', None)
result = super().run() result = super().run()
if len(result) == 2 or isinstance(result[0], nodes.system_message): if len(result) == 2 or isinstance(result[0], nodes.system_message):
@ -52,8 +51,7 @@ class Figure(images.Figure):
class Meta(html.Meta, SphinxDirective): class Meta(html.Meta, SphinxDirective):
def run(self): def run(self) -> List[Node]:
# type: () -> List[nodes.Node]
result = super().run() result = super().run()
for node in result: for node in result:
if (isinstance(node, nodes.pending) and if (isinstance(node, nodes.pending) and
@ -74,8 +72,7 @@ class RSTTable(tables.RSTTable):
Only for docutils-0.13 or older version.""" Only for docutils-0.13 or older version."""
def make_title(self): def make_title(self) -> Tuple[nodes.title, List[system_message]]:
# type: () -> Tuple[nodes.title, List[nodes.system_message]]
title, message = super().make_title() title, message = super().make_title()
if title: if title:
set_source_info(self, title) set_source_info(self, title)
@ -88,8 +85,7 @@ class CSVTable(tables.CSVTable):
Only for docutils-0.13 or older version.""" Only for docutils-0.13 or older version."""
def make_title(self): def make_title(self) -> Tuple[nodes.title, List[system_message]]:
# type: () -> Tuple[nodes.title, List[nodes.system_message]]
title, message = super().make_title() title, message = super().make_title()
if title: if title:
set_source_info(self, title) set_source_info(self, title)
@ -102,8 +98,7 @@ class ListTable(tables.ListTable):
Only for docutils-0.13 or older version.""" Only for docutils-0.13 or older version."""
def make_title(self): def make_title(self) -> Tuple[nodes.title, List[system_message]]:
# type: () -> Tuple[nodes.title, List[nodes.system_message]]
title, message = super().make_title() title, message = super().make_title()
if title: if title:
set_source_info(self, title) set_source_info(self, title)
@ -125,8 +120,7 @@ class Code(SphinxDirective):
} }
has_content = True has_content = True
def run(self): def run(self) -> List[Node]:
# type: () -> List[nodes.Node]
self.assert_has_content() self.assert_has_content()
code = '\n'.join(self.content) code = '\n'.join(self.content)
@ -169,8 +163,7 @@ class MathDirective(SphinxDirective):
'nowrap': directives.flag, 'nowrap': directives.flag,
} }
def run(self): def run(self) -> List[Node]:
# type: () -> List[nodes.Node]
latex = '\n'.join(self.content) latex = '\n'.join(self.content)
if self.arguments and self.arguments[0]: if self.arguments and self.arguments[0]:
latex = self.arguments[0] + '\n\n' + latex latex = self.arguments[0] + '\n\n' + latex
@ -184,12 +177,11 @@ class MathDirective(SphinxDirective):
self.add_name(node) self.add_name(node)
self.set_source_info(node) self.set_source_info(node)
ret = [node] # type: List[nodes.Node] ret = [node] # type: List[Node]
self.add_target(ret) self.add_target(ret)
return ret return ret
def add_target(self, ret): def add_target(self, ret: List[Node]) -> None:
# type: (List[nodes.Node]) -> None
node = cast(nodes.math_block, ret[0]) node = cast(nodes.math_block, ret[0])
# assign label automatically if math_number_all enabled # assign label automatically if math_number_all enabled
@ -216,8 +208,7 @@ class MathDirective(SphinxDirective):
self.state_machine.reporter.warning(exc, line=self.lineno) self.state_machine.reporter.warning(exc, line=self.lineno)
def setup(app): def setup(app: "Sphinx") -> Dict[str, Any]:
# type: (Sphinx) -> Dict
directives.register_directive('figure', Figure) directives.register_directive('figure', Figure)
directives.register_directive('meta', Meta) directives.register_directive('meta', Meta)
directives.register_directive('table', RSTTable) directives.register_directive('table', RSTTable)