File Manager

Editing File: /usr/share/doc/python-babel-0.9.6/doc/api/babel.messages.pofile-module.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.pofile</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> ::
 Module&nbsp;pofile
 
 </td>
 <td>
 <table cellpadding="0" cellspacing="0">
 
 </table>
 </td>
 </tr>
</table>

<h1 class="epydoc">Module pofile</h1>
Reading and writing of files in the <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">gettext</tt> PO (portable object)
format.

<hr />
<div class="fields"> See Also:
 <a class="rst-reference external" href="http://www.gnu.org/software/gettext/manual/gettext.html#PO-Files" target="_top">The Format of PO Files</a>
 
</div>
<a name="section-Functions"></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">
 Functions</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.pofile-module.html#read_po" class="summary-sig-name">read_po</a>(fileobj,
 locale=None,
 domain=None,
 ignore_obsolete=False) 
 Read messages from a <tt class="rst-docutils literal">gettext</tt> PO (portable object) file from the given
file-like object and return a <a href="babel.messages.catalog.Catalog-class.html" class="link">Catalog</a>.</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.pofile-module.html#write_po" class="summary-sig-name">write_po</a>(fileobj,
 catalog,
 width=76,
 no_location=False,
 omit_header=False,
 sort_output=False,
 sort_by_file=False,
 ignore_obsolete=False,
 include_previous=False) 
 Write a <tt class="rst-docutils literal">gettext</tt> PO (portable object) template file for a given
message catalog to the provided file-like object.</td>
 <td align="right" valign="top">
 
 
 </td>
 </tr>
 </table>
 
 </td>
 </tr>
</table>

<a name="section-FunctionDetails"></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">
 Function Details</td>
</tr>
</table>
<a name="read_po"></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">read_po(fileobj,
 locale=None,
 domain=None,
 ignore_obsolete=False)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Read messages from a <tt class="rst-rst-docutils literal rst-docutils literal">gettext</tt> PO (portable object) file from the given
file-like object and return a <a href="babel.messages.catalog.Catalog-class.html" class="link">Catalog</a>.
<pre class="py-doctest">
&gt;&gt;&gt; from StringIO import StringIO
&gt;&gt;&gt; buf = StringIO('''
... #: main.py:1
... #, fuzzy, python-format
... msgid &quot;foo %(name)s&quot;
... msgstr &quot;&quot;
...
... # A user comment
... #. An auto comment
... #: main.py:3
... msgid &quot;bar&quot;
... msgid_plural &quot;baz&quot;
... msgstr[0] &quot;&quot;
... msgstr[1] &quot;&quot;
... ''')
&gt;&gt;&gt; catalog = read_po(buf)
&gt;&gt;&gt; catalog.revision_date = datetime(2007, 04, 01)</pre>
<pre class="py-doctest">
&gt;&gt;&gt; for message in catalog:
... if message.id:
... print (message.id, message.string)
... print ' ', (message.locations, message.flags)
... print ' ', (message.user_comments, message.auto_comments)
(u'foo %(name)s', '')
 ([(u'main.py', 1)], set([u'fuzzy', u'python-format']))
 ([], [])
((u'bar', u'baz'), ('', ''))
 ([(u'main.py', 3)], set([]))
 ([u'A user comment'], [u'An auto comment'])</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>fileobj</code> - the file-like object to read the PO file from</li>
 <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>ignore_obsolete</code> - whether to ignore obsolete messages in the input</li>
 </ul></dd>
 <dt>Returns: <tt class="rst-rst-docutils literal rst-docutils literal">iterator</tt></dt>
 <dd>an iterator over <tt class="rst-docutils literal">(message, translation, location)</tt> tuples</dd>
 </dl>
</td></tr></table>
</div>
<a name="write_po"></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">write_po(fileobj,
 catalog,
 width=76,
 no_location=False,
 omit_header=False,
 sort_output=False,
 sort_by_file=False,
 ignore_obsolete=False,
 include_previous=False)
 </h3>
 </td><td align="right" valign="top"
 >&nbsp;
 </td>
 </tr></table>
 
 Write a <tt class="rst-rst-docutils literal rst-docutils literal">gettext</tt> PO (portable object) template file for a given
message catalog to the provided file-like object.
<pre class="py-doctest">
&gt;&gt;&gt; catalog = Catalog()
&gt;&gt;&gt; catalog.add(u'foo %(name)s', locations=[('main.py', 1)],
... flags=('fuzzy',))
&gt;&gt;&gt; catalog.add((u'bar', u'baz'), locations=[('main.py', 3)])
&gt;&gt;&gt; from StringIO import StringIO
&gt;&gt;&gt; buf = StringIO()
&gt;&gt;&gt; write_po(buf, catalog, omit_header=True)
&gt;&gt;&gt; print buf.getvalue()
#: main.py:1
#, fuzzy, python-format
msgid &quot;foo %(name)s&quot;
msgstr &quot;&quot;
&lt;BLANKLINE&gt;
#: main.py:3
msgid &quot;bar&quot;
msgid_plural &quot;baz&quot;
msgstr[0] &quot;&quot;
msgstr[1] &quot;&quot;
&lt;BLANKLINE&gt;
&lt;BLANKLINE&gt;</pre>
 <dl class="fields">
 <dt>Parameters:</dt>
 <dd><ul class="nomargin-top">
 <li><code>fileobj</code> - the file-like object to write to</li>
 <li><code>catalog</code> - the <a href="babel.messages.catalog.Catalog-class.html" class="link">Catalog</a> instance</li>
 <li><code>width</code> - the maximum line width for the generated output; use <code class="link">None</code>,
0, or a negative number to completely disable line wrapping</li>
 <li><code>no_location</code> - do not emit a location comment for every message</li>
 <li><code>omit_header</code> - do not include the <tt class="rst-docutils literal">msgid &quot;&quot;</tt> entry at the top of the
output</li>
 <li><code>sort_output</code> - whether to sort the messages in the output by msgid</li>
 <li><code>sort_by_file</code> - whether to sort the messages in the output by their
locations</li>
 <li><code>ignore_obsolete</code> - whether to ignore obsolete messages and not include
them in the output; by default they are included as
comments</li>
 <li><code>include_previous</code> - include the old msgid as a comment when
updating the catalog</li>
 </ul></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