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">
6
<title>babel.support.Format</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="babel-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
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>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="babel-module.html">Package babel</a> ::
46
<a href="babel.support-module.html">Module support</a> ::
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
57
<!-- ==================== CLASS DESCRIPTION ==================== -->
58
<h1 class="epydoc">Class Format</h1><p class="nomargin-top"></p>
59
<pre class="base-tree">
62
<strong class="uidshort">Format</strong>
66
<p>Wrapper class providing the various date and number formatting functions
67
bound to a specific locale and time-zone.</p>
68
<pre class="py-doctest">
69
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>, UTC)
70
<span class="py-prompt">>>> </span>fmt.date(date(2007, 4, 1))
71
<span class="py-output">u'Apr 1, 2007'</span>
72
<span class="py-output"></span><span class="py-prompt">>>> </span>fmt.decimal(1.2345)
73
<span class="py-output">u'1.234'</span></pre>
75
<!-- ==================== INSTANCE METHODS ==================== -->
76
<a name="section-InstanceMethods"></a>
77
<table class="summary" border="1" cellpadding="3"
78
cellspacing="0" width="100%" bgcolor="white">
79
<tr bgcolor="#70b0f0" class="table-header">
80
<td align="left" colspan="2" class="table-header">
81
<span class="table-header">Instance Methods</span></td>
84
<td width="15%" align="right" valign="top" class="summary">
85
<span class="summary-type"> </span>
86
</td><td class="summary">
87
<table width="100%" cellpadding="0" cellspacing="0" border="0">
89
<td><span class="summary-sig"><a href="babel.support.Format-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
90
<span class="summary-sig-arg">locale</span>,
91
<span class="summary-sig-arg">tzinfo</span>=<span class="summary-sig-default">None</span>)</span><br />
92
Initialize the formatter.</td>
93
<td align="right" valign="top">
103
<td width="15%" align="right" valign="top" class="summary">
104
<span class="summary-type"> </span>
105
</td><td class="summary">
106
<table width="100%" cellpadding="0" cellspacing="0" border="0">
108
<td><span class="summary-sig"><a href="babel.support.Format-class.html#date" class="summary-sig-name">date</a>(<span class="summary-sig-arg">self</span>,
109
<span class="summary-sig-arg">date</span>=<span class="summary-sig-default">None</span>,
110
<span class="summary-sig-arg">format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span><br />
111
Return a date formatted according to the given pattern.</td>
112
<td align="right" valign="top">
122
<td width="15%" align="right" valign="top" class="summary">
123
<span class="summary-type"> </span>
124
</td><td class="summary">
125
<table width="100%" cellpadding="0" cellspacing="0" border="0">
127
<td><span class="summary-sig"><a href="babel.support.Format-class.html#datetime" class="summary-sig-name">datetime</a>(<span class="summary-sig-arg">self</span>,
128
<span class="summary-sig-arg">datetime</span>=<span class="summary-sig-default">None</span>,
129
<span class="summary-sig-arg">format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span><br />
130
Return a date and time formatted according to the given pattern.</td>
131
<td align="right" valign="top">
141
<td width="15%" align="right" valign="top" class="summary">
142
<span class="summary-type"> </span>
143
</td><td class="summary">
144
<table width="100%" cellpadding="0" cellspacing="0" border="0">
146
<td><span class="summary-sig"><a href="babel.support.Format-class.html#time" class="summary-sig-name">time</a>(<span class="summary-sig-arg">self</span>,
147
<span class="summary-sig-arg">time</span>=<span class="summary-sig-default">None</span>,
148
<span class="summary-sig-arg">format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span><br />
149
Return a time formatted according to the given pattern.</td>
150
<td align="right" valign="top">
160
<td width="15%" align="right" valign="top" class="summary">
161
<span class="summary-type"> </span>
162
</td><td class="summary">
163
<table width="100%" cellpadding="0" cellspacing="0" border="0">
165
<td><span class="summary-sig"><a href="babel.support.Format-class.html#number" class="summary-sig-name">number</a>(<span class="summary-sig-arg">self</span>,
166
<span class="summary-sig-arg">number</span>)</span><br />
167
Return an integer number formatted for the locale.</td>
168
<td align="right" valign="top">
178
<td width="15%" align="right" valign="top" class="summary">
179
<span class="summary-type"> </span>
180
</td><td class="summary">
181
<table width="100%" cellpadding="0" cellspacing="0" border="0">
183
<td><span class="summary-sig"><a href="babel.support.Format-class.html#decimal" class="summary-sig-name">decimal</a>(<span class="summary-sig-arg">self</span>,
184
<span class="summary-sig-arg">number</span>,
185
<span class="summary-sig-arg">format</span>=<span class="summary-sig-default">None</span>)</span><br />
186
Return a decimal number formatted for the locale.</td>
187
<td align="right" valign="top">
197
<td width="15%" align="right" valign="top" class="summary">
198
<span class="summary-type"> </span>
199
</td><td class="summary">
200
<table width="100%" cellpadding="0" cellspacing="0" border="0">
202
<td><span class="summary-sig"><a href="babel.support.Format-class.html#currency" class="summary-sig-name">currency</a>(<span class="summary-sig-arg">self</span>,
203
<span class="summary-sig-arg">number</span>,
204
<span class="summary-sig-arg">currency</span>)</span><br />
205
Return a number in the given currency formatted for the locale.</td>
206
<td align="right" valign="top">
216
<td width="15%" align="right" valign="top" class="summary">
217
<span class="summary-type"> </span>
218
</td><td class="summary">
219
<table width="100%" cellpadding="0" cellspacing="0" border="0">
221
<td><span class="summary-sig"><a href="babel.support.Format-class.html#percent" class="summary-sig-name">percent</a>(<span class="summary-sig-arg">self</span>,
222
<span class="summary-sig-arg">number</span>,
223
<span class="summary-sig-arg">format</span>=<span class="summary-sig-default">None</span>)</span><br />
224
Return a number formatted as percentage for the locale.</td>
225
<td align="right" valign="top">
235
<td width="15%" align="right" valign="top" class="summary">
236
<span class="summary-type"> </span>
237
</td><td class="summary">
238
<table width="100%" cellpadding="0" cellspacing="0" border="0">
240
<td><span class="summary-sig"><a href="babel.support.Format-class.html#scientific" class="summary-sig-name">scientific</a>(<span class="summary-sig-arg">self</span>,
241
<span class="summary-sig-arg">number</span>)</span><br />
242
Return a number formatted using scientific notation for the locale.</td>
243
<td align="right" valign="top">
253
<td colspan="2" class="summary">
254
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
255
<code>__delattr__</code>,
256
<code>__format__</code>,
257
<code>__getattribute__</code>,
258
<code>__hash__</code>,
259
<code>__new__</code>,
260
<code>__reduce__</code>,
261
<code>__reduce_ex__</code>,
262
<code>__repr__</code>,
263
<code>__setattr__</code>,
264
<code>__sizeof__</code>,
265
<code>__str__</code>,
266
<code>__subclasshook__</code>
271
<!-- ==================== PROPERTIES ==================== -->
272
<a name="section-Properties"></a>
273
<table class="summary" border="1" cellpadding="3"
274
cellspacing="0" width="100%" bgcolor="white">
275
<tr bgcolor="#70b0f0" class="table-header">
276
<td align="left" colspan="2" class="table-header">
277
<span class="table-header">Properties</span></td>
280
<td colspan="2" class="summary">
281
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
282
<code>__class__</code>
287
<!-- ==================== METHOD DETAILS ==================== -->
288
<a name="section-MethodDetails"></a>
289
<table class="details" border="1" cellpadding="3"
290
cellspacing="0" width="100%" bgcolor="white">
291
<tr bgcolor="#70b0f0" class="table-header">
292
<td align="left" colspan="2" class="table-header">
293
<span class="table-header">Method Details</span></td>
296
<a name="__init__"></a>
298
<table class="details" border="1" cellpadding="3"
299
cellspacing="0" width="100%" bgcolor="white">
301
<table width="100%" cellpadding="0" cellspacing="0" border="0">
302
<tr valign="top"><td>
303
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
304
<span class="sig-arg">locale</span>,
305
<span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>
306
<br /><em class="fname">(Constructor)</em>
308
</td><td align="right" valign="top"
313
Initialize the formatter.
316
<dd><ul class="nomargin-top">
317
<li><strong class="pname"><code>locale</code></strong> - the locale identifier or <a href="babel.core.Locale-class.html" class="link">Locale</a> instance</li>
318
<li><strong class="pname"><code>tzinfo</code></strong> - the time-zone info (a <code class="link">tzinfo</code> instance or <code class="link">None</code>)</li>
328
<table class="details" border="1" cellpadding="3"
329
cellspacing="0" width="100%" bgcolor="white">
331
<table width="100%" cellpadding="0" cellspacing="0" border="0">
332
<tr valign="top"><td>
333
<h3 class="epydoc"><span class="sig"><span class="sig-name">date</span>(<span class="sig-arg">self</span>,
334
<span class="sig-arg">date</span>=<span class="sig-default">None</span>,
335
<span class="sig-arg">format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span>
337
</td><td align="right" valign="top"
342
<p>Return a date formatted according to the given pattern.</p>
343
<pre class="py-doctest">
344
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>)
345
<span class="py-prompt">>>> </span>fmt.date(date(2007, 4, 1))
346
<span class="py-output">u'Apr 1, 2007'</span></pre>
349
<div class="fields"> <p><strong>See Also:</strong>
350
<a href="babel.dates-module.html#format_date" class="link">babel.dates.format_date</a>
352
</div></td></tr></table>
354
<a name="datetime"></a>
356
<table class="details" border="1" cellpadding="3"
357
cellspacing="0" width="100%" bgcolor="white">
359
<table width="100%" cellpadding="0" cellspacing="0" border="0">
360
<tr valign="top"><td>
361
<h3 class="epydoc"><span class="sig"><span class="sig-name">datetime</span>(<span class="sig-arg">self</span>,
362
<span class="sig-arg">datetime</span>=<span class="sig-default">None</span>,
363
<span class="sig-arg">format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span>
365
</td><td align="right" valign="top"
370
<p>Return a date and time formatted according to the given pattern.</p>
371
<pre class="py-doctest">
372
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> pytz <span class="py-keyword">import</span> timezone
373
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>, tzinfo=timezone(<span class="py-string">'US/Eastern'</span>))
374
<span class="py-prompt">>>> </span>fmt.datetime(datetime(2007, 4, 1, 15, 30))
375
<span class="py-output">u'Apr 1, 2007 11:30:00 AM'</span></pre>
378
<div class="fields"> <p><strong>See Also:</strong>
379
<a href="babel.dates-module.html#format_datetime" class="link">babel.dates.format_datetime</a>
381
</div></td></tr></table>
385
<table class="details" border="1" cellpadding="3"
386
cellspacing="0" width="100%" bgcolor="white">
388
<table width="100%" cellpadding="0" cellspacing="0" border="0">
389
<tr valign="top"><td>
390
<h3 class="epydoc"><span class="sig"><span class="sig-name">time</span>(<span class="sig-arg">self</span>,
391
<span class="sig-arg">time</span>=<span class="sig-default">None</span>,
392
<span class="sig-arg">format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">medium</code><code class="variable-quote">'</code></span>)</span>
394
</td><td align="right" valign="top"
399
<p>Return a time formatted according to the given pattern.</p>
400
<pre class="py-doctest">
401
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> pytz <span class="py-keyword">import</span> timezone
402
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>, tzinfo=timezone(<span class="py-string">'US/Eastern'</span>))
403
<span class="py-prompt">>>> </span>fmt.time(datetime(2007, 4, 1, 15, 30))
404
<span class="py-output">u'11:30:00 AM'</span></pre>
407
<div class="fields"> <p><strong>See Also:</strong>
408
<a href="babel.dates-module.html#format_time" class="link">babel.dates.format_time</a>
410
</div></td></tr></table>
412
<a name="number"></a>
414
<table class="details" border="1" cellpadding="3"
415
cellspacing="0" width="100%" bgcolor="white">
417
<table width="100%" cellpadding="0" cellspacing="0" border="0">
418
<tr valign="top"><td>
419
<h3 class="epydoc"><span class="sig"><span class="sig-name">number</span>(<span class="sig-arg">self</span>,
420
<span class="sig-arg">number</span>)</span>
422
</td><td align="right" valign="top"
427
<p>Return an integer number formatted for the locale.</p>
428
<pre class="py-doctest">
429
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>)
430
<span class="py-prompt">>>> </span>fmt.number(1099)
431
<span class="py-output">u'1,099'</span></pre>
434
<div class="fields"> <p><strong>See Also:</strong>
435
<a href="babel.numbers-module.html#format_number" class="link">babel.numbers.format_number</a>
437
</div></td></tr></table>
439
<a name="decimal"></a>
441
<table class="details" border="1" cellpadding="3"
442
cellspacing="0" width="100%" bgcolor="white">
444
<table width="100%" cellpadding="0" cellspacing="0" border="0">
445
<tr valign="top"><td>
446
<h3 class="epydoc"><span class="sig"><span class="sig-name">decimal</span>(<span class="sig-arg">self</span>,
447
<span class="sig-arg">number</span>,
448
<span class="sig-arg">format</span>=<span class="sig-default">None</span>)</span>
450
</td><td align="right" valign="top"
455
<p>Return a decimal number formatted for the locale.</p>
456
<pre class="py-doctest">
457
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>)
458
<span class="py-prompt">>>> </span>fmt.decimal(1.2345)
459
<span class="py-output">u'1.234'</span></pre>
462
<div class="fields"> <p><strong>See Also:</strong>
463
<a href="babel.numbers-module.html#format_decimal" class="link">babel.numbers.format_decimal</a>
465
</div></td></tr></table>
467
<a name="currency"></a>
469
<table class="details" border="1" cellpadding="3"
470
cellspacing="0" width="100%" bgcolor="white">
472
<table width="100%" cellpadding="0" cellspacing="0" border="0">
473
<tr valign="top"><td>
474
<h3 class="epydoc"><span class="sig"><span class="sig-name">currency</span>(<span class="sig-arg">self</span>,
475
<span class="sig-arg">number</span>,
476
<span class="sig-arg">currency</span>)</span>
478
</td><td align="right" valign="top"
483
Return a number in the given currency formatted for the locale.
486
<div class="fields"> <p><strong>See Also:</strong>
487
<a href="babel.numbers-module.html#format_currency" class="link">babel.numbers.format_currency</a>
489
</div></td></tr></table>
491
<a name="percent"></a>
493
<table class="details" border="1" cellpadding="3"
494
cellspacing="0" width="100%" bgcolor="white">
496
<table width="100%" cellpadding="0" cellspacing="0" border="0">
497
<tr valign="top"><td>
498
<h3 class="epydoc"><span class="sig"><span class="sig-name">percent</span>(<span class="sig-arg">self</span>,
499
<span class="sig-arg">number</span>,
500
<span class="sig-arg">format</span>=<span class="sig-default">None</span>)</span>
502
</td><td align="right" valign="top"
507
<p>Return a number formatted as percentage for the locale.</p>
508
<pre class="py-doctest">
509
<span class="py-prompt">>>> </span>fmt = Format(<span class="py-string">'en_US'</span>)
510
<span class="py-prompt">>>> </span>fmt.percent(0.34)
511
<span class="py-output">u'34%'</span></pre>
514
<div class="fields"> <p><strong>See Also:</strong>
515
<a href="babel.numbers-module.html#format_percent" class="link">babel.numbers.format_percent</a>
517
</div></td></tr></table>
519
<a name="scientific"></a>
521
<table class="details" border="1" cellpadding="3"
522
cellspacing="0" width="100%" bgcolor="white">
524
<table width="100%" cellpadding="0" cellspacing="0" border="0">
525
<tr valign="top"><td>
526
<h3 class="epydoc"><span class="sig"><span class="sig-name">scientific</span>(<span class="sig-arg">self</span>,
527
<span class="sig-arg">number</span>)</span>
529
</td><td align="right" valign="top"
534
Return a number formatted using scientific notation for the locale.
537
<div class="fields"> <p><strong>See Also:</strong>
538
<a href="babel.numbers-module.html#format_scientific" class="link">babel.numbers.format_scientific</a>
540
</div></td></tr></table>
543
<!-- ==================== NAVIGATION BAR ==================== -->
544
<table class="navbar" border="0" width="100%" cellpadding="0"
545
bgcolor="#a0c0ff" cellspacing="0">
548
<th> <a
549
href="babel-module.html">Home</a> </th>
552
<th> <a
553
href="module-tree.html">Trees</a> </th>
556
<th> <a
557
href="identifier-index.html">Indices</a> </th>
560
<th> <a
561
href="help.html">Help</a> </th>
563
<!-- Project homepage -->
564
<th class="navbar" align="right" width="100%">
565
<table border="0" cellpadding="0" cellspacing="0">
566
<tr><th class="navbar" align="center"
567
><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
571
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
573
<td align="left" class="footer">
574
Generated by Epydoc 3.0.1 on Thu Mar 17 15:12:45 2011
576
<td align="right" class="footer">
577
<a target="mainFrame" href="http://epydoc.sourceforge.net"
578
>http://epydoc.sourceforge.net</a>
583
<script type="text/javascript">
585
// Private objects are initially displayed (because if
586
// javascript is turned off then we want them to be
587
// visible); but by default, we want to hide them. So hide
588
// them unless we have a cookie that says to show them.