summaryrefslogtreecommitdiff
path: root/sphinx/util/compat.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-06-02 17:01:28 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2019-06-03 12:29:32 +0900
commitf3e45e485e9caefb9099e0598549b73231401264 (patch)
treeee350ffed7b1632a0e67c11e39f8566449b03ceb /sphinx/util/compat.py
parent24f8a3caf03ee2c11a1746413d68a572cb59f23e (diff)
downloadsphinx-git-f3e45e485e9caefb9099e0598549b73231401264.tar.gz
Migrate to py3 style type annotation: sphinx.util.compat
Diffstat (limited to 'sphinx/util/compat.py')
-rw-r--r--sphinx/util/compat.py18
1 files changed, 7 insertions, 11 deletions
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index 492c313d0..75ef90350 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -10,23 +10,22 @@
import sys
import warnings
+from typing import Any, Dict
from docutils.utils import get_source_line
from sphinx import addnodes
+from sphinx.config import Config
from sphinx.deprecation import RemovedInSphinx30Warning, RemovedInSphinx40Warning
from sphinx.transforms import SphinxTransform
from sphinx.util import import_object
if False:
# For type annotation
- from typing import Any, Dict # NOQA
- from sphinx.application import Sphinx # NOQA
- from sphinx.config import Config # NOQA
+ from sphinx.application import Sphinx
-def deprecate_source_parsers(app, config):
- # type: (Sphinx, Config) -> None
+def deprecate_source_parsers(app: "Sphinx", config: Config) -> None:
if config.source_parsers:
warnings.warn('The config variable "source_parsers" is deprecated. '
'Please update your extension for the parser and remove the setting.',
@@ -37,8 +36,7 @@ def deprecate_source_parsers(app, config):
app.add_source_parser(suffix, parser)
-def register_application_for_autosummary(app):
- # type: (Sphinx) -> None
+def register_application_for_autosummary(app: "Sphinx") -> None:
"""Register application object to autosummary module.
Since Sphinx-1.7, documenters and attrgetters are registered into
@@ -55,8 +53,7 @@ class IndexEntriesMigrator(SphinxTransform):
"""Migrating indexentries from old style (4columns) to new style (5columns)."""
default_priority = 700
- def apply(self, **kwargs):
- # type: (Any) -> None
+ def apply(self, **kwargs) -> None:
for node in self.document.traverse(addnodes.index):
for i, entries in enumerate(node['entries']):
if len(entries) == 4:
@@ -66,8 +63,7 @@ class IndexEntriesMigrator(SphinxTransform):
node['entries'][i] = entries + (None,)
-def setup(app):
- # type: (Sphinx) -> Dict[str, Any]
+def setup(app: "Sphinx") -> Dict[str, Any]:
app.add_transform(IndexEntriesMigrator)
app.connect('config-inited', deprecate_source_parsers)
app.connect('builder-inited', register_application_for_autosummary)