3
sݨ\_ @ st d Z ddlZddlmZ ddlmZmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZ ddlmZ ddlmZ ddlmZmZ ddlmZmZmZ dd l m Z m Z m Z d(Z G d
d de!Z"G dd de e"e#Z$edd Z%dd Z&dd Z'G dd de$Z(G dd de$Z)G dd d e$Z*G d d d e$Z+G d d d e$Z,e d!fd"d#Z-G d$d% d%e#Z.d&d' Z/e(Z0e)Z1e*Z2e+Z3e,Z4dS ))a
jinja2.ext
~~~~~~~~~~
Jinja extensions allow to add custom tags similar to the way django custom
tags work. By default two example extensions exist: an i18n and a cache
extension.
:copyright: (c) 2017 by the Jinja Team.
:license: BSD.
N)nodes) BLOCK_START_STRINGBLOCK_END_STRINGVARIABLE_START_STRINGVARIABLE_END_STRINGCOMMENT_START_STRINGCOMMENT_END_STRINGLINE_STATEMENT_PREFIXLINE_COMMENT_PREFIX TRIM_BLOCKSNEWLINE_SEQUENCEKEEP_TRAILING_NEWLINE
LSTRIP_BLOCKS) Environment)concat)TemplateAssertionErrorTemplateSyntaxError)contextfunction
import_stringMarkup)with_metaclass string_types iteritems_gettextngettextc @ s e Zd ZdZdd ZdS )ExtensionRegistryz)Gives the extension an unique identifier.c C s& t j| |||}|jd |j |_|S )N.)type__new__
__module____name__
identifier)clsnamebasesdrv r( /usr/lib/python3.6/ext.pyr % s zExtensionRegistry.__new__N)r! r __qualname____doc__r r( r( r( r) r " s r c @ sX e Zd ZdZe ZdZdd Zdd Zddd Z d
d Z
d d
Z dddZ dddZ
dS ) Extensionag 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).
d c C s
|| _ d S )N) environment)selfr. r( r( r) __init__H s zExtension.__init__c C s$ t j| j}|jj| j ||_|S )z=Create a copy of this extension bound to another environment.)objectr __class____dict__updater. )r/ r. r' r( r( r) bindK s zExtension.bindNc C s |S )zThis 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.
r( )r/ sourcer$ filenamer( r( r)
preprocessR s zExtension.preprocessc C s |S )a 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`.
In the `ext` folder of the Jinja2 source distribution there is a file
called `inlinegettext.py` which implements a filter that utilizes this
method.
r( )r/ streamr( r( r)
filter_streamY s
zExtension.filter_streamc C s
t dS )a 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.
N)NotImplementedError)r/ parserr( r( r) parsee s zExtension.parsec C s t j| j||dS )zReturn 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)
)lineno)r ZExtensionAttributer" )r/ r$ r> r( r( r) attrm s zExtension.attrc C s8 |dkr g }|dkrg }t j| j||d|||||dS )zsCall a method of the extension. This is a shortcut for
:meth:`attr` + :class:`jinja2.nodes.Call`.
N)r> )r Callr? )r/ r$ argskwargsdyn_args
dyn_kwargsr> r( r( r) call_methodw s zExtension.call_method)N)N)NNNNN)r! r r* r+ settagsZpriorityr0 r5 r8 r: r= r? rE r( r( r( r) r, + s
r, c O s | j | jdf||S )Nr )callZresolve) __contextrA rB r( r( r) _gettext_alias s rJ c s t fdd}|S )Nc s$ | j |}| jjr t|}|| S )N)rH eval_ctx
autoescaper )rI Z__string variablesr' )funcr( r) r s z"_make_new_gettext..gettext)r )rN r r( )rN r) _make_new_gettext s rO c s t fdd}|S )Nc s4 |j d| | j |||}| jjr,t|}|| S )Nnum)
setdefaultrH rK rL r )rI Z
__singularZ__pluralZ__numrM r' )rN r( r) r s
z$_make_new_ngettext..ngettext)r )rN r r( )rN r) _make_new_ngettext s rR c @ s~ e Zd ZdZedgZdd ZdddZddd Zdd
d Z d d
Z
e fddZ dd Z
ejdfddZdd Zdd ZdS ) InternationalizationExtensionz.This extension adds gettext support to Jinja2.Ztransc C s: t j| | t|jd< |j| j| j| j| j| j dd d S )Nr F)Z install_gettext_translationsZinstall_null_translationsZinstall_gettext_callablesZ uninstall_gettext_translationsZextract_translationsnewstyle_gettext)
r, r0 rJ globalsextend_install
_install_null_install_callables
_uninstall_extract)r/ r. r( r( r) r0 s
z&InternationalizationExtension.__init__Nc C sF t |dd }|d kr|j}t |dd }|d kr4|j}| j||| d S )NZugettextZ ungettext)getattrr r rY )r/ translationsnewstyler r r( r( r) rW s z&InternationalizationExtension._installc C s | j dd dd | d S )Nc S s | S )Nr( )xr( r( r) s z=InternationalizationExtension._install_null..c S s |dkr|fp| fd S )N r r( )spnr( r( r) r` s )rY )r/ r^ r( r( r) rX s z+InternationalizationExtension._install_nullc C s> |d k r|| j _| j jr(t|}t|}| j jj||d d S )N)r r )r. rT rO rR rU r4 )r/ r r r^ r( r( r) rY s z0InternationalizationExtension._install_callablesc C s" x dD ]}| j jj|d qW d S )Nr r )r r )r. rU pop)r/ r] keyr( r( r) rZ s
z(InternationalizationExtension._uninstallc C s t |tr| jj|}t||S )N)
isinstancer r. r= extract_from_ast)r/ r6 gettext_functionsr( r( r) r[ s
z&InternationalizationExtension._extractc C s
t |jj}d}d}d}i }d}x|jjjdkr6|rD|jjd |jjdrRP |jjd}|j|kr|jd|j |jt d |jjjd krt |j |j
||j< } n8|dkr|jdkr|jd
k}q$nt j |jd ||j< } |dkr$t
| t jr&t j d
d }|||j< t jt j d
d| }n| }|jdk}q$W |jjd d}
d} t } | j|d\}
}|
r| j|
|dkrt j |
d d }|
d dk}|jjjdr currentr expectZskip_ifvaluefailr Zparse_expressionr Namerg r@ ZAssignrF _parse_blockr4 testr. policies_trim_whitespace
_make_nodeboolZ
set_lineno)r/ r< r> num_called_num plural_exprZplural_expr_assignmentrM rk r$ varpluralZ have_plural
referencedZsingular_namessingularZ plural_namesnoder( r( r) r= s
z#InternationalizationExtension.parsez\s*\n\s*c C s |j d|j S )N )substrip)r/ stringZ_ws_rer( r( r) rw B s z.InternationalizationExtension._trim_whitespacec C s g }g }x|j jjdkr<|j|j jjjdd t|j q
|j jjdkrt|j |j jdj}|j| |jd| |j jd q
|j jjdkrt|j |j jjd rP n |j jjd
r|rP |j d |j d q
|j j
r
|j d
q
q
W |t |fS )z1Parse until the next block tag with a given name.data%z%%Zvariable_beginr$ z%%(%s)sZ variable_endZ block_beginz
name:endtranszname:pluralizez:a translatable section can have only one pluralize sectionz;control structures in translatable sections are not allowedzunclosed translation block) r9 ro r appendrq replacern rp ru rr Zeosr )r/ r< Zallow_pluralizer~ Zbufr$ r( r( r) rt E s2
z*InternationalizationExtension._parse_blockc C s | r,| j j r,|jdd}|r,|jdd}|dkr\tjdd}tj|tj|gg dd}n0tjdd} tj| tj|tj||gg dd}| j jrxft|D ]*\}
} |r|
dkrq|jj tj
|
| qW n.tj |}|rtj |tj
dd |j D }tj|gS )
z/Generates a useful node from the data provided.z%%r Nr rm r rP c S s" g | ]\}}t jt j||qS r( )r ZPairConst).0rf rq r( r( r)
s z.)r. rT r r rs r@ r r rB r ZKeywordZMarkSafeIfAutoescapeZModZDictitemsZOutput) r/ r r} rM r{ Zvars_referencedrz r r r rf rq r( r( r) rx e s2
z(InternationalizationExtension._make_node)N)N)N)r! r r* r+ rF rG r0 rW rX rY rZ GETTEXT_FUNCTIONSr[ r= recompilerw rt rx r( r( r( r) rS s
i rS c @ s" e Zd ZdZedgZdd ZdS )ExprStmtExtensionzsAdds a `do` tag to Jinja2 that works like the print statement just
that it doesn't print the return value.
doc C s" t jt|jjd}|j |_|S )N)r> )r ZExprStmtrn r9 r> Z parse_tupler )r/ r< r r( r( r) r= s
zExprStmtExtension.parseN)r! r r* r+ rF rG r= r( r( r( r) r s
r c @ s$ e Zd ZdZeddgZdd ZdS )LoopControlExtensionz/Adds break and continue to the template engine.breakcontinuec C s0 t |j}|jdkr"tj|jdS tj|jdS )Nr )r> )rn r9 rq r ZBreakr> ZContinue)r/ r< tokenr( r( r) r= s
zLoopControlExtension.parseN)r! r r* r+ rF rG r= r( r( r( r) r s r c @ s e Zd ZdS )
WithExtensionN)r! r r* r( r( r( r) r s r c @ s e Zd ZdS )AutoEscapeExtensionN)r! r r* r( r( r( r) r s r Tc c s x| j tjD ]} t| jtj s| jj|kr2qg }x>| jD ]4}t|tjrht|j t
rh|j |j q>|j d q>W x| j D ]}|j d q~W | j
dk r|j d | jdk r|j d |stdd |D }|sqn t|dkr|d }nt|}| j| jj|fV qW dS )a 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.
Nc s s | ]}|d k r|V qd S )Nr( )r r_ r( r( r) s z#extract_from_ast..ra r )Zfind_allr r@ rg r rs r$ rA r rq r r rB rC rD tuplelenr> )r ri Z babel_styleZstringsargr( r( r) rh s0 $
rh c @ s( e Zd ZdZdd Zdd Zdd ZdS ) _CommentFinderzHelper 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 not return a
usable value.
c C s || _ || _d| _d| _d S )Nr )tokens comment_tagsoffset last_lineno)r/ r r r( r( r) r0 s z_CommentFinder.__init__c C s~ zpxjt | j| j| D ]R\}}}|dkry|jd d\}}W n tk
rT wY nX || jkr|j gS qW g S || _X d S )Ncomment linecommentra )r r )reversedr r split
ValueErrorr rstrip)r/ r r
token_typeZ token_valueprefixr r( r( r) find_backwards s
z _CommentFinder.find_backwardsc C sf | j s| j|krg S x>t| j| jd D ]&\}\}}}||kr,| j| j| S q,W | jt| jS )N)r r enumerater r r r )r/ r> idxZ token_linenor r( r( r)
find_comments s $z _CommentFinder.find_commentsN)r! r r* r+ r0 r r r( r( r( r) r s r c c s t }x6|jddjdD ] }|j }|s,q|jt| qW t|krP|jt d dd}||dd}t|jd t|jd
t |jd t
|jd t |jd
t |jdt
|jdpt|jdpt||dt||dtt||dtt|ddd}||drd|jd< ||drd|_| j j|jdd} y"|j| }
t|j|j | } W n* t k
rv } z |sh dS d} ~ X nX t | |}
x.t |
|D ] \}}}||||
j |fV qW dS ) a 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 preceeding 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)
extensions ,Fc S s | j |t|j dkS )N1onyestrue)r r r r )getstrlower)optionsrf defaultr( r( r) getboolC s z babel_extract..getboolsilentTZblock_start_stringZblock_end_stringZvariable_start_stringZvariable_end_stringZcomment_start_stringZcomment_end_stringZline_statement_prefixZline_comment_prefixZ trim_blocksZ
lstrip_blocksZkeep_trailing_newliner )Z
cache_sizeZ auto_reloadrk zext.i18n.trimmedrT encodingzutf-8N)F)!rF r r r addr rS r r r r r r r r r
r r r r
frozensetrv rT readdecoder= listZlexr8 r r rh r )Zfileobjkeywordsr r r extensionr r r. r6 r r efinderr> rN messager( r( r)
babel_extract sR
r )r r r )5r+ r Zjinja2r Zjinja2.defaultsr r r r r r r r
r r r
r Zjinja2.environmentr Zjinja2.runtimer Zjinja2.exceptionsr r Z jinja2.utilsr r r Zjinja2._compatr r r r r r r1 r, rJ rO rR rS r r r r rh r r Zi18nr Z loopcontrolsZwith_rL r( r( r( r) s: 8 Y
y C%Q