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
|
<?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.extract</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="babel-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<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%">
<span class="breadcrumbs">
<a href="babel-module.html">Package babel</a> ::
<a href="babel.messages-module.html">Package messages</a> ::
Module extract
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module extract</h1><br /><br />
<p>Basic infrastructure for extracting localizable messages from source files.</p>
<p>This module defines an extensible system for collecting localizable message
strings from a variety of sources. A native extractor for Python source files
is builtin, extractors for other sources can be added using very simple plugins.</p>
<p>The main entry points into the extraction functionality are the functions
<a href="babel.messages.extract-module.html#extract_from_dir" class="link">extract_from_dir</a> and <a href="babel.messages.extract-module.html#extract_from_file" class="link">extract_from_file</a>.</p><br /><br />
<!-- ==================== FUNCTIONS ==================== -->
<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">
<span class="table-header">Functions</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><tt class="rst-docutils literal"><span class="pre">iterator</span></tt></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="babel.messages.extract-module.html#extract_from_dir" class="summary-sig-name">extract_from_dir</a>(<span class="summary-sig-arg">dirname</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">/Users/chris/Projects/Edgewall/Babel/tags/0.9.1</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">method_map</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">**.py</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">python</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-group">]</code></span>,
<span class="summary-sig-arg">options_map</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>,
<span class="summary-sig-arg">keywords</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="summary-sig-arg">comment_tags</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span><br />
Extract messages from any source files found in the given directory.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">list</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="babel.messages.extract-module.html#extract_from_file" class="summary-sig-name">extract_from_file</a>(<span class="summary-sig-arg">method</span>,
<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">keywords</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="summary-sig-arg">comment_tags</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">options</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span><br />
Extract messages from a specific file.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">list</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="babel.messages.extract-module.html#extract" class="summary-sig-name">extract</a>(<span class="summary-sig-arg">method</span>,
<span class="summary-sig-arg">fileobj</span>,
<span class="summary-sig-arg">keywords</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="summary-sig-arg">comment_tags</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">options</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span><br />
Extract messages from the given file-like object using the specified
extraction method.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<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">
<span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="extract_from_dir"></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"><span class="sig"><span class="sig-name">extract_from_dir</span>(<span class="sig-arg">dirname</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">/Users/chris/Projects/Edgewall/Babel/tags/0.9.1</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">method_map</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">**.py</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">python</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-group">]</code></span>,
<span class="sig-arg">options_map</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>,
<span class="sig-arg">keywords</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="sig-arg">comment_tags</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">callback</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</table>
<p>Extract messages from any source files found in the given directory.</p>
<p>This function generates tuples of the form:</p>
<blockquote>
<tt class="rst-docutils literal"><span class="pre">(filename,</span> <span class="pre">lineno,</span> <span class="pre">message,</span> <span class="pre">comments)</span></tt></blockquote>
<p>Which extraction method is used per file is determined by the <code class="link">method_map</code>
parameter, which maps extended glob patterns to extraction method names.
For example, the following is the default mapping:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>method_map = [
<span class="py-more">... </span> (<span class="py-string">'**.py'</span>, <span class="py-string">'python'</span>)
<span class="py-more">... </span>]</pre>
<p>This basically says that files with the filename extension ".py" at any
level inside the directory should be processed by the "python" extraction
method. Files that don't match any of the mapping patterns are ignored. See
the documentation of the <a href="babel.util-module.html#pathmatch" class="link">pathmatch</a> function for details on the pattern
syntax.</p>
<p>The following extended mapping would also use the "genshi" extraction
method on any file in "templates" subdirectory:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>method_map = [
<span class="py-more">... </span> (<span class="py-string">'**/templates/**.*'</span>, <span class="py-string">'genshi'</span>),
<span class="py-more">... </span> (<span class="py-string">'**.py'</span>, <span class="py-string">'python'</span>)
<span class="py-more">... </span>]</pre>
<p>The dictionary provided by the optional <code class="link">options_map</code> parameter augments
these mappings. It uses extended glob patterns as keys, and the values are
dictionaries mapping options names to option values (both strings).</p>
<p>The glob patterns of the <code class="link">options_map</code> do not necessarily need to be the
same as those used in the method mapping. For example, while all files in
the <tt class="rst-docutils literal"><span class="pre">templates</span></tt> folders in an application may be Genshi applications, the
options for those files may differ based on extension:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>options_map = {
<span class="py-more">... </span> <span class="py-string">'**/templates/**.txt'</span>: {
<span class="py-more">... </span> <span class="py-string">'template_class'</span>: <span class="py-string">'genshi.template:TextTemplate'</span>,
<span class="py-more">... </span> <span class="py-string">'encoding'</span>: <span class="py-string">'latin-1'</span>
<span class="py-more">... </span> },
<span class="py-more">... </span> <span class="py-string">'**/templates/**.html'</span>: {
<span class="py-more">... </span> <span class="py-string">'include_attrs'</span>: <span class="py-string">''</span>
<span class="py-more">... </span> }
<span class="py-more">... </span>}</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>dirname</code></strong> - the path to the directory to extract messages from</li>
<li><strong class="pname"><code>method_map</code></strong> - a list of <tt class="rst-docutils literal"><span class="pre">(pattern,</span> <span class="pre">method)</span></tt> tuples that maps of
extraction method names to extended glob patterns</li>
<li><strong class="pname"><code>options_map</code></strong> - a dictionary of additional options (optional)</li>
<li><strong class="pname"><code>keywords</code></strong> - a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings</li>
<li><strong class="pname"><code>comment_tags</code></strong> - a list of tags of translator comments to search for
and include in the results</li>
<li><strong class="pname"><code>callback</code></strong> - a function that is called for every file that message are
extracted from, just before the extraction itself is
performed; the function is passed the filename, the name
of the extraction method and and the options dictionary as
positional arguments, in that order</li>
</ul></dd>
<dt>Returns: <tt class="rst-rst-docutils literal rst-docutils literal"><span class="pre">iterator</span></tt></dt>
<dd>an iterator over <tt class="rst-docutils literal"><span class="pre">(filename,</span> <span class="pre">lineno,</span> <span class="pre">funcname,</span> <span class="pre">message)</span></tt> tuples</dd>
</dl>
<div class="fields"> <p><strong>See Also:</strong>
<a href="babel.util-module.html#pathmatch" class="link">pathmatch</a>
</p>
</div></td></tr></table>
</div>
<a name="extract_from_file"></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"><span class="sig"><span class="sig-name">extract_from_file</span>(<span class="sig-arg">method</span>,
<span class="sig-arg">filename</span>,
<span class="sig-arg">keywords</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="sig-arg">comment_tags</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">options</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</table>
<p>Extract messages from a specific file.</p>
<p>This function returns a list of tuples of the form:</p>
<blockquote>
<tt class="rst-docutils literal"><span class="pre">(lineno,</span> <span class="pre">funcname,</span> <span class="pre">message)</span></tt></blockquote>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> - the path to the file to extract messages from</li>
<li><strong class="pname"><code>method</code></strong> - a string specifying the extraction method (.e.g. "python")</li>
<li><strong class="pname"><code>keywords</code></strong> - a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings</li>
<li><strong class="pname"><code>comment_tags</code></strong> - a list of translator tags to search for and include
in the results</li>
<li><strong class="pname"><code>options</code></strong> - a dictionary of additional options (optional)</li>
</ul></dd>
<dt>Returns: <code class="link">list</code></dt>
<dd>the list of extracted messages</dd>
</dl>
</td></tr></table>
</div>
<a name="extract"></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"><span class="sig"><span class="sig-name">extract</span>(<span class="sig-arg">method</span>,
<span class="sig-arg">fileobj</span>,
<span class="sig-arg">keywords</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">N_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dgettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">dngettext</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>2<code class="variable-op">, </code>3<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></span>,
<span class="sig-arg">comment_tags</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">options</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">territory_zones</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">001</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Etc/GMT-</code><code class="variable-ellipsis">...</code></span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</table>
<p>Extract messages from the given file-like object using the specified
extraction method.</p>
<p>This function returns a list of tuples of the form:</p>
<blockquote>
<tt class="rst-docutils literal"><span class="pre">(lineno,</span> <span class="pre">message,</span> <span class="pre">comments)</span></tt></blockquote>
<p>The implementation dispatches the actual extraction to plugins, based on the
value of the <tt class="rst-docutils literal"><span class="pre">method</span></tt> parameter.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>source = <span class="py-string">'''# foo module</span>
<span class="py-more">... </span><span class="py-string">def run(argv):</span>
<span class="py-more">... </span><span class="py-string"> print _('Hello, world!')</span>
<span class="py-more">... </span><span class="py-string">'''</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> StringIO <span class="py-keyword">import</span> StringIO
<span class="py-prompt">>>> </span><span class="py-keyword">for</span> message <span class="py-keyword">in</span> extract(<span class="py-string">'python'</span>, StringIO(source)):
<span class="py-more">... </span> <span class="py-keyword">print</span> message
<span class="py-output">(3, u'Hello, world!', [])</span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>method</code></strong> - a string specifying the extraction method (.e.g. "python");
if this is a simple name, the extraction function will be
looked up by entry point; if it is an explicit reference
to a function (of the form <tt class="rst-docutils literal"><span class="pre">package.module:funcname</span></tt>), the
corresponding function will be imported and used</li>
<li><strong class="pname"><code>fileobj</code></strong> - the file-like object the messages should be extracted from</li>
<li><strong class="pname"><code>keywords</code></strong> - a dictionary mapping keywords (i.e. names of functions
that should be recognized as translation functions) to
tuples that specify which of their arguments contain
localizable strings</li>
<li><strong class="pname"><code>comment_tags</code></strong> - a list of translator tags to search for and include
in the results</li>
<li><strong class="pname"><code>options</code></strong> - a dictionary of additional options (optional)</li>
</ul></dd>
<dt>Returns: <code class="link">list</code></dt>
<dd>the list of extracted messages</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - if the extraction method is not registered</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="babel-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<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 border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Fri Sep 7 12:36:49 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
|
