File Manager

Editing File: /usr/share/doc/python-babel-0.9.6/doc/api/babel.messages.catalog.Catalog-class.html

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
 <title>babel.messages.catalog.Catalog</title>
 <link rel="stylesheet" href="epydoc.css" type="text/css" />
 <script type="text/javascript" src="epydoc.js"></script>
</head>

<th>&nbsp;&nbsp;&nbsp;<a
 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

<th class="navbar" align="right" width="100%">
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><th class="navbar" align="center"
 ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 </tr></table></th>
 </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
 <tr valign="top">
 <td width="100%">
 
 <a href="babel-module.html">Package&nbsp;babel</a> ::
 <a href="babel.messages-module.html">Package&nbsp;messages</a> ::
 <a href="babel.messages.catalog-module.html">Module&nbsp;catalog</a> ::
 Class&nbsp;Catalog
 
 </td>
 <td>
 <table cellpadding="0" cellspacing="0">
 
 </table>
 </td>
 </tr>
</table>

<h1 class="epydoc">Class Catalog</h1>
<pre class="base-tree">
object --+
 |
 Catalog
</pre>

<hr />
Representation of a message catalog.

<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Instance Methods</td>
</tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#__init__" class="summary-sig-name">__init__</a>(self,
 locale=None,
 domain=None,
 header_comment=<code class="variable-quote">u'</code><code class="variable-string"># Translations template for PROJE</code><code class="variable-ellipsis">...</code>,
 project=None,
 version=None,
 copyright_holder=None,
 msgid_bugs_address=None,
 creation_date=None,
 revision_date=None,
 last_translator=None,
 language_team=None,
 charset=<code class="variable-quote">'</code><code class="variable-string">utf-8</code><code class="variable-quote">'</code>,
 fuzzy=True) 
 Initialize the catalog object.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a name="__contains__"></a>__contains__(self,
 id) 
 Return whether the catalog has a message with the specified ID.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#__len__" class="summary-sig-name">__len__</a>(self) 
 The number of messages in the catalog.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <tt class="rst-docutils literal">iterator</tt>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a name="__iter__"></a>__iter__(self) 
 Iterates through all the entries in the catalog, in the order they
were added, yielding a <a href="babel.messages.catalog.Message-class.html" class="link">Message</a> object for every entry.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#__repr__" class="summary-sig-name">__repr__</a>(self) 
 repr(x)</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a name="__delitem__"></a>__delitem__(self,
 id) 
 Delete the message with the specified ID.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <a href="babel.messages.catalog.Message-class.html" class="link">Message</a>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(self,
 id) 
 Return the message with the specified ID.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#__setitem__" class="summary-sig-name">__setitem__</a>(self,
 id,
 message) 
 Add or update the message with the specified ID.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#add" class="summary-sig-name">add</a>(self,
 id,
 string=None,
 locations=<code class="variable-group">(</code><code class="variable-group">)</code>,
 flags=<code class="variable-group">(</code><code class="variable-group">)</code>,
 auto_comments=<code class="variable-group">(</code><code class="variable-group">)</code>,
 user_comments=<code class="variable-group">(</code><code class="variable-group">)</code>,
 previous_id=<code class="variable-group">(</code><code class="variable-group">)</code>,
 lineno=None) 
 Add or update the message with the specified ID.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <tt class="rst-docutils literal">iterator</tt>
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#check" class="summary-sig-name">check</a>(self) 
 Run various validation checks on the translations in the catalog.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr>
 <td><a href="babel.messages.catalog.Catalog-class.html#update" class="summary-sig-name">update</a>(self,
 template,
 no_fuzzy_matching=False) 
 Update the catalog based on the given template catalog.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
 <tr>
 <td colspan="2" class="summary">
 Inherited from <code>object</code>:
 <code>__delattr__</code>,
 <code>__format__</code>,
 <code>__getattribute__</code>,
 <code>__hash__</code>,
 <code>__new__</code>,
 <code>__reduce__</code>,
 <code>__reduce_ex__</code>,
 <code>__setattr__</code>,
 <code>__sizeof__</code>,
 <code>__str__</code>,
 <code>__subclasshook__</code>
 
 </td>
 </tr>
