class Extension: (source)
Known subclasses: jinja2.ext.DebugExtension
, jinja2.ext.ExprStmtExtension
, jinja2.ext.InternationalizationExtension
, jinja2.ext.LoopControlExtension
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 is not 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).
Method | __init__ |
Undocumented |
Method | __init |
Undocumented |
Method | attr |
Return an attribute node for the current extension. This is useful to pass constants on extensions to generated template code. |
Method | bind |
Create a copy of this extension bound to another environment. |
Method | call |
Call a method of the extension. This is a shortcut for :meth:`attr` + :class:`jinja2.nodes.Call`. |
Method | filter |
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... |
Method | parse |
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. |
Method | preprocess |
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. |
Class Variable | identifier |
Undocumented |
Class Variable | priority |
Undocumented |
Class Variable | tags |
Undocumented |
Instance Variable | environment |
Undocumented |
jinja2.ext.InternationalizationExtension
Undocumented
Parameters | |
environment:Environment | Undocumented |
Return an attribute node for the current extension. This is useful to pass constants on extensions to generated template code. :: self.attr('_my_attribute', lineno=lineno)
Parameters | |
name:str | Undocumented |
lineno:t.Optional[ | Undocumented |
Returns | |
nodes.ExtensionAttribute | Undocumented |
Create a copy of this extension bound to another environment.
Parameters | |
environment:Environment | Undocumented |
Returns | |
Extension | Undocumented |
Call a method of the extension. This is a shortcut for :meth:`attr` + :class:`jinja2.nodes.Call`.
Parameters | |
name:str | Undocumented |
args:t.Optional[ | Undocumented |
kwargs:t.Optional[ | Undocumented |
dynt.Optional[ | Undocumented |
dynt.Optional[ | Undocumented |
lineno:t.Optional[ | Undocumented |
Returns | |
nodes.Call | Undocumented |
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`.
Parameters | |
stream:TokenStream | Undocumented |
Returns | |
t.Union[ | Undocumented |
jinja2.ext.DebugExtension
, jinja2.ext.ExprStmtExtension
, jinja2.ext.InternationalizationExtension
, jinja2.ext.LoopControlExtension
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.
Parameters | |
parser:Parser | Undocumented |
Returns | |
t.Union[ | Undocumented |
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.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
Returns | |
str | Undocumented |
jinja2.ext.DebugExtension
, jinja2.ext.ExprStmtExtension
, jinja2.ext.InternationalizationExtension
, jinja2.ext.LoopControlExtension
Undocumented