summaryrefslogtreecommitdiff
path: root/sphinx/theming.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2018-12-15 03:14:11 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2018-12-15 23:57:43 +0900
commit6bc357140dbb074eb0d590c1226009f83f97862e (patch)
treea7c8d2087ee1f50dadb5ca78343ac10c6959b740 /sphinx/theming.py
parent0031c9b4822ae9684888ae90bc70d6ceb3313581 (diff)
downloadsphinx-git-6bc357140dbb074eb0d590c1226009f83f97862e.tar.gz
Replace all "unicode" type by "str"
Diffstat (limited to 'sphinx/theming.py')
-rw-r--r--sphinx/theming.py25
1 files changed, 12 insertions, 13 deletions
diff --git a/sphinx/theming.py b/sphinx/theming.py
index 1ab5b8124..75e972cd0 100644
--- a/sphinx/theming.py
+++ b/sphinx/theming.py
@@ -30,14 +30,13 @@ if False:
# For type annotation
from typing import Any, Dict, Iterator, List, Tuple # NOQA
from sphinx.application import Sphinx # NOQA
- from sphinx.util.typing import unicode # NOQA
NODEFAULT = object()
THEMECONF = 'theme.conf'
def extract_zip(filename, targetdir):
- # type: (unicode, unicode) -> None
+ # type: (str, str) -> None
"""Extract zip file to target directory."""
ensuredir(targetdir)
@@ -57,7 +56,7 @@ class Theme:
This class supports both theme directory and theme archive (zipped theme)."""
def __init__(self, name, theme_path, factory):
- # type: (unicode, unicode, HTMLThemeFactory) -> None
+ # type: (str, str, HTMLThemeFactory) -> None
self.name = name
self.base = None
self.rootdir = None
@@ -90,7 +89,7 @@ class Theme:
(inherit, name))
def get_theme_dirs(self):
- # type: () -> List[unicode]
+ # type: () -> List[str]
"""Return a list of theme directories, beginning with this theme's,
then the base theme's, then that one's base theme's, etc.
"""
@@ -100,7 +99,7 @@ class Theme:
return [self.themedir] + self.base.get_theme_dirs()
def get_config(self, section, name, default=NODEFAULT):
- # type: (unicode, unicode, Any) -> Any
+ # type: (str, str, Any) -> Any
"""Return the value for a theme configuration setting, searching the
base theme chain.
"""
@@ -117,7 +116,7 @@ class Theme:
return default
def get_options(self, overrides={}):
- # type: (Dict[unicode, Any]) -> Dict[unicode, Any]
+ # type: (Dict[str, Any]) -> Dict[str, Any]
"""Return a dictionary of theme options and their values."""
if self.base:
options = self.base.get_options()
@@ -150,7 +149,7 @@ class Theme:
def is_archived_theme(filename):
- # type: (unicode) -> bool
+ # type: (str) -> bool
"""Check the specified file is an archived theme file or not."""
try:
with ZipFile(filename) as f:
@@ -178,7 +177,7 @@ class HTMLThemeFactory:
self.themes[name] = theme
def load_additional_themes(self, theme_paths):
- # type: (unicode) -> None
+ # type: (str) -> None
"""Load additional themes placed at specified directories."""
for theme_path in theme_paths:
abs_theme_path = path.abspath(path.join(self.app.confdir, theme_path))
@@ -187,7 +186,7 @@ class HTMLThemeFactory:
self.themes[name] = theme
def load_extra_theme(self, name):
- # type: (unicode) -> None
+ # type: (str) -> None
"""Try to load a theme having specifed name."""
if name == 'alabaster':
self.load_alabaster_theme()
@@ -213,7 +212,7 @@ class HTMLThemeFactory:
pass
def load_external_theme(self, name):
- # type: (unicode) -> None
+ # type: (str) -> None
"""Try to load a theme using entry_points.
Sphinx refers to ``sphinx_themes`` entry_points.
@@ -228,9 +227,9 @@ class HTMLThemeFactory:
pass
def find_themes(self, theme_path):
- # type: (unicode) -> Dict[unicode, unicode]
+ # type: (str) -> Dict[str, str]
"""Search themes from specified directory."""
- themes = {} # type: Dict[unicode, unicode]
+ themes = {} # type: Dict[str, str]
if not path.isdir(theme_path):
return themes
@@ -250,7 +249,7 @@ class HTMLThemeFactory:
return themes
def create(self, name):
- # type: (unicode) -> Theme
+ # type: (str) -> Theme
"""Create an instance of theme."""
if name not in self.themes:
self.load_extra_theme(name)