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

annotate babel/core.py @ 260:0c6ff02563a7

Fix minor glitch in docstring.

author	cmlenz
date	Mon, 20 Aug 2007 08:33:44 +0000
parents	756ee2f610d8
children	786db1a6f588

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
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	17 import pickle
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	18
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	19 from babel import localedata
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	20
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	21 __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	22 'parse_locale']
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	23 __docformat__ = 'restructuredtext en'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	24
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	25 _global_data = None
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	26
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	27 def get_global(key):
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	28 """Return the dictionary for the given key in the global data.
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	29
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	30 The global data is stored in the ``babel/global.dat`` file and contains
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	31 information independent of individual locales.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	32
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	33 >>> get_global('zone_aliases')['UTC']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	34 'Etc/GMT'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	35 >>> get_global('zone_territories')['Europe/Berlin']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	36 'DE'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	37
260 0c6ff02563a7 Fix minor glitch in docstring. cmlenz parents: 259 diff changeset	38 :param key: the data key
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	39 :return the dictionary found in the global data under the given key
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	40 :rtype: `dict`
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	41 :since: version 0.9
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	42 """
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	43 global _global_data
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	44 if _global_data is None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	45 dirname = os.path.join(os.path.dirname(__file__))
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	46 filename = os.path.join(dirname, 'global.dat')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	47 fileobj = open(filename, 'rb')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	48 try:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	49 _global_data = pickle.load(fileobj)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	50 finally:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	51 fileobj.close()
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	52 return _global_data.get(key, {})
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	53
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	54 LOCALE_ALIASES = {
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	55 'ar': 'ar_SY', 'bg': 'bg_BG', 'bs': 'bs_BA', 'ca': 'ca_ES', 'cs': 'cs_CZ',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	56 'da': 'da_DK', 'de': 'de_DE', 'el': 'el_GR', 'en': 'en_US', 'es': 'es_ES',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	57 'et': 'et_EE', 'fa': 'fa_IR', 'fi': 'fi_FI', 'fr': 'fr_FR', 'gl': 'gl_ES',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	58 'he': 'he_IL', 'hu': 'hu_HU', 'id': 'id_ID', 'is': 'is_IS', 'it': 'it_IT',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	59 'ja': 'ja_JP', 'km': 'km_KH', 'ko': 'ko_KR', 'lt': 'lt_LT', 'lv': 'lv_LV',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	60 'mk': 'mk_MK', 'nl': 'nl_NL', 'nn': 'nn_NO', 'no': 'nb_NO', 'pl': 'pl_PL',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	61 'pt': 'pt_PT', 'ro': 'ro_RO', 'ru': 'ru_RU', 'sk': 'sk_SK', 'sl': 'sl_SI',
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	62 'sv': 'sv_SE', 'th': 'th_TH', 'tr': 'tr_TR', 'uk': 'uk_UA'
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	63 }
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	64
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	65
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	66 class UnknownLocaleError(Exception):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	67 """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	68 is available.
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	69 """
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	70
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	71 def __init__(self, identifier):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	72 """Create the exception.
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	73
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	74 :param identifier: the identifier string of the unsupported locale
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	75 """
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	76 Exception.__init__(self, 'unknown locale %r' % identifier)
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	77 self.identifier = identifier
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	78
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	79
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	80 class Locale(object):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	81 """Representation of a specific locale.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	82
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	83 >>> locale = Locale('en', 'US')
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	84 >>> repr(locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	85 '<Locale "en_US">'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	86 >>> locale.display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	87 u'English (United States)'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	88
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	89 A `Locale` object can also be instantiated from a raw locale string:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	90
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	91 >>> locale = Locale.parse('en-US', sep='-')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	92 >>> repr(locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	93 '<Locale "en_US">'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	94
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	95 `Locale` objects provide access to a collection of locale data, such as
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	96 territory and language names, number and date format patterns, and more:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	97
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	98 >>> locale.number_symbols['decimal']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	99 u'.'
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	100
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	101 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	102 `UnknownLocaleError` is raised:
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	103
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	104 >>> Locale.parse('en_DE')
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	105 Traceback (most recent call last):
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	106 ...
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	107 UnknownLocaleError: unknown locale 'en_DE'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	108
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	109 :see: `IETF RFC 3066 <http://www.ietf.org/rfc/rfc3066.txt>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	110 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	111
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	112 def __init__(self, language, territory=None, script=None, variant=None):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	113 """Initialize the locale object from the given identifier components.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	114
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	115 >>> locale = Locale('en', 'US')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	116 >>> locale.language
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	117 'en'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	118 >>> locale.territory
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	119 'US'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	120
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	121 :param language: the language code
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	122 :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	123 :param script: the script code
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	124 :param variant: the variant code
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	125 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	126 requested locale
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	127 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	128 self.language = language
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	129 self.territory = territory
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	130 self.script = script
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	131 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	132 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	133
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	134 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	135 if not localedata.exists(identifier):
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	136 raise UnknownLocaleError(identifier)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	137
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	138 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	139 """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	140
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	141 >>> 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	142 ... 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	143 >>> 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	144 >>> 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	145 <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	146
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	147 :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	148 :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	149 (``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	150 :rtype: `Locale`
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	151 :see: `default_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	152 """
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	153 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	154 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	155
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	156 def negotiate(cls, preferred, available, sep='_', aliases=LOCALE_ALIASES):
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	157 """Find the best match between available and requested locale strings.
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	158
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	159 >>> 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	160 <Locale "de_DE">
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	161 >>> 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	162 <Locale "de">
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	163 >>> Locale.negotiate(['de_DE', 'de'], ['en_US'])
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	164
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	165 You can specify the character used in the locale identifiers to separate
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	166 the differnet components. This separator is applied to both lists. Also,
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	167 case is ignored in the comparison:
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	168
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	169 >>> Locale.negotiate(['de-DE', 'de'], ['en-us', 'de-de'], sep='-')
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	170 <Locale "de_DE">
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	171
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	172 :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	173 :param available: the list of locale identifiers available
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	174 :param aliases: a dictionary of aliases for locale identifiers
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	175 :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	176 was found
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	177 :rtype: `Locale`
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	178 :see: `negotiate_locale`
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	179 """
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	180 identifier = negotiate_locale(preferred, available, sep=sep,
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	181 aliases=aliases)
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	182 if identifier:
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	183 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	184 negotiate = classmethod(negotiate)
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	185
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	186 def parse(cls, identifier, sep='_'):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	187 """Create a `Locale` instance for the given locale identifier.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	188
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	189 >>> l = Locale.parse('de-DE', sep='-')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	190 >>> l.display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	191 u'Deutsch (Deutschland)'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	192
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	193 If the `identifier` parameter is not a string, but actually a `Locale`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	194 object, that object is returned:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	195
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	196 >>> Locale.parse(l)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	197 <Locale "de_DE">
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	198
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	199 :param identifier: the locale identifier string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	200 :param sep: optional component separator
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	201 :return: a corresponding `Locale` instance
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	202 :rtype: `Locale`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	203 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	204 identifier
31 b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	205 :raise `UnknownLocaleError`: if no locale data is available for the
b6ff3e4b43e5 Raise error on unsupported locales. Closes #5. cmlenz parents: 28 diff changeset	206 requested locale
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	207 :see: `parse_locale`
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	208 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	209 if type(identifier) is cls:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	210 return identifier
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	211 return cls(*parse_locale(identifier, sep=sep))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	212 parse = classmethod(parse)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	213
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	214 def __eq__(self, other):
4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	215 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	216
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	217 def __repr__(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	218 return '<Locale "%s">' % str(self)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	219
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	220 def __str__(self):
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	221 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	222 self.territory, self.variant]))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	223
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	224 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	225 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	226 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	227 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	228 _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	229
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	230 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	231 """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	232
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	233 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	234 variant, if those are specified.
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	235
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	236 >>> 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	237 u'Chinese (Simplified Han, China)'
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	238
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	239 :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	240 :return: the display name
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	241 """
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	242 if locale is None:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	243 locale = self
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	244 locale = Locale.parse(locale)
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	245 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	246 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	247 details = []
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	248 if self.script:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	249 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	250 if self.territory:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	251 details.append(locale.territories.get(self.territory))
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	252 if self.variant:
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	253 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	254 details = filter(None, details)
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	255 if details:
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	256 retval += ' (%s)' % u', '.join(details)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	257 return retval
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	258
170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	259 display_name = property(get_display_name, doc="""\
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	260 The localized display name of the locale.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	261
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	262 >>> Locale('en').display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	263 u'English'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	264 >>> Locale('en', 'US').display_name
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	265 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	266 >>> 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	267 u'svenska'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	268
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	269 :type: `unicode`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	270 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	271
53 83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	272 def english_name(self):
185 170cffc66554 Add a command-line option that prints out all available locales. Closes #24. cmlenz parents: 182 diff changeset	273 return self.get_display_name(Locale('en'))
53 83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	274 english_name = property(english_name, doc="""\
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	275 The english display name of the locale.
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	276
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	277 >>> Locale('de').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	278 u'German'
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	279 >>> Locale('de', 'DE').english_name
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	280 u'German (Germany)'
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	281
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	282 :type: `unicode`
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	283 """)
83f3f70c6ca3 Add `english_name` property to `Locale` class. cmlenz parents: 41 diff changeset	284
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	285 #{ 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	286
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	287 def languages(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	288 return self._data['languages']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	289 languages = property(languages, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	290 Mapping of language codes to translated language names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	291
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	292 >>> Locale('de', 'DE').languages['ja']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	293 u'Japanisch'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	294
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	295 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	296 :see: `ISO 639 <http://www.loc.gov/standards/iso639-2/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	297 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	298
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	299 def scripts(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	300 return self._data['scripts']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	301 scripts = property(scripts, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	302 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	303
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	304 >>> Locale('en', 'US').scripts['Hira']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	305 u'Hiragana'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	306
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	307 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	308 :see: `ISO 15924 <http://www.evertype.com/standards/iso15924/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	309 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	310
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	311 def territories(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	312 return self._data['territories']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	313 territories = property(territories, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	314 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	315
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	316 >>> Locale('es', 'CO').territories['DE']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	317 u'Alemania'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	318
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	319 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	320 :see: `ISO 3166 <http://www.iso.org/iso/en/prods-services/iso3166ma/>`_
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	321 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	322
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	323 def variants(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	324 return self._data['variants']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	325 variants = property(variants, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	326 Mapping of script codes to translated script names.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	327
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	328 >>> Locale('de', 'DE').variants['1901']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	329 u'alte deutsche Rechtschreibung'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	330
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	331 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	332 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	333
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	334 #{ 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	335
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	336 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	337 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	338 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	339 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	340
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	341 >>> 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	342 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	343 >>> 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	344 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	345
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	346 :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	347 """)
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	348
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	349 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	350 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	351 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	352 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	353
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	354 >>> 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	355 u'$'
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	356 >>> Locale('es', 'CO').currency_symbols['USD']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	357 u'US$'
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	358
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	359 :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	360 """)
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	361
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	362 def number_symbols(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	363 return self._data['number_symbols']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	364 number_symbols = property(number_symbols, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	365 Symbols used in number formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	366
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	367 >>> Locale('fr', 'FR').number_symbols['decimal']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	368 u','
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	369
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	370 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	371 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	372
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	373 def decimal_formats(self):
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	374 return self._data['decimal_formats']
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	375 decimal_formats = property(decimal_formats, doc="""\
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	376 Locale patterns for decimal number formatting.
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	377
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	378 >>> Locale('en', 'US').decimal_formats[None]
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	379 <NumberPattern u'#,##0.###'>
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	380
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	381 :type: `dict`
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	382 """)
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	383
125 b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	384 def currency_formats(self):
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	385 return self._data['currency_formats']
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	386 currency_formats = property(currency_formats, doc=r"""\
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	387 Locale patterns for currency number formatting.
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	388
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	389 >>> print Locale('en', 'US').currency_formats[None]
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	390 <NumberPattern u'\xa4#,##0.00'>
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	391
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	392 :type: `dict`
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	393 """)
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	394
22 7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	395 def percent_formats(self):
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	396 return self._data['percent_formats']
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	397 percent_formats = property(percent_formats, doc="""\
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	398 Locale patterns for percent number formatting.
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	399
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	400 >>> Locale('en', 'US').percent_formats[None]
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	401 <NumberPattern u'#,##0%'>
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	402
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	403 :type: `dict`
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	404 """)
7d37639a7411 Implemented babel.numbers.format_percent jonas parents: 15 diff changeset	405
125 b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	406 def scientific_formats(self):
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	407 return self._data['scientific_formats']
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	408 scientific_formats = property(scientific_formats, doc="""\
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	409 Locale patterns for scientific number formatting.
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	410
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	411 >>> Locale('en', 'US').scientific_formats[None]
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	412 <NumberPattern u'#E0'>
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	413
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	414 :type: `dict`
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	415 """)
b75ae5def3b1 Add currency formatting. cmlenz parents: 72 diff changeset	416
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	417 #{ 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	418
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	419 def periods(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	420 return self._data['periods']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	421 periods = property(periods, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	422 Locale display names for day periods (AM/PM).
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	423
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	424 >>> Locale('en', 'US').periods['am']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	425 u'AM'
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
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	430 def days(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	431 return self._data['days']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	432 days = property(days, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	433 Locale display names for weekdays.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	434
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	435 >>> Locale('de', 'DE').days['format']['wide'][3]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	436 u'Donnerstag'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	437
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	438 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	439 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	440
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	441 def months(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	442 return self._data['months']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	443 months = property(months, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	444 Locale display names for months.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	445
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	446 >>> Locale('de', 'DE').months['format']['wide'][10]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	447 u'Oktober'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	448
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	449 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	450 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	451
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	452 def quarters(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	453 return self._data['quarters']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	454 quarters = property(quarters, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	455 Locale display names for quarters.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	456
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	457 >>> Locale('de', 'DE').quarters['format']['wide'][1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	458 u'1. Quartal'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	459
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	460 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	461 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	462
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	463 def eras(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	464 return self._data['eras']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	465 eras = property(eras, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	466 Locale display names for eras.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	467
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	468 >>> Locale('en', 'US').eras['wide'][1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	469 u'Anno Domini'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	470 >>> Locale('en', 'US').eras['abbreviated'][0]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	471 u'BC'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	472
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	473 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	474 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	475
28 11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	476 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	477 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	478 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	479 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	480
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	481 >>> Locale('en', 'US').time_zones['Europe/London']['long']['daylight']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	482 u'British Summer Time'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	483 >>> Locale('en', 'US').time_zones['America/St_Johns']['city']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	484 u'St. John\u2019s'
28 11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	485
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	486 :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	487 """)
11278622ede9 Import basic timezone info from CLDR (see #3). Still missing a couple other pieces in the puzzle. cmlenz parents: 26 diff changeset	488
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	489 def meta_zones(self):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	490 return self._data['meta_zones']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	491 meta_zones = property(meta_zones, doc="""\
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	492 Locale display names for meta time zones.
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	493
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	494 Meta time zones are basically groups of different Olson time zones that
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	495 have the same GMT offset and daylight savings time.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	496
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	497 >>> Locale('en', 'US').meta_zones['Europe_Central']['long']['daylight']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	498 u'Central European Summer Time'
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	499
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	500 :type: `dict`
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	501 :since: version 0.9
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	502 """)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	503
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	504 def zone_formats(self):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	505 return self._data['zone_formats']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	506 zone_formats = property(zone_formats, doc=r"""\
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	507 Patterns related to the formatting of time zones.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	508
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	509 >>> Locale('en', 'US').zone_formats['fallback']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	510 u'%(1)s (%(0)s)'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	511 >>> Locale('pt', 'BR').zone_formats['region']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	512 u'Hor\xe1rio %s'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	513
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	514 :type: `dict`
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 185 diff changeset	515 :since: version 0.9
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	516 """)
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	517
8 9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	518 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	519 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	520 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	521 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	522
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	523 >>> Locale('de', 'DE').first_week_day
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	524 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	525 >>> Locale('en', 'US').first_week_day
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	526 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	527
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	528 :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	529 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	530
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	531 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	532 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	533 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	534 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	535
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	536 >>> Locale('de', 'DE').weekend_start
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	537 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	538
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	539 :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	540 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	541
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	542 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	543 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	544 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	545 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	546
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	547 >>> Locale('de', 'DE').weekend_end
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	548 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	549
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	550 :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	551 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	552
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	553 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	554 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	555 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	556 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	557 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	558
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	559 >>> 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	560 4
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	561
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	562 :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	563 """)
9132c9218745 Pull in some supplemental data from the CLDR, for things like the first day of the week. cmlenz parents: 1 diff changeset	564
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	565 def date_formats(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	566 return self._data['date_formats']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	567 date_formats = property(date_formats, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	568 Locale patterns for date formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	569
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	570 >>> Locale('en', 'US').date_formats['short']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	571 <DateTimePattern u'M/d/yy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	572 >>> Locale('fr', 'FR').date_formats['long']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	573 <DateTimePattern u'd MMMM yyyy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	574
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	575 :type: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	576 """)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	577
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	578 def time_formats(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	579 return self._data['time_formats']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	580 time_formats = property(time_formats, doc="""\
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	581 Locale patterns for time formatting.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	582
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	583 >>> Locale('en', 'US').time_formats['short']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	584 <DateTimePattern u'h:mm a'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	585 >>> Locale('fr', 'FR').time_formats['long']
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 9 diff changeset	586 <DateTimePattern u'HH:mm:ss z'>
9 3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	587
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	588 :type: `dict`
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	589 """)
3be73c6f01f1 Add basic support for number format patterns. jonas parents: 8 diff changeset	590
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	591 def datetime_formats(self):
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	592 return self._data['datetime_formats']
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	593 datetime_formats = property(datetime_formats, doc="""\
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	594 Locale patterns for datetime formatting.
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	595
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	596 >>> Locale('en').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	597 u'{1} {0}'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	598 >>> Locale('th').datetime_formats[None]
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	599 u'{1}, {0}'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	600
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	601 :type: `dict`
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	602 """)
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 31 diff changeset	603
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 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	606 """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	607 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	608
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 >>> 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	610 ... 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	611 >>> 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	612 >>> 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	613 '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	614
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	615 :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	616 :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	617 ``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	618
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	619 :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	620 """
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	621 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	622 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	623 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	624 if locale:
148 37f4875bad88 The `LANGUAGE` environment variable may contain a colon-separated list of language codes. cmlenz parents: 125 diff changeset	625 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	626 # 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	627 # 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	628 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	629 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	630
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	631 def negotiate_locale(preferred, available, sep='_', aliases=LOCALE_ALIASES):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	632 """Find the best match between available and requested locale strings.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	633
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	634 >>> negotiate_locale(['de_DE', 'en_US'], ['de_DE', 'de_AT'])
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	635 'de_DE'
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	636 >>> negotiate_locale(['de_DE', 'en_US'], ['en', 'de'])
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	637 'de'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	638
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	639 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	640 locale identifier:
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	641
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	642 >>> negotiate_locale(['de_DE', 'en_US'], ['de_de', 'de_at'])
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	643 'de_DE'
e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	644
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	645 >>> negotiate_locale(['de_DE', 'en_US'], ['de_de', 'de_at'])
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	646 'de_DE'
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	647
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	648 By default, some web browsers unfortunately do not include the territory
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	649 in the locale identifier for many locales, and some don't even allow the
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	650 user to easily add the territory. So while you may prefer using qualified
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	651 locale identifiers in your web-application, they would not normally match
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	652 the language-only locale sent by such browsers. To workaround that, this
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	653 function uses a default mapping of commonly used langauge-only locale
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	654 identifiers to identifiers including the territory:
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	655
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	656 >>> negotiate_locale(['ja', 'en_US'], ['ja_JP', 'en_US'])
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	657 'ja_JP'
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	658
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	659 Some browsers even use an incorrect or outdated language code, such as "no"
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	660 for Norwegian, where the correct locale identifier would actually be "nb_NO"
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	661 (Bokmål) or "nn_NO" (Nynorsk). The aliases are intended to take care of
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	662 such cases, too:
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	663
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	664 >>> negotiate_locale(['no', 'sv'], ['nb_NO', 'sv_SE'])
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	665 'nb_NO'
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	666
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	667 You can override this default mapping by passing a different `aliases`
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	668 dictionary to this function, or you can bypass the behavior althogher by
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	669 setting the `aliases` parameter to `None`.
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	670
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	671 :param preferred: the list of locale strings preferred by the user
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	672 :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	673 :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	674 strings
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	675 :param aliases: a dictionary of aliases for locale identifiers
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	676 :return: the locale identifier for the best match, or `None` if no match
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	677 was found
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	678 :rtype: `str`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	679 """
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	680 available = [a.lower() for a in available if a]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	681 for locale in preferred:
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	682 ll = locale.lower()
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	683 if ll in available:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	684 return locale
259 756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	685 if aliases:
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	686 alias = aliases.get(ll)
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	687 if alias:
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	688 alias = alias.replace('_', sep)
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	689 if alias.lower() in available:
756ee2f610d8 Apply patch for #26 to implement locale aliases. cmlenz parents: 238 diff changeset	690 return alias
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	691 parts = locale.split(sep)
156 e1985b8cdcd6 Minor improvements to locale negotation. cmlenz parents: 148 diff changeset	692 if len(parts) > 1 and parts[0].lower() in available:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	693 return parts[0]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	694 return None
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	695
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	696 def parse_locale(identifier, sep='_'):
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	697 """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	698
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	699 ``(language, territory, script, variant)``
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	700
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	701 >>> parse_locale('zh_CN')
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	702 ('zh', 'CN', None, None)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	703 >>> parse_locale('zh_Hans_CN')
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	704 ('zh', 'CN', 'Hans', None)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	705
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	706 The default component separator is "_", but a different separator can be
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	707 specified using the `sep` parameter:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	708
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 53 diff changeset	709 >>> parse_locale('zh-CN', sep='-')
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	710 ('zh', 'CN', None, None)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	711
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	712 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	713 is raised:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	714
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	715 >>> parse_locale('not_a_LOCALE_String')
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	716 Traceback (most recent call last):
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	717 ...
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	718 ValueError: 'not_a_LOCALE_String' is not a valid locale identifier
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	719
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	720 :param identifier: the locale identifier string
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	721 :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	722 identifier
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	723 :return: the ``(language, territory, script, variant)`` tuple
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	724 :rtype: `tuple`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	725 :raise `ValueError`: if the string does not appear to be a valid locale
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	726 identifier
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	727
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	728 :see: `IETF RFC 4646 <http://www.ietf.org/rfc/rfc4646.txt>`_
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	729 """
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	730 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	731 # 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	732 identifier = identifier.split('.', 1)[0]
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	733
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	734 parts = identifier.split(sep)
182 0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	735 lang = parts.pop(0).lower()
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	736 if not lang.isalpha():
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	737 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	738
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	739 script = territory = variant = None
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	740 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	741 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	742 script = parts.pop(0).title()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	743
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	744 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	745 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	746 territory = parts.pop(0).upper()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	747 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	748 territory = parts.pop(0)
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	749
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	750 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	751 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	752 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	753 variant = parts.pop()
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	754
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	755 if parts:
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	756 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	757
0db5d8723c76 More robust locale string parsing, with support for scripts. Closes #27. cmlenz parents: 156 diff changeset	758 return lang, territory, script, variant

Mercurial > babel > old > babel-test

annotate babel/core.py @ 260:0c6ff02563a7