OpenQuizz
Une application de gestion des contenus pédagogiques
|
Public Member Functions | |
def | __init__ (self, block_start_string=BLOCK_START_STRING, block_end_string=BLOCK_END_STRING, variable_start_string=VARIABLE_START_STRING, variable_end_string=VARIABLE_END_STRING, comment_start_string=COMMENT_START_STRING, comment_end_string=COMMENT_END_STRING, line_statement_prefix=LINE_STATEMENT_PREFIX, line_comment_prefix=LINE_COMMENT_PREFIX, trim_blocks=TRIM_BLOCKS, lstrip_blocks=LSTRIP_BLOCKS, newline_sequence=NEWLINE_SEQUENCE, keep_trailing_newline=KEEP_TRAILING_NEWLINE, extensions=(), optimized=True, undefined=Undefined, finalize=None, autoescape=False, loader=None, cache_size=400, auto_reload=True, bytecode_cache=None, enable_async=False) |
def | add_extension (self, extension) |
def | extend (self, **attributes) |
def | overlay (self, block_start_string=missing, block_end_string=missing, variable_start_string=missing, variable_end_string=missing, comment_start_string=missing, comment_end_string=missing, line_statement_prefix=missing, line_comment_prefix=missing, trim_blocks=missing, lstrip_blocks=missing, extensions=missing, optimized=missing, undefined=missing, finalize=missing, autoescape=missing, loader=missing, cache_size=missing, auto_reload=missing, bytecode_cache=missing) |
def | iter_extensions (self) |
def | getitem (self, obj, argument) |
def | getattr (self, obj, attribute) |
def | call_filter (self, name, value, args=None, kwargs=None, context=None, eval_ctx=None) |
def | call_test (self, name, value, args=None, kwargs=None) |
def | parse (self, source, name=None, filename=None) |
def | lex (self, source, name=None, filename=None) |
def | preprocess (self, source, name=None, filename=None) |
def | compile (self, source, name=None, filename=None, raw=False, defer_init=False) |
def | compile_expression (self, source, undefined_to_none=True) |
def | compile_templates (self, target, extensions=None, filter_func=None, zip="deflated", log_function=None, ignore_errors=True, py_compile=False) |
def | list_templates (self, extensions=None, filter_func=None) |
def | handle_exception (self, source=None) |
def | join_path (self, template, parent) |
def | get_template (self, name, parent=None, globals=None) |
def | select_template (self, names, parent=None, globals=None) |
def | get_or_select_template (self, template_name_or_list, parent=None, globals=None) |
def | from_string (self, source, globals=None, template_class=None) |
def | make_globals (self, d) |
Static Public Attributes | |
sandboxed | |
overlayed | |
linked_to | |
shared | |
code_generator_class | |
context_class | |
Properties | |
lexer = property(get_lexer, doc="The lexer for this environment.") | |
The core component of Jinja is the `Environment`. It contains important shared variables like configuration, filters, tests, globals and others. Instances of this class may be modified if they are not shared and if no template was loaded so far. Modifications on environments after the first template was loaded will lead to surprising effects and undefined behavior. Here are the possible initialization parameters: `block_start_string` The string marking the beginning of a block. Defaults to ``'{%'``. `block_end_string` The string marking the end of a block. Defaults to ``'%}'``. `variable_start_string` The string marking the beginning of a print statement. Defaults to ``'{{'``. `variable_end_string` The string marking the end of a print statement. Defaults to ``'}}'``. `comment_start_string` The string marking the beginning of a comment. Defaults to ``'{#'``. `comment_end_string` The string marking the end of a comment. Defaults to ``'#}'``. `line_statement_prefix` If given and a string, this will be used as prefix for line based statements. See also :ref:`line-statements`. `line_comment_prefix` If given and a string, this will be used as prefix for line based comments. See also :ref:`line-statements`. .. versionadded:: 2.2 `trim_blocks` If this is set to ``True`` the first newline after a block is removed (block, not variable tag!). Defaults to `False`. `lstrip_blocks` If this is set to ``True`` leading spaces and tabs are stripped from the start of a line to a block. Defaults to `False`. `newline_sequence` The sequence that starts a newline. Must be one of ``'\r'``, ``'\n'`` or ``'\r\n'``. The default is ``'\n'`` which is a useful default for Linux and OS X systems as well as web applications. `keep_trailing_newline` Preserve the trailing newline when rendering templates. The default is ``False``, which causes a single newline, if present, to be stripped from the end of the template. .. versionadded:: 2.7 `extensions` List of Jinja extensions to use. This can either be import paths as strings or extension classes. For more information have a look at :ref:`the extensions documentation <jinja-extensions>`. `optimized` should the optimizer be enabled? Default is ``True``. `undefined` :class:`Undefined` or a subclass of it that is used to represent undefined values in the template. `finalize` A callable that can be used to process the result of a variable expression before it is output. For example one can convert ``None`` implicitly into an empty string here. `autoescape` If set to ``True`` the XML/HTML autoescaping feature is enabled by default. For more details about autoescaping see :class:`~markupsafe.Markup`. As of Jinja 2.4 this can also be a callable that is passed the template name and has to return ``True`` or ``False`` depending on autoescape should be enabled by default. .. versionchanged:: 2.4 `autoescape` can now be a function `loader` The template loader for this environment. `cache_size` The size of the cache. Per default this is ``400`` which means that if more than 400 templates are loaded the loader will clean out the least recently used template. If the cache size is set to ``0`` templates are recompiled all the time, if the cache size is ``-1`` the cache will not be cleaned. .. versionchanged:: 2.8 The cache size was increased to 400 from a low 50. `auto_reload` Some loaders load templates from locations where the template sources may change (ie: file system or database). If ``auto_reload`` is set to ``True`` (default) every time a template is requested the loader checks if the source changed and if yes, it will reload the template. For higher performance it's possible to disable that. `bytecode_cache` If set to a bytecode cache object, this object will provide a cache for the internal Jinja bytecode so that templates don't have to be parsed if they were not changed. See :ref:`bytecode-cache` for more information. `enable_async` If set to true this enables async template execution which allows you to take advantage of newer Python features. This requires Python 3.6 or later.
def __init__ | ( | self, | |
block_start_string = BLOCK_START_STRING , |
|||
block_end_string = BLOCK_END_STRING , |
|||
variable_start_string = VARIABLE_START_STRING , |
|||
variable_end_string = VARIABLE_END_STRING , |
|||
comment_start_string = COMMENT_START_STRING , |
|||
comment_end_string = COMMENT_END_STRING , |
|||
line_statement_prefix = LINE_STATEMENT_PREFIX , |
|||
line_comment_prefix = LINE_COMMENT_PREFIX , |
|||
trim_blocks = TRIM_BLOCKS , |
|||
lstrip_blocks = LSTRIP_BLOCKS , |
|||
newline_sequence = NEWLINE_SEQUENCE , |
|||
keep_trailing_newline = KEEP_TRAILING_NEWLINE , |
|||
extensions = () , |
|||
optimized = True , |
|||
undefined = Undefined , |
|||
finalize = None , |
|||
autoescape = False , |
|||
loader = None , |
|||
cache_size = 400 , |
|||
auto_reload = True , |
|||
bytecode_cache = None , |
|||
enable_async = False |
|||
) |
def add_extension | ( | self, | |
extension | |||
) |
Adds an extension after the environment was created. .. versionadded:: 2.5
def call_filter | ( | self, | |
name, | |||
value, | |||
args = None , |
|||
kwargs = None , |
|||
context = None , |
|||
eval_ctx = None |
|||
) |
Invokes a filter on a value the same way the compiler does it. Note that on Python 3 this might return a coroutine in case the filter is running from an environment in async mode and the filter supports async execution. It's your responsibility to await this if needed. .. versionadded:: 2.7
def call_test | ( | self, | |
name, | |||
value, | |||
args = None , |
|||
kwargs = None |
|||
) |
Invokes a test on a value the same way the compiler does it. .. versionadded:: 2.7
def compile | ( | self, | |
source, | |||
name = None , |
|||
filename = None , |
|||
raw = False , |
|||
defer_init = False |
|||
) |
Compile a node or template source code. The `name` parameter is the load name of the template after it was joined using :meth:`join_path` if necessary, not the filename on the file system. the `filename` parameter is the estimated filename of the template on the file system. If the template came from a database or memory this can be omitted. The return value of this method is a python code object. If the `raw` parameter is `True` the return value will be a string with python code equivalent to the bytecode returned otherwise. This method is mainly used internally. `defer_init` is use internally to aid the module code generator. This causes the generated code to be able to import without the global environment variable to be set. .. versionadded:: 2.4 `defer_init` parameter added.
def compile_expression | ( | self, | |
source, | |||
undefined_to_none = True |
|||
) |
A handy helper method that returns a callable that accepts keyword arguments that appear as variables in the expression. If called it returns the result of the expression. This is useful if applications want to use the same rules as Jinja in template "configuration files" or similar situations. Example usage: >>> env = Environment() >>> expr = env.compile_expression('foo == 42') >>> expr(foo=23) False >>> expr(foo=42) True Per default the return value is converted to `None` if the expression returns an undefined value. This can be changed by setting `undefined_to_none` to `False`. >>> env.compile_expression('var')() is None True >>> env.compile_expression('var', undefined_to_none=False)() Undefined .. versionadded:: 2.1
def compile_templates | ( | self, | |
target, | |||
extensions = None , |
|||
filter_func = None , |
|||
zip = "deflated" , |
|||
log_function = None , |
|||
ignore_errors = True , |
|||
py_compile = False |
|||
) |
Finds all the templates the loader can find, compiles them and stores them in `target`. If `zip` is `None`, instead of in a zipfile, the templates will be stored in a directory. By default a deflate zip algorithm is used. To switch to the stored algorithm, `zip` can be set to ``'stored'``. `extensions` and `filter_func` are passed to :meth:`list_templates`. Each template returned will be compiled to the target folder or zipfile. By default template compilation errors are ignored. In case a log function is provided, errors are logged. If you want template syntax errors to abort the compilation you can set `ignore_errors` to `False` and you will get an exception on syntax errors. If `py_compile` is set to `True` .pyc files will be written to the target instead of standard .py files. This flag does not do anything on pypy and Python 3 where pyc files are not picked up by itself and don't give much benefit. .. versionadded:: 2.4
def extend | ( | self, | |
** | attributes | ||
) |
Add the items to the instance of the environment if they do not exist yet. This is used by :ref:`extensions <writing-extensions>` to register callbacks and configuration values without breaking inheritance.
def from_string | ( | self, | |
source, | |||
globals = None , |
|||
template_class = None |
|||
) |
Load a template from a string. This parses the source given and returns a :class:`Template` object.
def get_or_select_template | ( | self, | |
template_name_or_list, | |||
parent = None , |
|||
globals = None |
|||
) |
Does a typecheck and dispatches to :meth:`select_template` if an iterable of template names is given, otherwise to :meth:`get_template`. .. versionadded:: 2.3
def get_template | ( | self, | |
name, | |||
parent = None , |
|||
globals = None |
|||
) |
Load a template from the loader. If a loader is configured this method asks the loader for the template and returns a :class:`Template`. If the `parent` parameter is not `None`, :meth:`join_path` is called to get the real template name before loading. The `globals` parameter can be used to provide template wide globals. These variables are available in the context at render time. If the template does not exist a :exc:`TemplateNotFound` exception is raised. .. versionchanged:: 2.4 If `name` is a :class:`Template` object it is returned from the function unchanged.
def getattr | ( | self, | |
obj, | |||
attribute | |||
) |
Get an item or attribute of an object but prefer the attribute. Unlike :meth:`getitem` the attribute *must* be a bytestring.
Reimplemented in SandboxedEnvironment.
def getitem | ( | self, | |
obj, | |||
argument | |||
) |
Get an item or attribute of an object but prefer the item.
Reimplemented in SandboxedEnvironment.
def handle_exception | ( | self, | |
source = None |
|||
) |
Exception handling helper. This is used internally to either raise rewritten exceptions or return a rendered traceback for the template.
def iter_extensions | ( | self | ) |
Iterates over the extensions by priority.
def join_path | ( | self, | |
template, | |||
parent | |||
) |
Join a template with the parent. By default all the lookups are relative to the loader root so this method returns the `template` parameter unchanged, but if the paths should be relative to the parent template, this function can be used to calculate the real template name. Subclasses may override this method and implement template path joining here.
def lex | ( | self, | |
source, | |||
name = None , |
|||
filename = None |
|||
) |
Lex the given sourcecode and return a generator that yields tokens as tuples in the form ``(lineno, token_type, value)``. This can be useful for :ref:`extension development <writing-extensions>` and debugging templates. This does not perform preprocessing. If you want the preprocessing of the extensions to be applied you have to filter source through the :meth:`preprocess` method.
def list_templates | ( | self, | |
extensions = None , |
|||
filter_func = None |
|||
) |
Returns a list of templates for this environment. This requires that the loader supports the loader's :meth:`~BaseLoader.list_templates` method. If there are other files in the template folder besides the actual templates, the returned list can be filtered. There are two ways: either `extensions` is set to a list of file extensions for templates, or a `filter_func` can be provided which is a callable that is passed a template name and should return `True` if it should end up in the result list. If the loader does not support that, a :exc:`TypeError` is raised. .. versionadded:: 2.4
def make_globals | ( | self, | |
d | |||
) |
Return a dict for the globals.
def overlay | ( | self, | |
block_start_string = missing , |
|||
block_end_string = missing , |
|||
variable_start_string = missing , |
|||
variable_end_string = missing , |
|||
comment_start_string = missing , |
|||
comment_end_string = missing , |
|||
line_statement_prefix = missing , |
|||
line_comment_prefix = missing , |
|||
trim_blocks = missing , |
|||
lstrip_blocks = missing , |
|||
extensions = missing , |
|||
optimized = missing , |
|||
undefined = missing , |
|||
finalize = missing , |
|||
autoescape = missing , |
|||
loader = missing , |
|||
cache_size = missing , |
|||
auto_reload = missing , |
|||
bytecode_cache = missing |
|||
) |
Create a new overlay environment that shares all the data with the current environment except for cache and the overridden attributes. Extensions cannot be removed for an overlayed environment. An overlayed environment automatically gets all the extensions of the environment it is linked to plus optional extra extensions. Creating overlays should happen after the initial environment was set up completely. Not all attributes are truly linked, some are just copied over so modifications on the original environment may not shine through.
def parse | ( | self, | |
source, | |||
name = None , |
|||
filename = None |
|||
) |
Parse the sourcecode and return the abstract syntax tree. This tree of nodes is used by the compiler to convert the template into executable source- or bytecode. This is useful for debugging or to extract information from templates. If you are :ref:`developing Jinja extensions <writing-extensions>` this gives you a good overview of the node tree generated.
def preprocess | ( | self, | |
source, | |||
name = None , |
|||
filename = None |
|||
) |
Preprocesses the source with all extensions. This is automatically called for all parsing and compiling methods but *not* for :meth:`lex` because there you usually only want the actual source tokenized.
def select_template | ( | self, | |
names, | |||
parent = None , |
|||
globals = None |
|||
) |
Works like :meth:`get_template` but tries a number of templates before it fails. If it cannot find any of the templates, it will raise a :exc:`TemplatesNotFound` exception. .. versionchanged:: 2.11 If names is :class:`Undefined`, an :exc:`UndefinedError` is raised instead. If no templates were found and names contains :class:`Undefined`, the message is more helpful. .. versionchanged:: 2.4 If `names` contains a :class:`Template` object it is returned from the function unchanged. .. versionadded:: 2.3
auto_reload |
autoescape |
block_end_string |
block_start_string |
bytecode_cache |
cache |
|
static |
comment_end_string |
comment_start_string |
|
static |
enable_async |
extensions |
filters |
finalize |
globals |
is_async |
keep_trailing_newline |
line_comment_prefix |
line_statement_prefix |
|
static |
loader |
lstrip_blocks |
newline_sequence |
optimized |
|
static |
policies |
|
static |
|
static |
tests |
trim_blocks |
undefined |
variable_end_string |
variable_start_string |
|
static |