3
eY
y @ s d Z ddlZddlZddlmZ ddlmZmZ ddlmZ ddl m
Z
ddl m Z ddl m
Z dd lmZ dd
lmZ dd lmZ dd lmZmZmZmZ dd
lmZm Z m Z m Z dddgZ ej dej!Z"dd Z#G dd de$Z%G dd de&Z'dZ(e rdd Z)ne
Z)G dd de$Z*dS )z
babel.messages.catalog
~~~~~~~~~~~~~~~~~~~~~~
Data structures for message catalogs.
:copyright: (c) 2013 by the Babel Team.
:license: BSD, see LICENSE for more details.
N) parse_header)datetimetime)get_close_matches)message_from_string)copy) __version__)Locale)format_datetime)
get_plural)odictdistinctLOCALTZFixedOffsetTimezone) string_types number_typesPY2cmpMessageCatalogTranslationErrorz
\%
(?:\(([\w]*)\))?
(
[-#0\ +]?(?:\*|[\d]+)?
(?:\.(?:\*|[\d]+))?
[hlL]?
)
([diouxXeEfFgGcrs%])
c C s t jd| }tj|jdd}tj|}tj|}|jd}|d k r|d |dd }}|d d |dd }} t|d }
t|} t| } | d }
|
| 7 }
|
|
9 }
t |
}|j
|d
}|S ) Nz+^(?P.*?)(?P[+-]\d{4})?$r z%Y-%m-%d %H:%Mtzoffsetr 1< )tzinfo) rematchr ZstrptimegroupZmktimer Z
fromtimestampintr replace)valuer ZttZtsZdtr Z plus_minus_srestZhours_offset_sZ
mins_offset_sZ
plus_minusZ hours_offsetZ mins_offsetZnet_mins_offset r$ /usr/lib/python3.6/catalog.py_parse_datetime_header+ s"
r& c @ s e Zd ZdZdf f f f f ddfddZdd Zdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
d ddZedd Zed d Zed d ZdS )!r z0Representation of a single message in a catalog. Nc
C s || _ | r| jrd}|| _tt|| _t|| _|rL| jrL| jj d n | jj
d tt|| _ tt|| _ t
|tr|g| _n
t|| _|| _| | _dS )a_ Create the message object.
:param id: the message ID, or a ``(singular, plural)`` tuple for
pluralizable messages
:param string: the translated message string, or a
``(singular, plural)`` tuple for pluralizable messages
:param locations: a sequence of ``(filename, lineno)`` tuples
:param flags: a set or sequence of flags
:param auto_comments: a sequence of automatic comments for the message
:param user_comments: a sequence of user comments for the message
:param previous_id: the previous message ID, or a ``(singular, plural)``
tuple for pluralizable messages
:param lineno: the line number on which the msgid line was found in the
PO file, if any
:param context: the message context
r' z
python-formatN)r' r' )id pluralizablestringlistr
locationssetflags
python_formatadddiscard
auto_comments
user_comments
isinstancer previous_idlinenocontext)
selfr( r* r, r. r2 r3 r5 r6 r7 r$ r$ r% __init__N s
zMessage.__init__c C s dt | j| jt| jf S )Nz<%s %r (flags: %r)>)type__name__r( r+ r. )r8 r$ r$ r% __repr__s s zMessage.__repr__c C s dd }t || ||S )z0Compare Messages, taking into account plural idsc S s4 t | tr$| jr$| jd | jp dfS | j| jp0dfS )Nr r' )r4 r r) r( r7 )objr$ r$ r% values_to_comparey s z*Message.__cmp__..values_to_compare)r )r8 otherr> r$ r$ r% __cmp__w s zMessage.__cmp__c C s | j |dkS )Nr )r@ )r8 r? r$ r$ r% __gt__ s zMessage.__gt__c C s | j |dk S )Nr )r@ )r8 r? r$ r$ r% __lt__ s zMessage.__lt__c C s | j |dkS )Nr )r@ )r8 r? r$ r$ r% __ge__ s zMessage.__ge__c C s | j |dkS )Nr )r@ )r8 r? r$ r$ r% __le__ s zMessage.__le__c C s | j |dkS )Nr )r@ )r8 r? r$ r$ r% __eq__ s zMessage.__eq__c C s | j |dkS )Nr )r@ )r8 r? r$ r$ r% __ne__ s zMessage.__ne__c C s2 t tt| j| j| j| j| j| j| j | j
| j f S )N) r mapr r( r* r, r. r2 r3 r5 r6 r7 )r8 r$ r$ r% clone s z
Message.clonec C s^ ddl m} g }xH|D ]@}y||| W q tk
rT } z|j| W Y dd}~X qX qW |S )a Run various validation checks on the message. Some validations
are only performed if the catalog is provided. This method returns
a sequence of `TranslationError` objects.
:rtype: ``iterator``
:param catalog: A catalog instance that is passed to the checkers
:see: `Catalog.check` for a way to perform checks for all messages
in a catalog.
r )checkersN)Zbabel.messages.checkersrI r append)r8 catalogrI errorsZcheckerer$ r$ r% check s
z
Message.checkc C s
d| j kS )a Whether the translation is fuzzy.
>>> Message('foo').fuzzy
False
>>> msg = Message('foo', 'foo', flags=['fuzzy'])
>>> msg.fuzzy
True
>>> msg
:type: `bool`fuzzy)r. )r8 r$ r$ r% rO s
z
Message.fuzzyc C s t | jttfS )zWhether the message is plurizable.
>>> Message('foo').pluralizable
False
>>> Message(('foo', 'bar')).pluralizable
True
:type: `bool`)r4 r( r+ tuple)r8 r$ r$ r% r) s
zMessage.pluralizablec C s, | j }t|ttfs|g}tdd |D S )zWhether the message contains Python-style parameters.
>>> Message('foo %(name)s bar').python_format
True
>>> Message(('foo %(name)s', 'foo %(name)s')).python_format
True
:type: `bool`c s s | ]}t j|V qd S )N)
PYTHON_FORMATsearch).0r( r$ r$ r% s z(Message.python_format..)r( r4 r+ rP any)r8 Zidsr$ r$ r% r/ s
zMessage.python_format)N)r;
__module__ __qualname____doc__r9 r< r@ rA rB rC rD rE rF rH rN propertyrO r) r/ r$ r$ r$ r% r K s $
c @ s e Zd ZdZdS )r z_Exception thrown by translation checkers when invalid message
translations are encountered.N)r; rV rW rX r$ r$ r$ r% r s z# Translations template for PROJECT.
# Copyright (C) YEAR ORGANIZATION
# This file is distributed under the same license as the PROJECT project.
# FIRST AUTHOR , YEAR.
#c C sH t | jd}i }x0|j D ]$\}}|jd}|jd}|||< q W |S )Nutf8)r encodeitemsdecode)Z
header_stringheadersZdecoded_headersnamer" r$ r$ r%
_parse_header s
r` c
@ s e Zd ZdZddeddddddddddf
ddZdd Zdd Zeeed
d Z d d
Z
dd Z ee
e dd Z edd Z
edd Zedd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Zdf f f f f ddfd%d&Zd'd( Zd2d)d*Zd3d+d,Zd4d.d/Zd5d0d1Z dS )6r z$Representation of a message catalog.NTc C s || _ |rtj|}|| _|| _t | _|p.d| _|p8d| _|pBd| _ |pLd| _
|
pVd| _ | p`d| _ | pjd| _
|dkrtjt}n t|tr|j r|jtd }|| _| dkrd
} n t| tr| j r| jtd } | | _|
| _t | _d| _d| _dS ) aD Initialize the catalog object.
:param locale: the locale identifier or `Locale` object, or `None`
if the catalog is not bound to a locale (which basically
means it's a template)
:param domain: the message domain
:param header_comment: the header comment as string, or `None` for the
default header
:param project: the project's name
:param version: the project's version
:param copyright_holder: the copyright holder of the catalog
:param msgid_bugs_address: the email address or URL to submit bug
reports to
:param creation_date: the date the catalog was created
:param revision_date: the date the catalog was revised
:param last_translator: the name and email of the last translator
:param language_team: the name and email of the language team
:param charset: the encoding to use in the output (defaults to utf-8)
:param fuzzy: the fuzzy bit on the catalog header
PROJECTVERSION ORGANIZATIONz
EMAIL@ADDRESSzFULL NAME zLANGUAGE zutf-8N)r zYEAR-MO-DA HO:MI+ZONE)domainr parselocale_header_commentr _messagesprojectversioncopyright_holdermsgid_bugs_addresslast_translator
language_teamcharsetr nowr r4 r r!
creation_date
revision_daterO obsolete _num_plurals _plural_expr)r8 rf rd header_commentri rj rk rl rq rr rm rn ro rO r$ r$ r% r9 s6
zCatalog.__init__c C sv | j }tjtjd}t| jdr.| jjd}|jd| jjd| j jd|jd| j
}| j rr|jdd| j j }|S ) Nz%Ystrftimera rb YEARrc zTranslations templatez%s translations)
rg r rp r rw hasattrrr r! ri rj rk rf Z english_name)r8 ZcommentZyearr$ r$ r% _get_header_comment0 s
zCatalog._get_header_commentc C s
|| _ d S )N)rg )r8 r* r$ r$ r% _set_header_comment> s zCatalog._set_header_commenta The header comment for the catalog.
>>> catalog = Catalog(project='Foobar', version='1.0',
... copyright_holder='Foo Company')
>>> print(catalog.header_comment) #doctest: +ELLIPSIS
# Translations template for Foobar.
# Copyright (C) ... Foo Company
# This file is distributed under the same license as the Foobar project.
# FIRST AUTHOR , ....
#
The header can also be set from a string. Any known upper-case variables
will be replaced when the header is retrieved again:
>>> catalog = Catalog(project='Foobar', version='1.0',
... copyright_holder='Foo Company')
>>> catalog.header_comment = '''\
... # The POT for my really cool PROJECT project.
... # Copyright (C) 1990-2003 ORGANIZATION
... # This file is distributed under the same license as the PROJECT
... # project.
... #'''
>>> print(catalog.header_comment)
# The POT for my really cool Foobar project.
# Copyright (C) 1990-2003 Foo Company
# This file is distributed under the same license as the Foobar
# project.
#
:type: `unicode`
)docc C sT g }|j dd| j| jf f |j d| jf |j dt| jdddf t| jtt ft
rx|j dt| jdddf n|j d| jf |j d | j f | j d k r|j d
t
| j f | j d k rd | jkr|j d | jjd t
| j f n|j d | jf | j d k r|j d
| jf |j d |j dd| j f |j d |j ddt f |S )NzProject-Id-Versionz%s %szReport-Msgid-Bugs-TozPOT-Creation-Datezyyyy-MM-dd HH:mmZZen)rf zPO-Revision-DatezLast-TranslatorZLanguageZLANGUAGEz
Language-Teamz Plural-Forms MIME-Version1.0z Content-Typeztext/plain; charset=%sContent-Transfer-Encoding8bitz Generated-Byz Babel %s
)r} r~ )r r )rJ ri rj rl r
rq r4 rr r time_r rm rf strrn r! plural_formsro rb )r8 r^ r$ r$ r% _get_mime_headersb s8
zCatalog._get_mime_headersc C s> x6|D ],\}}|j }|dkrL|jd}dj|d d | _|d | _q|dkr\|| _q|dkrl|| _q|dkr|jdd}tj || _
q|d kr|| _ q|d
krt |\}}d |kr|d j | _
q|d krt d
| \}}t|jdd| _|jdd| _q|dkr t|| _q|dkrd|krt|| _qW d S )Nzproject-id-version r zreport-msgid-bugs-tozlast-translatorZlanguage-_z
language-teamz content-typero z plural-formsz ;Znpluralsr Zpluralz(n != 1)zpot-creation-datezpo-revision-daterx r )lowersplitjoinri rj rl rm r! r re rf rn r ro r getrt ru r& rq rr )r8 r^ r_ r" partsZmimetypeZparamsr r$ r$ r% _set_mime_headers s8
zCatalog._set_mime_headersa The MIME headers of the catalog, used for the special ``msgid ""`` entry.
The behavior of this property changes slightly depending on whether a locale
is set or not, the latter indicating that the catalog is actually a template
for actual translations.
Here's an example of the output for such a catalog template:
>>> from babel.dates import UTC
>>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
>>> catalog = Catalog(project='Foobar', version='1.0',
... creation_date=created)
>>> for name, value in catalog.mime_headers:
... print('%s: %s' % (name, value))
Project-Id-Version: Foobar 1.0
Report-Msgid-Bugs-To: EMAIL@ADDRESS
POT-Creation-Date: 1990-04-01 15:30+0000
PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
Last-Translator: FULL NAME
Language-Team: LANGUAGE
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Generated-By: Babel ...
And here's an example of the output when the locale is set:
>>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
>>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
... creation_date=created, revision_date=revised,
... last_translator='John Doe ',
... language_team='de_DE ')
>>> for name, value in catalog.mime_headers:
... print('%s: %s' % (name, value))
Project-Id-Version: Foobar 1.0
Report-Msgid-Bugs-To: EMAIL@ADDRESS
POT-Creation-Date: 1990-04-01 15:30+0000
PO-Revision-Date: 1990-08-03 12:00+0000
Last-Translator: John Doe
Language: de_DE
Language-Team: de_DE
Plural-Forms: nplurals=2; plural=(n != 1)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Generated-By: Babel ...
:type: `list`
c C s. | j dkr(d}| jr"t| jd }|| _ | j S )zThe number of plurals used by the catalog or locale.
>>> Catalog(locale='en').num_plurals
2
>>> Catalog(locale='ga').num_plurals
5
:type: `int`Nr r )rt rf r )r8 Znumr$ r$ r% num_plurals s
zCatalog.num_pluralsc C s. | j dkr(d}| jr"t| jd }|| _ | j S )a The plural expression used by the catalog or locale.
>>> Catalog(locale='en').plural_expr
'(n != 1)'
>>> Catalog(locale='ga').plural_expr
'(n==1 ? 0 : n==2 ? 1 : n>=3 && n<=6 ? 2 : n>=7 && n<=10 ? 3 : 4)'
:type: `string_types`Nz(n != 1)r )ru rf r )r8 exprr$ r$ r% plural_expr s
zCatalog.plural_exprc C s d| j | jf S )zReturn the plural forms declaration for the locale.
>>> Catalog(locale='en').plural_forms
'nplurals=2; plural=(n != 1)'
>>> Catalog(locale='pt_BR').plural_forms
'nplurals=2; plural=(n > 1)'
:type: `str`znplurals=%s; plural=%s)r r )r8 r$ r$ r% r s
zCatalog.plural_formsc C s | j || jkS )z?Return whether the catalog has a message with the specified ID.)_key_forrh )r8 r( r$ r$ r% __contains__ s zCatalog.__contains__c C s
t | jS )zeThe number of messages in the catalog.
This does not include the special ``msgid ""`` entry.)lenrh )r8 r$ r$ r% __len__ s zCatalog.__len__c c sz g }x$| j D ]\}}|jd||f q W t }| jrD|tdgO }tddj||dV x| jD ]}| j| V qbW dS )zIterates through all the entries in the catalog, in the order they
were added, yielding a `Message` object for every entry.
:rtype: ``iterator``z%s: %srO r'
)r. N) mime_headersrJ r- rO r r rh )r8 Zbufr_ r" r. keyr$ r$ r% __iter__ s zCatalog.__iter__c C s* d}| j rd| j }dt| j| j|f S )Nr' z %sz <%s %r%s>)rf r: r; rd )r8 rf r$ r$ r% r< s
zCatalog.__repr__c C s | j | dS )z)Delete the message with the specified ID.N)delete)r8 r( r$ r$ r% __delitem__! s zCatalog.__delitem__c C s
| j |S )zUReturn the message with the specified ID.
:param id: the message ID
)r )r8 r( r$ r$ r% __getitem__% s zCatalog.__getitem__c C s" t |tstd| j||j}| jj|}|r|jrN|j rN|j|_|j |_ t
t |j |j |_ t
t |j
|j
|_
t
t |j|j |_| j|jO _|}nx|dkrt|j j | _djdd |jD | _|j| _n>t |t
tfrt |j t
tfstdt|j || j|< dS )a Add or update the message with the specified ID.
>>> catalog = Catalog()
>>> catalog[u'foo'] = Message(u'foo')
>>> catalog[u'foo']
If a message with that ID is already in the catalog, it is updated
to include the locations and flags of the new message.
>>> catalog = Catalog()
>>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
>>> catalog[u'foo'].locations
[('main.py', 1)]
>>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
>>> catalog[u'foo'].locations
[('main.py', 1), ('utils.py', 5)]
:param id: the message ID
:param message: the `Message` object
zexpected a Message objectr' r c S s g | ]}d | j qS )z# %s)rstrip)rS cr$ r$ r%
U s z'Catalog.__setitem__..z Expected sequence but got %sN)r4 r AssertionErrorr r7 rh r r) r( r* r+ r
r, r2 r3 r. r` r\ r r rv rO rP r: )r8 r( messager Zcurrentr$ r$ r% __setitem__, s0
zCatalog.__setitem__c
C s* t ||t||||||| d }
|
| |< |
S )at Add or update the message with the specified ID.
>>> catalog = Catalog()
>>> catalog.add(u'foo')
>>> catalog[u'foo']
This method simply constructs a `Message` object with the given
arguments and invokes `__setitem__` with that object.
:param id: the message ID, or a ``(singular, plural)`` tuple for
pluralizable messages
:param string: the translated message string, or a
``(singular, plural)`` tuple for pluralizable messages
:param locations: a sequence of ``(filename, lineno)`` tuples
:param flags: a set or sequence of flags
:param auto_comments: a sequence of automatic comments
:param user_comments: a sequence of user comments
:param previous_id: the previous message ID, or a ``(singular, plural)``
tuple for pluralizable messages
:param lineno: the line number on which the msgid line was found in the
PO file, if any
:param context: the message context
)r6 r7 )r r+ ) r8 r( r* r, r. r2 r3 r5 r6 r7 r r$ r$ r% r0 ^ s
z Catalog.addc c s2 x,| j j D ] }|j| d}|r ||fV q W dS )aB Run various validation checks on the translations in the catalog.
For every message which fails validation, this method yield a
``(message, errors)`` tuple, where ``message`` is the `Message` object
and ``errors`` is a sequence of `TranslationError` objects.
:rtype: ``iterator``
)rK N)rh valuesrN )r8 r rL r$ r$ r% rN s z
Catalog.checkc C s | j j| j||S )zReturn the message with the specified ID and context.
:param id: the message ID
:param context: the message context, or ``None`` for no context
)rh r r )r8 r( r7 r$ r$ r% r s z Catalog.getc C s" | j ||}|| jkr | j|= dS )zDelete the message with the specified ID and context.
:param id: the message ID
:param context: the message context, or ``None`` for no context
N)r rh )r8 r( r7 r r$ r$ r% r s
zCatalog.deleteFc
sD j j t _ g }|s6tfddD }t fdd}x|D ]}|jrTj|j|j}|kr|||| qT|dkrt|t r|d }n|}t
|j j |j
d} | r| d }
||
} | dk r|
| f}
|||
| qT||j< qTW x,D ]$} |s| kr| j| < qW |r8|j_|j_dS ) a Update the catalog based on the given template catalog.
>>> from babel.messages import Catalog
>>> template = Catalog()
>>> template.add('green', locations=[('main.py', 99)])
>>> template.add('blue', locations=[('main.py', 100)])
>>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
>>> catalog = Catalog(locale='de_DE')
>>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
>>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
>>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
... locations=[('util.py', 38)])
>>> catalog.update(template)
>>> len(catalog)
3
>>> msg1 = catalog['green']
>>> msg1.string
>>> msg1.locations
[('main.py', 99)]
>>> msg2 = catalog['blue']
>>> msg2.string
u'blau'
>>> msg2.locations
[('main.py', 100)]
>>> msg3 = catalog['salad']
>>> msg3.string
(u'Salat', u'Salate')
>>> msg3.locations
[('util.py', 42)]
Messages that are in the catalog but not in the template are removed
from the main collection, but can still be accessed via the `obsolete`
member:
>>> 'head' in catalog
False
>>> list(catalog.obsolete.values())
[]
:param template: the reference catalog, usually read from a POT file
:param no_fuzzy_matching: whether to use fuzzy matching of message IDs
c s. g | ]&}|r | j rj| | jfqS r$ )r* r r7 )rS msgid)messagesr8 r$ r% r s z"Catalog.update..c s8 | j } d}||krRd} j| j|}t|jtrD|jg| _q^t|j| _n j|d }|j | _ t| jtt
frt| j tt
fsd}t
| j gdgt | jd | _ n.t | j j krd}t
| j d t |j | _ n"t| j tt
fr d}| j d | _ | j
|j
O _
|r*| j
tdgO _
| | j< d S )NFTr' r r rO )rH r0 r r4 r( r r5 r+ popr* rP r r r. r- )r ZoldkeynewkeyrO Zoldmsg)
fuzzy_matchesr remainingr8 r$ r% _merge s4
" z Catalog.update.._mergeFr r N)rh r r dictr- r( r r7 r4 rP r r stripkeysrs rv rq )
r8 templateZno_fuzzy_matchingZupdate_header_commentZfuzzy_candidatesr r r ZmatchkeyZmatchesr Znewctxtr r$ )r r r r8 r% update sF 5
zCatalog.updatec C s. |}t |ttfr|d }|dk r*||f}|S )zThe key for a message is just the singular ID even for pluralizable
messages, but is a ``(msgid, msgctxt)`` tuple for context-specific
messages.
r N)r4 r+ rP )r8 r( r7 r r$ r$ r% r % s zCatalog._key_for)N)N)FF)N) r; rV rW rX DEFAULT_HEADERr9 rz r{ rY rv r r r r r r r r r r< r r r r0 rN r r r r r$ r$ r$ r% r s@ 8 1 2
)+rX r r Zcgir r r Zdifflibr Zemailr r Zbabelr rb Z
babel.corer Z babel.datesr
Zbabel.messages.pluralsr Z
babel.utilr r
r r Z
babel._compatr r r r __all__compileVERBOSErQ r& objectr Exceptionr r r` r r$ r$ r$ r%
s2