3
eY7g @ s d Z ddlZddlmZ ddlZddlmZmZmZm Z m
Z
ddl m Z m
Z
mZ ddlmZmZ ddlmZ dZddd"dd#d$d%dd'd)d
Zd*gZdZdd Zdedef ddfddZd+ddZef ddfddZef ddfddZ d d Z d d Z d d! Z dS ),aa
babel.messages.extract
~~~~~~~~~~~~~~~~~~~~~~
Basic infrastructure for extracting localizable messages from source files.
This module defines an extensible system for collecting localizable message
strings from a variety of sources. A native extractor for Python source
files is builtin, extractors for other sources can be added using very
simple plugins.
The main entry points into the extraction functionality are the functions
`extract_from_dir` and `extract_from_file`.
:copyright: (c) 2013 by the Babel Team.
:license: BSD, see LICENSE for more details.
N)relpath)generate_tokensCOMMENTNAMEOPSTRING)parse_encodingparse_future_flags pathmatch)PY2 text_type)dedentzbabel.extractors c)
_gettextZngettextZugettextZ ungettextdgettextZ dngettextZN_ZpgettextZ npgettext**.pypythonz%s: warning: Empty msgid. It is reserved by GNU gettext: gettext("") returns the header entry with meta information, not the empty string.c s" fdd}t || | dd< dS )zHelper function for `extract` that strips comment tags from strings
in a list of comment lines. This functions operates in-place.
c s0 x* D ]"}| j |r| t|d j S qW | S )N)
startswithlenstrip)linetag)tags /usr/lib/python3.6/extract.py_strip8 s
z#_strip_comment_tags.._stripN)map)commentsr r r )r r _strip_comment_tags4 s r" Fc c s | dkrt j } |dkr i }t jj| }xt j|D ]~\}} }
dd | D | dd< | j |
j xL|
D ]D} t jj|| jt jd} x&t | |||||||dD ]
}
|
V qW qjW q4W dS )a8 Extract messages from any source files found in the given directory.
This function generates tuples of the form ``(filename, lineno, message,
comments, context)``.
Which extraction method is used per file is determined by the `method_map`
parameter, which maps extended glob patterns to extraction method names.
For example, the following is the default mapping:
>>> method_map = [
... ('**.py', 'python')
... ]
This basically says that files with the filename extension ".py" at any
level inside the directory should be processed by the "python" extraction
method. Files that don't match any of the mapping patterns are ignored. See
the documentation of the `pathmatch` function for details on the pattern
syntax.
The following extended mapping would also use the "genshi" extraction
method on any file in "templates" subdirectory:
>>> method_map = [
... ('**/templates/**.*', 'genshi'),
... ('**.py', 'python')
... ]
The dictionary provided by the optional `options_map` parameter augments
these mappings. It uses extended glob patterns as keys, and the values are
dictionaries mapping options names to option values (both strings).
The glob patterns of the `options_map` do not necessarily need to be the
same as those used in the method mapping. For example, while all files in
the ``templates`` folders in an application may be Genshi applications, the
options for those files may differ based on extension:
>>> options_map = {
... '**/templates/**.txt': {
... 'template_class': 'genshi.template:TextTemplate',
... 'encoding': 'latin-1'
... },
... '**/templates/**.html': {
... 'include_attrs': ''
... }
... }
:param dirname: the path to the directory to extract messages from. If
not given the current working directory is used.
:param method_map: a list of ``(pattern, method)`` tuples that maps of
extraction method names to extended glob patterns
:param options_map: a dictionary of additional options (optional)
:param keywords: a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings
:param comment_tags: a list of tags of translator comments to search for
and include in the results
:param callback: a function that is called for every file that message are
extracted from, just before the extraction itself is
performed; the function is passed the filename, the name
of the extraction method and and the options dictionary as
positional arguments, in that order
:param strip_comment_tags: a flag that if set to `True` causes all comment
tags to be removed from the collected comments.
:see: `pathmatch`
Nc S s$ g | ] }|j d p|j ds|qS ).r )r ).0Zsubdirr r r
s z$extract_from_dir../)dirpath)
osgetcwdpathabspathwalksortjoinreplacesepcheck_and_call_extract_file)dirname
method_map options_mapkeywords comment_tagscallbackstrip_comment_tagsZabsnamerootZdirnames filenamesfilenamefilepath
message_tupler r r extract_from_dir@ s* E
r> c c s t | |}x|D ]x\} }
t| |s$qi } x"|j D ]\} }
t| |r2|
} q2W |r\|||
| x(t|
| ||| |dD ]}|f| V qrW P qW dS )a Checks if the given file matches an extraction method mapping, and if so, calls extract_from_file.
Note that the extraction method mappings are based relative to dirpath.
So, given an absolute path to a file `filepath`, we want to check using
just the relative path from `dirpath` to `filepath`.
Yields 5-tuples (filename, lineno, messages, comments, context).
:param filepath: An absolute path to a file that exists.
:param method_map: a list of ``(pattern, method)`` tuples that maps of
extraction method names to extended glob patterns
:param options_map: a dictionary of additional options (optional)
:param callback: a function that is called for every file that message are
extracted from, just before the extraction itself is
performed; the function is passed the filename, the name
of the extraction method and and the options dictionary as
positional arguments, in that order
:param keywords: a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings
:param comment_tags: a list of tags of translator comments to search for
and include in the results
:param strip_comment_tags: a flag that if set to `True` causes all comment
tags to be removed from the collected comments.
:param dirpath: the path to the directory to extract messages from.
:return: iterable of 5-tuples (filename, lineno, messages, comments, context)
:rtype: Iterable[tuple[str, int, str|tuple[str], list[str], str|None]
)r5 r6 optionsr8 N)r r
itemsextract_from_file)r< r3 r4 r7 r5 r6 r8 r' r; patternmethodr? ZopatternZodictr= r r r r1 s$ !
r1 c C s, t |d}tt| |||||S Q R X dS )a Extract messages from a specific file.
This function returns a list of tuples of the form ``(lineno, message, comments, context)``.
:param filename: the path to the file to extract messages from
:param method: a string specifying the extraction method (.e.g. "python")
:param keywords: a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings
:param comment_tags: a list of translator tags to search for and include
in the results
:param strip_comment_tags: a flag that if set to `True` causes all comment
tags to be removed from the collected comments.
:param options: a dictionary of additional options (optional)
:returns: list of tuples of the form ``(lineno, message, comments, context)``
:rtype: list[tuple[int, str|tuple[str], list[str], str|None]
rbN)openlistextract)rC r; r5 r6 r? r8 fileobjr r r rA s rA c c s d}t | r| }nd| ks"d| kr|d| krT| jd}| d| | |d d }} n| jdd\}} tt|i i | g| }nhyddlm}
W n tk
r Y n&X x"|
jt | D ]} | j
dd}P qW |dkrt t t
d } | j| }|dkrtd
| |||j ||p i d }
x~|
D ]t\}}}}|r>|| p:d}nd}t|ttfsX|g}|sbqd}g }d }t|}xd|D ]\}t|tr||d d }q|||k rd}P ||d }|dkrd}P |j| q|W |rqt|d tr|d d }n |d d }|| sRd
t|dr0|jp2d|f }tjjt| d qt|}t|dkrp|d }|rt || ||||fV qW dS )a Extract messages from the given file-like object using the specified
extraction method.
This function returns tuples of the form ``(lineno, message, comments, context)``.
The implementation dispatches the actual extraction to plugins, based on the
value of the ``method`` parameter.
>>> source = b'''# foo module
... def run(argv):
... print(_('Hello, world!'))
... '''
>>> from babel._compat import BytesIO
>>> for message in extract('python', BytesIO(source)):
... print(message)
(3, u'Hello, world!', [], None)
:param method: an extraction method (a callable), or
a string specifying the extraction method (.e.g. "python");
if this is a simple name, the extraction function will be
looked up by entry point; if it is an explicit reference
to a function (of the form ``package.module:funcname`` or
``package.module.funcname``), the corresponding function
will be imported and used
:param fileobj: the file-like object the messages should be extracted from
:param keywords: a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings
:param comment_tags: a list of translator tags to search for and include
in the results
:param options: a dictionary of additional options (optional)
:param strip_comment_tags: a flag that if set to `True` causes all comment
tags to be removed from the collected comments.
:raise ValueError: if the extraction method is not registered
:returns: iterable of tuples of the form ``(lineno, message, comments, context)``
:rtype: Iterable[tuple[int, str|tuple[str], list[str], str|None]
N:r# r r ) working_setT)Zrequire)ignorer Z
javascriptz Unknown extraction method %r)r? Fz%s:%inamez (unknown)
)r )r ) callablerfindsplitgetattr
__import__Z
pkg_resourcesrJ ImportErrorZiter_entry_points
GROUP_NAMEloadextract_nothingextract_pythonextract_javascriptget
ValueErrorkeys
isinstancerF tupler appendhasattrrL sysstderrwriteempty_msgid_warningr" )rC rH r5 r6 r? r8 funcZlastdotmoduleZattrnamerJ Z entry_pointZbuiltinresultslinenofuncnamemessagesr! speccontextZmsgsZinvalidZ
last_indexindexmessageZfirst_msg_indexwherer r r rG s )
rG c C s g S )zdPseudo extractor that does not actually extract anything, but simply
returns an empty list.
r )rH r5 r6 r? r r r rV x s rV c # s d } }}d}g }g } g }
d } } d}
t p:|jdd t }trRj}n fdd}t|}x|D ]\}}\}}}}|dkr|tkr|dkrd
} qp|tkr|d kr| rd} qp|r|}|d7 }qp| r|tkr|d krd} qpqp|dkr||tkr|tr|j }|dd j
}| rJ|
d d
|d krJ|
j ||f qpx.|D ]&}
|j |
rPd
} |
j ||f P qPW qp|r(|d
kr(|tko||k}|tkr|dks|rd|r| j dj
| |dd= n
| j d t| dkrt| } n| d
} |
r$|
d d
|d k r$g }
||| dd |
D fV d } }}d }g } g }
d} |r&|}n|tkrtdt |f dd|}t|di ii }trt|t r|j }|j | nd|tkrz|dkrz|r| j dj
| |dd= n
| j d |
rz|
j \}}|
j |d |f qp|d
krP|tkrP|dkrP|d8 }qp|rf|d krfd}qp|tkrp||krp|}qpW dS ) ac Extract messages from Python source code.
It returns an iterator yielding tuples in the following form ``(lineno,
funcname, message, comments)``.
:param fileobj: the seekable, 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)
:rtype: ``iterator``
Nr FencodingzUTF-8c s j j S )N)readlinedecoder )ro rH r r s z extract_python..defclassT(rI r ) c S s g | ] }|d qS )r r )r$ commentr r r r% s z"extract_python..z# coding=%s
%szeval __builtins__,r| )rs rt r| r| r| r| r| )r rY r r rp r r r r rq r r^ r r. r r] r compilestrry r\ r pop)rH r5 r6 r? rh rg message_lineno
call_stackZbufri translator_commentsZin_defZin_translator_comments comment_tagZ future_flagsZ next_linetokenstokvaluer nestedcodeZ
old_linenoZ old_commentr )ro rH r rW s
rW c c s ddl m}m}m} d }}g } d}
g } d} |jdd}
d}d }tdd |D }x|| j j|
|jd
d |jd d |d
D ]}|r|r|jdkr|jd kr|j }||j
g} d}|dd|j }|jdkr|j
dkr|r|j }|d7 }n |d kr~|jdkr~|j
dd j }| rH| d d |j d krH| j |j |f qx0|D ](}|j
|rN| j |j |j f P qNW n|jdkr.g } |j
dd j }x|D ]}|j
|r|j }|r"|d j |d< tdj|dd j |dd< x*t|D ] \}}| j |j | |f q W P qW n|r|dkr|jdkr|j
dkr|
dk rj| j |
t| dkrt| } n| r| d } nd} | r| d! d |d k rg } | dk r||| dd | D fV d } }}
d} g } g } d"}n|jd#kr,||j
}| r&|
pd| }
d} n|}
nR|jdkr |j
dkrn|
dk r^| j |
d}
n
| j d d} n|j
dkr d } n|dkr|jdkr|j
dkr|d8 }n`|r|d$krd}nJ|d%kr |jdkr |j
|kr |dks|jdks|j
d kr |j
}|}qW dS )&a Extract messages from JavaScript source code.
:param fileobj: the seekable, 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)
Supported options are:
* `jsx` -- set to false to disable JSX/E4X support.
* `template_string` -- set to false to disable ES6
template string support.
r )Tokentokenizeunquote_stringNFro zutf-8r c s s | ]}d |kV qdS )r# Nr )r$ kwr r r s z%extract_javascript..jsxTtemplate_string)r r dottedrL operatorrv ru Z linecommentr ZmultilinecommentrM c S s g | ] }|d qS )r r )r$ rx r r r r% Z s z&extract_javascript..stringrw r{ +Zfunctionr| r| r| r| r| )r r r| r| )Zbabel.messages.jslexerr r r rY anyreadrq typerg r r r^ r
splitlinesr
r. enumerater r] )rH r5 r6 r? r r r rh r ri Z
last_argumentr Zconcatenate_nextro Z
last_tokenr r tokenr r linesoffsetr Z new_valuer r r rX s
"
rX )r r )r r )r )r r r r )r r r r )r r r )r r )N) __doc__r( Zos.pathr r` r r r r r r Z
babel.utilr r r
Z
babel._compatr r textwrapr
rT ZDEFAULT_KEYWORDSZDEFAULT_MAPPINGrc r" r> r1 rA rG rV rW rX r r r r sB b
7 ~