U \Sh@sUdZddlmZddlZddlZddlmZmZddlmZddl m Z ddl m Z ddl mZdd lmZdd lmZdd lmZdd lmZmZdd lmZddlmZddlmZmZm Z m!Z!erddl"m#Z#e$e%e$dfBe&e$BZ'de(d<dddddgZ)d4ddZ*e+dej,Z-ddd d!d"Z.dd#d$d%d&Z/Gd'ddZ0Gd(dde1Z2d)Z3dd*d$d+d,Z4d5d/dddd0d1d2Z5Gd3ddZ6dS)6z babel.messages.catalog ~~~~~~~~~~~~~~~~~~~~~~ Data structures for message catalogs. :copyright: (c) 2013-2025 by the Babel Team. :license: BSD, see LICENSE for more details. ) annotationsN)IterableIterator)copy)SequenceMatcher)message_from_string)nlargest) Formatter) TYPE_CHECKING) __version__)LocaleUnknownLocaleError)format_datetime) get_plural)LOCALTZFixedOffsetTimezone_cmpdistinct) TypeAlias.r _MessageIDDEFAULT_HEADER PYTHON_FORMATCatalogMessageTranslationError333333?cCs|dkstd|d|kr*dks:ntd|g}tdd}|||D]D}||||krV||krV||krV|||fqVt||}dd |DS) zA modified version of ``difflib.get_close_matches``. It just passes ``autojunk=False`` to the ``SequenceMatcher``, to work around https://github.com/python/cpython/issues/90825. rzn must be > 0: gg?zcutoff must be in [0.0, 1.0]: F)ZautojunkcSsg|] \}}|qSr).0ZscorexrrI/root/rtd-docs/venv/lib/python3.8/site-packages/babel/messages/catalog.py Asz%get_close_matches..) ValueErrorrZset_seq2Zset_seq1Zreal_quick_ratioZ quick_ratioratioappendr)word possibilitiesncutoffresultsrrrr get_close_matches*s"       r+z \% (?:\(([\w]*)\))? ( [-#0\ +]?(?:\*|[\d]+)? (?:\.(?:\*|[\d]+))? [hlL]? ) ([diouxXeEfFgGcrs%]) strboolstringreturncCsVd|kr dSt}z(d}||D]}|ddk r"d}q"Wntk rPYdSX|S)N{FT)r parser")r/fmtZfield_name_seentrrr _has_python_brace_formatPs  r6zdatetime.datetime)valuer0c Cstd|}tj|dd}|d}|dk r|d|dd}}|dd|dd}}t|d}t|} t|} | d } | | 7} | |9} t| }|j|d }|S) Nz+^(?P.*?)(?P[+-]\d{4})?$datetimez%Y-%m-%d %H:%Mtzoffsetrr21<tzinfo)rematchr8strptimegroupintrreplace) r7r@dtr9Z plus_minus_srestZhours_offset_sZ mins_offset_sZ plus_minusZ hours_offsetZ mins_offsetZnet_mins_offsetrrr _parse_datetime_headercs   rGc @s(eZdZdZd6dddddddd d d d d dZddddZdddddZdddddZdddddZdddddZ ddddd Z dddd!d"Z dddd#d$Z dddd%d&Z ddd'd(Zd7d)d*d+d,d-Zeddd.d/Zeddd0d1Zeddd2d3Zeddd4d5ZdS)8rz0Representation of a single message in a catalog.rNr_MessageID | NoneIterable[tuple[str, int]] Iterable[str] int | None str | NoneNone idr/ locationsflags auto_comments user_comments previous_idlinenocontextr0c Cs||_|s|jrd}||_tt||_t||_|rJ|jrJ|j dn |j d|rn|j rn|j dn |j dtt||_ 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 )rHrHz python-formatzpython-brace-formatN)rP pluralizabler/listrrQsetrR python_formatadddiscardpython_brace_formatrSrT isinstancer,rUrVrW) selfrPr/rQrRrSrTrUrVrWrrr __init__s&         zMessage.__init__r,r0cCs&dt|jd|jdt|jdS)N< z (flags: z)>)type__name__rPrYrRr`rrr __repr__szMessage.__repr__objectrCotherr0cCsdd}t||||S)z0Compare Messages, taking into account plural idscSs4t|tr$|jr$|jd|jp dfS|j|jp0dfS)NrrH)r_rrXrPrW)objrrr values_to_comparesz*Message.__cmp__..values_to_compare)r)r`rkrmrrr __cmp__szMessage.__cmp__r-cCs||dkSNrrnr`rkrrr __gt__szMessage.__gt__cCs||dkSrorprqrrr __lt__szMessage.__lt__cCs||dkSrorprqrrr __ge__szMessage.__ge__cCs||dkSrorprqrrr __le__szMessage.__le__cCs||dkSrorprqrrr __eq__szMessage.__eq__cCs||dkSrorprqrrr __ne__szMessage.__ne__cCst|tst|j|jkS)z[Checks whether messages are identical, taking into account all properties. )r_rAssertionError__dict__rqrrr is_identicalszMessage.is_identicalc Cs2ttt|j|j|j|j|j|j|j |j |j f SN) rmaprrPr/rQrRrSrTrUrVrWrgrrr clonesz Message.clonezCatalog | Nonezlist[TranslationError])catalogr0c CsZddlm}g}|D]@}z|||Wqtk rR}z||W5d}~XYqXq|S)aRun 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.checkersrrr$)r`r~rerrorscheckererrr checks z Message.checkcCs d|jkS)aWhether the translation is fuzzy. >>> Message('foo').fuzzy False >>> msg = Message('foo', 'foo', flags=['fuzzy']) >>> msg.fuzzy True >>> msg :type: `bool`fuzzyrRrgrrr rs z Message.fuzzycCst|jttfS)zWhether the message is plurizable. >>> Message('foo').pluralizable False >>> Message(('foo', 'bar')).pluralizable True :type: `bool`)r_rPrYtuplergrrr rXs zMessage.pluralizablecCs,|j}t|ttfs|g}tdd|DS)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`css|]}t|VqdSr{)rsearchrrPrrr sz(Message.python_format..rPr_rYranyr`Zidsrrr r[s zMessage.python_formatcCs,|j}t|ttfs|g}tdd|DS)zWhether the message contains Python f-string parameters. >>> Message('Hello, {name}!').python_brace_format True >>> Message(('One apple', '{count} apples')).python_brace_format True :type: `bool`css|]}t|VqdSr{)r6rrrr r+sz.Message.python_brace_format..rrrrr r^s zMessage.python_brace_format)rHrrrrrNN)N)rf __module__ __qualname____doc__rarhrnrrrsrtrurvrwrzr}rpropertyrrXr[r^rrrr rs:"3 c@seZdZdZdS)rz_Exception thrown by translation checkers when invalid message translations are encountered.N)rfrrrrrrr r.sz# Translations template for PROJECT. # Copyright (C) YEAR ORGANIZATION # This file is distributed under the same license as the PROJECT project. # FIRST AUTHOR , YEAR. #zdict[str, str]cCs&ddlm}|}||d<t|S)Nr)r content-type) email.messagerdict get_params)r7rmrrr parse_separated_header;s rutf-8strictz str | bytes)r*encodingrr0cCs,t|tr|St|tr$|||St|Sr{)r_r,bytesdecode)r*rrrrr _force_textCs    rc@s2eZdZdZddeddddddddddf dddddddddddddd d d d Zdd d ddZddddZddddZe eeZ e eZ ddddZ dd dddZ e e e ddZdddd Zd!d d"d#d$Ze eed%dZe d&dd'd(Ze ddd)d*Ze ddd+d,Zd-dd.d/d0Zd&dd1d2Zd3dd4d5Zddd6d7Zd-d d.d8d9Zd-d:d.d;d<Zd-d:d d=d>d?Zd^d-dAdBdCdCdCd-dDdd:dE dFdGZdHddIdJZd_d-ddKdLdMdNZd`d-dd dLdOdPZdadddddd dRdSdTZ dUddVdWdXZ!dbd-ddUdLdYdZZ"ddd[d\d]Z#dS)crz$Representation of a message catalog.NTzLocale | str | NonerMzdatetime.datetime | str | Nonez6datetime.datetime | datetime.time | float | str | Noner-rN)localedomainheader_commentprojectversioncopyright_holdermsgid_bugs_address creation_date revision_datelast_translator language_teamcharsetrr0cCs||_||_||_i|_|pd|_|p(d|_|p2d|_|pzLANGUAGE rNr=zYEAR-MO-DA HO:MI+ZONE)rr_header_comment _messagesrrrrrrrr8nowrr_r>rDrrrobsolete _num_plurals _plural_expr)r`rrrrrrrrrrrrrrrr raNs2$         zCatalog.__init__)rr0cCs|dkrd|_d|_dSt|tr6t||_||_dSt|trzt||_zt||_Wntk rtd|_YnXdStd|dS)NzD`locale` must be a Locale, a locale identifier string, or None; got )_locale_identifier_localer_r r,r3r TypeErrorr`rrrr _set_locales      zCatalog._set_localez Locale | NonerbcCs|jSr{)rrgrrr _get_localeszCatalog._get_localecCs|jSr{)rrgrrr _get_locale_identifierszCatalog._get_locale_identifierr,cCs|j}tjtd}t|jdr0|jd}|d|jd|j d|d|j }|j rh|j j n|j }|r|d|d}|S) Nz%YstrftimerrYEARrzTranslations templatez translations)rr8rrrhasattrrrDrrrrZ english_namelocale_identifier)r`commentyearZ locale_namerrr _get_header_comments$  zCatalog._get_header_commentr.cCs ||_dSr{)r)r`r/rrr _set_header_commentszCatalog._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` )doczlist[tuple[str, str]]cCst|jtjtjttfr*t|jddd}n|j}|j}|jrVd|krV| dt |j}d|j d|j fd|j fdt|jdddfd |fd |jfg}|jr|d t |jf|d |f|jdk r|d |jf|ddd|jfdddtdfg7}|S)Nzyyyy-MM-dd HH:mmZen)rLANGUAGEzProject-Id-VersionrdzReport-Msgid-Bugs-TozPOT-Creation-DatezPO-Revision-DatezLast-TranslatorZLanguagez Language-Teamz Plural-Forms)z MIME-Versionz1.0z Content-Typeztext/plain; charset=)zContent-Transfer-Encoding8bitz Generated-ByzBabel  )r_rr8timerCfloatrrrrDr,rrrrrr$r plural_formsrr)r`rrheadersrrr _get_mime_headerss0 zCatalog._get_mime_headerszIterable[tuple[str, str]])rr0cCsL|D]@\}}t||jd}t||jd}|dkr`|d}d|dd|_|d|_q|dkrp||_q|dkr||_q|dkr| dd }| |pdq|d kr||_ q|d krt |}d |kr|d |_q|d krt d|}t |dd|_|dd|_q|dkr,t||_q|dkrd|krt||_qdS)N)rzproject-id-versionrdzreport-msgid-bugs-tozlast-translatorlanguage-_z language-teamrrz plural-formsz ;Znpluralsr:plural(n != 1)zpot-creation-datezpo-revision-dater)rlowerrsplitjoinrrrrrDrrrrCgetrrrGrr)r`rnamer7partsparamsrrr _set_mime_headerss:      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 >>> from datetime import datetime >>> 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` rCcCs.|jdkr(d}|jr"t|jd}||_|jS)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)rrr)r`numrrr num_pluralsZs zCatalog.num_pluralscCs.|jdkr(d}|jr"t|jd}||_|jS)aWThe 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)' >>> Catalog(locale='ding').plural_expr # unknown locale '(n != 1)' :type: `str`Nrr2)rrr)r`exprrrr plural_exprks zCatalog.plural_exprcCsd|jd|jdS)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`z nplurals=z ; plural=;)rrrgrrr r~s zCatalog.plural_formsr)rPr0cCs|||jkS)z?Return whether the catalog has a message with the specified ID._key_forrr`rPrrr __contains__szCatalog.__contains__cCs t|jS)zeThe number of messages in the catalog. This does not include the special ``msgid ""`` entry.)lenrrgrrr __len__szCatalog.__len__zIterator[Message]ccspg}|jD]\}}||d|q t}|jr>|dhO}tdd||dV|jD]}|j|VqZdS)zIterates through all the entries in the catalog, in the order they were added, yielding a `Message` object for every entry. :rtype: ``iterator``z: rrHrrN) mime_headersr$rZrrrr)r`bufrr7rRkeyrrr __iter__s  zCatalog.__iter__cCs4d}|jrd|j}dt|jd|j|dS)NrHrdrc>)rrerfrrrrr rhs zCatalog.__repr__cCs||dS)z)Delete the message with the specified ID.N)deleterrrr __delitem__szCatalog.__delitem__rcCs ||S)zUReturn the message with the specified ID. :param id: the message ID )rrrrr __getitem__szCatalog.__getitem__)rPmessager0cCst|tstd|||j}|j|}|r|jrL|jsL|j|_|j |_ t t |j |j |_ t t |j |j |_ t t |j|j|_|j|jO_nz|dkrt|j |_ddd|jD|_|j|_n@t|t tfrt|j t tfstdt|j ||j|<dS)aAdd 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 objectrHrcSsg|]}d|qS)z# )rstrip)rcrrr r!sz'Catalog.__setitem__..zExpected sequence but got N)r_rrxrrWrrrXrPr/rYrrQrSrTrRritemsrrrrrre)r`rPrrcurrentrrr __setitem__s4      zCatalog.__setitem__rrIrJrKrLrOc Cs*t||t||||||| d } | ||<| S)atAdd 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 )rVrW)rrY) r`rPr/rQrRrSrTrUrVrWrrrr r\s%z Catalog.addz0Iterable[tuple[Message, list[TranslationError]]]ccs.|jD]}|j|d}|r ||fVq dS)a\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: ``generator`` of ``(message, errors)`` )r~N)rvaluesr)r`rrrrr rs  z Catalog.checkzMessage | None)rPrWr0cCs|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 )rrr)r`rPrWrrr rsz Catalog.getcCs"|||}||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 Nrr`rPrWrrrr r%s  zCatalog.deleteF)templateno_fuzzy_matchingupdate_header_commentkeep_user_commentsupdate_creation_dater0cs^ji_i}|sZD]8}|r |jr |}|j} || f||<q tdddddfdd } |D]} | jr| j| j}|kr| | ||q|st|| d} | r| d} || \}}|d k r||f}| | ||q| | j<qD]$}|s,|kr|j |<q|rL|j _ |rZ|j _ d S) aUpdate 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 :param update_header_comment: whether to copy the header comment from the template :param keep_user_comments: whether to keep user comments from the old catalog :param update_creation_date: whether to copy the creation date from the template rtuple[str, str] | strrN)roldkeynewkeyr0csd|}d}||kr^d}||}|dk s8tt|jtrP|jg|_qvt|j|_n |d}|dk svt|j |_ rtt |j |_ t|jtt frt|j tt fsd}t |j gdgt|jd|_ n0t|j jkr0d}t |j dt|j |_ n"t|j tt fr0d}|j d|_ |j|jO_|rV|jdhO_||j<dS)NFTrHr2rr)r}r\rrxr_rPr,rUrYpopr/rrTrrrrR)rrrrZoldmsgZ fuzzy_matchesrmessages remainingr`rr _merge|s>        zCatalog.update.._merger2rN) rrr/rrW_to_fuzzy_match_keyrZrPr+keysrrr)r`rrrrrZfuzzy_candidatesmsgidrZctxtrrmatchesZ modified_keyrZnewctxtrrr update/sL?   %   zCatalog.updater)rr0cCs$t|tr|d}n|}|S)z?Converts a message key to a string suitable for fuzzy matching.r)r_rrstrip)r`rZmatchkeyrrr rs  zCatalog._to_fuzzy_match_keycCs.|}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. rN)r_rYrrrrr rs zCatalog._key_forrjcCspt|tst|j|jBD]8}||}||}|dksT|dksT||s"dSq"t|jt|jkS)z\Checks if catalogs are identical, taking into account messages and headers. NF) r_rrxrrrrzrr)r`rkrZ message_1Z message_2rrr rzs  zCatalog.is_identical)NrrrrrNN)N)N)FFTT)N)$rfrrrrrarrrrrrrrrrrrrrrrrrrhrrrr\rrrrrrrzrrrr rKsx*F !$4 3"+  )rr)rr)7r __future__rr8r?collections.abcrrrdifflibremailrheapqrr/r typingr Zbabelr rZ babel.corer r Z babel.datesrZbabel.messages.pluralsrZ babel.utilrrrrtyping_extensionsrr,rrYr__annotations____all__r+compileVERBOSErr6rGr Exceptionrrrrrrrrr sJ               .