summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-06-04 01:02:02 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2019-06-05 01:29:54 +0900
commit1e70267cc8a3a31dbadea4e72971bec4c60cb255 (patch)
tree2a4067def2f31f5286a410b24ae3961cc43439ba
parent073b92d45a59eb5065d304fbaf0fc2d2ff88c5e8 (diff)
downloadsphinx-git-1e70267cc8a3a31dbadea4e72971bec4c60cb255.tar.gz
Migrate to py3 style type annotation: sphinx.util.template
-rw-r--r--sphinx/util/template.py34
1 files changed, 11 insertions, 23 deletions
diff --git a/sphinx/util/template.py b/sphinx/util/template.py
index b521c5c79..636767d41 100644
--- a/sphinx/util/template.py
+++ b/sphinx/util/template.py
@@ -9,7 +9,9 @@
"""
import os
+from typing import Dict
+from jinja2.loaders import BaseLoader
from jinja2.sandbox import SandboxedEnvironment
from sphinx import package_dir
@@ -17,58 +19,45 @@ from sphinx.jinja2glue import SphinxFileSystemLoader
from sphinx.locale import get_translator
from sphinx.util import rst, texescape
-if False:
- # For type annotation
- from typing import Dict # NOQA
- from jinja2.loaders import BaseLoader # NOQA
-
class BaseRenderer:
- def __init__(self, loader=None):
- # type: (BaseLoader) -> None
+ def __init__(self, loader: BaseLoader = None) -> None:
self.env = SandboxedEnvironment(loader=loader, extensions=['jinja2.ext.i18n'])
self.env.filters['repr'] = repr
self.env.install_gettext_translations(get_translator()) # type: ignore
- def render(self, template_name, context):
- # type: (str, Dict) -> str
+ def render(self, template_name: str, context: Dict) -> str:
return self.env.get_template(template_name).render(context)
- def render_string(self, source, context):
- # type: (str, Dict) -> str
+ def render_string(self, source: str, context: Dict) -> str:
return self.env.from_string(source).render(context)
class FileRenderer(BaseRenderer):
- def __init__(self, search_path):
- # type: (str) -> None
+ def __init__(self, search_path: str) -> None:
loader = SphinxFileSystemLoader(search_path)
super().__init__(loader)
@classmethod
- def render_from_file(cls, filename, context):
- # type: (str, Dict) -> str
+ def render_from_file(cls, filename: str, context: Dict) -> str:
dirname = os.path.dirname(filename)
basename = os.path.basename(filename)
return cls(dirname).render(basename, context)
class SphinxRenderer(FileRenderer):
- def __init__(self, template_path=None):
- # type: (str) -> None
+ def __init__(self, template_path: str = None) -> None:
if template_path is None:
template_path = os.path.join(package_dir, 'templates')
super().__init__(template_path)
@classmethod
- def render_from_file(cls, filename, context):
- # type: (str, Dict) -> str
+ def render_from_file(cls, filename: str, context: Dict) -> str:
return FileRenderer.render_from_file(filename, context)
class LaTeXRenderer(SphinxRenderer):
- def __init__(self, template_path=None):
- # type: (str) -> None
+ def __init__(self, template_path: str = None) -> None:
if template_path is None:
template_path = os.path.join(package_dir, 'templates', 'latex')
super().__init__(template_path)
@@ -87,8 +76,7 @@ class LaTeXRenderer(SphinxRenderer):
class ReSTRenderer(SphinxRenderer):
- def __init__(self, template_path=None, language=None):
- # type: (str, str) -> None
+ def __init__(self, template_path: str = None, language: str = None) -> None:
super().__init__(template_path)
# add language to environment