OpenQuizz
Une application de gestion des contenus pédagogiques
jinja2.ext Namespace Reference

Data Structures

class  _CommentFinder
 
class  AutoEscapeExtension
 
class  DebugExtension
 
class  ExprStmtExtension
 
class  Extension
 
class  ExtensionRegistry
 
class  InternationalizationExtension
 
class  LoopControlExtension
 
class  WithExtension
 

Functions

def extract_from_ast (node, gettext_functions=GETTEXT_FUNCTIONS, babel_style=True)
 
def babel_extract (fileobj, keywords, comment_tags, options)
 

Variables

 GETTEXT_FUNCTIONS
 
 i18n
 
 do
 
 loopcontrols
 
 with_
 
 autoescape
 
 debug
 

Function Documentation

◆ babel_extract()

def jinja2.ext.babel_extract (   fileobj,
  keywords,
  comment_tags,
  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()

def jinja2.ext.extract_from_ast (   node,
  gettext_functions = GETTEXT_FUNCTIONS,
  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 itself (a ``unicode`` object, or a tuple
   of ``unicode`` objects 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

◆ autoescape

autoescape

◆ debug

debug

◆ do

do

◆ GETTEXT_FUNCTIONS

GETTEXT_FUNCTIONS

◆ i18n

i18n

◆ loopcontrols

loopcontrols

◆ with_

with_