</table>

<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Instance Variables</td>
</tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="domain"></a>domain 
 The message domain
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="locale"></a>locale 
 The locale or <code class="link">None</code>
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="project"></a>project 
 The project name
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="version"></a>version 
 The project version
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="last_translator"></a>last_translator 
 Name and email address of the last translator.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="language_team"></a>language_team 
 Name and email address of the language team.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="creation_date"></a>creation_date 
 Creation date of the template
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="revision_date"></a>revision_date 
 Last revision date of the catalog
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="fuzzy"></a>fuzzy 
 Catalog header fuzzy bit (<code class="link">True</code> or <code class="link">False</code>)
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 &nbsp;
 </td><td class="summary">
 <a name="obsolete"></a>obsolete 
 Dictionary of obsolete messages
 </td>
 </tr>
</table>

<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Properties</td>
</tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">unicode</code>
 </td><td class="summary">
 <a href="babel.messages.catalog.Catalog-class.html#header_comment" class="summary-name">header_comment</a> 
 The header comment for the catalog.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">list</code>
 </td><td class="summary">
 <a href="babel.messages.catalog.Catalog-class.html#mime_headers" class="summary-name">mime_headers</a> 
 The MIME headers of the catalog, used for the special <tt class="rst-docutils literal">msgid &quot;&quot;</tt> entry.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">int</code>
 </td><td class="summary">
 <a href="babel.messages.catalog.Catalog-class.html#num_plurals" class="summary-name">num_plurals</a> 
 The number of plurals used by the catalog or locale.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">basestring</code>
 </td><td class="summary">
 <a href="babel.messages.catalog.Catalog-class.html#plural_expr" class="summary-name">plural_expr</a> 
 The plural expression used by the catalog or locale.
 </td>
 </tr>
<tr>
 <td width="15%" align="right" valign="top" class="summary">
 <code class="link">str</code>
 </td><td class="summary">
 <a href="babel.messages.catalog.Catalog-class.html#plural_forms" class="summary-name">plural_forms</a> 
 Return the plural forms declaration for the locale.
 </td>
 </tr>
 <tr>
 <td colspan="2" class="summary">
 Inherited from <code>object</code>:
 <code>__class__</code>
 
 </td>
 </tr>
</table>

