annotate babel/core.py @ 148:37f4875bad88

The `LANGUAGE` environment variable may contain a colon-separated list of language codes.
author cmlenz
date Wed, 20 Jun 2007 20:18:52 +0000
parents b75ae5def3b1
children e1985b8cdcd6
rev   line source
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
2 #
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
3 # Copyright (C) 2007 Edgewall Software
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
4 # All rights reserved.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
5 #
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
8 # are also available at http://babel.edgewall.org/wiki/License.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
9 #
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
12 # history and logs, available at http://babel.edgewall.org/log/.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
13
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
14 """Core locale representation and locale data access."""
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
15
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
16 import os
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
17
26
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
18 from babel import localedata
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
19
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
20 __all__ = ['UnknownLocaleError', 'Locale', 'default_locale', 'negotiate_locale',
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
21 'parse_locale']
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
22 __docformat__ = 'restructuredtext en'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
23
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
24
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
25 class UnknownLocaleError(Exception):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
26 """Exception thrown when a locale is requested for which no locale data
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
27 is available.
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
28 """
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
29
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
30 def __init__(self, identifier):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
31 """Create the exception.
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
32
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
33 :param identifier: the identifier string of the unsupported locale
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
34 """
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
35 Exception.__init__(self, 'unknown locale %r' % identifier)
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
36 self.identifier = identifier
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
37
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
38
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
39 class Locale(object):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
40 """Representation of a specific locale.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
41
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
42 >>> locale = Locale('en', territory='US')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
43 >>> repr(locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
44 '<Locale "en_US">'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
45 >>> locale.display_name
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
46 u'English (United States)'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
47
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
48 A `Locale` object can also be instantiated from a raw locale string:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
49
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
50 >>> locale = Locale.parse('en-US', sep='-')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
51 >>> repr(locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
52 '<Locale "en_US">'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
53
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
54 `Locale` objects provide access to a collection of locale data, such as
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
55 territory and language names, number and date format patterns, and more:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
56
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
57 >>> locale.number_symbols['decimal']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
58 u'.'
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
59
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
60 If a locale is requested for which no locale data is available, an
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
61 `UnknownLocaleError` is raised:
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
62
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
63 >>> Locale.parse('en_DE')
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
64 Traceback (most recent call last):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
65 ...
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
66 UnknownLocaleError: unknown locale 'en_DE'
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
67
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
68 :see: `IETF RFC 3066 <http://www.ietf.org/rfc/rfc3066.txt>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
69 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
70
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
71 def __init__(self, language, territory=None, variant=None):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
72 """Initialize the locale object from the given identifier components.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
73
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
74 >>> locale = Locale('en', 'US')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
75 >>> locale.language
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
76 'en'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
77 >>> locale.territory
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
78 'US'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
79
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
80 :param language: the language code
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
81 :param territory: the territory (country or region) code
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
82 :param variant: the variant code
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
83 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
84 requested locale
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
85 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
86 self.language = language
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
87 self.territory = territory
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
88 self.variant = variant
41
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
89 self.__data = None
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
90
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
91 identifier = str(self)
41
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
92 if not localedata.exists(identifier):
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
93 raise UnknownLocaleError(identifier)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
94
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
95 def default(cls, category=None):
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
96 """Return the system default locale for the specified category.
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
97
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
98 >>> for name in ['LANGUAGE', 'LC_ALL', 'LC_CTYPE']:
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
99 ... os.environ[name] = ''
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
100 >>> os.environ['LANG'] = 'fr_FR.UTF-8'
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
101 >>> Locale.default('LC_MESSAGES')
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
102 <Locale "fr_FR">
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
103
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
104 :param category: one of the ``LC_XXX`` environment variable names
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
105 :return: the value of the variable, or any of the fallbacks
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
106 (``LANGUAGE``, ``LC_ALL``, ``LC_CTYPE``, and ``LANG``)
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
107 :rtype: `Locale`
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
108 """
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
109 return cls(default_locale(category))
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
110 default = classmethod(default)
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
111
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
112 def negotiate(cls, preferred, available, sep='_'):
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
113 """Find the best match between available and requested locale strings.
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
114
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
115 >>> Locale.negotiate(['de_DE', 'en_US'], ['de_DE', 'de_AT'])
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
116 <Locale "de_DE">
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
117 >>> Locale.negotiate(['de_DE', 'en_US'], ['en', 'de'])
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
118 <Locale "de">
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
119 >>> Locale.negotiate(['de_DE', 'de'], ['en_US'])
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
120
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
121 :param preferred: the list of locale identifers preferred by the user
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
122 :param available: the list of locale identifiers available
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
123 :return: the `Locale` object for the best match, or `None` if no match
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
124 was found
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
125 :rtype: `Locale`
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
126 """
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
127 identifier = negotiate_locale(preferred, available, sep=sep)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
128 if identifier:
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
129 return Locale.parse(identifier)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
130 negotiate = classmethod(negotiate)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
131
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
132 def parse(cls, identifier, sep='_'):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
133 """Create a `Locale` instance for the given locale identifier.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
134
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
135 >>> l = Locale.parse('de-DE', sep='-')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
136 >>> l.display_name
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
137 u'Deutsch (Deutschland)'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
138
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
139 If the `identifier` parameter is not a string, but actually a `Locale`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
140 object, that object is returned:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
141
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
142 >>> Locale.parse(l)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
143 <Locale "de_DE">
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
144
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
145 :param identifier: the locale identifier string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
146 :param sep: optional component separator
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
147 :return: a corresponding `Locale` instance
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
148 :rtype: `Locale`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
149 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
150 identifier
31
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
151 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5.
cmlenz
parents: 28
diff changeset
152 requested locale
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
153 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
154 if type(identifier) is cls:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
155 return identifier
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
156 return cls(*parse_locale(identifier, sep=sep))
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
157 parse = classmethod(parse)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
158
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
159 def __eq__(self, other):
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
160 return str(self) == str(other)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
161
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
162 def __repr__(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
163 return '<Locale "%s">' % str(self)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
164
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
165 def __str__(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
166 return '_'.join(filter(None, [self.language, self.territory,
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
167 self.variant]))
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
168
41
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
169 def _data(self):
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
170 if self.__data is None:
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
171 self.__data = localedata.load(str(self))
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
172 return self.__data
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
173 _data = property(_data)
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
174
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
175 def display_name(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
176 retval = self.languages.get(self.language)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
177 if self.territory:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
178 variant = ''
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
179 if self.variant:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
180 variant = ', %s' % self.variants.get(self.variant)
41
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
181 retval += ' (%s%s)' % (self.territories.get(self.territory),
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
182 variant)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
183 return retval
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
184 display_name = property(display_name, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
185 The localized display name of the locale.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
186
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
187 >>> Locale('en').display_name
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
188 u'English'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
189 >>> Locale('en', 'US').display_name
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
190 u'English (United States)'
41
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
191 >>> Locale('sv').display_name
e967fbafcda1 Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.
cmlenz
parents: 39
diff changeset
192 u'svenska'
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
193
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
194 :type: `unicode`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
195 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
196
53
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
197 def english_name(self):
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
198 en = Locale('en')
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
199 retval = en.languages.get(self.language)
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
200 if self.territory:
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
201 variant = ''
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
202 if self.variant:
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
203 variant = ', %s' % en.variants.get(self.variant)
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
204 retval += ' (%s%s)' % (en.territories.get(self.territory),
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
205 variant)
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
206 return retval
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
207 english_name = property(english_name, doc="""\
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
208 The english display name of the locale.
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
209
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
210 >>> Locale('de').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
211 u'German'
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
212 >>> Locale('de', 'DE').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
213 u'German (Germany)'
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
214
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
215 :type: `unicode`
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
216 """)
83f3f70c6ca3 Add `english_name` property to `Locale` class.
cmlenz
parents: 41
diff changeset
217
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
218 #{ General Locale Display Names
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
219
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
220 def languages(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
221 return self._data['languages']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
222 languages = property(languages, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
223 Mapping of language codes to translated language names.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
224
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
225 >>> Locale('de', 'DE').languages['ja']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
226 u'Japanisch'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
227
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
228 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
229 :see: `ISO 639 <http://www.loc.gov/standards/iso639-2/>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
230 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
231
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
232 def scripts(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
233 return self._data['scripts']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
234 scripts = property(scripts, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
235 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
236
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
237 >>> Locale('en', 'US').scripts['Hira']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
238 u'Hiragana'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
239
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
240 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
241 :see: `ISO 15924 <http://www.evertype.com/standards/iso15924/>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
242 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
243
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
244 def territories(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
245 return self._data['territories']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
246 territories = property(territories, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
247 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
248
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
249 >>> Locale('es', 'CO').territories['DE']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
250 u'Alemania'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
251
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
252 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
253 :see: `ISO 3166 <http://www.iso.org/iso/en/prods-services/iso3166ma/>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
254 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
255
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
256 def variants(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
257 return self._data['variants']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
258 variants = property(variants, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
259 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
260
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
261 >>> Locale('de', 'DE').variants['1901']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
262 u'alte deutsche Rechtschreibung'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
263
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
264 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
265 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
266
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
267 #{ Number Formatting
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
268
26
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
269 def currencies(self):
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
270 return self._data['currency_names']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
271 currencies = property(currencies, doc="""\
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
272 Mapping of currency codes to translated currency names.
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
273
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
274 >>> Locale('en').currencies['COP']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
275 u'Colombian Peso'
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
276 >>> Locale('de', 'DE').currencies['COP']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
277 u'Kolumbianischer Peso'
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
278
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
279 :type: `dict`
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
280 """)
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
281
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
282 def currency_symbols(self):
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
283 return self._data['currency_symbols']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
284 currency_symbols = property(currency_symbols, doc="""\
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
285 Mapping of currency codes to symbols.
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
286
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
287 >>> Locale('en').currency_symbols['USD']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
288 u'US$'
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
289 >>> Locale('en', 'US').currency_symbols['USD']
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
290 u'$'
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
291
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
292 :type: `dict`
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
293 """)
710090104678 * Reduce size of locale data pickles by only storing the data provided by each locale itself, and merging inherited data at runtime.
cmlenz
parents: 22
diff changeset
294
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
295 def number_symbols(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
296 return self._data['number_symbols']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
297 number_symbols = property(number_symbols, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
298 Symbols used in number formatting.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
299
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
300 >>> Locale('fr', 'FR').number_symbols['decimal']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
301 u','
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
302
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
303 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
304 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
305
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
306 def decimal_formats(self):
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
307 return self._data['decimal_formats']
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
308 decimal_formats = property(decimal_formats, doc="""\
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
309 Locale patterns for decimal number formatting.
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
310
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
311 >>> Locale('en', 'US').decimal_formats[None]
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
312 <NumberPattern u'#,##0.###'>
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
313
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
314 :type: `dict`
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
315 """)
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
316
125
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
317 def currency_formats(self):
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
318 return self._data['currency_formats']
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
319 currency_formats = property(currency_formats, doc=r"""\
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
320 Locale patterns for currency number formatting.
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
321
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
322 >>> print Locale('en', 'US').currency_formats[None]
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
323 <NumberPattern u'\xa4#,##0.00'>
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
324
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
325 :type: `dict`
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
326 """)
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
327
22
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
328 def percent_formats(self):
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
329 return self._data['percent_formats']
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
330 percent_formats = property(percent_formats, doc="""\
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
331 Locale patterns for percent number formatting.
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
332
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
333 >>> Locale('en', 'US').percent_formats[None]
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
334 <NumberPattern u'#,##0%'>
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
335
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
336 :type: `dict`
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
337 """)
7d37639a7411 Implemented babel.numbers.format_percent
jonas
parents: 15
diff changeset
338
125
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
339 def scientific_formats(self):
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
340 return self._data['scientific_formats']
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
341 scientific_formats = property(scientific_formats, doc="""\
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
342 Locale patterns for scientific number formatting.
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
343
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
344 >>> Locale('en', 'US').scientific_formats[None]
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
345 <NumberPattern u'#E0'>
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
346
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
347 :type: `dict`
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
348 """)
b75ae5def3b1 Add currency formatting.
cmlenz
parents: 72
diff changeset
349
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
350 #{ Calendar Information and Date Formatting
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
351
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
352 def periods(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
353 return self._data['periods']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
354 periods = property(periods, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
355 Locale display names for day periods (AM/PM).
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
356
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
357 >>> Locale('en', 'US').periods['am']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
358 u'AM'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
359
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
360 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
361 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
362
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
363 def days(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
364 return self._data['days']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
365 days = property(days, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
366 Locale display names for weekdays.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
367
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
368 >>> Locale('de', 'DE').days['format']['wide'][3]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
369 u'Donnerstag'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
370
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
371 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
372 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
373
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
374 def months(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
375 return self._data['months']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
376 months = property(months, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
377 Locale display names for months.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
378
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
379 >>> Locale('de', 'DE').months['format']['wide'][10]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
380 u'Oktober'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
381
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
382 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
383 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
384
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
385 def quarters(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
386 return self._data['quarters']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
387 quarters = property(quarters, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
388 Locale display names for quarters.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
389
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
390 >>> Locale('de', 'DE').quarters['format']['wide'][1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
391 u'1. Quartal'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
392
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
393 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
394 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
395
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
396 def eras(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
397 return self._data['eras']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
398 eras = property(eras, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
399 Locale display names for eras.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
400
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
401 >>> Locale('en', 'US').eras['wide'][1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
402 u'Anno Domini'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
403 >>> Locale('en', 'US').eras['abbreviated'][0]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
404 u'BC'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
405
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
406 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
407 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
408
28
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
409 def time_zones(self):
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
410 return self._data['time_zones']
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
411 time_zones = property(time_zones, doc="""\
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
412 Locale display names for time zones.
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
413
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
414 >>> Locale('en', 'US').time_zones['America/Los_Angeles']['long']['standard']
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
415 u'Pacific Standard Time'
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
416 >>> Locale('en', 'US').time_zones['Europe/Dublin']['city']
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
417 u'Dublin'
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
418
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
419 :type: `dict`
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
420 """)
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle.
cmlenz
parents: 26
diff changeset
421
34
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
422 def zone_aliases(self):
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
423 return self._data['zone_aliases']
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
424 zone_aliases = property(zone_aliases, doc="""\
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
425 Mapping of time zone aliases to their respective canonical identifer.
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
426
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
427 >>> Locale('en').zone_aliases['UTC']
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
428 'Etc/GMT'
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
429
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
430 :type: `dict`
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
431 :note: this doesn't really belong here, as it does not change between
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
432 locales
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
433 """)
3666f3d3df15 Extended time-zone support.
cmlenz
parents: 33
diff changeset
434
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
435 def first_week_day(self):
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
436 return self._data['week_data']['first_day']
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
437 first_week_day = property(first_week_day, doc="""\
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
438 The first day of a week.
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
439
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
440 >>> Locale('de', 'DE').first_week_day
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
441 0
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
442 >>> Locale('en', 'US').first_week_day
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
443 6
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
444
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
445 :type: `int`
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
446 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
447
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
448 def weekend_start(self):
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
449 return self._data['week_data']['weekend_start']
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
450 weekend_start = property(weekend_start, doc="""\
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
451 The day the weekend starts.
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
452
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
453 >>> Locale('de', 'DE').weekend_start
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
454 5
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
455
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
456 :type: `int`
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
457 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
458
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
459 def weekend_end(self):
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
460 return self._data['week_data']['weekend_end']
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
461 weekend_end = property(weekend_end, doc="""\
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
462 The day the weekend ends.
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
463
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
464 >>> Locale('de', 'DE').weekend_end
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
465 6
8
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
466
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
467 :type: `int`
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
468 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
469
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
470 def min_week_days(self):
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
471 return self._data['week_data']['min_days']
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
472 min_week_days = property(min_week_days, doc="""\
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
473 The minimum number of days in a week so that the week is counted as the
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
474 first week of a year or month.
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
475
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
476 >>> Locale('de', 'DE').min_week_days
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
477 4
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
478
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
479 :type: `int`
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
480 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week.
cmlenz
parents: 1
diff changeset
481
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
482 def date_formats(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
483 return self._data['date_formats']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
484 date_formats = property(date_formats, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
485 Locale patterns for date formatting.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
486
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
487 >>> Locale('en', 'US').date_formats['short']
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
488 <DateTimePattern u'M/d/yy'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
489 >>> Locale('fr', 'FR').date_formats['long']
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
490 <DateTimePattern u'd MMMM yyyy'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
491
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
492 :type: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
493 """)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
494
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
495 def time_formats(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
496 return self._data['time_formats']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
497 time_formats = property(time_formats, doc="""\
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
498 Locale patterns for time formatting.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
499
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
500 >>> Locale('en', 'US').time_formats['short']
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
501 <DateTimePattern u'h:mm a'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
502 >>> Locale('fr', 'FR').time_formats['long']
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 9
diff changeset
503 <DateTimePattern u'HH:mm:ss z'>
9
3be73c6f01f1 Add basic support for number format patterns.
jonas
parents: 8
diff changeset
504
3be73c6f01f1 Add basic support for number format patterns.
jonas
parents: 8
diff changeset
505 :type: `dict`
3be73c6f01f1 Add basic support for number format patterns.
jonas
parents: 8
diff changeset
506 """)
3be73c6f01f1 Add basic support for number format patterns.
jonas
parents: 8
diff changeset
507
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
508 def datetime_formats(self):
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
509 return self._data['datetime_formats']
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
510 datetime_formats = property(datetime_formats, doc="""\
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
511 Locale patterns for datetime formatting.
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
512
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
513 >>> Locale('en').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
514 u'{1} {0}'
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
515 >>> Locale('th').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
516 u'{1}, {0}'
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
517
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
518 :type: `dict`
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
519 """)
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 31
diff changeset
520
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
521
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
522 def default_locale(category=None):
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
523 """Returns the system default locale for a given category, based on
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
524 environment variables.
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
525
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
526 >>> for name in ['LANGUAGE', 'LC_ALL', 'LC_CTYPE']:
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
527 ... os.environ[name] = ''
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
528 >>> os.environ['LANG'] = 'fr_FR.UTF-8'
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
529 >>> default_locale('LC_MESSAGES')
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
530 'fr_FR'
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
531
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
532 :param category: one of the ``LC_XXX`` environment variable names
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
533 :return: the value of the variable, or any of the fallbacks (``LANGUAGE``,
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
534 ``LC_ALL``, ``LC_CTYPE``, and ``LANG``)
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
535
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
536 :rtype: `str`
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
537 """
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
538 varnames = (category, 'LANGUAGE', 'LC_ALL', 'LC_CTYPE', 'LANG')
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
539 for name in filter(None, varnames):
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
540 locale = os.getenv(name)
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
541 if locale:
148
37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes.
cmlenz
parents: 125
diff changeset
542 if name == 'LANGUAGE' and ':' in locale:
37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes.
cmlenz
parents: 125
diff changeset
543 # the LANGUAGE variable may contain a colon-separated list of
37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes.
cmlenz
parents: 125
diff changeset
544 # language codes; we just pick the language on the list
37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes.
cmlenz
parents: 125
diff changeset
545 locale = locale.split(':')[0]
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
546 return '_'.join(filter(None, parse_locale(locale)))
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
547
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
548 def negotiate_locale(preferred, available, sep='_'):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
549 """Find the best match between available and requested locale strings.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
550
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
551 >>> negotiate_locale(['de_DE', 'en_US'], ['de_DE', 'de_AT'])
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
552 'de_DE'
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
553 >>> negotiate_locale(['de_DE', 'en_US'], ['en', 'de'])
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
554 'de'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
555
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
556 :param preferred: the list of locale strings preferred by the user
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
557 :param available: the list of locale strings available
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
558 :param sep: character that separates the different parts of the locale
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
559 strings
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
560 :return: the locale identifier for the best match, or `None` if no match
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
561 was found
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
562 :rtype: `str`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
563 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
564 for locale in preferred:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
565 if locale in available:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
566 return locale
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
567 parts = locale.split(sep)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
568 if len(parts) > 1 and parts[0] in available:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
569 return parts[0]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
570 return None
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
571
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
572 def parse_locale(identifier, sep='_'):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
573 """Parse a locale identifier into a ``(language, territory, variant)``
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
574 tuple.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
575
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
576 >>> parse_locale('zh_CN')
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
577 ('zh', 'CN', None)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
578
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
579 The default component separator is "_", but a different separator can be
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
580 specified using the `sep` parameter:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
581
72
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method.
cmlenz
parents: 53
diff changeset
582 >>> parse_locale('zh-CN', sep='-')
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
583 ('zh', 'CN', None)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
584
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
585 :param identifier: the locale identifier string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
586 :param sep: character that separates the different parts of the locale
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
587 string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
588 :return: the ``(language, territory, variant)`` tuple
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
589 :rtype: `tuple`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
590 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
591 identifier
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
592
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
593 :see: `IETF RFC 3066 <http://www.ietf.org/rfc/rfc3066.txt>`_
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
594 """
39
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
595 if '.' in identifier:
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
596 # this is probably the charset/encoding, which we don't care about
3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`.
cmlenz
parents: 34
diff changeset
597 identifier = identifier.split('.', 1)[0]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
598 parts = identifier.split(sep)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
599 lang, territory, variant = parts[0].lower(), None, None
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
600 if not lang.isalpha():
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
601 raise ValueError('expected only letters, got %r' % lang)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
602 if len(parts) > 1:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
603 territory = parts[1].upper().split('.', 1)[0]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
604 if not territory.isalpha():
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
605 raise ValueError('expected only letters, got %r' % territory)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
606 if len(parts) > 2:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
607 variant = parts[2].upper().split('.', 1)[0]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
608 return lang, territory, variant
Copyright (C) 2012-2017 Edgewall Software