Skip to content

Commit

Permalink
Fix type annotations (for jinja2)
Browse files Browse the repository at this point in the history
Jinja2 starts to bundle its typehints since v3.0.  As a result, mypy
warns "ignore" hint is needless.  This removes them all to keep it
valid.
  • Loading branch information
tk0miya committed May 19, 2021
1 parent bb2c662 commit 08ee8e5
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 9 deletions.
5 changes: 5 additions & 0 deletions sphinx/jinja2glue.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
from sphinx.util import logging
from sphinx.util.osutil import mtimes_of_files

try:
from jinja2.utils import pass_context
except ImportError:
from jinja2 import contextfunction as pass_context

if TYPE_CHECKING:
from sphinx.builders import Builder

Expand Down
2 changes: 1 addition & 1 deletion sphinx/util/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def save_traceback(app: "Sphinx") -> str:
platform.python_version(),
platform.python_implementation(),
docutils.__version__, docutils.__version_details__,
jinja2.__version__, # type: ignore
jinja2.__version__,
last_msgs)).encode())
if app is not None:
for ext in app.extensions.values():
Expand Down
8 changes: 7 additions & 1 deletion sphinx/util/rst.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
from sphinx.locale import __
from sphinx.util import docutils, logging

try:
from jinja2.utils import pass_environment
except ImportError:
from jinja2 import environmentfilter as pass_environment


logger = logging.getLogger(__name__)

docinfo_re = re.compile(':\\w+:.*?')
Expand Down Expand Up @@ -55,7 +61,7 @@ def charwidth(char: str, widechars: str) -> int:
def heading(env: Environment, text: str, level: int = 1) -> str:
"""Create a heading for *level*."""
assert level <= 3
width = textwidth(text, WIDECHARS[env.language]) # type: ignore
width = textwidth(text, WIDECHARS[env.language])
sectioning_char = SECTIONING_CHARS[level - 1]
return '%s\n%s' % (text, sectioning_char * width)

Expand Down
14 changes: 7 additions & 7 deletions sphinx/util/tags.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,18 @@ def eval_condition(self, condition: str) -> bool:

def eval_node(node: Node) -> bool:
if isinstance(node, nodes.CondExpr):
if eval_node(node.test): # type: ignore
return eval_node(node.expr1) # type: ignore
if eval_node(node.test):
return eval_node(node.expr1)
else:
return eval_node(node.expr2) # type: ignore
return eval_node(node.expr2)
elif isinstance(node, nodes.And):
return eval_node(node.left) and eval_node(node.right) # type: ignore
return eval_node(node.left) and eval_node(node.right)
elif isinstance(node, nodes.Or):
return eval_node(node.left) or eval_node(node.right) # type: ignore
return eval_node(node.left) or eval_node(node.right)
elif isinstance(node, nodes.Not):
return not eval_node(node.node) # type: ignore
return not eval_node(node.node)
elif isinstance(node, nodes.Name):
return self.tags.get(node.name, False) # type: ignore
return self.tags.get(node.name, False)
else:
raise ValueError('invalid node, check parsing')

Expand Down

0 comments on commit 08ee8e5

Please sign in to comment.