<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Method Details</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">__init__(self,
 locale=None,
 domain=None,
 header_comment=<code class="variable-quote">u'</code><code class="variable-string"># Translations template for PROJE</code><code class="variable-ellipsis">...</code>,
 project=None,
 version=None,
 copyright_holder=None,
 msgid_bugs_address=None,
 creation_date=None,
 revision_date=None,
 last_translator=None,
 language_team=None,
 charset=<code class="variable-quote">'</code><code class="variable-string">utf-8</code><code class="variable-quote">'</code>,
 fuzzy=True)
 (Constructor)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Initialize the catalog object.
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>locale</code> - the locale identifier or <a href="babel.core.Locale-class.html" class="link">Locale</a> object, or <code class="link">None</code>
if the catalog is not bound to a locale (which basically
means it's a template)</li>
 <li><code>domain</code> - the message domain</li>
 <li><code>header_comment</code> - the header comment as string, or <code class="link">None</code> for the
default header</li>
 <li><code>project</code> - the project's name</li>
 <li><code>version</code> - the project's version</li>
 <li><code>copyright_holder</code> - the copyright holder of the catalog</li>
 <li><code>msgid_bugs_address</code> - the email address or URL to submit bug
reports to</li>
 <li><code>creation_date</code> - the date the catalog was created</li>
 <li><code>revision_date</code> - the date the catalog was revised</li>
 <li><code>last_translator</code> - the name and email of the last translator</li>
 <li><code>language_team</code> - the name and email of the language team</li>
 <li><code>charset</code> - the encoding to use in the output</li>
 <li><code>fuzzy</code> - the fuzzy bit on the catalog header</li>
 </ul></dd>
 <dt>Overrides:
 object.__init__
 </dt>
 </dl>
</td></tr></table>
</div>
<a name="__len__"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">__len__(self)
 (Length operator)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 The number of messages in the catalog.
This does not include the special <tt class="rst-docutils literal">msgid &quot;&quot;</tt> entry.
 <dl class="fields">
 </dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">__repr__(self)
 (Representation operator)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 repr(x)
 <dl class="fields">
 <dt>Overrides:
 object.__repr__
 <dd>(inherited documentation)</dd>
 </dt>
 </dl>
</td></tr></table>
</div>
<a name="__getitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">__getitem__(self,
 id)
 (Indexing operator)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Return the message with the specified ID.
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>id</code> - the message ID</li>
 </ul></dd>
 <dt>Returns: <a href="babel.messages.catalog.Message-class.html" class="link">Message</a></dt>
 <dd>the message with the specified ID, or <code class="link">None</code> if no such message
is in the catalog</dd>
 </dl>
</td></tr></table>
</div>
<a name="__setitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">__setitem__(self,
 id,
 message)
 (Index assignment operator)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Add or update the message with the specified ID.
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog()
&gt;&gt;&gt; catalog[u'foo'] = Message(u'foo')
&gt;&gt;&gt; catalog[u'foo']
&lt;Message u'foo' (flags: [])&gt;</pre>
If a message with that ID is already in the catalog, it is updated
to include the locations and flags of the new message.
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog()
&gt;&gt;&gt; catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
&gt;&gt;&gt; catalog[u'foo'].locations
[('main.py', 1)]
&gt;&gt;&gt; catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
&gt;&gt;&gt; catalog[u'foo'].locations
[('main.py', 1), ('utils.py', 5)]</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>id</code> - the message ID</li>
 <li><code>message</code> - the <a href="babel.messages.catalog.Message-class.html" class="link">Message</a> object</li>
 </ul></dd>
 </dl>
</td></tr></table>
</div>
<a name="add"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">add(self,
 id,
 string=None,
 locations=<code class="variable-group">(</code><code class="variable-group">)</code>,
 flags=<code class="variable-group">(</code><code class="variable-group">)</code>,
 auto_comments=<code class="variable-group">(</code><code class="variable-group">)</code>,
 user_comments=<code class="variable-group">(</code><code class="variable-group">)</code>,
 previous_id=<code class="variable-group">(</code><code class="variable-group">)</code>,
 lineno=None)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Add or update the message with the specified ID.
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog()
&gt;&gt;&gt; catalog.add(u'foo')
&gt;&gt;&gt; catalog[u'foo']
&lt;Message u'foo' (flags: [])&gt;</pre>
This method simply constructs a <a href="babel.messages.catalog.Message-class.html" class="link">Message</a> object with the given
arguments and invokes <a href="babel.messages.catalog.Catalog-class.html#__setitem__" class="link">__setitem__</a> with that object.
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>id</code> - the message ID, or a <tt class="rst-docutils literal">(singular, plural)</tt> tuple for
pluralizable messages</li>
 <li><code>string</code> - the translated message string, or a
<tt class="rst-docutils literal">(singular, plural)</tt> tuple for pluralizable messages</li>
 <li><code>locations</code> - a sequence of <tt class="rst-docutils literal">(filenname, lineno)</tt> tuples</li>
 <li><code>flags</code> - a set or sequence of flags</li>
 <li><code>auto_comments</code> - a sequence of automatic comments</li>
 <li><code>user_comments</code> - a sequence of user comments</li>
 <li><code>previous_id</code> - the previous message ID, or a <tt class="rst-docutils literal">(singular, plural)</tt>
tuple for pluralizable messages</li>
 <li><code>lineno</code> - the line number on which the msgid line was found in the
PO file, if any</li>
 </ul></dd>
 </dl>
