"""Extension API for adding custom tags and behavior.""" import pprint import re import typing as t
from markupsafe import Markup
from . import defaults from . import nodes from .environment import Environment from .exceptions import TemplateAssertionError from .exceptions import TemplateSyntaxError from .runtime import concat # type: ignore from .runtime import Context from .runtime import Undefined from .utils import import_string from .utils import pass_context
if t.TYPE_CHECKING: import typing_extensions as te from .lexer import Token from .lexer import TokenStream from .parser import Parser
class _TranslationsBasic(te.Protocol): def gettext(self, message: str) -> str:
...
# I18N functions available in Jinja templates. If the I18N library # provides ugettext, it will be assigned to gettext.
GETTEXT_FUNCTIONS: t.Tuple[str, ...] = ( "_", "gettext", "ngettext", "pgettext", "npgettext",
)
_ws_re = re.compile(r"\s*\n\s*")
class Extension: """Extensions can be used to add extra functionality to the Jinja template
system at the parser level. Custom extensions are bound to an environment
but may not store environment specific data on `self`. The reason for
this is that an extension can be bound to another environment (for
overlays) by creating a copy and reassigning the `environment` attribute.
As extensions are created by the environment they cannot accept any
arguments for configuration. One may want to work around that by using
a factory function, but that isnot possible as extensions are identified
by their import name. The correct way to configure the extension is
storing the configuration values on the environment. Because this way the
environment ends up acting as central configuration storage the
attributes may clash which is why extensions have to ensure that the names
they choose for configuration are not too generic. ``prefix`` for example is a terrible name, ``fragment_cache_prefix`` on the other hand is a good
name as includes the name of the extension (fragment cache). """
#: if this extension parses this is the list of tags it's listening to.
tags: t.Set[str] = set()
#: the priority of that extension. This is especially useful for #: extensions that preprocess values. A lower value means higher #: priority. #: #: .. versionadded:: 2.4
priority = 100
def bind(self, environment: Environment) -> "Extension": """Create a copy of this extension bound to another environment."""
rv = object.__new__(self.__class__)
rv.__dict__.update(self.__dict__)
rv.environment = environment return rv
def preprocess(
self, source: str, name: t.Optional[str], filename: t.Optional[str] = None
) -> str: """This method is called before the actual lexing and can be used to
preprocess the source. The `filename` is optional. The return value
must be the preprocessed source. """ return source
def filter_stream(
self, stream: "TokenStream"
) -> t.Union["TokenStream", t.Iterable["Token"]]: """It's passed a :class:`~jinja2.lexer.TokenStream` that can be used
to filter tokens returned. This method has to return an iterable of
:class:`~jinja2.lexer.Token`\\s, but it doesn't have to return a
:class:`~jinja2.lexer.TokenStream`. """ return stream
def parse(self, parser: "Parser") -> t.Union[nodes.Node, t.List[nodes.Node]]: """If any of the :attr:`tags` matched this method is called with the
parser as first argument. The token the parser stream is pointing at is the name token that matched. This method has to return one or a
list of multiple nodes. """ raise NotImplementedError()
def attr(
self, name: str, lineno: t.Optional[int] = None
) -> nodes.ExtensionAttribute: """Return an attribute node for the current extension. This is useful
to pass constants on extensions to generated template code.
def _make_new_gettext(func: t.Callable[[str], str]) -> t.Callable[..., str]:
@pass_context def gettext(__context: Context, __string: str, **variables: t.Any) -> str:
rv = __context.call(func, __string) if __context.eval_ctx.autoescape:
rv = Markup(rv) # Always treat as a format string, even if there are no # variables. This makes translation strings more consistent # and predictable. This requires escaping return rv % variables # type: ignore
# Always treat as a format string, see gettext comment above. return rv % variables # type: ignore
return npgettext
class InternationalizationExtension(Extension): """This extension adds gettext support to Jinja."""
tags = {"trans"}
# TODO: the i18n extension is currently reevaluating values in a few # situations. Take this example: # {% trans count=something() %}{{ count }} foo{% pluralize # %}{{ count }} fooss{% endtrans %} # something is called twice here. One time for the gettext value and # the other time for the n-parameter of the ngettext function.
if context_token isnotNone:
context = context_token.value
# find all the variables referenced. Additionally a variable can be # defined in the body of the trans block too, but this is checked at # a later state.
plural_expr: t.Optional[nodes.Expr] = None
plural_expr_assignment: t.Optional[nodes.Assign] = None
num_called_num = False
variables: t.Dict[str, nodes.Expr] = {}
trimmed = None while parser.stream.current.type != "block_end": if variables:
parser.stream.expect("comma")
# skip colon for python compatibility if parser.stream.skip_if("colon"): break
token = parser.stream.expect("name") if token.value in variables:
parser.fail(
f"translatable variable {token.value!r} defined twice.",
token.lineno,
exc=TemplateAssertionError,
)
# expressions if parser.stream.current.type == "assign":
next(parser.stream)
variables[token.value] = var = parser.parse_expression() elif trimmed isNoneand token.value in ("trimmed", "notrimmed"):
trimmed = token.value == "trimmed" continue else:
variables[token.value] = var = nodes.Name(token.value, "load")
if plural_expr isNone: if isinstance(var, nodes.Call):
plural_expr = nodes.Name("_trans", "load")
variables[token.value] = plural_expr
plural_expr_assignment = nodes.Assign(
nodes.Name("_trans", "store"), var
) else:
plural_expr = var
num_called_num = token.value == "num"
# now parse until endtrans or pluralize
singular_names, singular = self._parse_block(parser, True) if singular_names:
referenced.update(singular_names) if plural_expr isNone:
plural_expr = nodes.Name(singular_names[0], "load")
num_called_num = singular_names[0] == "num"
# if we have a pluralize block, we parse that too if parser.stream.current.test("name:pluralize"):
have_plural = True
next(parser.stream) if parser.stream.current.type != "block_end":
token = parser.stream.expect("name") if token.value notin variables:
parser.fail(
f"unknown variable {token.value!r} for pluralization",
token.lineno,
exc=TemplateAssertionError,
)
plural_expr = variables[token.value]
num_called_num = token.value == "num"
parser.stream.expect("block_end")
plural_names, plural = self._parse_block(parser, False)
next(parser.stream)
referenced.update(plural_names) else:
next(parser.stream)
# register free names as simple name expressions for name in referenced: if name notin variables:
variables[name] = nodes.Name(name, "load")
def _parse_block(
self, parser: "Parser", allow_pluralize: bool
) -> t.Tuple[t.List[str], str]: """Parse until the next block tag with a given name."""
referenced = []
buf = []
whileTrue: if parser.stream.current.type == "data":
buf.append(parser.stream.current.value.replace("%", "%%"))
next(parser.stream) elif parser.stream.current.type == "variable_begin":
next(parser.stream)
name = parser.stream.expect("name").value
referenced.append(name)
buf.append(f"%({name})s")
parser.stream.expect("variable_end") elif parser.stream.current.type == "block_begin":
next(parser.stream) if parser.stream.current.test("name:endtrans"): break elif parser.stream.current.test("name:pluralize"): if allow_pluralize: break
parser.fail( "a translatable section can have only one pluralize section"
)
parser.fail( "control structures in translatable sections are not allowed"
) elif parser.stream.eos:
parser.fail("unclosed translation block") else: raise RuntimeError("internal parser error")
return referenced, concat(buf)
def _make_node(
self,
singular: str,
plural: t.Optional[str],
context: t.Optional[str],
variables: t.Dict[str, nodes.Expr],
plural_expr: t.Optional[nodes.Expr],
vars_referenced: bool,
num_called_num: bool,
) -> nodes.Output: """Generates a useful node from the data provided."""
newstyle = self.environment.newstyle_gettext # type: ignore
node: nodes.Expr
# no variables referenced? no need to escape for old style # gettext invocations only if there are vars. ifnot vars_referenced andnot newstyle:
singular = singular.replace("%%", "%") if plural:
plural = plural.replace("%%", "%")
# in case newstyle gettext is used, the method is powerful # enough to handle the variable expansion and autoescape # handling itself if newstyle: for key, value in variables.items(): # the function adds that later anyways in case num was # called num, so just skip it. if num_called_num and key == "num": continue
node.kwargs.append(nodes.Keyword(key, value))
# otherwise do that here else: # mark the return value as safe if we are in an # environment with autoescaping turned on
node = nodes.MarkSafeIfAutoescape(node) if variables:
node = nodes.Mod(
node,
nodes.Dict(
[
nodes.Pair(nodes.Const(key), value) for key, value in variables.items()
]
),
) return nodes.Output([node])
class ExprStmtExtension(Extension): """Adds a `do` tag to Jinja that works like the print statement just
that it doesn't print the return value. """
# Set the depth since the intent is to show the top few names. return pprint.pformat(result, depth=3, compact=True)
def extract_from_ast(
ast: nodes.Template,
gettext_functions: t.Sequence[str] = GETTEXT_FUNCTIONS,
babel_style: bool = True,
) -> t.Iterator[
t.Tuple[int, str, t.Union[t.Optional[str], t.Tuple[t.Optional[str], ...]]]
]: """Extract localizable strings from the given template node. Per
default this function returns matches in babel style that means non string
parameters as well as keyword arguments are returned as `None`. This
allows Babel to figure out what you really meant if you are using
gettext functions that allow keyword arguments for placeholder expansion. If you don't want that behavior set the `babel_style` parameter to `False`
which causes only strings to be returned and parameters are always stored in tuples. As a consequence invalid gettext calls (calls without a single
string parameter or string parameters after non-string parameters) are
skipped.
For every string found this function yields a ``(lineno, function,
message)`` tuple, where:
* ``lineno`` is the number of the line on which the string was found,
* ``function`` is the name of the ``gettext`` function used (if the
string was extracted from embedded Python code), and
* ``message`` is the string, or a tuple of strings for functions with multiple string arguments.
This extraction function operates on the AST andis because of that unable
to extract any comments. For comment support you have to use the babel
extraction interface or extract comments yourself. """
out: t.Union[t.Optional[str], t.Tuple[t.Optional[str], ...]]
for node in ast.find_all(nodes.Call): if ( not isinstance(node.node, nodes.Name) or node.node.name notin gettext_functions
): continue
strings: t.List[t.Optional[str]] = []
for arg in node.args: if isinstance(arg, nodes.Const) and isinstance(arg.value, str):
strings.append(arg.value) else:
strings.append(None)
for _ in node.kwargs:
strings.append(None) if node.dyn_args isnotNone:
strings.append(None) if node.dyn_kwargs isnotNone:
strings.append(None)
ifnot babel_style:
out = tuple(x for x in strings if x isnotNone)
ifnot out: continue else: if len(strings) == 1:
out = strings[0] else:
out = tuple(strings)
yield node.lineno, node.node.name, out
class _CommentFinder: """Helper class to find comments in a token stream. Can only
find comments for gettext calls forwards. Once the comment from line 4 is found, a comment for line 1 will notreturn a
usable value. """
.. versionchanged:: 2.3
Basic support for translation comments was added. If `comment_tags` is now set to a list of keywords for extraction, the extractor will try to find the best preceding comment that begins with one of the
keywords. For best results, make sure to not have more than one
gettext call in one line of code and the matching comment in the
same line or the line before.
.. versionchanged:: 2.5.1
The `newstyle_gettext` flag can be set to `True` to enable newstyle
gettext calls.
.. versionchanged:: 2.7
A `silent` option can now be provided. If set to `False` template
syntax errors are propagated instead of being ignored.
:param fileobj: the file-like object the messages should be extracted from
:param keywords: a list of keywords (i.e. function names) that should be
recognized as translation functions
:param comment_tags: a list of translator tags to search forand include in the results.
:param options: a dictionary of additional options (optional)
:return: an iterator over ``(lineno, funcname, message, comments)`` tuples.
(comments will be empty currently) """
extensions: t.Dict[t.Type[Extension], None] = {}
for extension_name in options.get("extensions", "").split(","):
extension_name = extension_name.strip()
ifnot extension_name: continue
extensions[import_string(extension_name)] = None
if InternationalizationExtension notin extensions:
extensions[InternationalizationExtension] = None
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.