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