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.core.Locale</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.core-module.html">Module core</a> ::
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
57
<!-- ==================== CLASS DESCRIPTION ==================== -->
58
<h1 class="epydoc">Class Locale</h1><p class="nomargin-top"></p>
59
<pre class="base-tree">
62
<strong class="uidshort">Locale</strong>
66
<p>Representation of a specific locale.</p>
67
<pre class="py-doctest">
68
<span class="py-prompt">>>> </span>locale = Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>)
69
<span class="py-prompt">>>> </span>repr(locale)
70
<span class="py-output">'<Locale "en_US">'</span>
71
<span class="py-output"></span><span class="py-prompt">>>> </span>locale.display_name
72
<span class="py-output">u'English (United States)'</span></pre>
73
<p>A <a href="babel.core.Locale-class.html" class="link">Locale</a> object can also be instantiated from a raw locale string:</p>
74
<pre class="py-doctest">
75
<span class="py-prompt">>>> </span>locale = Locale.parse(<span class="py-string">'en-US'</span>, sep=<span class="py-string">'-'</span>)
76
<span class="py-prompt">>>> </span>repr(locale)
77
<span class="py-output">'<Locale "en_US">'</span></pre>
78
<p><a href="babel.core.Locale-class.html" class="link">Locale</a> objects provide access to a collection of locale data, such as
79
territory and language names, number and date format patterns, and more:</p>
80
<pre class="py-doctest">
81
<span class="py-prompt">>>> </span>locale.number_symbols[<span class="py-string">'decimal'</span>]
82
<span class="py-output">u'.'</span></pre>
83
<p>If a locale is requested for which no locale data is available, an
84
<a href="babel.core.UnknownLocaleError-class.html" class="link">UnknownLocaleError</a> is raised:</p>
85
<pre class="py-doctest">
86
<span class="py-prompt">>>> </span>Locale.parse(<span class="py-string">'en_DE'</span>)
87
<span class="py-except">Traceback (most recent call last):</span>
88
<span class="py-except"> ...</span>
89
<span class="py-except">UnknownLocaleError: unknown locale 'en_DE'</span></pre>
92
<div class="fields"> <p><strong>See Also:</strong>
93
<a class="rst-reference external" href="http://www.ietf.org/rfc/rfc3066.txt" target="_top">IETF RFC 3066</a>
95
</div><!-- ==================== INSTANCE METHODS ==================== -->
96
<a name="section-InstanceMethods"></a>
97
<table class="summary" border="1" cellpadding="3"
98
cellspacing="0" width="100%" bgcolor="white">
99
<tr bgcolor="#70b0f0" class="table-header">
100
<td align="left" colspan="2" class="table-header">
101
<span class="table-header">Instance Methods</span></td>
104
<td width="15%" align="right" valign="top" class="summary">
105
<span class="summary-type"> </span>
106
</td><td class="summary">
107
<table width="100%" cellpadding="0" cellspacing="0" border="0">
109
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
110
<span class="summary-sig-arg">language</span>,
111
<span class="summary-sig-arg">territory</span>=<span class="summary-sig-default">None</span>,
112
<span class="summary-sig-arg">script</span>=<span class="summary-sig-default">None</span>,
113
<span class="summary-sig-arg">variant</span>=<span class="summary-sig-default">None</span>)</span><br />
114
Initialize the locale object from the given identifier components.</td>
115
<td align="right" valign="top">
125
<td width="15%" align="right" valign="top" class="summary">
126
<span class="summary-type"> </span>
127
</td><td class="summary">
128
<table width="100%" cellpadding="0" cellspacing="0" border="0">
130
<td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">self</span>,
131
<span class="summary-sig-arg">other</span>)</span></td>
132
<td align="right" valign="top">
142
<td width="15%" align="right" valign="top" class="summary">
143
<span class="summary-type"> </span>
144
</td><td class="summary">
145
<table width="100%" cellpadding="0" cellspacing="0" border="0">
147
<td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">self</span>,
148
<span class="summary-sig-arg">other</span>)</span></td>
149
<td align="right" valign="top">
159
<td width="15%" align="right" valign="top" class="summary">
160
<span class="summary-type"> </span>
161
</td><td class="summary">
162
<table width="100%" cellpadding="0" cellspacing="0" border="0">
164
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
166
<td align="right" valign="top">
176
<td width="15%" align="right" valign="top" class="summary">
177
<span class="summary-type"> </span>
178
</td><td class="summary">
179
<table width="100%" cellpadding="0" cellspacing="0" border="0">
181
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
183
<td align="right" valign="top">
193
<td width="15%" align="right" valign="top" class="summary">
194
<span class="summary-type"> </span>
195
</td><td class="summary">
196
<table width="100%" cellpadding="0" cellspacing="0" border="0">
198
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#get_display_name" class="summary-sig-name">get_display_name</a>(<span class="summary-sig-arg">self</span>,
199
<span class="summary-sig-arg">locale</span>=<span class="summary-sig-default">None</span>)</span><br />
200
Return the display name of the locale using the given locale.</td>
201
<td align="right" valign="top">
211
<td colspan="2" class="summary">
212
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
213
<code>__delattr__</code>,
214
<code>__format__</code>,
215
<code>__getattribute__</code>,
216
<code>__hash__</code>,
217
<code>__new__</code>,
218
<code>__reduce__</code>,
219
<code>__reduce_ex__</code>,
220
<code>__setattr__</code>,
221
<code>__sizeof__</code>,
222
<code>__subclasshook__</code>
227
<!-- ==================== CLASS METHODS ==================== -->
228
<a name="section-ClassMethods"></a>
229
<table class="summary" border="1" cellpadding="3"
230
cellspacing="0" width="100%" bgcolor="white">
231
<tr bgcolor="#70b0f0" class="table-header">
232
<td align="left" colspan="2" class="table-header">
233
<span class="table-header">Class Methods</span></td>
236
<td width="15%" align="right" valign="top" class="summary">
237
<span class="summary-type"><a href="babel.core.Locale-class.html" class="link">Locale</a></span>
238
</td><td class="summary">
239
<table width="100%" cellpadding="0" cellspacing="0" border="0">
241
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#default" class="summary-sig-name">default</a>(<span class="summary-sig-arg">cls</span>,
242
<span class="summary-sig-arg">category</span>=<span class="summary-sig-default">None</span>,
243
<span class="summary-sig-arg">aliases</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">ar</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ar_SY</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bg_BG</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bs</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bs_BA</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">ca</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ca_ES</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></span>)</span><br />
244
Return the system default locale for the specified category.</td>
245
<td align="right" valign="top">
255
<td width="15%" align="right" valign="top" class="summary">
256
<span class="summary-type"><a href="babel.core.Locale-class.html" class="link">Locale</a></span>
257
</td><td class="summary">
258
<table width="100%" cellpadding="0" cellspacing="0" border="0">
260
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#negotiate" class="summary-sig-name">negotiate</a>(<span class="summary-sig-arg">cls</span>,
261
<span class="summary-sig-arg">preferred</span>,
262
<span class="summary-sig-arg">available</span>,
263
<span class="summary-sig-arg">sep</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code></span>,
264
<span class="summary-sig-arg">aliases</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">ar</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ar_SY</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bg_BG</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bs</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bs_BA</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">ca</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ca_ES</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></span>)</span><br />
265
Find the best match between available and requested locale strings.</td>
266
<td align="right" valign="top">
276
<td width="15%" align="right" valign="top" class="summary">
277
<span class="summary-type"><a href="babel.core.Locale-class.html" class="link">Locale</a></span>
278
</td><td class="summary">
279
<table width="100%" cellpadding="0" cellspacing="0" border="0">
281
<td><span class="summary-sig"><a href="babel.core.Locale-class.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">cls</span>,
282
<span class="summary-sig-arg">identifier</span>,
283
<span class="summary-sig-arg">sep</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code></span>)</span><br />
284
Create a <a href="babel.core.Locale-class.html" class="link">Locale</a> instance for the given locale identifier.</td>
285
<td align="right" valign="top">
295
<!-- ==================== PROPERTIES ==================== -->
296
<a name="section-Properties"></a>
297
<table class="summary" border="1" cellpadding="3"
298
cellspacing="0" width="100%" bgcolor="white">
299
<tr bgcolor="#70b0f0" class="table-header">
300
<td align="left" colspan="2" class="table-header">
301
<span class="table-header">Properties</span></td>
304
<td width="15%" align="right" valign="top" class="summary">
305
<span class="summary-type"><code class="link">unicode</code></span>
306
</td><td class="summary">
307
<a href="babel.core.Locale-class.html#display_name" class="summary-name">display_name</a><br />
308
The localized display name of the locale.
312
<td width="15%" align="right" valign="top" class="summary">
313
<span class="summary-type"><code class="link">unicode</code></span>
314
</td><td class="summary">
315
<a href="babel.core.Locale-class.html#english_name" class="summary-name">english_name</a><br />
316
The english display name of the locale.
320
<td colspan="2" class="summary">
321
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
322
<code>__class__</code>
326
<tr bgcolor="#e8f0f8" >
327
<th colspan="2" class="group-header"
328
> General Locale Display Names</th></tr>
330
<td width="15%" align="right" valign="top" class="summary">
331
<span class="summary-type"><code class="link">dict</code></span>
332
</td><td class="summary">
333
<a href="babel.core.Locale-class.html#languages" class="summary-name">languages</a><br />
334
Mapping of language codes to translated language names.
338
<td width="15%" align="right" valign="top" class="summary">
339
<span class="summary-type"><code class="link">dict</code></span>
340
</td><td class="summary">
341
<a href="babel.core.Locale-class.html#scripts" class="summary-name">scripts</a><br />
342
Mapping of script codes to translated script names.
346
<td width="15%" align="right" valign="top" class="summary">
347
<span class="summary-type"><code class="link">dict</code></span>
348
</td><td class="summary">
349
<a href="babel.core.Locale-class.html#territories" class="summary-name">territories</a><br />
350
Mapping of script codes to translated script names.
354
<td width="15%" align="right" valign="top" class="summary">
355
<span class="summary-type"><code class="link">dict</code></span>
356
</td><td class="summary">
357
<a href="babel.core.Locale-class.html#variants" class="summary-name">variants</a><br />
358
Mapping of script codes to translated script names.
361
<tr bgcolor="#e8f0f8" >
362
<th colspan="2" class="group-header"
363
> Number Formatting</th></tr>
365
<td width="15%" align="right" valign="top" class="summary">
366
<span class="summary-type"><code class="link">dict</code></span>
367
</td><td class="summary">
368
<a href="babel.core.Locale-class.html#currencies" class="summary-name">currencies</a><br />
369
Mapping of currency codes to translated currency names.
373
<td width="15%" align="right" valign="top" class="summary">
374
<span class="summary-type"><code class="link">dict</code></span>
375
</td><td class="summary">
376
<a href="babel.core.Locale-class.html#currency_symbols" class="summary-name">currency_symbols</a><br />
377
Mapping of currency codes to symbols.
381
<td width="15%" align="right" valign="top" class="summary">
382
<span class="summary-type"><code class="link">dict</code></span>
383
</td><td class="summary">
384
<a href="babel.core.Locale-class.html#number_symbols" class="summary-name">number_symbols</a><br />
385
Symbols used in number formatting.
389
<td width="15%" align="right" valign="top" class="summary">
390
<span class="summary-type"><code class="link">dict</code></span>
391
</td><td class="summary">
392
<a href="babel.core.Locale-class.html#decimal_formats" class="summary-name">decimal_formats</a><br />
393
Locale patterns for decimal number formatting.
397
<td width="15%" align="right" valign="top" class="summary">
398
<span class="summary-type"><code class="link">dict</code></span>
399
</td><td class="summary">
400
<a href="babel.core.Locale-class.html#currency_formats" class="summary-name">currency_formats</a><br />
401
Locale patterns for currency number formatting.
405
<td width="15%" align="right" valign="top" class="summary">
406
<span class="summary-type"><code class="link">dict</code></span>
407
</td><td class="summary">
408
<a href="babel.core.Locale-class.html#percent_formats" class="summary-name">percent_formats</a><br />
409
Locale patterns for percent number formatting.
413
<td width="15%" align="right" valign="top" class="summary">
414
<span class="summary-type"><code class="link">dict</code></span>
415
</td><td class="summary">
416
<a href="babel.core.Locale-class.html#scientific_formats" class="summary-name">scientific_formats</a><br />
417
Locale patterns for scientific number formatting.
420
<tr bgcolor="#e8f0f8" >
421
<th colspan="2" class="group-header"
422
> Calendar Information and Date Formatting</th></tr>
424
<td width="15%" align="right" valign="top" class="summary">
425
<span class="summary-type"><code class="link">dict</code></span>
426
</td><td class="summary">
427
<a href="babel.core.Locale-class.html#periods" class="summary-name">periods</a><br />
428
Locale display names for day periods (AM/PM).
432
<td width="15%" align="right" valign="top" class="summary">
433
<span class="summary-type"><code class="link">dict</code></span>
434
</td><td class="summary">
435
<a href="babel.core.Locale-class.html#days" class="summary-name">days</a><br />
436
Locale display names for weekdays.
440
<td width="15%" align="right" valign="top" class="summary">
441
<span class="summary-type"><code class="link">dict</code></span>
442
</td><td class="summary">
443
<a href="babel.core.Locale-class.html#months" class="summary-name">months</a><br />
444
Locale display names for months.
448
<td width="15%" align="right" valign="top" class="summary">
449
<span class="summary-type"><code class="link">dict</code></span>
450
</td><td class="summary">
451
<a href="babel.core.Locale-class.html#quarters" class="summary-name">quarters</a><br />
452
Locale display names for quarters.
456
<td width="15%" align="right" valign="top" class="summary">
457
<span class="summary-type"><code class="link">dict</code></span>
458
</td><td class="summary">
459
<a href="babel.core.Locale-class.html#eras" class="summary-name">eras</a><br />
460
Locale display names for eras.
464
<td width="15%" align="right" valign="top" class="summary">
465
<span class="summary-type"><code class="link">dict</code></span>
466
</td><td class="summary">
467
<a href="babel.core.Locale-class.html#time_zones" class="summary-name">time_zones</a><br />
468
Locale display names for time zones.
472
<td width="15%" align="right" valign="top" class="summary">
473
<span class="summary-type"><code class="link">dict</code></span>
474
</td><td class="summary">
475
<a href="babel.core.Locale-class.html#meta_zones" class="summary-name">meta_zones</a><br />
476
Locale display names for meta time zones.
480
<td width="15%" align="right" valign="top" class="summary">
481
<span class="summary-type"><code class="link">dict</code></span>
482
</td><td class="summary">
483
<a href="babel.core.Locale-class.html#zone_formats" class="summary-name">zone_formats</a><br />
484
Patterns related to the formatting of time zones.
488
<td width="15%" align="right" valign="top" class="summary">
489
<span class="summary-type"><code class="link">int</code></span>
490
</td><td class="summary">
491
<a href="babel.core.Locale-class.html#first_week_day" class="summary-name">first_week_day</a><br />
492
The first day of a week, with 0 being Monday.
496
<td width="15%" align="right" valign="top" class="summary">
497
<span class="summary-type"><code class="link">int</code></span>
498
</td><td class="summary">
499
<a href="babel.core.Locale-class.html#weekend_start" class="summary-name">weekend_start</a><br />
500
The day the weekend starts, with 0 being Monday.
504
<td width="15%" align="right" valign="top" class="summary">
505
<span class="summary-type"><code class="link">int</code></span>
506
</td><td class="summary">
507
<a href="babel.core.Locale-class.html#weekend_end" class="summary-name">weekend_end</a><br />
508
The day the weekend ends, with 0 being Monday.
512
<td width="15%" align="right" valign="top" class="summary">
513
<span class="summary-type"><code class="link">int</code></span>
514
</td><td class="summary">
515
<a href="babel.core.Locale-class.html#min_week_days" class="summary-name">min_week_days</a><br />
516
The minimum number of days in a week so that the week is counted as the
517
first week of a year or month.
521
<td width="15%" align="right" valign="top" class="summary">
522
<span class="summary-type"><code class="link">dict</code></span>
523
</td><td class="summary">
524
<a href="babel.core.Locale-class.html#date_formats" class="summary-name">date_formats</a><br />
525
Locale patterns for date formatting.
529
<td width="15%" align="right" valign="top" class="summary">
530
<span class="summary-type"><code class="link">dict</code></span>
531
</td><td class="summary">
532
<a href="babel.core.Locale-class.html#time_formats" class="summary-name">time_formats</a><br />
533
Locale patterns for time formatting.
537
<td width="15%" align="right" valign="top" class="summary">
538
<span class="summary-type"><code class="link">dict</code></span>
539
</td><td class="summary">
540
<a href="babel.core.Locale-class.html#datetime_formats" class="summary-name">datetime_formats</a><br />
541
Locale patterns for datetime formatting.
545
<!-- ==================== METHOD DETAILS ==================== -->
546
<a name="section-MethodDetails"></a>
547
<table class="details" border="1" cellpadding="3"
548
cellspacing="0" width="100%" bgcolor="white">
549
<tr bgcolor="#70b0f0" class="table-header">
550
<td align="left" colspan="2" class="table-header">
551
<span class="table-header">Method Details</span></td>
554
<a name="__init__"></a>
556
<table class="details" border="1" cellpadding="3"
557
cellspacing="0" width="100%" bgcolor="white">
559
<table width="100%" cellpadding="0" cellspacing="0" border="0">
560
<tr valign="top"><td>
561
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
562
<span class="sig-arg">language</span>,
563
<span class="sig-arg">territory</span>=<span class="sig-default">None</span>,
564
<span class="sig-arg">script</span>=<span class="sig-default">None</span>,
565
<span class="sig-arg">variant</span>=<span class="sig-default">None</span>)</span>
566
<br /><em class="fname">(Constructor)</em>
568
</td><td align="right" valign="top"
573
<p>Initialize the locale object from the given identifier components.</p>
574
<pre class="py-doctest">
575
<span class="py-prompt">>>> </span>locale = Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>)
576
<span class="py-prompt">>>> </span>locale.language
577
<span class="py-output">'en'</span>
578
<span class="py-output"></span><span class="py-prompt">>>> </span>locale.territory
579
<span class="py-output">'US'</span></pre>
582
<dd><ul class="nomargin-top">
583
<li><strong class="pname"><code>language</code></strong> - the language code</li>
584
<li><strong class="pname"><code>territory</code></strong> - the territory (country or region) code</li>
585
<li><strong class="pname"><code>script</code></strong> - the script code</li>
586
<li><strong class="pname"><code>variant</code></strong> - the variant code</li>
589
<dd><ul class="nomargin-top">
590
<li><code><strong class='fraise'><a href="babel.core.UnknownLocaleError-class.html">UnknownLocaleError</a></strong></code> - if no locale data is available for the
591
requested locale</li>
599
<a name="default"></a>
601
<table class="details" border="1" cellpadding="3"
602
cellspacing="0" width="100%" bgcolor="white">
604
<table width="100%" cellpadding="0" cellspacing="0" border="0">
605
<tr valign="top"><td>
606
<h3 class="epydoc"><span class="sig"><span class="sig-name">default</span>(<span class="sig-arg">cls</span>,
607
<span class="sig-arg">category</span>=<span class="sig-default">None</span>,
608
<span class="sig-arg">aliases</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">ar</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ar_SY</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bg_BG</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bs</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bs_BA</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">ca</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ca_ES</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></span>)</span>
609
<br /><em class="fname">Class Method</em>
611
</td><td align="right" valign="top"
616
<p>Return the system default locale for the specified category.</p>
617
<pre class="py-doctest">
618
<span class="py-prompt">>>> </span><span class="py-keyword">for</span> name <span class="py-keyword">in</span> [<span class="py-string">'LANGUAGE'</span>, <span class="py-string">'LC_ALL'</span>, <span class="py-string">'LC_CTYPE'</span>]:
619
<span class="py-more">... </span> os.environ[name] = <span class="py-string">''</span>
620
<span class="py-prompt">>>> </span>os.environ[<span class="py-string">'LANG'</span>] = <span class="py-string">'fr_FR.UTF-8'</span>
621
<span class="py-prompt">>>> </span>Locale.default(<span class="py-string">'LC_MESSAGES'</span>)
622
<span class="py-output"><Locale "fr_FR"></span></pre>
625
<dd><ul class="nomargin-top">
626
<li><strong class="pname"><code>category</code></strong> - one of the <tt class="rst-docutils literal">LC_XXX</tt> environment variable names</li>
627
<li><strong class="pname"><code>aliases</code></strong> - a dictionary of aliases for locale identifiers</li>
629
<dt>Returns: <a href="babel.core.Locale-class.html" class="link">Locale</a></dt>
630
<dd>the value of the variable, or any of the fallbacks
631
(<tt class="rst-docutils literal">LANGUAGE</tt>, <tt class="rst-docutils literal">LC_ALL</tt>, <tt class="rst-docutils literal">LC_CTYPE</tt>, and <tt class="rst-docutils literal">LANG</tt>)</dd>
633
<div class="fields"> <p><strong>See Also:</strong>
634
<a href="babel.core-module.html#default_locale" class="link">default_locale</a>
636
</div></td></tr></table>
638
<a name="negotiate"></a>
640
<table class="details" border="1" cellpadding="3"
641
cellspacing="0" width="100%" bgcolor="white">
643
<table width="100%" cellpadding="0" cellspacing="0" border="0">
644
<tr valign="top"><td>
645
<h3 class="epydoc"><span class="sig"><span class="sig-name">negotiate</span>(<span class="sig-arg">cls</span>,
646
<span class="sig-arg">preferred</span>,
647
<span class="sig-arg">available</span>,
648
<span class="sig-arg">sep</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code></span>,
649
<span class="sig-arg">aliases</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">ar</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ar_SY</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bg_BG</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">bs</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bs_BA</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">ca</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">ca_ES</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></span>)</span>
650
<br /><em class="fname">Class Method</em>
652
</td><td align="right" valign="top"
657
<p>Find the best match between available and requested locale strings.</p>
658
<pre class="py-doctest">
659
<span class="py-prompt">>>> </span>Locale.negotiate([<span class="py-string">'de_DE'</span>, <span class="py-string">'en_US'</span>], [<span class="py-string">'de_DE'</span>, <span class="py-string">'de_AT'</span>])
660
<span class="py-output"><Locale "de_DE"></span>
661
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale.negotiate([<span class="py-string">'de_DE'</span>, <span class="py-string">'en_US'</span>], [<span class="py-string">'en'</span>, <span class="py-string">'de'</span>])
662
<span class="py-output"><Locale "de"></span>
663
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale.negotiate([<span class="py-string">'de_DE'</span>, <span class="py-string">'de'</span>], [<span class="py-string">'en_US'</span>])</pre>
664
<p>You can specify the character used in the locale identifiers to separate
665
the differnet components. This separator is applied to both lists. Also,
666
case is ignored in the comparison:</p>
667
<pre class="py-doctest">
668
<span class="py-prompt">>>> </span>Locale.negotiate([<span class="py-string">'de-DE'</span>, <span class="py-string">'de'</span>], [<span class="py-string">'en-us'</span>, <span class="py-string">'de-de'</span>], sep=<span class="py-string">'-'</span>)
669
<span class="py-output"><Locale "de_DE"></span></pre>
672
<dd><ul class="nomargin-top">
673
<li><strong class="pname"><code>preferred</code></strong> - the list of locale identifers preferred by the user</li>
674
<li><strong class="pname"><code>available</code></strong> - the list of locale identifiers available</li>
675
<li><strong class="pname"><code>aliases</code></strong> - a dictionary of aliases for locale identifiers</li>
677
<dt>Returns: <a href="babel.core.Locale-class.html" class="link">Locale</a></dt>
678
<dd>the <a href="babel.core.Locale-class.html" class="link">Locale</a> object for the best match, or <code class="link">None</code> if no match
681
<div class="fields"> <p><strong>See Also:</strong>
682
<a href="babel.core-module.html#negotiate_locale" class="link">negotiate_locale</a>
684
</div></td></tr></table>
688
<table class="details" border="1" cellpadding="3"
689
cellspacing="0" width="100%" bgcolor="white">
691
<table width="100%" cellpadding="0" cellspacing="0" border="0">
692
<tr valign="top"><td>
693
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse</span>(<span class="sig-arg">cls</span>,
694
<span class="sig-arg">identifier</span>,
695
<span class="sig-arg">sep</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">_</code><code class="variable-quote">'</code></span>)</span>
696
<br /><em class="fname">Class Method</em>
698
</td><td align="right" valign="top"
703
<p>Create a <a href="babel.core.Locale-class.html" class="link">Locale</a> instance for the given locale identifier.</p>
704
<pre class="py-doctest">
705
<span class="py-prompt">>>> </span>l = Locale.parse(<span class="py-string">'de-DE'</span>, sep=<span class="py-string">'-'</span>)
706
<span class="py-prompt">>>> </span>l.display_name
707
<span class="py-output">u'Deutsch (Deutschland)'</span></pre>
708
<p>If the <code class="link">identifier</code> parameter is not a string, but actually a <a href="babel.core.Locale-class.html" class="link">Locale</a>
709
object, that object is returned:</p>
710
<pre class="py-doctest">
711
<span class="py-prompt">>>> </span>Locale.parse(l)
712
<span class="py-output"><Locale "de_DE"></span></pre>
715
<dd><ul class="nomargin-top">
716
<li><strong class="pname"><code>identifier</code></strong> - the locale identifier string</li>
717
<li><strong class="pname"><code>sep</code></strong> - optional component separator</li>
719
<dt>Returns: <a href="babel.core.Locale-class.html" class="link">Locale</a></dt>
720
<dd>a corresponding <a href="babel.core.Locale-class.html" class="link">Locale</a> instance</dd>
722
<dd><ul class="nomargin-top">
723
<li><code><strong class='fraise'>ValueError</strong></code> - if the string does not appear to be a valid locale
725
<li><code><strong class='fraise'><a href="babel.core.UnknownLocaleError-class.html">UnknownLocaleError</a></strong></code> - if no locale data is available for the
726
requested locale</li>
729
<div class="fields"> <p><strong>See Also:</strong>
730
<a href="babel.core-module.html#parse_locale" class="link">parse_locale</a>
732
</div></td></tr></table>
734
<a name="__repr__"></a>
736
<table class="details" border="1" cellpadding="3"
737
cellspacing="0" width="100%" bgcolor="white">
739
<table width="100%" cellpadding="0" cellspacing="0" border="0">
740
<tr valign="top"><td>
741
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
742
<br /><em class="fname">(Representation operator)</em>
744
</td><td align="right" valign="top"
753
<dd><em class="note">(inherited documentation)</em></dd>
758
<a name="__str__"></a>
760
<table class="details" border="1" cellpadding="3"
761
cellspacing="0" width="100%" bgcolor="white">
763
<table width="100%" cellpadding="0" cellspacing="0" border="0">
764
<tr valign="top"><td>
765
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
766
<br /><em class="fname">(Informal representation operator)</em>
768
</td><td align="right" valign="top"
777
<dd><em class="note">(inherited documentation)</em></dd>
782
<a name="get_display_name"></a>
784
<table class="details" border="1" cellpadding="3"
785
cellspacing="0" width="100%" bgcolor="white">
787
<table width="100%" cellpadding="0" cellspacing="0" border="0">
788
<tr valign="top"><td>
789
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_display_name</span>(<span class="sig-arg">self</span>,
790
<span class="sig-arg">locale</span>=<span class="sig-default">None</span>)</span>
792
</td><td align="right" valign="top"
797
<p>Return the display name of the locale using the given locale.</p>
798
<p>The display name will include the language, territory, script, and
799
variant, if those are specified.</p>
800
<pre class="py-doctest">
801
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'zh'</span>, <span class="py-string">'CN'</span>, script=<span class="py-string">'Hans'</span>).get_display_name(<span class="py-string">'en'</span>)
802
<span class="py-output">u'Chinese (Simplified Han, China)'</span></pre>
805
<dd><ul class="nomargin-top">
806
<li><strong class="pname"><code>locale</code></strong> - the locale to use</li>
809
<dd>the display name</dd>
814
<!-- ==================== PROPERTY DETAILS ==================== -->
815
<a name="section-PropertyDetails"></a>
816
<table class="details" border="1" cellpadding="3"
817
cellspacing="0" width="100%" bgcolor="white">
818
<tr bgcolor="#70b0f0" class="table-header">
819
<td align="left" colspan="2" class="table-header">
820
<span class="table-header">Property Details</span></td>
823
<a name="display_name"></a>
825
<table class="details" border="1" cellpadding="3"
826
cellspacing="0" width="100%" bgcolor="white">
828
<h3 class="epydoc">display_name</h3>
829
<p>The localized display name of the locale.</p>
830
<pre class="py-doctest">
831
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>).display_name
832
<span class="py-output">u'English'</span>
833
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).display_name
834
<span class="py-output">u'English (United States)'</span>
835
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'sv'</span>).display_name
836
<span class="py-output">u'svenska'</span></pre>
839
<dd class="value"><span class="summary-sig"><a href="babel.core.Locale-class.html#get_display_name" class="summary-sig-name">get_display_name</a>(<span class="summary-sig-arg">self</span>,
840
<span class="summary-sig-arg">locale</span>=<span class="summary-sig-default">None</span>)</span>
841
- Return the display name of the locale using the given locale.
844
<dd><code class="link">unicode</code></dd>
848
<a name="english_name"></a>
850
<table class="details" border="1" cellpadding="3"
851
cellspacing="0" width="100%" bgcolor="white">
853
<h3 class="epydoc">english_name</h3>
854
<p>The english display name of the locale.</p>
855
<pre class="py-doctest">
856
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>).english_name
857
<span class="py-output">u'German'</span>
858
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).english_name
859
<span class="py-output">u'German (Germany)'</span></pre>
862
<dd class="value"><span class="summary-sig"><i>unreachable</i>.english_name(<span class="summary-sig-arg">self</span>)</span>
865
<dd><code class="link">unicode</code></dd>
869
<a name="languages"></a>
871
<table class="details" border="1" cellpadding="3"
872
cellspacing="0" width="100%" bgcolor="white">
874
<h3 class="epydoc">languages</h3>
875
<p>Mapping of language codes to translated language names.</p>
876
<pre class="py-doctest">
877
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).languages[<span class="py-string">'ja'</span>]
878
<span class="py-output">u'Japanisch'</span></pre>
881
<dd class="value"><span class="summary-sig"><i>unreachable</i>.languages(<span class="summary-sig-arg">self</span>)</span>
884
<dd><code class="link">dict</code></dd>
886
<div class="fields"> <p><strong>See Also:</strong>
887
<a class="rst-reference external" href="http://www.loc.gov/standards/iso639-2/" target="_top">ISO 639</a>
889
</div></td></tr></table>
891
<a name="scripts"></a>
893
<table class="details" border="1" cellpadding="3"
894
cellspacing="0" width="100%" bgcolor="white">
896
<h3 class="epydoc">scripts</h3>
897
<p>Mapping of script codes to translated script names.</p>
898
<pre class="py-doctest">
899
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).scripts[<span class="py-string">'Hira'</span>]
900
<span class="py-output">u'Hiragana'</span></pre>
903
<dd class="value"><span class="summary-sig"><i>unreachable</i>.scripts(<span class="summary-sig-arg">self</span>)</span>
906
<dd><code class="link">dict</code></dd>
908
<div class="fields"> <p><strong>See Also:</strong>
909
<a class="rst-reference external" href="http://www.evertype.com/standards/iso15924/" target="_top">ISO 15924</a>
911
</div></td></tr></table>
913
<a name="territories"></a>
915
<table class="details" border="1" cellpadding="3"
916
cellspacing="0" width="100%" bgcolor="white">
918
<h3 class="epydoc">territories</h3>
919
<p>Mapping of script codes to translated script names.</p>
920
<pre class="py-doctest">
921
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'es'</span>, <span class="py-string">'CO'</span>).territories[<span class="py-string">'DE'</span>]
922
<span class="py-output">u'Alemania'</span></pre>
925
<dd class="value"><span class="summary-sig"><i>unreachable</i>.territories(<span class="summary-sig-arg">self</span>)</span>
928
<dd><code class="link">dict</code></dd>
930
<div class="fields"> <p><strong>See Also:</strong>
931
<a class="rst-reference external" href="http://www.iso.org/iso/en/prods-services/iso3166ma/" target="_top">ISO 3166</a>
933
</div></td></tr></table>
935
<a name="variants"></a>
937
<table class="details" border="1" cellpadding="3"
938
cellspacing="0" width="100%" bgcolor="white">
940
<h3 class="epydoc">variants</h3>
941
<p>Mapping of script codes to translated script names.</p>
942
<pre class="py-doctest">
943
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).variants[<span class="py-string">'1901'</span>]
944
<span class="py-output">u'Alte deutsche Rechtschreibung'</span></pre>
947
<dd class="value"><span class="summary-sig"><i>unreachable</i>.variants(<span class="summary-sig-arg">self</span>)</span>
950
<dd><code class="link">dict</code></dd>
954
<a name="currencies"></a>
956
<table class="details" border="1" cellpadding="3"
957
cellspacing="0" width="100%" bgcolor="white">
959
<h3 class="epydoc">currencies</h3>
960
<p>Mapping of currency codes to translated currency names.</p>
961
<pre class="py-doctest">
962
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>).currencies[<span class="py-string">'COP'</span>]
963
<span class="py-output">u'Colombian Peso'</span>
964
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).currencies[<span class="py-string">'COP'</span>]
965
<span class="py-output">u'Kolumbianischer Peso'</span></pre>
968
<dd class="value"><span class="summary-sig"><i>unreachable</i>.currencies(<span class="summary-sig-arg">self</span>)</span>
971
<dd><code class="link">dict</code></dd>
975
<a name="currency_symbols"></a>
977
<table class="details" border="1" cellpadding="3"
978
cellspacing="0" width="100%" bgcolor="white">
980
<h3 class="epydoc">currency_symbols</h3>
981
<p>Mapping of currency codes to symbols.</p>
982
<pre class="py-doctest">
983
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).currency_symbols[<span class="py-string">'USD'</span>]
984
<span class="py-output">u'$'</span>
985
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'es'</span>, <span class="py-string">'CO'</span>).currency_symbols[<span class="py-string">'USD'</span>]
986
<span class="py-output">u'US$'</span></pre>
989
<dd class="value"><span class="summary-sig"><i>unreachable</i>.currency_symbols(<span class="summary-sig-arg">self</span>)</span>
992
<dd><code class="link">dict</code></dd>
996
<a name="number_symbols"></a>
998
<table class="details" border="1" cellpadding="3"
999
cellspacing="0" width="100%" bgcolor="white">
1001
<h3 class="epydoc">number_symbols</h3>
1002
<p>Symbols used in number formatting.</p>
1003
<pre class="py-doctest">
1004
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'fr'</span>, <span class="py-string">'FR'</span>).number_symbols[<span class="py-string">'decimal'</span>]
1005
<span class="py-output">u','</span></pre>
1007
<dt>Get Method:</dt>
1008
<dd class="value"><span class="summary-sig"><i>unreachable</i>.number_symbols(<span class="summary-sig-arg">self</span>)</span>
1011
<dd><code class="link">dict</code></dd>
1015
<a name="decimal_formats"></a>
1017
<table class="details" border="1" cellpadding="3"
1018
cellspacing="0" width="100%" bgcolor="white">
1020
<h3 class="epydoc">decimal_formats</h3>
1021
<p>Locale patterns for decimal number formatting.</p>
1022
<pre class="py-doctest">
1023
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).decimal_formats[None]
1024
<span class="py-output"><NumberPattern u'#,##0.###'></span></pre>
1026
<dt>Get Method:</dt>
1027
<dd class="value"><span class="summary-sig"><i>unreachable</i>.decimal_formats(<span class="summary-sig-arg">self</span>)</span>
1030
<dd><code class="link">dict</code></dd>
1034
<a name="currency_formats"></a>
1036
<table class="details" border="1" cellpadding="3"
1037
cellspacing="0" width="100%" bgcolor="white">
1039
<h3 class="epydoc">currency_formats</h3>
1040
<p>Locale patterns for currency number formatting.</p>
1041
<pre class="py-doctest">
1042
<span class="py-prompt">>>> </span><span class="py-keyword">print</span> Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).currency_formats[None]
1043
<span class="py-output"><NumberPattern u'\xa4#,##0.00'></span></pre>
1045
<dt>Get Method:</dt>
1046
<dd class="value"><span class="summary-sig"><i>unreachable</i>.currency_formats(<span class="summary-sig-arg">self</span>)</span>
1049
<dd><code class="link">dict</code></dd>
1053
<a name="percent_formats"></a>
1055
<table class="details" border="1" cellpadding="3"
1056
cellspacing="0" width="100%" bgcolor="white">
1058
<h3 class="epydoc">percent_formats</h3>
1059
<p>Locale patterns for percent number formatting.</p>
1060
<pre class="py-doctest">
1061
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).percent_formats[None]
1062
<span class="py-output"><NumberPattern u'#,##0%'></span></pre>
1064
<dt>Get Method:</dt>
1065
<dd class="value"><span class="summary-sig"><i>unreachable</i>.percent_formats(<span class="summary-sig-arg">self</span>)</span>
1068
<dd><code class="link">dict</code></dd>
1072
<a name="scientific_formats"></a>
1074
<table class="details" border="1" cellpadding="3"
1075
cellspacing="0" width="100%" bgcolor="white">
1077
<h3 class="epydoc">scientific_formats</h3>
1078
<p>Locale patterns for scientific number formatting.</p>
1079
<pre class="py-doctest">
1080
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).scientific_formats[None]
1081
<span class="py-output"><NumberPattern u'#E0'></span></pre>
1083
<dt>Get Method:</dt>
1084
<dd class="value"><span class="summary-sig"><i>unreachable</i>.scientific_formats(<span class="summary-sig-arg">self</span>)</span>
1087
<dd><code class="link">dict</code></dd>
1091
<a name="periods"></a>
1093
<table class="details" border="1" cellpadding="3"
1094
cellspacing="0" width="100%" bgcolor="white">
1096
<h3 class="epydoc">periods</h3>
1097
<p>Locale display names for day periods (AM/PM).</p>
1098
<pre class="py-doctest">
1099
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).periods[<span class="py-string">'am'</span>]
1100
<span class="py-output">u'AM'</span></pre>
1102
<dt>Get Method:</dt>
1103
<dd class="value"><span class="summary-sig"><i>unreachable</i>.periods(<span class="summary-sig-arg">self</span>)</span>
1106
<dd><code class="link">dict</code></dd>
1112
<table class="details" border="1" cellpadding="3"
1113
cellspacing="0" width="100%" bgcolor="white">
1115
<h3 class="epydoc">days</h3>
1116
<p>Locale display names for weekdays.</p>
1117
<pre class="py-doctest">
1118
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).days[<span class="py-string">'format'</span>][<span class="py-string">'wide'</span>][3]
1119
<span class="py-output">u'Donnerstag'</span></pre>
1121
<dt>Get Method:</dt>
1122
<dd class="value"><span class="summary-sig"><i>unreachable</i>.days(<span class="summary-sig-arg">self</span>)</span>
1125
<dd><code class="link">dict</code></dd>
1129
<a name="months"></a>
1131
<table class="details" border="1" cellpadding="3"
1132
cellspacing="0" width="100%" bgcolor="white">
1134
<h3 class="epydoc">months</h3>
1135
<p>Locale display names for months.</p>
1136
<pre class="py-doctest">
1137
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).months[<span class="py-string">'format'</span>][<span class="py-string">'wide'</span>][10]
1138
<span class="py-output">u'Oktober'</span></pre>
1140
<dt>Get Method:</dt>
1141
<dd class="value"><span class="summary-sig"><i>unreachable</i>.months(<span class="summary-sig-arg">self</span>)</span>
1144
<dd><code class="link">dict</code></dd>
1148
<a name="quarters"></a>
1150
<table class="details" border="1" cellpadding="3"
1151
cellspacing="0" width="100%" bgcolor="white">
1153
<h3 class="epydoc">quarters</h3>
1154
<p>Locale display names for quarters.</p>
1155
<pre class="py-doctest">
1156
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).quarters[<span class="py-string">'format'</span>][<span class="py-string">'wide'</span>][1]
1157
<span class="py-output">u'1. Quartal'</span></pre>
1159
<dt>Get Method:</dt>
1160
<dd class="value"><span class="summary-sig"><i>unreachable</i>.quarters(<span class="summary-sig-arg">self</span>)</span>
1163
<dd><code class="link">dict</code></dd>
1169
<table class="details" border="1" cellpadding="3"
1170
cellspacing="0" width="100%" bgcolor="white">
1172
<h3 class="epydoc">eras</h3>
1173
<p>Locale display names for eras.</p>
1174
<pre class="py-doctest">
1175
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).eras[<span class="py-string">'wide'</span>][1]
1176
<span class="py-output">u'Anno Domini'</span>
1177
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).eras[<span class="py-string">'abbreviated'</span>][0]
1178
<span class="py-output">u'BC'</span></pre>
1180
<dt>Get Method:</dt>
1181
<dd class="value"><span class="summary-sig"><i>unreachable</i>.eras(<span class="summary-sig-arg">self</span>)</span>
1184
<dd><code class="link">dict</code></dd>
1188
<a name="time_zones"></a>
1190
<table class="details" border="1" cellpadding="3"
1191
cellspacing="0" width="100%" bgcolor="white">
1193
<h3 class="epydoc">time_zones</h3>
1194
<p>Locale display names for time zones.</p>
1195
<pre class="py-doctest">
1196
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).time_zones[<span class="py-string">'Europe/London'</span>][<span class="py-string">'long'</span>][<span class="py-string">'daylight'</span>]
1197
<span class="py-output">u'British Summer Time'</span>
1198
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).time_zones[<span class="py-string">'America/St_Johns'</span>][<span class="py-string">'city'</span>]
1199
<span class="py-output">u"St. John's"</span></pre>
1201
<dt>Get Method:</dt>
1202
<dd class="value"><span class="summary-sig"><i>unreachable</i>.time_zones(<span class="summary-sig-arg">self</span>)</span>
1205
<dd><code class="link">dict</code></dd>
1209
<a name="meta_zones"></a>
1211
<table class="details" border="1" cellpadding="3"
1212
cellspacing="0" width="100%" bgcolor="white">
1214
<h3 class="epydoc">meta_zones</h3>
1215
<p>Locale display names for meta time zones.</p>
1216
<p>Meta time zones are basically groups of different Olson time zones that
1217
have the same GMT offset and daylight savings time.</p>
1218
<pre class="py-doctest">
1219
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).meta_zones[<span class="py-string">'Europe_Central'</span>][<span class="py-string">'long'</span>][<span class="py-string">'daylight'</span>]
1220
<span class="py-output">u'Central European Summer Time'</span></pre>
1222
<dt>Get Method:</dt>
1223
<dd class="value"><span class="summary-sig"><i>unreachable</i>.meta_zones(<span class="summary-sig-arg">self</span>)</span>
1226
<dd><code class="link">dict</code></dd>
1228
<div class="fields"> <p><strong>Since:</strong>
1231
</div></td></tr></table>
1233
<a name="zone_formats"></a>
1235
<table class="details" border="1" cellpadding="3"
1236
cellspacing="0" width="100%" bgcolor="white">
1238
<h3 class="epydoc">zone_formats</h3>
1239
<p>Patterns related to the formatting of time zones.</p>
1240
<pre class="py-doctest">
1241
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).zone_formats[<span class="py-string">'fallback'</span>]
1242
<span class="py-output">u'%(1)s (%(0)s)'</span>
1243
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'pt'</span>, <span class="py-string">'BR'</span>).zone_formats[<span class="py-string">'region'</span>]
1244
<span class="py-output">u'Hor\xe1rio %s'</span></pre>
1246
<dt>Get Method:</dt>
1247
<dd class="value"><span class="summary-sig"><i>unreachable</i>.zone_formats(<span class="summary-sig-arg">self</span>)</span>
1250
<dd><code class="link">dict</code></dd>
1252
<div class="fields"> <p><strong>Since:</strong>
1255
</div></td></tr></table>
1257
<a name="first_week_day"></a>
1259
<table class="details" border="1" cellpadding="3"
1260
cellspacing="0" width="100%" bgcolor="white">
1262
<h3 class="epydoc">first_week_day</h3>
1263
<p>The first day of a week, with 0 being Monday.</p>
1264
<pre class="py-doctest">
1265
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).first_week_day
1266
<span class="py-output">0</span>
1267
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).first_week_day
1268
<span class="py-output">6</span></pre>
1270
<dt>Get Method:</dt>
1271
<dd class="value"><span class="summary-sig"><i>unreachable</i>.first_week_day(<span class="summary-sig-arg">self</span>)</span>
1274
<dd><code class="link">int</code></dd>
1278
<a name="weekend_start"></a>
1280
<table class="details" border="1" cellpadding="3"
1281
cellspacing="0" width="100%" bgcolor="white">
1283
<h3 class="epydoc">weekend_start</h3>
1284
<p>The day the weekend starts, with 0 being Monday.</p>
1285
<pre class="py-doctest">
1286
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).weekend_start
1287
<span class="py-output">5</span></pre>
1289
<dt>Get Method:</dt>
1290
<dd class="value"><span class="summary-sig"><i>unreachable</i>.weekend_start(<span class="summary-sig-arg">self</span>)</span>
1293
<dd><code class="link">int</code></dd>
1297
<a name="weekend_end"></a>
1299
<table class="details" border="1" cellpadding="3"
1300
cellspacing="0" width="100%" bgcolor="white">
1302
<h3 class="epydoc">weekend_end</h3>
1303
<p>The day the weekend ends, with 0 being Monday.</p>
1304
<pre class="py-doctest">
1305
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).weekend_end
1306
<span class="py-output">6</span></pre>
1308
<dt>Get Method:</dt>
1309
<dd class="value"><span class="summary-sig"><i>unreachable</i>.weekend_end(<span class="summary-sig-arg">self</span>)</span>
1312
<dd><code class="link">int</code></dd>
1316
<a name="min_week_days"></a>
1318
<table class="details" border="1" cellpadding="3"
1319
cellspacing="0" width="100%" bgcolor="white">
1321
<h3 class="epydoc">min_week_days</h3>
1322
<p>The minimum number of days in a week so that the week is counted as the
1323
first week of a year or month.</p>
1324
<pre class="py-doctest">
1325
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'de'</span>, <span class="py-string">'DE'</span>).min_week_days
1326
<span class="py-output">4</span></pre>
1328
<dt>Get Method:</dt>
1329
<dd class="value"><span class="summary-sig"><i>unreachable</i>.min_week_days(<span class="summary-sig-arg">self</span>)</span>
1332
<dd><code class="link">int</code></dd>
1336
<a name="date_formats"></a>
1338
<table class="details" border="1" cellpadding="3"
1339
cellspacing="0" width="100%" bgcolor="white">
1341
<h3 class="epydoc">date_formats</h3>
1342
<p>Locale patterns for date formatting.</p>
1343
<pre class="py-doctest">
1344
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).date_formats[<span class="py-string">'short'</span>]
1345
<span class="py-output"><DateTimePattern u'M/d/yy'></span>
1346
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'fr'</span>, <span class="py-string">'FR'</span>).date_formats[<span class="py-string">'long'</span>]
1347
<span class="py-output"><DateTimePattern u'd MMMM yyyy'></span></pre>
1349
<dt>Get Method:</dt>
1350
<dd class="value"><span class="summary-sig"><i>unreachable</i>.date_formats(<span class="summary-sig-arg">self</span>)</span>
1353
<dd><code class="link">dict</code></dd>
1357
<a name="time_formats"></a>
1359
<table class="details" border="1" cellpadding="3"
1360
cellspacing="0" width="100%" bgcolor="white">
1362
<h3 class="epydoc">time_formats</h3>
1363
<p>Locale patterns for time formatting.</p>
1364
<pre class="py-doctest">
1365
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>, <span class="py-string">'US'</span>).time_formats[<span class="py-string">'short'</span>]
1366
<span class="py-output"><DateTimePattern u'h:mm a'></span>
1367
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'fr'</span>, <span class="py-string">'FR'</span>).time_formats[<span class="py-string">'long'</span>]
1368
<span class="py-output"><DateTimePattern u'HH:mm:ss z'></span></pre>
1370
<dt>Get Method:</dt>
1371
<dd class="value"><span class="summary-sig"><i>unreachable</i>.time_formats(<span class="summary-sig-arg">self</span>)</span>
1374
<dd><code class="link">dict</code></dd>
1378
<a name="datetime_formats"></a>
1380
<table class="details" border="1" cellpadding="3"
1381
cellspacing="0" width="100%" bgcolor="white">
1383
<h3 class="epydoc">datetime_formats</h3>
1384
<p>Locale patterns for datetime formatting.</p>
1385
<pre class="py-doctest">
1386
<span class="py-prompt">>>> </span>Locale(<span class="py-string">'en'</span>).datetime_formats[None]
1387
<span class="py-output">u'{1} {0}'</span>
1388
<span class="py-output"></span><span class="py-prompt">>>> </span>Locale(<span class="py-string">'th'</span>).datetime_formats[None]
1389
<span class="py-output">u'{1}, {0}'</span></pre>
1391
<dt>Get Method:</dt>
1392
<dd class="value"><span class="summary-sig"><i>unreachable</i>.datetime_formats(<span class="summary-sig-arg">self</span>)</span>
1395
<dd><code class="link">dict</code></dd>
1400
<!-- ==================== NAVIGATION BAR ==================== -->
1401
<table class="navbar" border="0" width="100%" cellpadding="0"
1402
bgcolor="#a0c0ff" cellspacing="0">
1403
<tr valign="middle">
1405
<th> <a
1406
href="babel-module.html">Home</a> </th>
1409
<th> <a
1410
href="module-tree.html">Trees</a> </th>
1413
<th> <a
1414
href="identifier-index.html">Indices</a> </th>
1417
<th> <a
1418
href="help.html">Help</a> </th>
1420
<!-- Project homepage -->
1421
<th class="navbar" align="right" width="100%">
1422
<table border="0" cellpadding="0" cellspacing="0">
1423
<tr><th class="navbar" align="center"
1424
><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
1428
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1430
<td align="left" class="footer">
1431
Generated by Epydoc 3.0.1 on Thu Mar 17 15:12:44 2011
1433
<td align="right" class="footer">
1434
<a target="mainFrame" href="http://epydoc.sourceforge.net"
1435
>http://epydoc.sourceforge.net</a>
1440
<script type="text/javascript">
1442
// Private objects are initially displayed (because if
1443
// javascript is turned off then we want them to be
1444
// visible); but by default, we want to hide them. So hide
1445
// them unless we have a cookie that says to show them.