babel/old/mirror: babel/core.py annotate

annotate babel/core.py @ 43:0ad88be7da38

Load locale data lazily to avoid penalizing usage of `Locale` objects when no locale data is actually needed.

author	cmlenz
date	Wed, 06 Jun 2007 12:12:44 +0000
parents	359ec55de578
children	b298e583d326

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

Mercurial > babel > old > mirror

annotate babel/core.py @ 43:0ad88be7da38