python-polib-doc 1.0.5-1 / usr / share / doc / python-polib-doc / html / api.html

This file is indexed.

/usr/share/doc/python-polib-doc/html/api.html is in python-polib-doc 1.0.5-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>polib API &mdash; polib 1.0.5 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0.5',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="polib 1.0.5 documentation" href="index.html" />
    <link rel="next" title="Contributing to polib" href="contributing.html" />
    <link rel="prev" title="Installation guide" href="installation.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="contributing.html" title="Contributing to polib"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="installation.html" title="Installation guide"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">polib 1.0.5 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="polib-api">
<span id="api"></span><h1>polib API<a class="headerlink" href="#polib-api" title="Permalink to this headline"></a></h1>
<div class="section" id="the-pofile-function">
<h2>The <tt class="docutils literal"><span class="pre">pofile</span></tt> function<a class="headerlink" href="#the-pofile-function" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polib.pofile">
<tt class="descclassname">polib.</tt><tt class="descname">pofile</tt><big>(</big><em>pofile</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#pofile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.pofile" title="Permalink to this definition"></a></dt>
<dd><p>Convenience function that parses the po or pot file <tt class="docutils literal"><span class="pre">pofile</span></tt> and returns
a <a class="reference internal" href="#polib.POFile" title="polib.POFile"><tt class="xref py py-class docutils literal"><span class="pre">POFile</span></tt></a> instance.</p>
<p>Arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">pofile</span></tt></dt>
<dd>string, full or relative path to the po/pot file or its content (data).</dd>
<dt><tt class="docutils literal"><span class="pre">wrapwidth</span></tt></dt>
<dd>integer, the wrap width, only useful when the <tt class="docutils literal"><span class="pre">-w</span></tt> option was passed
to xgettext (optional, default: <tt class="docutils literal"><span class="pre">78</span></tt>).</dd>
<dt><tt class="docutils literal"><span class="pre">encoding</span></tt></dt>
<dd>string, the encoding to use (e.g. &#8220;utf-8&#8221;) (default: <tt class="docutils literal"><span class="pre">None</span></tt>, the
encoding will be auto-detected).</dd>
<dt><tt class="docutils literal"><span class="pre">check_for_duplicates</span></tt></dt>
<dd>whether to check for duplicate entries when adding entries to the
file (optional, default: <tt class="docutils literal"><span class="pre">False</span></tt>).</dd>
<dt><tt class="docutils literal"><span class="pre">klass</span></tt></dt>
<dd>class which is used to instantiate the return value (optional,
default: <tt class="docutils literal"><span class="pre">None</span></tt>, the return value with be a <a class="reference internal" href="#polib.POFile" title="polib.POFile"><tt class="xref py py-class docutils literal"><span class="pre">POFile</span></tt></a>
instance).</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="the-mofile-function">
<h2>The <tt class="docutils literal"><span class="pre">mofile</span></tt> function<a class="headerlink" href="#the-mofile-function" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polib.mofile">
<tt class="descclassname">polib.</tt><tt class="descname">mofile</tt><big>(</big><em>mofile</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#mofile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.mofile" title="Permalink to this definition"></a></dt>
<dd><p>Convenience function that parses the mo file <tt class="docutils literal"><span class="pre">mofile</span></tt> and returns a
<a class="reference internal" href="#polib.MOFile" title="polib.MOFile"><tt class="xref py py-class docutils literal"><span class="pre">MOFile</span></tt></a> instance.</p>
<p>Arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">mofile</span></tt></dt>
<dd>string, full or relative path to the mo file or its content (data).</dd>
<dt><tt class="docutils literal"><span class="pre">wrapwidth</span></tt></dt>
<dd>integer, the wrap width, only useful when the <tt class="docutils literal"><span class="pre">-w</span></tt> option was passed
to xgettext to generate the po file that was used to format the mo file
(optional, default: <tt class="docutils literal"><span class="pre">78</span></tt>).</dd>
<dt><tt class="docutils literal"><span class="pre">encoding</span></tt></dt>
<dd>string, the encoding to use (e.g. &#8220;utf-8&#8221;) (default: <tt class="docutils literal"><span class="pre">None</span></tt>, the
encoding will be auto-detected).</dd>
<dt><tt class="docutils literal"><span class="pre">check_for_duplicates</span></tt></dt>
<dd>whether to check for duplicate entries when adding entries to the
file (optional, default: <tt class="docutils literal"><span class="pre">False</span></tt>).</dd>
<dt><tt class="docutils literal"><span class="pre">klass</span></tt></dt>
<dd>class which is used to instantiate the return value (optional,
default: <tt class="docutils literal"><span class="pre">None</span></tt>, the return value with be a <a class="reference internal" href="#polib.POFile" title="polib.POFile"><tt class="xref py py-class docutils literal"><span class="pre">POFile</span></tt></a>
instance).</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="the-detect-encoding-function">
<h2>The <tt class="docutils literal"><span class="pre">detect_encoding</span></tt> function<a class="headerlink" href="#the-detect-encoding-function" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polib.detect_encoding">
<tt class="descclassname">polib.</tt><tt class="descname">detect_encoding</tt><big>(</big><em>file</em>, <em>binary_mode=False</em><big>)</big><a class="reference internal" href="_modules/polib.html#detect_encoding"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.detect_encoding" title="Permalink to this definition"></a></dt>
<dd><p>Try to detect the encoding used by the <tt class="docutils literal"><span class="pre">file</span></tt>. The <tt class="docutils literal"><span class="pre">file</span></tt> argument can
be a PO or MO file path or a string containing the contents of the file.
If the encoding cannot be detected, the function will return the value of
<tt class="docutils literal"><span class="pre">default_encoding</span></tt>.</p>
<p>Arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">file</span></tt></dt>
<dd>string, full or relative path to the po/mo file or its content.</dd>
<dt><tt class="docutils literal"><span class="pre">binary_mode</span></tt></dt>
<dd>boolean, set this to True if <tt class="docutils literal"><span class="pre">file</span></tt> is a mo file.</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="the-escape-function">
<h2>The <tt class="docutils literal"><span class="pre">escape</span></tt> function<a class="headerlink" href="#the-escape-function" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polib.escape">
<tt class="descclassname">polib.</tt><tt class="descname">escape</tt><big>(</big><em>st</em><big>)</big><a class="reference internal" href="_modules/polib.html#escape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.escape" title="Permalink to this definition"></a></dt>
<dd><p>Escapes the characters <tt class="docutils literal"><span class="pre">\\</span></tt>, <tt class="docutils literal"><span class="pre">\t</span></tt>, <tt class="docutils literal"><span class="pre">\n</span></tt>, <tt class="docutils literal"><span class="pre">\r</span></tt> and <tt class="docutils literal"><span class="pre">&quot;</span></tt> in
the given string <tt class="docutils literal"><span class="pre">st</span></tt> and returns it.</p>
</dd></dl>

</div>
<div class="section" id="the-unescape-function">
<h2>The <tt class="docutils literal"><span class="pre">unescape</span></tt> function<a class="headerlink" href="#the-unescape-function" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polib.unescape">
<tt class="descclassname">polib.</tt><tt class="descname">unescape</tt><big>(</big><em>st</em><big>)</big><a class="reference internal" href="_modules/polib.html#unescape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.unescape" title="Permalink to this definition"></a></dt>
<dd><p>Unescapes the characters <tt class="docutils literal"><span class="pre">\\</span></tt>, <tt class="docutils literal"><span class="pre">\t</span></tt>, <tt class="docutils literal"><span class="pre">\n</span></tt>, <tt class="docutils literal"><span class="pre">\r</span></tt> and <tt class="docutils literal"><span class="pre">&quot;</span></tt> in
the given string <tt class="docutils literal"><span class="pre">st</span></tt> and returns it.</p>
</dd></dl>

</div>
<div class="section" id="the-pofile-class">
<h2>The <tt class="docutils literal"><span class="pre">POFile</span></tt> class<a class="headerlink" href="#the-pofile-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="polib.POFile">
<em class="property">class </em><tt class="descclassname">polib.</tt><tt class="descname">POFile</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#POFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile" title="Permalink to this definition"></a></dt>
<dd><p>Po (or Pot) file reader/writer.
This class inherits the <tt class="xref py py-class docutils literal"><span class="pre">_BaseFile</span></tt> class and, by extension,
the python <tt class="docutils literal"><span class="pre">list</span></tt> type.</p>
<dl class="method">
<dt id="polib.POFile.fuzzy_entries">
<tt class="descname">fuzzy_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.fuzzy_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.fuzzy_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that returns the list of fuzzy entries.</p>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.merge">
<tt class="descname">merge</tt><big>(</big><em>refpot</em><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.merge" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that merges the current pofile with the pot file
provided. It behaves exactly as the gettext msgmerge utility:</p>
<ul class="simple">
<li>comments of this file will be preserved, but extracted comments and
occurrences will be discarded;</li>
<li>any translations or comments in the file will be discarded, however,
dot comments and file positions will be preserved;</li>
<li>the fuzzy flags are preserved.</li>
</ul>
<p>Keyword argument:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">refpot</span></tt></dt>
<dd>object POFile, the reference catalog.</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.obsolete_entries">
<tt class="descname">obsolete_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.obsolete_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.obsolete_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that returns the list of obsolete entries.</p>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.percent_translated">
<tt class="descname">percent_translated</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.percent_translated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.percent_translated" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that returns the percentage of translated
messages.</p>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.save_as_mofile">
<tt class="descname">save_as_mofile</tt><big>(</big><em>fpath</em><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.save_as_mofile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.save_as_mofile" title="Permalink to this definition"></a></dt>
<dd><p>Saves the binary representation of the file to given <tt class="docutils literal"><span class="pre">fpath</span></tt>.</p>
<p>Keyword argument:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">fpath</span></tt></dt>
<dd>string, full or relative path to the mo file.</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.translated_entries">
<tt class="descname">translated_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.translated_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.translated_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that returns the list of translated entries.</p>
</dd></dl>

<dl class="method">
<dt id="polib.POFile.untranslated_entries">
<tt class="descname">untranslated_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POFile.untranslated_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POFile.untranslated_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method that returns the list of untranslated entries.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-mofile-class">
<h2>The <tt class="docutils literal"><span class="pre">MOFile</span></tt> class<a class="headerlink" href="#the-mofile-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="polib.MOFile">
<em class="property">class </em><tt class="descclassname">polib.</tt><tt class="descname">MOFile</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile" title="Permalink to this definition"></a></dt>
<dd><p>Mo file reader/writer.
This class inherits the <tt class="xref py py-class docutils literal"><span class="pre">_BaseFile</span></tt> class and, by
extension, the python <tt class="docutils literal"><span class="pre">list</span></tt> type.</p>
<dl class="method">
<dt id="polib.MOFile.fuzzy_entries">
<tt class="descname">fuzzy_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.fuzzy_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.fuzzy_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method to keep the same interface with POFile instances.</p>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.obsolete_entries">
<tt class="descname">obsolete_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.obsolete_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.obsolete_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method to keep the same interface with POFile instances.</p>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.percent_translated">
<tt class="descname">percent_translated</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.percent_translated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.percent_translated" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method to keep the same interface with POFile instances.</p>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.save">
<tt class="descname">save</tt><big>(</big><em>fpath=None</em><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.save" title="Permalink to this definition"></a></dt>
<dd><p>Saves the mofile to <tt class="docutils literal"><span class="pre">fpath</span></tt>.</p>
<p>Keyword argument:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">fpath</span></tt></dt>
<dd>string, full or relative path to the file.</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.save_as_pofile">
<tt class="descname">save_as_pofile</tt><big>(</big><em>fpath</em><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.save_as_pofile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.save_as_pofile" title="Permalink to this definition"></a></dt>
<dd><p>Saves the mofile as a pofile to <tt class="docutils literal"><span class="pre">fpath</span></tt>.</p>
<p>Keyword argument:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">fpath</span></tt></dt>
<dd>string, full or relative path to the file.</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.translated_entries">
<tt class="descname">translated_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.translated_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.translated_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method to keep the same interface with POFile instances.</p>
</dd></dl>

<dl class="method">
<dt id="polib.MOFile.untranslated_entries">
<tt class="descname">untranslated_entries</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#MOFile.untranslated_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOFile.untranslated_entries" title="Permalink to this definition"></a></dt>
<dd><p>Convenience method to keep the same interface with POFile instances.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-poentry-class">
<h2>The <tt class="docutils literal"><span class="pre">POEntry</span></tt> class<a class="headerlink" href="#the-poentry-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="polib.POEntry">
<em class="property">class </em><tt class="descclassname">polib.</tt><tt class="descname">POEntry</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#POEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POEntry" title="Permalink to this definition"></a></dt>
<dd><p>Represents a po file entry.</p>
<dl class="method">
<dt id="polib.POEntry.merge">
<tt class="descname">merge</tt><big>(</big><em>other</em><big>)</big><a class="reference internal" href="_modules/polib.html#POEntry.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POEntry.merge" title="Permalink to this definition"></a></dt>
<dd><p>Merge the current entry with the given pot entry.</p>
</dd></dl>

<dl class="method">
<dt id="polib.POEntry.translated">
<tt class="descname">translated</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/polib.html#POEntry.translated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.POEntry.translated" title="Permalink to this definition"></a></dt>
<dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the entry has been translated or <tt class="docutils literal"><span class="pre">False</span></tt>
otherwise.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-moentry-class">
<h2>The <tt class="docutils literal"><span class="pre">MOEntry</span></tt> class<a class="headerlink" href="#the-moentry-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="polib.MOEntry">
<em class="property">class </em><tt class="descclassname">polib.</tt><tt class="descname">MOEntry</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/polib.html#MOEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#polib.MOEntry" title="Permalink to this definition"></a></dt>
<dd><p>Represents a mo file entry.</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">polib API</a><ul>
<li><a class="reference internal" href="#the-pofile-function">The <tt class="docutils literal"><span class="pre">pofile</span></tt> function</a></li>
<li><a class="reference internal" href="#the-mofile-function">The <tt class="docutils literal"><span class="pre">mofile</span></tt> function</a></li>
<li><a class="reference internal" href="#the-detect-encoding-function">The <tt class="docutils literal"><span class="pre">detect_encoding</span></tt> function</a></li>
<li><a class="reference internal" href="#the-escape-function">The <tt class="docutils literal"><span class="pre">escape</span></tt> function</a></li>
<li><a class="reference internal" href="#the-unescape-function">The <tt class="docutils literal"><span class="pre">unescape</span></tt> function</a></li>
<li><a class="reference internal" href="#the-pofile-class">The <tt class="docutils literal"><span class="pre">POFile</span></tt> class</a></li>
<li><a class="reference internal" href="#the-mofile-class">The <tt class="docutils literal"><span class="pre">MOFile</span></tt> class</a></li>
<li><a class="reference internal" href="#the-poentry-class">The <tt class="docutils literal"><span class="pre">POEntry</span></tt> class</a></li>
<li><a class="reference internal" href="#the-moentry-class">The <tt class="docutils literal"><span class="pre">MOEntry</span></tt> class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="installation.html"
                        title="previous chapter">Installation guide</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="contributing.html"
                        title="next chapter">Contributing to polib</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/api.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="contributing.html" title="Contributing to polib"
             >next</a> |</li>
        <li class="right" >
          <a href="installation.html" title="Installation guide"
             >previous</a> |</li>
        <li><a href="index.html">polib 1.0.5 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, David Jean Louis &lt;izimobil@gmail.com&gt;.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.