</td></tr></table>
</div>
<a name="check"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">check(self)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Run various validation checks on the translations in the catalog.
For every message which fails validation, this method yield a
<tt class="rst-docutils literal">(message, errors)</tt> tuple, where <tt class="rst-docutils literal">message</tt> is the <a href="babel.messages.catalog.Message-class.html" class="link">Message</a> object
and <tt class="rst-docutils literal">errors</tt> is a sequence of <a href="babel.messages.catalog.TranslationError-class.html" class="link">TranslationError</a> objects.
 <dl class="fields">
 <dt>Returns: <tt class="rst-rst-docutils literal rst-docutils literal">iterator</tt></dt>
 </dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <table width="100%" cellpadding="0" cellspacing="0" border="0">
 <tr valign="top"><td>
 <h3 class="epydoc">update(self,
 template,
 no_fuzzy_matching=False)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Update the catalog based on the given template catalog.
<pre class="py-doctest">
&gt;&gt;&gt; from babel.messages import Catalog
&gt;&gt;&gt; template = Catalog()
&gt;&gt;&gt; template.add('green', locations=[('main.py', 99)])
&gt;&gt;&gt; template.add('blue', locations=[('main.py', 100)])
&gt;&gt;&gt; template.add(('salad', 'salads'), locations=[('util.py', 42)])
&gt;&gt;&gt; catalog = Catalog(locale='de_DE')
&gt;&gt;&gt; catalog.add('blue', u'blau', locations=[('main.py', 98)])
&gt;&gt;&gt; catalog.add('head', u'Kopf', locations=[('util.py', 33)])
&gt;&gt;&gt; catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
... locations=[('util.py', 38)])</pre>
<pre class="py-doctest">
&gt;&gt;&gt; catalog.update(template)
&gt;&gt;&gt; len(catalog)
3</pre>
<pre class="py-doctest">
&gt;&gt;&gt; msg1 = catalog['green']
&gt;&gt;&gt; msg1.string
&gt;&gt;&gt; msg1.locations
[('main.py', 99)]</pre>
<pre class="py-doctest">
&gt;&gt;&gt; msg2 = catalog['blue']
&gt;&gt;&gt; msg2.string
u'blau'
&gt;&gt;&gt; msg2.locations
[('main.py', 100)]</pre>
<pre class="py-doctest">
&gt;&gt;&gt; msg3 = catalog['salad']
&gt;&gt;&gt; msg3.string
(u'Salat', u'Salate')
&gt;&gt;&gt; msg3.locations
[('util.py', 42)]</pre>
Messages that are in the catalog but not in the template are removed
from the main collection, but can still be accessed via the <a href="babel.messages.catalog.Catalog-class.html#obsolete" class="link">obsolete</a>
member:
<pre class="py-doctest">
&gt;&gt;&gt; 'head' in catalog
False
&gt;&gt;&gt; catalog.obsolete.values()
[&lt;Message 'head' (flags: [])&gt;]</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>template</code> - the reference catalog, usually read from a POT file</li>
 <li><code>no_fuzzy_matching</code> - whether to use fuzzy matching of message IDs</li>
 </ul></dd>
 </dl>
</td></tr></table>
</div>
 

<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
 <td align="left" colspan="2" class="table-header">
 Property Details</td>
</tr>
</table>
<a name="header_comment"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <h3 class="epydoc">header_comment</h3>
 The header comment for the catalog.
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog(project='Foobar', version='1.0',
... copyright_holder='Foo Company')
&gt;&gt;&gt; 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 &lt;EMAIL@ADDRESS&gt;, ....
#</pre>
The header can also be set from a string. Any known upper-case variables
will be replaced when the header is retrieved again:
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog(project='Foobar', version='1.0',
... copyright_holder='Foo Company')
&gt;&gt;&gt; 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.
... #'''
&gt;&gt;&gt; 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.
#</pre>
 <dl class="fields">
 <dt>Get Method:</dt>
 <dd class="value"><a href="babel.messages.catalog.Catalog-class.html#_get_header_comment" class="summary-sig-name" onclick="show_private();">_get_header_comment</a>(self)
 </dd>
 <dt>Set Method:</dt>
 <dd class="value"><a href="babel.messages.catalog.Catalog-class.html#_set_header_comment" class="summary-sig-name" onclick="show_private();">_set_header_comment</a>(self,
 string)
 </dd>
 <dt>Type:</dt>
 <dd><code class="link">unicode</code></dd>
 </dl>
