mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #6575 from tk0miya/mypy-0.720
Fix mypy violations (for mypy-0.720)
This commit is contained in:
commit
68973e803a
2
setup.py
2
setup.py
@ -47,7 +47,7 @@ extras_require = {
|
|||||||
'html5lib',
|
'html5lib',
|
||||||
'flake8>=3.5.0',
|
'flake8>=3.5.0',
|
||||||
'flake8-import-order',
|
'flake8-import-order',
|
||||||
'mypy>=0.711',
|
'mypy>=0.720',
|
||||||
'docutils-stubs',
|
'docutils-stubs',
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
@ -292,7 +292,7 @@ class DocTestBuilder(Builder):
|
|||||||
# for doctest examples but unusable for multi-statement code such
|
# for doctest examples but unusable for multi-statement code such
|
||||||
# as setup code -- to be able to use doctest error reporting with
|
# as setup code -- to be able to use doctest error reporting with
|
||||||
# that code nevertheless, we monkey-patch the "compile" it uses.
|
# that code nevertheless, we monkey-patch the "compile" it uses.
|
||||||
doctest.compile = self.compile # type: ignore
|
doctest.compile = self.compile
|
||||||
|
|
||||||
sys.path[0:0] = self.config.doctest_path
|
sys.path[0:0] = self.config.doctest_path
|
||||||
|
|
||||||
|
@ -414,6 +414,6 @@ def inspect_main(argv):
|
|||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
import logging # type: ignore
|
import logging # type: ignore
|
||||||
logging.basicConfig() # type: ignore
|
logging.basicConfig()
|
||||||
|
|
||||||
inspect_main(argv=sys.argv[1:])
|
inspect_main(argv=sys.argv[1:])
|
||||||
|
@ -298,7 +298,7 @@ class VariableCommentPicker(ast.NodeVisitor):
|
|||||||
"""Handles Assign node and pick up a variable comment."""
|
"""Handles Assign node and pick up a variable comment."""
|
||||||
try:
|
try:
|
||||||
targets = get_assign_targets(node)
|
targets = get_assign_targets(node)
|
||||||
varnames = sum([get_lvar_names(t, self=self.get_self()) for t in targets], [])
|
varnames = sum([get_lvar_names(t, self=self.get_self()) for t in targets], []) # type: List[str] # NOQA
|
||||||
current_line = self.get_line(node.lineno)
|
current_line = self.get_line(node.lineno)
|
||||||
except TypeError:
|
except TypeError:
|
||||||
return # this assignment is not new definition!
|
return # this assignment is not new definition!
|
||||||
|
@ -400,7 +400,7 @@ class GUILabel(SphinxRole):
|
|||||||
class MenuSelection(GUILabel):
|
class MenuSelection(GUILabel):
|
||||||
def run(self):
|
def run(self):
|
||||||
# type: () -> Tuple[List[nodes.Node], List[nodes.system_message]]
|
# type: () -> Tuple[List[nodes.Node], List[nodes.system_message]]
|
||||||
self.text = self.text.replace('-->', '\N{TRIANGULAR BULLET}') # type: ignore
|
self.text = self.text.replace('-->', '\N{TRIANGULAR BULLET}')
|
||||||
return super().run()
|
return super().run()
|
||||||
|
|
||||||
|
|
||||||
|
@ -130,8 +130,8 @@ class SphinxTestApp(application.Sphinx):
|
|||||||
warningiserror = False
|
warningiserror = False
|
||||||
|
|
||||||
self._saved_path = sys.path[:]
|
self._saved_path = sys.path[:]
|
||||||
self._saved_directives = directives._directives.copy() # type: ignore
|
self._saved_directives = directives._directives.copy()
|
||||||
self._saved_roles = roles._roles.copy() # type: ignore
|
self._saved_roles = roles._roles.copy()
|
||||||
|
|
||||||
self._saved_nodeclasses = {v for v in dir(nodes.GenericNodeVisitor)
|
self._saved_nodeclasses = {v for v in dir(nodes.GenericNodeVisitor)
|
||||||
if v.startswith('visit_')}
|
if v.startswith('visit_')}
|
||||||
@ -151,8 +151,8 @@ class SphinxTestApp(application.Sphinx):
|
|||||||
locale.translators.clear()
|
locale.translators.clear()
|
||||||
sys.path[:] = self._saved_path
|
sys.path[:] = self._saved_path
|
||||||
sys.modules.pop('autodoc_fodder', None)
|
sys.modules.pop('autodoc_fodder', None)
|
||||||
directives._directives = self._saved_directives # type: ignore
|
directives._directives = self._saved_directives
|
||||||
roles._roles = self._saved_roles # type: ignore
|
roles._roles = self._saved_roles
|
||||||
for method in dir(nodes.GenericNodeVisitor):
|
for method in dir(nodes.GenericNodeVisitor):
|
||||||
if method.startswith('visit_') and \
|
if method.startswith('visit_') and \
|
||||||
method not in self._saved_nodeclasses:
|
method not in self._saved_nodeclasses:
|
||||||
|
@ -260,7 +260,7 @@ def save_traceback(app):
|
|||||||
platform.python_version(),
|
platform.python_version(),
|
||||||
platform.python_implementation(),
|
platform.python_implementation(),
|
||||||
docutils.__version__, docutils.__version_details__,
|
docutils.__version__, docutils.__version_details__,
|
||||||
jinja2.__version__, # type: ignore
|
jinja2.__version__,
|
||||||
last_msgs)).encode())
|
last_msgs)).encode())
|
||||||
if app is not None:
|
if app is not None:
|
||||||
for ext in app.extensions.values():
|
for ext in app.extensions.values():
|
||||||
|
@ -54,13 +54,13 @@ def docutils_namespace():
|
|||||||
# type: () -> Generator[None, None, None]
|
# type: () -> Generator[None, None, None]
|
||||||
"""Create namespace for reST parsers."""
|
"""Create namespace for reST parsers."""
|
||||||
try:
|
try:
|
||||||
_directives = copy(directives._directives) # type: ignore
|
_directives = copy(directives._directives)
|
||||||
_roles = copy(roles._roles) # type: ignore
|
_roles = copy(roles._roles)
|
||||||
|
|
||||||
yield
|
yield
|
||||||
finally:
|
finally:
|
||||||
directives._directives = _directives # type: ignore
|
directives._directives = _directives
|
||||||
roles._roles = _roles # type: ignore
|
roles._roles = _roles
|
||||||
|
|
||||||
for node in list(additional_nodes):
|
for node in list(additional_nodes):
|
||||||
unregister_node(node)
|
unregister_node(node)
|
||||||
@ -70,7 +70,7 @@ def docutils_namespace():
|
|||||||
def is_directive_registered(name):
|
def is_directive_registered(name):
|
||||||
# type: (str) -> bool
|
# type: (str) -> bool
|
||||||
"""Check the *name* directive is already registered."""
|
"""Check the *name* directive is already registered."""
|
||||||
return name in directives._directives # type: ignore
|
return name in directives._directives
|
||||||
|
|
||||||
|
|
||||||
def register_directive(name, directive):
|
def register_directive(name, directive):
|
||||||
@ -86,7 +86,7 @@ def register_directive(name, directive):
|
|||||||
def is_role_registered(name):
|
def is_role_registered(name):
|
||||||
# type: (str) -> bool
|
# type: (str) -> bool
|
||||||
"""Check the *name* role is already registered."""
|
"""Check the *name* role is already registered."""
|
||||||
return name in roles._roles # type: ignore
|
return name in roles._roles
|
||||||
|
|
||||||
|
|
||||||
def register_role(name, role):
|
def register_role(name, role):
|
||||||
@ -102,7 +102,7 @@ def register_role(name, role):
|
|||||||
def unregister_role(name):
|
def unregister_role(name):
|
||||||
# type: (str) -> None
|
# type: (str) -> None
|
||||||
"""Unregister a role from docutils."""
|
"""Unregister a role from docutils."""
|
||||||
roles._roles.pop(name, None) # type: ignore
|
roles._roles.pop(name, None)
|
||||||
|
|
||||||
|
|
||||||
def is_node_registered(node):
|
def is_node_registered(node):
|
||||||
@ -119,7 +119,7 @@ def register_node(node):
|
|||||||
inside ``docutils_namespace()`` to prevent side-effects.
|
inside ``docutils_namespace()`` to prevent side-effects.
|
||||||
"""
|
"""
|
||||||
if not hasattr(nodes.GenericNodeVisitor, 'visit_' + node.__name__):
|
if not hasattr(nodes.GenericNodeVisitor, 'visit_' + node.__name__):
|
||||||
nodes._add_node_class_names([node.__name__]) # type: ignore
|
nodes._add_node_class_names([node.__name__])
|
||||||
additional_nodes.add(node)
|
additional_nodes.add(node)
|
||||||
|
|
||||||
|
|
||||||
|
@ -560,7 +560,7 @@ class Signature:
|
|||||||
qualname = repr(annotation)
|
qualname = repr(annotation)
|
||||||
|
|
||||||
if (hasattr(typing, 'TupleMeta') and
|
if (hasattr(typing, 'TupleMeta') and
|
||||||
isinstance(annotation, typing.TupleMeta) and # type: ignore
|
isinstance(annotation, typing.TupleMeta) and
|
||||||
not hasattr(annotation, '__tuple_params__')):
|
not hasattr(annotation, '__tuple_params__')):
|
||||||
# This is for Python 3.6+, 3.5 case is handled below
|
# This is for Python 3.6+, 3.5 case is handled below
|
||||||
params = annotation.__args__
|
params = annotation.__args__
|
||||||
@ -591,7 +591,7 @@ class Signature:
|
|||||||
param_str = ', '.join(self.format_annotation(p) for p in params)
|
param_str = ', '.join(self.format_annotation(p) for p in params)
|
||||||
return '%s[%s]' % (qualname, param_str)
|
return '%s[%s]' % (qualname, param_str)
|
||||||
elif (hasattr(typing, 'UnionMeta') and # for py35 or below
|
elif (hasattr(typing, 'UnionMeta') and # for py35 or below
|
||||||
isinstance(annotation, typing.UnionMeta) and # type: ignore
|
isinstance(annotation, typing.UnionMeta) and
|
||||||
hasattr(annotation, '__union_params__')):
|
hasattr(annotation, '__union_params__')):
|
||||||
params = annotation.__union_params__
|
params = annotation.__union_params__
|
||||||
if params is not None:
|
if params is not None:
|
||||||
@ -611,7 +611,7 @@ class Signature:
|
|||||||
param_str = ', '.join(self.format_annotation(p) for p in params)
|
param_str = ', '.join(self.format_annotation(p) for p in params)
|
||||||
return 'Union[%s]' % param_str
|
return 'Union[%s]' % param_str
|
||||||
elif (hasattr(typing, 'CallableMeta') and # for py36 or below
|
elif (hasattr(typing, 'CallableMeta') and # for py36 or below
|
||||||
isinstance(annotation, typing.CallableMeta) and # type: ignore
|
isinstance(annotation, typing.CallableMeta) and
|
||||||
getattr(annotation, '__args__', None) is not None and
|
getattr(annotation, '__args__', None) is not None and
|
||||||
hasattr(annotation, '__result__')):
|
hasattr(annotation, '__result__')):
|
||||||
# Skipped in the case of plain typing.Callable
|
# Skipped in the case of plain typing.Callable
|
||||||
@ -627,7 +627,7 @@ class Signature:
|
|||||||
args_str,
|
args_str,
|
||||||
self.format_annotation(annotation.__result__))
|
self.format_annotation(annotation.__result__))
|
||||||
elif (hasattr(typing, 'TupleMeta') and # for py36 or below
|
elif (hasattr(typing, 'TupleMeta') and # for py36 or below
|
||||||
isinstance(annotation, typing.TupleMeta) and # type: ignore
|
isinstance(annotation, typing.TupleMeta) and
|
||||||
hasattr(annotation, '__tuple_params__') and
|
hasattr(annotation, '__tuple_params__') and
|
||||||
hasattr(annotation, '__tuple_use_ellipsis__')):
|
hasattr(annotation, '__tuple_use_ellipsis__')):
|
||||||
params = annotation.__tuple_params__
|
params = annotation.__tuple_params__
|
||||||
|
@ -377,7 +377,7 @@ class TextWriter(writers.Writer):
|
|||||||
settings_spec = ('No options here.', '', ())
|
settings_spec = ('No options here.', '', ())
|
||||||
settings_defaults = {} # type: Dict
|
settings_defaults = {} # type: Dict
|
||||||
|
|
||||||
output = None
|
output = None # type: str
|
||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (TextBuilder) -> None
|
# type: (TextBuilder) -> None
|
||||||
|
Loading…
Reference in New Issue
Block a user