babel/old/babel-test: babel/core.py annotate

annotate babel/core.py @ 185:170cffc66554

Add a command-line option that prints out all available locales. Closes #24.

author	cmlenz
date	Thu, 28 Jun 2007 16:34:40 +0000
parents	0db5d8723c76
children	bc22f5aef216

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
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	42 >>> locale = Locale('en', 'US')
1 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'.'
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	59
31 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
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	71 def __init__(self, language, territory=None, script=None, variant=None):
1 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
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	82 :param script: the script code
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	83 :param variant: the variant code
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	84 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	85 requested locale
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	86 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	87 self.language = language
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	88 self.territory = territory
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	89 self.script = script
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	90 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	91 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	92
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	93 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	94 if not localedata.exists(identifier):
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	95 raise UnknownLocaleError(identifier)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	96
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	97 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	98 """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	99
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 >>> 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	101 ... 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	102 >>> 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	103 >>> 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	104 <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	105
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 :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	107 :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	108 (``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	109 :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	110 """
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	111 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	112 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	113
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	114 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	115 """Find the best match between available and requested locale strings.
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	116
72 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'], ['de_DE', 'de_AT'])
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	118 <Locale "de_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', 'en_US'], ['en', 'de'])
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	120 <Locale "de">
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	121 >>> Locale.negotiate(['de_DE', 'de'], ['en_US'])
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	122
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	123 You can specify the character used in the locale identifiers to separate
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	124 the differnet components. This separator is applied to both lists. Also,
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	125 case is ignored in the comparison:
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	126
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	127 >>> Locale.negotiate(['de-DE', 'de'], ['en-us', 'de-de'], sep='-')
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	128 <Locale "de_DE">
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	129
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	130 :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	131 :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	132 :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	133 was found
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	134 :rtype: `Locale`
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	135 """
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	136 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	137 if identifier:
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	138 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	139 negotiate = classmethod(negotiate)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	140
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	141 def parse(cls, identifier, sep='_'):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	142 """Create a `Locale` instance for the given locale identifier.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	143
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	144 >>> l = Locale.parse('de-DE', sep='-')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	145 >>> l.display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	146 u'Deutsch (Deutschland)'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	147
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	148 If the `identifier` parameter is not a string, but actually a `Locale`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	149 object, that object is returned:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	150
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	151 >>> Locale.parse(l)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	152 <Locale "de_DE">
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	153
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	154 :param identifier: the locale identifier string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	155 :param sep: optional component separator
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	156 :return: a corresponding `Locale` instance
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	157 :rtype: `Locale`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	158 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	159 identifier
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	160 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	161 requested locale
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	162 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	163 if type(identifier) is cls:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	164 return identifier
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	165 return cls(*parse_locale(identifier, sep=sep))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	166 parse = classmethod(parse)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	167
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	168 def __eq__(self, other):
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	169 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	170
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	171 def __repr__(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	172 return '<Locale "%s">' % str(self)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	173
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	174 def __str__(self):
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	175 return '_'.join(filter(None, [self.language, self.script,
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	176 self.territory, self.variant]))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	177
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	178 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	179 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	180 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	181 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	182 _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	183
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	184 def get_display_name(self, locale=None):
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	185 """Return the display name of the locale using the given locale.
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	186
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	187 The display name will include the language, territory, script, and
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	188 variant, if those are specified.
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	189
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	190 >>> Locale('zh', 'CN', script='Hans').get_display_name('en')
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	191 u'Chinese (Simplified Han, China)'
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	192
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	193 :param locale: the locale to use
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	194 :return: the display name
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	195 """
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	196 if locale is None:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	197 locale = self
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	198 locale = Locale.parse(locale)
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	199 retval = locale.languages.get(self.language)
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	200 if self.territory or self.script or self.variant:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	201 details = []
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	202 if self.script:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	203 details.append(locale.scripts.get(self.script))
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	204 if self.territory:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	205 details.append(locale.territories.get(self.territory))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	206 if self.variant:
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	207 details.append(locale.variants.get(self.variant))
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	208 details = filter(None, details)
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	209 if details:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	210 retval += ' (%s)' % u', '.join(details)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	211 return retval
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	212
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	213 display_name = property(get_display_name, doc="""\
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	214 The localized display name of the locale.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	215
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	216 >>> Locale('en').display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	217 u'English'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	218 >>> Locale('en', 'US').display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	219 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	220 >>> 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	221 u'svenska'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	222
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	223 :type: `unicode`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	224 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	225
53 83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	226 def english_name(self):
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	227 return self.get_display_name(Locale('en'))
53 83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	228 english_name = property(english_name, doc="""\
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	229 The english display name of the locale.
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	230
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	231 >>> Locale('de').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	232 u'German'
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	233 >>> Locale('de', 'DE').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	234 u'German (Germany)'
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	235
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	236 :type: `unicode`
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	237 """)
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	238
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	239 #{ 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	240
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	241 def languages(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	242 return self._data['languages']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	243 languages = property(languages, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	244 Mapping of language codes to translated language names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	245
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	246 >>> Locale('de', 'DE').languages['ja']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	247 u'Japanisch'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	248
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	249 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	250 :see: `ISO 639 <http://www.loc.gov/standards/iso639-2/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	251 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	252
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	253 def scripts(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	254 return self._data['scripts']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	255 scripts = property(scripts, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	256 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	257
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	258 >>> Locale('en', 'US').scripts['Hira']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	259 u'Hiragana'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	260
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	261 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	262 :see: `ISO 15924 <http://www.evertype.com/standards/iso15924/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	263 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	264
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	265 def territories(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	266 return self._data['territories']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	267 territories = property(territories, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	268 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	269
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	270 >>> Locale('es', 'CO').territories['DE']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	271 u'Alemania'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	272
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	273 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	274 :see: `ISO 3166 <http://www.iso.org/iso/en/prods-services/iso3166ma/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	275 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	276
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	277 def variants(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	278 return self._data['variants']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	279 variants = property(variants, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	280 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	281
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	282 >>> Locale('de', 'DE').variants['1901']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	283 u'alte deutsche Rechtschreibung'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	284
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	285 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	286 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	287
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	288 #{ 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	289
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	290 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	291 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	292 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	293 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	294
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 >>> 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	296 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	297 >>> 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	298 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	299
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 :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	301 """)
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	302
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	303 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	304 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	305 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	306 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	307
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	308 >>> 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	309 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	310 >>> 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	311 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	312
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	313 :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	314 """)
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	315
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	316 def number_symbols(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	317 return self._data['number_symbols']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	318 number_symbols = property(number_symbols, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	319 Symbols used in number formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	320
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	321 >>> Locale('fr', 'FR').number_symbols['decimal']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	322 u','
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	323
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	324 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	325 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	326
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	327 def decimal_formats(self):
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	328 return self._data['decimal_formats']
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	329 decimal_formats = property(decimal_formats, doc="""\
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	330 Locale patterns for decimal number formatting.
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	331
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	332 >>> Locale('en', 'US').decimal_formats[None]
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	333 <NumberPattern u'#,##0.###'>
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	334
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	335 :type: `dict`
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	336 """)
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	337
125 b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	338 def currency_formats(self):
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	339 return self._data['currency_formats']
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	340 currency_formats = property(currency_formats, doc=r"""\
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	341 Locale patterns for currency number formatting.
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	342
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	343 >>> print Locale('en', 'US').currency_formats[None]
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	344 <NumberPattern u'\xa4#,##0.00'>
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	345
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	346 :type: `dict`
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	347 """)
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	348
22 7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	349 def percent_formats(self):
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	350 return self._data['percent_formats']
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	351 percent_formats = property(percent_formats, doc="""\
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	352 Locale patterns for percent number formatting.
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	353
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	354 >>> Locale('en', 'US').percent_formats[None]
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	355 <NumberPattern u'#,##0%'>
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	356
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	357 :type: `dict`
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	358 """)
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	359
125 b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	360 def scientific_formats(self):
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	361 return self._data['scientific_formats']
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	362 scientific_formats = property(scientific_formats, doc="""\
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	363 Locale patterns for scientific number formatting.
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	364
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	365 >>> Locale('en', 'US').scientific_formats[None]
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	366 <NumberPattern u'#E0'>
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	367
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	368 :type: `dict`
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	369 """)
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	370
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	371 #{ 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	372
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	373 def periods(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	374 return self._data['periods']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	375 periods = property(periods, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	376 Locale display names for day periods (AM/PM).
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	377
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	378 >>> Locale('en', 'US').periods['am']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	379 u'AM'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	380
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	381 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	382 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	383
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	384 def days(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	385 return self._data['days']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	386 days = property(days, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	387 Locale display names for weekdays.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	388
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	389 >>> Locale('de', 'DE').days['format']['wide'][3]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	390 u'Donnerstag'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	391
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	392 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	393 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	394
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	395 def months(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	396 return self._data['months']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	397 months = property(months, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	398 Locale display names for months.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	399
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	400 >>> Locale('de', 'DE').months['format']['wide'][10]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	401 u'Oktober'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	402
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	403 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	404 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	405
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	406 def quarters(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	407 return self._data['quarters']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	408 quarters = property(quarters, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	409 Locale display names for quarters.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	410
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	411 >>> Locale('de', 'DE').quarters['format']['wide'][1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	412 u'1. Quartal'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	413
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	414 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	415 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	416
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	417 def eras(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	418 return self._data['eras']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	419 eras = property(eras, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	420 Locale display names for eras.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	421
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	422 >>> Locale('en', 'US').eras['wide'][1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	423 u'Anno Domini'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	424 >>> Locale('en', 'US').eras['abbreviated'][0]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	425 u'BC'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	426
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	427 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	428 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	429
28 11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	430 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	431 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	432 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	433 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	434
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	435 >>> 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	436 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	437 >>> 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	438 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	439
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	440 :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	441 """)
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	442
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	443 def zone_aliases(self):
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	444 return self._data['zone_aliases']
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	445 zone_aliases = property(zone_aliases, doc="""\
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	446 Mapping of time zone aliases to their respective canonical identifer.
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	447
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	448 >>> Locale('en').zone_aliases['UTC']
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	449 'Etc/GMT'
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	450
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	451 :type: `dict`
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	452 :note: this doesn't really belong here, as it does not change between
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	453 locales
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	454 """)
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	455
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	456 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	457 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	458 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	459 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	460
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	461 >>> Locale('de', 'DE').first_week_day
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	462 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	463 >>> Locale('en', 'US').first_week_day
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	464 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	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 :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	467 """)
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 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	470 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	471 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	472 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	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 >>> Locale('de', 'DE').weekend_start
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	475 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	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 :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	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
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	480 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	481 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	482 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	483 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	484
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	485 >>> Locale('de', 'DE').weekend_end
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	486 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	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 :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	489 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	490
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	491 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	492 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	493 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	494 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	495 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	496
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	497 >>> 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	498 4
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	499
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	500 :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	501 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	502
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	503 def date_formats(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	504 return self._data['date_formats']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	505 date_formats = property(date_formats, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	506 Locale patterns for date formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	507
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	508 >>> Locale('en', 'US').date_formats['short']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	509 <DateTimePattern u'M/d/yy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	510 >>> Locale('fr', 'FR').date_formats['long']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	511 <DateTimePattern u'd MMMM yyyy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	512
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	513 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	514 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	515
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	516 def time_formats(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	517 return self._data['time_formats']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	518 time_formats = property(time_formats, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	519 Locale patterns for time formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	520
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	521 >>> Locale('en', 'US').time_formats['short']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	522 <DateTimePattern u'h:mm a'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	523 >>> Locale('fr', 'FR').time_formats['long']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	524 <DateTimePattern u'HH:mm:ss z'>
9 3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	525
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	526 :type: `dict`
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	527 """)
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	528
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	529 def datetime_formats(self):
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	530 return self._data['datetime_formats']
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	531 datetime_formats = property(datetime_formats, doc="""\
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	532 Locale patterns for datetime formatting.
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	533
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	534 >>> Locale('en').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	535 u'{1} {0}'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	536 >>> Locale('th').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	537 u'{1}, {0}'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	538
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	539 :type: `dict`
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	540 """)
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	541
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	542
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	543 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	544 """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	545 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	546
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 >>> 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	548 ... 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	549 >>> 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	550 >>> 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	551 '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	552
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	553 :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	554 :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	555 ``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	556
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	557 :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	558 """
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	559 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	560 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	561 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	562 if locale:
148 37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes. cmlenz parents: 125 diff changeset	563 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	564 # 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	565 # 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	566 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	567 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	568
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	569 def negotiate_locale(preferred, available, sep='_'):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	570 """Find the best match between available and requested locale strings.
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 >>> negotiate_locale(['de_DE', 'en_US'], ['de_DE', 'de_AT'])
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	573 'de_DE'
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	574 >>> negotiate_locale(['de_DE', 'en_US'], ['en', 'de'])
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	575 'de'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	576
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	577 Case is ignored by the algorithm, the result uses the case of the preferred
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	578 locale identifier:
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	579
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	580 >>> negotiate_locale(['de_DE', 'en_US'], ['de_de', 'de_at'])
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	581 'de_DE'
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	582
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	583 :param preferred: the list of locale strings preferred by the user
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	584 :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	585 :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	586 strings
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	587 :return: the locale identifier for the best match, or `None` if no match
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	588 was found
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	589 :rtype: `str`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	590 """
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	591 available = [a.lower() for a in available if a]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	592 for locale in preferred:
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	593 if locale.lower() in available:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	594 return locale
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	595 parts = locale.split(sep)
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	596 if len(parts) > 1 and parts[0].lower() in available:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	597 return parts[0]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	598 return None
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	599
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	600 def parse_locale(identifier, sep='_'):
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	601 """Parse a locale identifier into a tuple of the form::
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	602
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	603 ``(language, territory, script, variant)``
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	604
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	605 >>> parse_locale('zh_CN')
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	606 ('zh', 'CN', None, None)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	607 >>> parse_locale('zh_Hans_CN')
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	608 ('zh', 'CN', 'Hans', None)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	609
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	610 The default component separator is "_", but a different separator can be
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	611 specified using the `sep` parameter:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	612
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	613 >>> parse_locale('zh-CN', sep='-')
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	614 ('zh', 'CN', None, None)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	615
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	616 If the identifier cannot be parsed into a locale, a `ValueError` exception
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	617 is raised:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	618
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	619 >>> parse_locale('not_a_LOCALE_String')
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	620 Traceback (most recent call last):
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	621 ...
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	622 ValueError: 'not_a_LOCALE_String' is not a valid locale identifier
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	623
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	624 :param identifier: the locale identifier string
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	625 :param sep: character that separates the different components of the locale
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	626 identifier
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	627 :return: the ``(language, territory, script, variant)`` tuple
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	628 :rtype: `tuple`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	629 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	630 identifier
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	631
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	632 :see: `IETF RFC 4646 <http://www.ietf.org/rfc/rfc4646.txt>`_
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	633 """
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	634 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	635 # 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	636 identifier = identifier.split('.', 1)[0]
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	637
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	638 parts = identifier.split(sep)
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	639 lang = parts.pop(0).lower()
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	640 if not lang.isalpha():
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	641 raise ValueError('expected only letters, got %r' % lang)
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	642
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	643 script = territory = variant = None
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	644 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	645 if len(parts[0]) == 4 and parts[0].isalpha():
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	646 script = parts.pop(0).title()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	647
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	648 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	649 if len(parts[0]) == 2 and parts[0].isalpha():
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	650 territory = parts.pop(0).upper()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	651 elif len(parts[0]) == 3 and parts[0].isdigit():
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	652 territory = parts.pop(0)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	653
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	654 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	655 if len(parts[0]) == 4 and parts[0][0].isdigit() or \
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	656 len(parts[0]) >= 5 and parts[0][0].isalpha():
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	657 variant = parts.pop()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	658
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	659 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	660 raise ValueError('%r is not a valid locale identifier' % identifier)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	661
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	662 return lang, territory, script, variant

Mercurial > babel > old > babel-test

annotate babel/core.py @ 185:170cffc66554