3
HXU @ s d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl Z ddl
m
Z
ddl m Z ddl
mZ ddl
mZmZ ddlmZmZmZ dd lmZ dd
lmZ dd lmZm Z m Z m Z dd l m Z dd
l!m"Z"m#Z# ddl$m%Z%m&Z& ddl'm(Z) ddl*m+Z, ddl-m.Z.m/Z/ yddl0m1Z1 W n" e2k
rF ddl3m1Z1 Y nX d*ddZ4G dd de,Z+G dd de+Z5G dd de+Z6dd Z7G d d d e+Z8G d d d e+Z9G d!d" d"e:Z;d#d$ Ze?d)kre< dS ),z
babel.messages.frontend
~~~~~~~~~~~~~~~~~~~~~~~
Frontends for the message extraction functionality.
:copyright: (c) 2013 by the Babel Team.
:license: BSD, see LICENSE for more details.
)print_functionN)datetime)getpreferredencoding) __version__)Locale
localedata)StringIO string_types text_type)UnknownLocaleError)Catalog)DEFAULT_KEYWORDSDEFAULT_MAPPINGcheck_and_call_extract_fileextract_from_dir)write_mo)read_powrite_po)LOCALTZodict)log)Command)DistutilsOptionErrorDistutilsSetupError)RawConfigParserc C s g }t | ttfs| g} xV| D ]N}|dkr,q t |ttfrN|jt||d q |jdd t|j|D q W tdd |D st|S )a
Make a list out of an argument.
Values from `distutils` argument parsing are always single strings;
values from `optparse` parsing may be lists of strings that may need
to be further split.
No matter the input, this function returns a flat list of whitespace-trimmed
strings, with `None` values filtered out.
>>> listify_value("foo bar")
['foo', 'bar']
>>> listify_value(["foo bar"])
['foo', 'bar']
>>> listify_value([["foo"], "bar"])
['foo', 'bar']
>>> listify_value([["foo"], ["bar", None, "foo"]])
['foo', 'bar', 'foo']
>>> listify_value("foo, bar, quux", ",")
['foo', 'bar', 'quux']
:param arg: A string or a list of strings
:param split: The argument to pass to `str.split()`.
:return:
N)splitc s s | ]}|j V qd S )N)strip).0s r /usr/lib/python3.6/frontend.py O s z listify_value..c s s | ]}t |tV qd S )N)
isinstancer )r valr r r r! P s ) r" listtupleextend
listify_valuer
r allAssertionError)argr outr# r r r r' * s
"r' c @ s. e Zd ZdZf Zf Zi Zi ZeZ dddZ
dS )r Nc C s0 || _ | j d | _d| _d | _d| _d| _d S )NFr ) distributioninitialize_optionsZ_dry_runverboseforcehelpZ finalized)selfdistr r r __init__r s zCommand.__init__)N) __name__
__module__ __qualname__as_argsmultiple_value_optionsboolean_optionsoption_aliasesoption_choices
distutils_logr r3 r r r r r T s r c @ sN e Zd ZdZdZd d!d"d#d$d%d&gZddgZdd Zdd Zd d Z d d Z
dS )'compile_cataloga Catalog compilation command for use in ``setup.py`` scripts.
If correctly installed, this command is available to Setuptools-using
setup scripts automatically. For projects using plain old ``distutils``,
the command needs to be registered explicitly in ``setup.py``::
from babel.messages.frontend import compile_catalog
setup(
...
cmdclass = {'compile_catalog': compile_catalog}
)
.. versionadded:: 0.9
z+compile message catalogs to binary MO filesdomain=D>domains of PO files (space separated list, default 'messages')
directory=d.path to base directory containing the catalogs input-file=iname of the input file output-file=oQname of the output file (default '//LC_MESSAGES/.mo')locale=l locale of the catalog to compile use-fuzzyf also include fuzzy translations
statisticsN#print statistics about translationsc C s. d| _ d | _d | _d | _d | _d| _d| _d S )NmessagesF)domain directory
input_file output_filelocale use_fuzzyrP )r1 r r r r- s z"compile_catalog.initialize_optionsc C s@ t | j| _| j r$| j r$td| j r<| j r r? r@ )rA rB rC )rD rE rF )rG rH rI )rJ rK rL )rM rN rO )rP NrQ ) r4 r5 r6 __doc__ description user_optionsr9 r- rY r[ rZ r r r r r= } s* r= c @ s e Zd ZdZdZdFdGdHdIdJdKdLdMdNdOdPdQdRdSdTdUdVdWdXdYgZd dddd d d+gZd2ZdZZd[d\d]d^d9Z d:d_iZ
d>d? Z d@dA Z dBdC Z
dDdE ZdS )`extract_messagesa Message extraction command for use in ``setup.py`` scripts.
If correctly installed, this command is available to Setuptools-using
setup scripts automatically. For projects using plain old ``distutils``,
the command needs to be registered explicitly in ``setup.py``::
from babel.messages.frontend import extract_messages
setup(
...
cmdclass = {'extract_messages': extract_messages}
)
z1extract localizable strings from the project codecharset=N3charset to use in the output file (default "utf-8") keywords=kispace-separated list of keywords to look for in addition to the defaults (may be repeated multiple times)no-default-keywords#do not include the default keywords
mapping-file=F&path to the mapping configuration file no-location>do not include location comments with filename and line number
add-location=location lines format. If it is not given or "full", it generates the lines with both file name and line number. If it is "file", the line number part is omitted. If it is "never", it completely suppresses the lines (same as --no-location). omit-header'do not include msgid "" entry in header output-file=rH name of the output filewidth=w"set output line width (default 76)no-wrapVdo not break long message lines, longer than the output line width, into several lines sort-output&generate sorted output (default False) sort-by-file,sort output by file location (default False)msgid-bugs-address= set report address for msgidcopyright-holder= set copyright holder in outputproject=set project name in outputversion= set project version in output
add-comments=cuplace comment block with TAG (or those preceding keyword lines) in output file. Separate multiple TAGs with commas(,)strip-commentsr )strip the comment TAGs from the comments. input-paths=ofiles or directories that should be scanned for messages. Separate multiple files or directories with commas(,) input-dirs=@alias for input-paths (does allow files as well as directories).z input-paths add-commentskeywords --keyword --mapping--output--strip-comment-tags)r z mapping-filez output-filezstrip-commentsz add-locationfullfileneverc C s d| _ d | _d| _d | _d| _d | _d| _d | _d | _d | _ d | _
d| _ d| _ d| _
d | _d | _d | _d | _d | _d| _d| _d S )Nzutf-8FT)charsetr no_default_keywords mapping_file no_location add_location omit_headerrV
input_dirs input_pathswidthno_wrap sort_output sort_by_filemsgid_bugs_addresscopyright_holderprojectversion add_commentsstrip_commentsinclude_lineno)r1 r r r r- M s* z#extract_messages.initialize_optionsc C s | j r | js| j | _ntd| jr*i }ntj }|jtt| j || _ | j sZtd| j
shtd| j r|| j r|td| j r| j rd| _ n| j d k rt
| j | _ | jr| jrtd| jrt| jtrtjd| j| _n8| jd k rtjdd | jjpf D j | _ng | _| js*td
x*| jD ] }tjj|s2td | q2W t| j pbf d | _ | jr| j s| jj | _ | j s| jj | _ | j!d
krd| _"n| j!dkrd| _#d S )Nz1input-dirs and input-paths are mutually exclusivez=you must specify new keywords if you disable the default oneszno output file specifiedz0'--no-wrap' and '--width' are mutually exclusiveL z;'--sort-output' and '--sort-by-file' are mutually exclusivez,\s*c S s g | ]}|j d dd qS ).r^ r )r )r r~ r r r
s z5extract_messages.finalize_options..z'no input files or directories specifiedz Input path: %s does not exist,r Tr F)$r r r r r
copyupdateparse_keywordsr' r rV r r intr r r" r rer r, dictfromkeysZpackageskeysrb rc rf r r Zget_namer Z get_versionr r r )r1 r rc r r r rY d sZ
z!extract_messages.finalize_optionsc s@ j }tjd }tjjjjjd}x|D ]\ }} fdd}t j
j rt j }t
|||jjj|}n t ||jj|jd}xX|D ]P\} }
} } }
t j
j r| }nt j
jt j
j | }|j| d ||
fg| |
d qW q:W jjdj t||jjjjj j d W d Q R X d S ) Nr` )r r r r r c sl |dkr d S t jj r }nt jjt jj | }d}|rXddjdd |j D }jjd|| d S )Nignore z (%s)z, c S s g | ]\}}d ||f qS )z%s="%s"r )r r~ vr r r r s z:extract_messages.run..callback..z extracting messages from %s%s)rb rc isfilenormpathrd itemsr rk )filenamemethodoptionsfilepathZoptstr)rc r1 r r callback s z&extract_messages.run..callback)r Z comment_tagsr Zstrip_comment_tags)Z
auto_commentscontextz writing PO template file to %s)r r r r r r )
_get_mappingsrh rV r r r r r r rb rc r getcwdr r r r r r rd addr rk r r r r r r r )r1 mappingsrv rs
method_map options_mapr Z current_dirZ extractedr rn rt Zcommentsr r r )rc r1 r r[ sD
zextract_messages.runc C s g }| j rPt| j d}t|\}}W d Q R X x| jD ]}|j|||f q6W nt| jdd r| jj}x|j D ]l\}}t |t
rtt |\}}n8g i }}x,|D ]$\}} }
|j|| f |
pi ||< qW |j|||f qpW n x | jD ]}|j|t i f qW |S )NUmessage_extractors)
r rh
parse_mappingr ra getattrr, r r r" r r r ) r1 r fileobjr r rc r mappingpatternr r r r r r s&
z extract_messages._get_mappings)r{ Nr| )r} r~ r )r Nr )r r r )r Nr )r Nr )r Nr )r rH r )r r r )r Nr )r Nr )r Nr )r Nr )r Nr )r Nr )r Nr )r r r )r r r )r Nr )r Nr )r r )r )r )r )r )r r r )r4 r5 r6 rw rx ry r9 r7 r8 r: r; r- rY r[ r r r r r rz sn
C=rz c C s" |dks t t|ts tddS )ag Validate the ``message_extractors`` keyword argument to ``setup()``.
:param dist: the distutils/setuptools ``Distribution`` object
:param name: the name of the keyword argument (should always be
"message_extractors")
:param value: the value of the keyword argument
:raise `DistutilsSetupError`: if the value is not valid
r zDthe value of the "message_extractors" parameter must be a dictionaryN)r) r" r r )r2 namevaluer r r check_message_extractors s
r c @ sD e Zd ZdZdZd d d d!d"d#d$gZdgZdd Zdd Zd d Z dS )% init_cataloga New catalog initialization command for use in ``setup.py`` scripts.
If correctly installed, this command is available to Setuptools-using
setup scripts automatically. For projects using plain old ``distutils``,
the command needs to be registered explicitly in ``setup.py``::
from babel.messages.frontend import init_catalog
setup(
...
cmdclass = {'init_catalog': init_catalog}
)
z(create a new catalog based on a POT filedomain=r? &domain of PO file (default 'messages') input-file=rE name of the input file output-dir=rB path to output directory output-file=rH Qname of the output file (default '//LC_MESSAGES/.po')locale=rK $locale for the new localized catalogwidth=r "set output line width (default 76)no-wrapNVdo not break long message lines, longer than the output line width, into several linesc C s. d | _ d | _d | _d | _d| _d| _d | _d S )NrR F)
output_dirrV rU rW rS r r )r1 r r r r- 3 s z init_catalog.initialize_optionsc C s | j std| js tdytj| j| _W n* tk
rX } zt|W Y d d }~X nX | j rr| j rrtd| jst j
j | j| jd| j d | _t j
j
t j
j| jst jt j
j| j | jr| jrtd| j r| j rd| _n| jd k rt| j| _d S )Nz you must specify the input filez-you must provide a locale for the new catalogz%you must specify the output directoryr\ z.poz0'--no-wrap' and '--width' are mutually exclusiver )rU r rW r parse_localer rV r rb rc rd rS rf dirnamemakedirsr r r )r1 er r r rY < s* z init_catalog.finalize_optionsc C s | j jd| j| j t| jd}t|| jd}W d Q R X | j|_tj t
|_ d|_ t| jd}t
||| jd W d Q R X d S )Nz creating catalog %s based on %sr] )rW Fr` )r )r rk rV rU rh r rW r r Znowr Z
revision_daterl r r )r1 rr rs rv r r r r[ X s zinit_catalog.run)r r? r )r rE r )r rB r )r rH r )r rK r )r r r )r Nr )
r4 r5 r6 rw rx ry r9 r- rY r[ r r r r r s(
r c
@ sT e Zd ZdZdZd(d)d*d+d,d-d.d/d0d1d2g Zdd!dd d gZd"d# Zd$d% Zd&d' Z dS )3update_cataloga Catalog merging command for use in ``setup.py`` scripts.
If correctly installed, this command is available to Setuptools-using
setup scripts automatically. For projects using plain old ``distutils``,
the command needs to be registered explicitly in ``setup.py``::
from babel.messages.frontend import update_catalog
setup(
...
cmdclass = {'update_catalog': update_catalog}
)
.. versionadded:: 0.9
z'update message catalogs from a POT filedomain=r? &domain of PO file (default 'messages') input-file=rE name of the input file output-dir=rB .path to base directory containing the catalogs output-file=rH Qname of the output file (default '//LC_MESSAGES/.po')locale=rK locale of the catalog to compilewidth=r "set output line width (default 76)no-wrapNVdo not break long message lines, longer than the output line width, into several linesignore-obsolete=1whether to omit obsolete messages from the outputno-fuzzy-matchingNdo not use fuzzy matchingupdate-header-comment update target header commentprevious+keep previous msgids of translated messageszignore-obsoletec C sF d| _ d | _d | _d | _d | _d | _d| _d| _d| _d| _ d| _
d S )NrR F) rS rU r rV rW r r ignore_obsoleteno_fuzzy_matchingupdate_header_commentr )r1 r r r r- s z!update_catalog.initialize_optionsc C s | j std| j r&| j r&td| jr<| j r}tj|}|||jf } t| j t j j p*t p*dd qW dS |sL| jj d |d }
|
| j!krp| jj d |
| j"|
|dd } | j# S ) z{Main entry point of the command-line interface.
:param argv: list of arguments passed on the command-line
Ncommand[args])usager z--list-locales list_locales
store_truez print all known locales and exit)destactionr0 z-vz --verbose store_constloglevelzprint as much as possible)r, r+ constr0 z-qz--quietzprint as little as possibleF)r) r. r^ c S s g | ] }t |qS r )rj )r
identifierr r r r , s z,CommandLineInterface.run..z
%%-%ds %%sasciireplacer zQno valid command or option passed. Try the -h/--help option for more information.zunknown command "%s")r& r' )$sysargvoptparse OptionParserr( r parserZdisable_interspersed_args_helpZ
print_help
add_optionloggingDEBUGZERRORZ set_defaultsINFO
parse_args_configure_loggingr. r) r Zlocale_identifiersmaxsortr r Z english_nameprintencodestdoutencodingr rm commands_configure_commandr[ ) r1 r4 r argsZ identifierslongestformatr0 rW outputcmdnamecmdinstr r r r[ sJ
zCommandLineInterface.runc C sd t jd| _| jj| | jjr.| jjd }nt j }| jj| |j| t jd}|j| d S )Nbabelr z %(message)s) r: Z getLoggerr ZsetLevelZhandlersZ
StreamHandlerZ
addHandlerZ FormatterZ setFormatter)r1 r. ZhandlerZ formatterr r r r> B s
z'CommandLineInterface._configure_loggingc C sp t | jj t d tdd | jD }dtd|d }t| jj }x |D ]\}}t |||f qPW d S )Nz commands:c S s g | ] }t |qS r )rj )r r& r r r r T s z.CommandLineInterface._help..z %%-%ds %%s r^ )rA r7 Z format_helpr? rE sortedr )r1 rH rI rE r rx r r r r8 Q s zCommandLineInterface._helpc C s | j | }| }| jr | j|_t|ts,t|j tj| j|df | j | d}t
|df }x|j D ]\}}} |j d}
t
||
j
dd} d|
g} |r| jd| | j|jj|
f |jj|
d }
|
|kr| jd
|
7 _qf|
|jkr|j| d | d qf|
|jkr(|j| d
| |
d qf|j| | | |
d qfW |j|\}}|rht||j
dd| x&t|j D ]\}}t||| qvW y |j W n2 tk
r } z|j t | W Y d d }~X nX |S )zB
:type cmdname: str
:type argv: list[str]
r )r( rx r7 =-_z--%sz-%sNz<%s>r* )r, r0 ra )r, r0 choices)r0 defaultrS ) command_classesr r" r r) r- r5 r6 r( rE r ry r r2 ra r& r: getr; r9 r9 r8 r= setattrvarsr Zensure_finalizedr rm str)r1 rK r4 ZcmdclassrL r7 r7 ZlongZshortr0 r rT ZstrsrS r rG keyr errr r r rF Z sF
z'CommandLineInterface._configure_command)N)r4 r5 r6 rw r( VERSIONr rE r= rz r r rU r r[ r> r8 rF r r r r r# s
3 r# c C s t jtjS )N)r# r[ r3 r4 r r r r main s r] c
C s i }g }i }t }t|j|_|j| | xb|j D ]V}|dkrPt|j|}q4dd |jddD \}}|j||f t|j|||< q4W |rx4t |D ](\} \}}||kr|| }||f|| < qW ||fS )a Parse an extraction method mapping from a file-like object.
>>> buf = StringIO('''
... [extractors]
... custom = mypackage.module:myfunc
...
... # Python source files
... [python: **.py]
...
... # Genshi templates
... [genshi: **/templates/**.html]
... include_attrs =
... [genshi: **/templates/**.txt]
... template_class = genshi.template:TextTemplate
... encoding = latin-1
...
... # Some custom extractor
... [custom: **/custom/*.*]
... ''')
>>> method_map, options_map = parse_mapping(buf)
>>> len(method_map)
4
>>> method_map[0]
('**.py', 'python')
>>> options_map['**.py']
{}
>>> method_map[1]
('**/templates/**.html', 'genshi')
>>> options_map['**/templates/**.html']['include_attrs']
''
>>> method_map[2]
('**/templates/**.txt', 'genshi')
>>> options_map['**/templates/**.txt']['template_class']
'genshi.template:TextTemplate'
>>> options_map['**/templates/**.txt']['encoding']
'latin-1'
>>> method_map[3]
('**/custom/*.*', 'mypackage.module:myfunc')
>>> options_map['**/custom/*.*']
{}
:param fileobj: a readable file-like object containing the configuration
text to parse
:see: `extract_from_directory`
extractorsc S s g | ] }|j qS r )r )r partr r r r s z!parse_mapping..:r^ )
r r Z _sectionsZreadfpZsectionsr r r ra rg )
r r r^ r r r7 Zsectionr r rq r r r r s$ 1 r c C s i }x| D ]}d|kr&|j d\}}n
|d }}||kr
|rg }xH|j dD ]:}|d dkrx|jt|dd df qL|jt| qLW t|}|||< q
W |S )aQ Parse keywords specifications from the given list of strings.
>>> kw = sorted(parse_keywords(['_', 'dgettext:2', 'dngettext:2,3', 'pgettext:1c,2']).items())
>>> for keyword, indices in kw:
... print((keyword, indices))
('_', None)
('dgettext', (2,))
('dngettext', (2, 3))
('pgettext', ((1, 'c'), 2))
r` Nr r^ r ra )r ra r r% )Zstringsr ri funcnameindicesZindsxr r r r s
r __main__)N)N)@rw Z
__future__r r: r5 rb r r! r3 r r rW r rM r r\ r r Z
babel._compatr r r
Z
babel.corer Zbabel.messages.catalogr Zbabel.messages.extractr
r r r Zbabel.messages.mofiler Zbabel.messages.pofiler r Z
babel.utilr r Z distutilsr r< Z
distutils.cmdr Z_CommandZdistutils.errorsr r Z ConfigParserr ImportErrorZ configparserr' r= rz r r r objectr# r] r r r4 r r r r
sV
*) [
I