summaryrefslogtreecommitdiff
path: root/sphinx/util/docfields.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2018-12-16 00:24:21 +0900
committerGitHub <noreply@github.com>2018-12-16 00:24:21 +0900
commit79eec90f36f5a74e24cfd6740126396fd6567e07 (patch)
treea7c8d2087ee1f50dadb5ca78343ac10c6959b740 /sphinx/util/docfields.py
parent0031c9b4822ae9684888ae90bc70d6ceb3313581 (diff)
parent6bc357140dbb074eb0d590c1226009f83f97862e (diff)
downloadsphinx-git-79eec90f36f5a74e24cfd6740126396fd6567e07.tar.gz
Merge pull request #5773 from tk0miya/fix_typehints_for_unicode
Replace all "unicode" type by "str"
Diffstat (limited to 'sphinx/util/docfields.py')
-rw-r--r--sphinx/util/docfields.py44
1 files changed, 22 insertions, 22 deletions
diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py
index 277e497f3..34b5e8b9d 100644
--- a/sphinx/util/docfields.py
+++ b/sphinx/util/docfields.py
@@ -22,7 +22,7 @@ if False:
from typing import Any, Dict, Type, Union # NOQA
from sphinx.domains import Domain # NOQA
from sphinx.environment import BuildEnvironment # NOQA
- from sphinx.util.typing import TextlikeNode, unicode # NOQA
+ from sphinx.util.typing import TextlikeNode # NOQA
def _is_single_paragraph(node):
@@ -57,7 +57,7 @@ class Field:
def __init__(self, name, names=(), label=None, has_arg=True, rolename=None,
bodyrolename=None):
- # type: (unicode, Tuple[unicode, ...], unicode, bool, unicode, unicode) -> None
+ # type: (str, Tuple[str, ...], str, bool, str, str) -> None
self.name = name
self.names = names
self.label = label
@@ -66,9 +66,9 @@ class Field:
self.bodyrolename = bodyrolename
def make_xref(self,
- rolename, # type: unicode
- domain, # type: unicode
- target, # type: unicode
+ rolename, # type: str
+ domain, # type: str
+ target, # type: str
innernode=addnodes.literal_emphasis, # type: Type[TextlikeNode]
contnode=None, # type: nodes.Node
env=None, # type: BuildEnvironment
@@ -84,9 +84,9 @@ class Field:
return refnode
def make_xrefs(self,
- rolename, # type: unicode
- domain, # type: unicode
- target, # type: unicode
+ rolename, # type: str
+ domain, # type: str
+ target, # type: str
innernode=addnodes.literal_emphasis, # type: Type[TextlikeNode]
contnode=None, # type: nodes.Node
env=None, # type: BuildEnvironment
@@ -95,12 +95,12 @@ class Field:
return [self.make_xref(rolename, domain, target, innernode, contnode, env)]
def make_entry(self, fieldarg, content):
- # type: (unicode, List[nodes.Node]) -> Tuple[unicode, List[nodes.Node]]
+ # type: (str, List[nodes.Node]) -> Tuple[str, List[nodes.Node]]
return (fieldarg, content)
def make_field(self,
- types, # type: Dict[unicode, List[nodes.Node]]
- domain, # type: unicode
+ types, # type: Dict[str, List[nodes.Node]]
+ domain, # type: str
item, # type: Tuple
env=None, # type: BuildEnvironment
):
@@ -140,13 +140,13 @@ class GroupedField(Field):
def __init__(self, name, names=(), label=None, rolename=None,
can_collapse=False):
- # type: (unicode, Tuple[unicode, ...], unicode, unicode, bool) -> None
+ # type: (str, Tuple[str, ...], str, str, bool) -> None
super(GroupedField, self).__init__(name, names, label, True, rolename)
self.can_collapse = can_collapse
def make_field(self,
- types, # type: Dict[unicode, List[nodes.Node]]
- domain, # type: unicode
+ types, # type: Dict[str, List[nodes.Node]]
+ domain, # type: str
items, # type: Tuple
env=None, # type: BuildEnvironment
):
@@ -193,20 +193,20 @@ class TypedField(GroupedField):
def __init__(self, name, names=(), typenames=(), label=None,
rolename=None, typerolename=None, can_collapse=False):
- # type: (unicode, Tuple[unicode, ...], Tuple[unicode, ...], unicode, unicode, unicode, bool) -> None # NOQA
+ # type: (str, Tuple[str, ...], Tuple[str, ...], str, str, str, bool) -> None
super(TypedField, self).__init__(name, names, label, rolename, can_collapse)
self.typenames = typenames
self.typerolename = typerolename
def make_field(self,
- types, # type: Dict[unicode, List[nodes.Node]]
- domain, # type: unicode
+ types, # type: Dict[str, List[nodes.Node]]
+ domain, # type: str
items, # type: Tuple
env=None, # type: BuildEnvironment
):
# type: (...) -> nodes.field
def handle_item(fieldarg, content):
- # type: (unicode, unicode) -> nodes.paragraph
+ # type: (str, str) -> nodes.paragraph
par = nodes.paragraph()
par.extend(self.make_xrefs(self.rolename, domain, fieldarg,
addnodes.literal_strong, env=env))
@@ -244,7 +244,7 @@ class DocFieldTransformer:
Transforms field lists in "doc field" syntax into better-looking
equivalents, using the field type definitions given on a domain.
"""
- typemap = None # type: Dict[unicode, Tuple[Field, bool]]
+ typemap = None # type: Dict[str, Tuple[Field, bool]]
def __init__(self, directive):
# type: (Any) -> None
@@ -255,7 +255,7 @@ class DocFieldTransformer:
self.typemap = directive._doc_field_type_map
def preprocess_fieldtypes(self, types):
- # type: (List[Field]) -> Dict[unicode, Tuple[Field, bool]]
+ # type: (List[Field]) -> Dict[str, Tuple[Field, bool]]
typemap = {}
for fieldtype in types:
for name in fieldtype.names:
@@ -280,8 +280,8 @@ class DocFieldTransformer:
typemap = self.typemap
entries = [] # type: List[Union[nodes.field, Tuple[Field, Any]]]
- groupindices = {} # type: Dict[unicode, int]
- types = {} # type: Dict[unicode, Dict]
+ groupindices = {} # type: Dict[str, int]
+ types = {} # type: Dict[str, Dict]
# step 1: traverse all fields and collect field types and content
for field in cast(List[nodes.field], node):