← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-babel/trusty

« back to all changes in this revision

Viewing changes to doc/api/babel.messages.frontend.update_catalog-class.html

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2013-10-28 10:11:31 UTC
  • mfrom: (4.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131028101131-zwbmm8sc29iemmlr
Tags: 1.3-2ubuntu1
* Merge from Debian unstable.  Remaining changes:
  - debian/rules: Run the testsuite during builds.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/babel.messages.frontend.update_catalog-class.html
1
 
<?xml version="1.0" encoding="ascii"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>babel.messages.frontend.update_catalog</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8
 
  <script type="text/javascript" src="epydoc.js"></script>
9
 
</head>
10
 
 
11
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
 
      alink="#204080">
13
 
<!-- ==================== NAVIGATION BAR ==================== -->
14
 
<table class="navbar" border="0" width="100%" cellpadding="0"
15
 
       bgcolor="#a0c0ff" cellspacing="0">
16
 
  <tr valign="middle">
17
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
33
 
  <!-- Project homepage -->
34
 
      <th class="navbar" align="right" width="100%">
35
 
        <table border="0" cellpadding="0" cellspacing="0">
36
 
          <tr><th class="navbar" align="center"
37
 
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
38
 
          </tr></table></th>
39
 
  </tr>
40
 
</table>
41
 
<table width="100%" cellpadding="0" cellspacing="0">
42
 
  <tr valign="top">
43
 
    <td width="100%">
44
 
      <span class="breadcrumbs">
45
 
        <a href="babel-module.html">Package&nbsp;babel</a> ::
46
 
        <a href="babel.messages-module.html">Package&nbsp;messages</a> ::
47
 
        <a href="babel.messages.frontend-module.html">Module&nbsp;frontend</a> ::
48
 
        Class&nbsp;update_catalog
49
 
      </span>
50
 
    </td>
51
 
    <td>
52
 
      <table cellpadding="0" cellspacing="0">
53
 
        <!-- hide/show private -->
54
 
      </table>
55
 
    </td>
56
 
  </tr>
57
 
</table>
58
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
59
 
<h1 class="epydoc">Class update_catalog</h1><p class="nomargin-top"></p>
60
 
<pre class="base-tree">
61
 
distutils.cmd.Command --+
62
 
                        |
63
 
                       <strong class="uidshort">update_catalog</strong>
64
 
</pre>
65
 
 
66
 
<hr />
67
 
<p>Catalog merging command for use in <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">setup.py</tt> scripts.</p>
68
 
<p>If correctly installed, this command is available to Setuptools-using
69
 
setup scripts automatically. For projects using plain old <tt class="rst-docutils literal">distutils</tt>,
70
 
the command needs to be registered explicitly in <tt class="rst-docutils literal">setup.py</tt>:</p>
71
 
<pre class="rst-literal-block">
72
 
from babel.messages.frontend import update_catalog
73
 
 
74
 
setup(
75
 
    ...
76
 
    cmdclass = {'update_catalog': update_catalog}
77
 
)
78
 
</pre>
79
 
 
80
 
<hr />
81
 
<div class="fields">      <p><strong>Since:</strong>
82
 
        version 0.9
83
 
      </p>
84
 
      <dl><dt>See Also:</dt>
85
 
        <dd>
86
 
          <a class="rst-reference external" href="http://docs.python.org/dist/node32.html" target="_top">Integrating new distutils commands</a>,
87
 
          <a class="rst-reference external" href="http://peak.telecommunity.com/DevCenter/setuptools" target="_top">setuptools</a>
88
 
        </dd>
89
 
      </dl>
90
 
</div><!-- ==================== INSTANCE METHODS ==================== -->
91
 
<a name="section-InstanceMethods"></a>
92
 
<table class="summary" border="1" cellpadding="3"
93
 
       cellspacing="0" width="100%" bgcolor="white">
94
 
<tr bgcolor="#70b0f0" class="table-header">
95
 
  <td align="left" colspan="2" class="table-header">
96
 
    <span class="table-header">Instance Methods</span></td>
97
 
</tr>
98
 
<tr>
99
 
    <td width="15%" align="right" valign="top" class="summary">
100
 
      <span class="summary-type">&nbsp;</span>
101
 
    </td><td class="summary">
102
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
103
 
        <tr>
104
 
          <td><span class="summary-sig"><a href="babel.messages.frontend.update_catalog-class.html#initialize_options" class="summary-sig-name">initialize_options</a>(<span class="summary-sig-arg">self</span>)</span><br />
105
 
      Set default values for all the options that this command
106
 
supports.</td>
107
 
          <td align="right" valign="top">
108
 
            
109
 
            
110
 
          </td>
111
 
        </tr>
112
 
      </table>
113
 
      
114
 
    </td>
115
 
  </tr>
116
 
<tr>
117
 
    <td width="15%" align="right" valign="top" class="summary">
118
 
      <span class="summary-type">&nbsp;</span>
119
 
    </td><td class="summary">
120
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
121
 
        <tr>
122
 
          <td><span class="summary-sig"><a href="babel.messages.frontend.update_catalog-class.html#finalize_options" class="summary-sig-name">finalize_options</a>(<span class="summary-sig-arg">self</span>)</span><br />
123
 
      Set final values for all the options that this command supports.</td>
124
 
          <td align="right" valign="top">
125
 
            
126
 
            
127
 
          </td>
128
 
        </tr>
129
 
      </table>
130
 
      
131
 
    </td>
132
 
  </tr>
133
 
<tr>
134
 
    <td width="15%" align="right" valign="top" class="summary">
135
 
      <span class="summary-type">&nbsp;</span>
136
 
    </td><td class="summary">
137
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
138
 
        <tr>
139
 
          <td><span class="summary-sig"><a href="babel.messages.frontend.update_catalog-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
140
 
      A command's raison d'etre: carry out the action it exists to
141
 
perform, controlled by the options initialized in
142
 
'initialize_options()', customized by other commands, the setup
143
 
script, the command-line, and config files, and finalized in
144
 
'finalize_options()'.</td>
145
 
          <td align="right" valign="top">
146
 
            
147
 
            
148
 
          </td>
149
 
        </tr>
150
 
      </table>
151
 
      
152
 
    </td>
153
 
  </tr>
154
 
  <tr>
155
 
    <td colspan="2" class="summary">
156
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>distutils.cmd.Command</code></b>:
157
 
      <code>__getattr__</code>,
158
 
      <code>__init__</code>,
159
 
      <code>announce</code>,
160
 
      <code>copy_file</code>,
161
 
      <code>copy_tree</code>,
162
 
      <code>debug_print</code>,
163
 
      <code>dump_options</code>,
164
 
      <code>ensure_dirname</code>,
165
 
      <code>ensure_filename</code>,
166
 
      <code>ensure_finalized</code>,
167
 
      <code>ensure_string</code>,
168
 
      <code>ensure_string_list</code>,
169
 
      <code>execute</code>,
170
 
      <code>get_command_name</code>,
171
 
      <code>get_finalized_command</code>,
172
 
      <code>get_sub_commands</code>,
173
 
      <code>make_archive</code>,
174
 
      <code>make_file</code>,
175
 
      <code>mkpath</code>,
176
 
      <code>move_file</code>,
177
 
      <code>reinitialize_command</code>,
178
 
      <code>run_command</code>,
179
 
      <code>set_undefined_options</code>,
180
 
      <code>spawn</code>,
181
 
      <code>warn</code>
182
 
      </p>
183
 
    </td>
184
 
  </tr>
185
 
</table>
186
 
<!-- ==================== CLASS VARIABLES ==================== -->
187
 
<a name="section-ClassVariables"></a>
188
 
<table class="summary" border="1" cellpadding="3"
189
 
       cellspacing="0" width="100%" bgcolor="white">
190
 
<tr bgcolor="#70b0f0" class="table-header">
191
 
  <td align="left" colspan="2" class="table-header">
192
 
    <span class="table-header">Class Variables</span></td>
193
 
</tr>
194
 
<tr>
195
 
    <td width="15%" align="right" valign="top" class="summary">
196
 
      <span class="summary-type">&nbsp;</span>
197
 
    </td><td class="summary">
198
 
        <a name="description"></a><span class="summary-name">description</span> = <code title="'update message catalogs from a POT file'"><code class="variable-quote">'</code><code class="variable-string">update message catalogs from a POT file</code><code class="variable-quote">'</code></code>
199
 
    </td>
200
 
  </tr>
201
 
<tr>
202
 
    <td width="15%" align="right" valign="top" class="summary">
203
 
      <span class="summary-type">&nbsp;</span>
204
 
    </td><td class="summary">
205
 
        <a href="babel.messages.frontend.update_catalog-class.html#user_options" class="summary-name">user_options</a> = <code title="[('domain=', 'D', 'domain of PO file (default \'messages\')'),
206
 
 ('input-file=', 'i', 'name of the input file'),
207
 
 ('output-dir=',
208
 
  'd',
209
 
  'path to base directory containing the catalogs'),
210
 
 ('output-file=',
211
 
  'o',
212
 
  'name of the output file (default \'&lt;output_dir&gt;/&lt;locale&gt;/LC_MESSAGE\
213
 
..."><code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">domain=</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">D</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">domain of PO file (default \</code><code class="variable-ellipsis">...</code></code>
214
 
    </td>
215
 
  </tr>
216
 
<tr>
217
 
    <td width="15%" align="right" valign="top" class="summary">
218
 
      <span class="summary-type">&nbsp;</span>
219
 
    </td><td class="summary">
220
 
        <a href="babel.messages.frontend.update_catalog-class.html#boolean_options" class="summary-name">boolean_options</a> = <code title="['ignore_obsolete', 'no_fuzzy_matching', 'previous']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">ignore_obsolete</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">no_fuzzy_matching</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pr</code><code class="variable-ellipsis">...</code></code>
221
 
    </td>
222
 
  </tr>
223
 
  <tr>
224
 
    <td colspan="2" class="summary">
225
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>distutils.cmd.Command</code></b>:
226
 
      <code>sub_commands</code>
227
 
      </p>
228
 
    </td>
229
 
  </tr>
230
 
</table>
231
 
<!-- ==================== METHOD DETAILS ==================== -->
232
 
<a name="section-MethodDetails"></a>
233
 
<table class="details" border="1" cellpadding="3"
234
 
       cellspacing="0" width="100%" bgcolor="white">
235
 
<tr bgcolor="#70b0f0" class="table-header">
236
 
  <td align="left" colspan="2" class="table-header">
237
 
    <span class="table-header">Method Details</span></td>
238
 
</tr>
239
 
</table>
240
 
<a name="initialize_options"></a>
241
 
<div>
242
 
<table class="details" border="1" cellpadding="3"
243
 
       cellspacing="0" width="100%" bgcolor="white">
244
 
<tr><td>
245
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
246
 
  <tr valign="top"><td>
247
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">initialize_options</span>(<span class="sig-arg">self</span>)</span>
248
 
  </h3>
249
 
  </td><td align="right" valign="top"
250
 
    >&nbsp;
251
 
    </td>
252
 
  </tr></table>
253
 
  
254
 
  <p>Set default values for all the options that this command
255
 
supports.  Note that these defaults may be overridden by other
256
 
commands, by the setup script, by config files, or by the
257
 
command-line.  Thus, this is not the place to code dependencies
258
 
between options; generally, 'initialize_options()' implementations
259
 
are just a bunch of &quot;self.foo = None&quot; assignments.</p>
260
 
<p>This method must be implemented by all command classes.</p>
261
 
  <dl class="fields">
262
 
    <dt>Overrides:
263
 
        distutils.cmd.Command.initialize_options
264
 
        <dd><em class="note">(inherited documentation)</em></dd>
265
 
    </dt>
266
 
  </dl>
267
 
</td></tr></table>
268
 
</div>
269
 
<a name="finalize_options"></a>
270
 
<div>
271
 
<table class="details" border="1" cellpadding="3"
272
 
       cellspacing="0" width="100%" bgcolor="white">
273
 
<tr><td>
274
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
275
 
  <tr valign="top"><td>
276
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">finalize_options</span>(<span class="sig-arg">self</span>)</span>
277
 
  </h3>
278
 
  </td><td align="right" valign="top"
279
 
    >&nbsp;
280
 
    </td>
281
 
  </tr></table>
282
 
  
283
 
  <p>Set final values for all the options that this command supports.
284
 
This is always called as late as possible, ie.  after any option
285
 
assignments from the command-line or from other commands have been
286
 
done.  Thus, this is the place to code option dependencies: if
287
 
'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as
288
 
long as 'foo' still has the same value it was assigned in
289
 
'initialize_options()'.</p>
290
 
<p>This method must be implemented by all command classes.</p>
291
 
  <dl class="fields">
292
 
    <dt>Overrides:
293
 
        distutils.cmd.Command.finalize_options
294
 
        <dd><em class="note">(inherited documentation)</em></dd>
295
 
    </dt>
296
 
  </dl>
297
 
</td></tr></table>
298
 
</div>
299
 
<a name="run"></a>
300
 
<div>
301
 
<table class="details" border="1" cellpadding="3"
302
 
       cellspacing="0" width="100%" bgcolor="white">
303
 
<tr><td>
304
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
305
 
  <tr valign="top"><td>
306
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
307
 
  </h3>
308
 
  </td><td align="right" valign="top"
309
 
    >&nbsp;
310
 
    </td>
311
 
  </tr></table>
312
 
  
313
 
  <p>A command's raison d'etre: carry out the action it exists to
314
 
perform, controlled by the options initialized in
315
 
'initialize_options()', customized by other commands, the setup
316
 
script, the command-line, and config files, and finalized in
317
 
'finalize_options()'.  All terminal output and filesystem
318
 
interaction should be done by 'run()'.</p>
319
 
<p>This method must be implemented by all command classes.</p>
320
 
  <dl class="fields">
321
 
    <dt>Overrides:
322
 
        distutils.cmd.Command.run
323
 
        <dd><em class="note">(inherited documentation)</em></dd>
324
 
    </dt>
325
 
  </dl>
326
 
</td></tr></table>
327
 
</div>
328
 
<br />
329
 
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
330
 
<a name="section-ClassVariableDetails"></a>
331
 
<table class="details" border="1" cellpadding="3"
332
 
       cellspacing="0" width="100%" bgcolor="white">
333
 
<tr bgcolor="#70b0f0" class="table-header">
334
 
  <td align="left" colspan="2" class="table-header">
335
 
    <span class="table-header">Class Variable Details</span></td>
336
 
</tr>
337
 
</table>
338
 
<a name="user_options"></a>
339
 
<div>
340
 
<table class="details" border="1" cellpadding="3"
341
 
       cellspacing="0" width="100%" bgcolor="white">
342
 
<tr><td>
343
 
  <h3 class="epydoc">user_options</h3>
344
 
  
345
 
  <dl class="fields">
346
 
  </dl>
347
 
  <dl class="fields">
348
 
    <dt>Value:</dt>
349
 
      <dd><table><tr><td><pre class="variable">
350
 
<code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">domain=</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">D</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">domain of PO file (default \'messages\')</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
351
 
 <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">input-file=</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">i</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">name of the input file</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
352
 
 <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">output-dir=</code><code class="variable-quote">'</code><code class="variable-op">,</code>
353
 
  <code class="variable-quote">'</code><code class="variable-string">d</code><code class="variable-quote">'</code><code class="variable-op">,</code>
354
 
  <code class="variable-quote">'</code><code class="variable-string">path to base directory containing the catalogs</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
355
 
 <code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">output-file=</code><code class="variable-quote">'</code><code class="variable-op">,</code>
356
 
  <code class="variable-quote">'</code><code class="variable-string">o</code><code class="variable-quote">'</code><code class="variable-op">,</code>
357
 
  <code class="variable-quote">'</code><code class="variable-string">name of the output file (default \'&lt;output_dir&gt;/&lt;locale&gt;/LC_MESSAGE</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
358
 
<code class="variable-ellipsis">...</code>
359
 
</pre></td></tr></table>
360
 
</dd>
361
 
  </dl>
362
 
</td></tr></table>
363
 
</div>
364
 
<a name="boolean_options"></a>
365
 
<div>
366
 
<table class="details" border="1" cellpadding="3"
367
 
       cellspacing="0" width="100%" bgcolor="white">
368
 
<tr><td>
369
 
  <h3 class="epydoc">boolean_options</h3>
370
 
  
371
 
  <dl class="fields">
372
 
  </dl>
373
 
  <dl class="fields">
374
 
    <dt>Value:</dt>
375
 
      <dd><table><tr><td><pre class="variable">
376
 
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">ignore_obsolete</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">no_fuzzy_matching</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">previous</code><code class="variable-quote">'</code><code class="variable-group">]</code>
377
 
</pre></td></tr></table>
378
 
</dd>
379
 
  </dl>
380
 
</td></tr></table>
381
 
</div>
382
 
<br />
383
 
<!-- ==================== NAVIGATION BAR ==================== -->
384
 
<table class="navbar" border="0" width="100%" cellpadding="0"
385
 
       bgcolor="#a0c0ff" cellspacing="0">
386
 
  <tr valign="middle">
387
 
  <!-- Home link -->
388
 
      <th>&nbsp;&nbsp;&nbsp;<a
389
 
        href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
390
 
 
391
 
  <!-- Tree link -->
392
 
      <th>&nbsp;&nbsp;&nbsp;<a
393
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
394
 
 
395
 
  <!-- Index link -->
396
 
      <th>&nbsp;&nbsp;&nbsp;<a
397
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
398
 
 
399
 
  <!-- Help link -->
400
 
      <th>&nbsp;&nbsp;&nbsp;<a
401
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
402
 
 
403
 
  <!-- Project homepage -->
404
 
      <th class="navbar" align="right" width="100%">
405
 
        <table border="0" cellpadding="0" cellspacing="0">
406
 
          <tr><th class="navbar" align="center"
407
 
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
408
 
          </tr></table></th>
409
 
  </tr>
410
 
</table>
411
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
412
 
  <tr>
413
 
    <td align="left" class="footer">
414
 
    Generated by Epydoc 3.0.1 on Thu Mar 17 15:12:45 2011
415
 
    </td>
416
 
    <td align="right" class="footer">
417
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
418
 
        >http://epydoc.sourceforge.net</a>
419
 
    </td>
420
 
  </tr>
421
 
</table>
422
 
 
423
 
<script type="text/javascript">
424
 
  <!--
425
 
  // Private objects are initially displayed (because if
426
 
  // javascript is turned off then we want them to be
427
 
  // visible); but by default, we want to hide them.  So hide
428
 
  // them unless we have a cookie that says to show them.
429
 
  checkCookie();
430
 
  // -->
431
 
</script>
432
 
</body>
433
 
</html>