</td></tr></table>
</div>
<a name="mime_headers"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <h3 class="epydoc">mime_headers</h3>
 The MIME headers of the catalog, used for the special <tt class="rst-rst-docutils literal rst-docutils literal">msgid &quot;&quot;</tt> 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:
<pre class="py-doctest">
&gt;&gt;&gt; created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
&gt;&gt;&gt; catalog = Catalog(project='Foobar', version='1.0',
... creation_date=created)
&gt;&gt;&gt; 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 &lt;EMAIL@ADDRESS&gt;
Language-Team: LANGUAGE &lt;LL@li.org&gt;
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Generated-By: Babel ...</pre>
And here's an example of the output when the locale is set:
<pre class="py-doctest">
&gt;&gt;&gt; revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
&gt;&gt;&gt; catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
... creation_date=created, revision_date=revised,
... last_translator='John Doe &lt;jd@example.com&gt;',
... language_team='de_DE &lt;de@example.com&gt;')
&gt;&gt;&gt; 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 &lt;jd@example.com&gt;
Language-Team: de_DE &lt;de@example.com&gt;
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 ...</pre>
 <dl class="fields">
 <dt>Get Method:</dt>
 <dd class="value"><a href="babel.messages.catalog.Catalog-class.html#_get_mime_headers" class="summary-sig-name" onclick="show_private();">_get_mime_headers</a>(self)
 </dd>
 <dt>Set Method:</dt>
 <dd class="value"><a href="babel.messages.catalog.Catalog-class.html#_set_mime_headers" class="summary-sig-name" onclick="show_private();">_set_mime_headers</a>(self,
 headers)
 </dd>
 <dt>Type:</dt>
 <dd><code class="link">list</code></dd>
 </dl>
</td></tr></table>
</div>
<a name="num_plurals"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <h3 class="epydoc">num_plurals</h3>
 The number of plurals used by the catalog or locale.
<pre class="py-doctest">
&gt;&gt;&gt; Catalog(locale='en').num_plurals
2
&gt;&gt;&gt; Catalog(locale='ga').num_plurals
3</pre>
 <dl class="fields">
 <dt>Get Method:</dt>
 <dd class="value">unreachable.num_plurals(self)
 </dd>
 <dt>Type:</dt>
 <dd><code class="link">int</code></dd>
 </dl>
</td></tr></table>
</div>
<a name="plural_expr"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <h3 class="epydoc">plural_expr</h3>
 The plural expression used by the catalog or locale.
<pre class="py-doctest">
&gt;&gt;&gt; Catalog(locale='en').plural_expr
'(n != 1)'
&gt;&gt;&gt; Catalog(locale='ga').plural_expr
'(n==1 ? 0 : n==2 ? 1 : 2)'</pre>
 <dl class="fields">
 <dt>Get Method:</dt>
 <dd class="value">unreachable.plural_expr(self)
 </dd>
 <dt>Type:</dt>
 <dd><code class="link">basestring</code></dd>
 </dl>
</td></tr></table>
</div>
<a name="plural_forms"></a>
<div>
<table class="details" border="1" cellpadding="3"
 cellspacing="0" width="100%" bgcolor="white">
<tr><td>
 <h3 class="epydoc">plural_forms</h3>
 Return the plural forms declaration for the locale.
<pre class="py-doctest">
&gt;&gt;&gt; Catalog(locale='en').plural_forms
'nplurals=2; plural=(n != 1)'
&gt;&gt;&gt; Catalog(locale='pt_BR').plural_forms
'nplurals=2; plural=(n &gt; 1)'</pre>
 <dl class="fields">
 <dt>Get Method:</dt>
 <dd class="value">unreachable.plural_forms(self)
 </dd>
 <dt>Type:</dt>
 <dd><code class="link">str</code></dd>
 </dl>
</td></tr></table>
</div>
 

<table class="navbar" border="0" width="100%" cellpadding="0"
 bgcolor="#a0c0ff" cellspacing="0">
 <tr valign="middle">
 
 <th>&nbsp;&nbsp;&nbsp;<a
 href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<th>&nbsp;&nbsp;&nbsp;<a
 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

Back to Directory File Manager