jinja2.ext Namespace Reference

Classes
class	_CommentFinder
class	_TranslationsBasic
class	_TranslationsContext
class	DebugExtension
class	ExprStmtExtension
class	Extension
class	InternationalizationExtension
class	LoopControlExtension

Functions
t.Union[t.Any, Undefined]	_gettext_alias (Context __context, *t.Any args, **t.Any kwargs)
t.Callable[..., str]	_make_new_gettext (t.Callable[[str], str] func)
t.Callable[..., str]	_make_new_ngettext (t.Callable[[str, str, int], str] func)
t.Callable[..., str]	_make_new_pgettext (t.Callable[[str, str], str] func)
t.Callable[..., str]	_make_new_npgettext (t.Callable[[str, str, str, int], str] func)
t.Iterator[ t.Tuple[int, str, t.Union[t.Optional[str], t.Tuple[t.Optional[str],...]]]]	extract_from_ast (nodes.Template ast, t.Sequence[str] gettext_functions=GETTEXT_FUNCTIONS, bool babel_style=True)
t.Iterator[ t.Tuple[ int, str, t.Union[t.Optional[str], t.Tuple[t.Optional[str],...]], t.List[str]]]	babel_extract (t.BinaryIO fileobj, t.Sequence[str] keywords, t.Sequence[str] comment_tags, t.Dict[str, t.Any] options)

Variables
	_SupportedTranslations
tuple	GETTEXT_FUNCTIONS
	_ws_re = re.compile(r"\s*\n\s*")
	i18n = InternationalizationExtension
	do = ExprStmtExtension
	loopcontrols = LoopControlExtension
	debug = DebugExtension

Detailed Description

Extension API for adding custom tags and behavior.

Function Documentation

babel_extract()

t.Iterator[ t.Tuple[ int, str, t.Union[t.Optional[str], t.Tuple[t.Optional[str], ...]], t.List[str] ] ] jinja2.ext.babel_extract	(	t.BinaryIO	fileobj,
		t.Sequence[str]	keywords,
		t.Sequence[str]	comment_tags,
		t.Dict[str, t.Any]	options
	)

Babel extraction method for Jinja templates.

.. 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 for and 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)

extract_from_ast()

t.Iterator[ t.Tuple[int, str, t.Union[t.Optional[str], t.Tuple[t.Optional[str], ...]]] ] jinja2.ext.extract_from_ast	(	nodes.Template	ast,
		t.Sequence[str]	gettext_functions = GETTEXT_FUNCTIONS,
		bool	babel_style = True
	)

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.

This example explains the behavior:

>>> from jinja2 import Environment
>>> env = Environment()
>>> node = env.parse('{{ (_("foo"), _(), ngettext("foo", "bar", 42)) }}')
>>> list(extract_from_ast(node))
[(1, '_', 'foo'), (1, '_', ()), (1, 'ngettext', ('foo', 'bar', None))]
>>> list(extract_from_ast(node, babel_style=False))
[(1, '_', ('foo',)), (1, 'ngettext', ('foo', 'bar'))]

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 and is because of that unable
to extract any comments.  For comment support you have to use the babel
extraction interface or extract comments yourself.

Variable Documentation

GETTEXT_FUNCTIONS

tuple jinja2.ext.GETTEXT_FUNCTIONS

Initial value:

=  (
    "_",
    "gettext",
    "ngettext",
    "pgettext",
    "npgettext",
)