The module provides low-level access to the C lib's locale APIs
and adds high level number formatting APIs as well as a locale
aliasing engine to complement these.
The aliasing engine includes support for many commonly used locale
names and maps them to values suitable for passing to the C lib's
setlocale() function. It also includes default encodings for all
# Try importing the _locale module.
# If this fails, fall back on a basic 'C' locale emulation.
# Yuck: LC_MESSAGES is non-standard: can't tell whether it exists before
# trying the import. So __all__ is also fiddled at the end of the file.
__all__
= ["setlocale","Error","localeconv","strcoll","strxfrm",
"format","str","atof","atoi","LC_CTYPE","LC_COLLATE",
"LC_TIME","LC_MONETARY","LC_NUMERIC", "LC_ALL","CHAR_MAX"]
""" localeconv() -> dict.
Returns numeric and monetary locale-specific parameters.
# 'C' locale default values
return {'grouping': [127],
def setlocale(category
, value
=None):
""" setlocale(integer,string=None) -> string.
Activates/queries locale processing.
if value
not in (None, '', 'C'):
raise Error
, '_locale emulation only supports "C" locale'
""" strcoll(string,string) -> int.
Compares two strings according to the locale.
""" strxfrm(string) -> string.
Returns a string that behaves for cmp locale-aware.
### Number formatting APIs
# Author: Martin von Loewis
#perform the grouping from right to left
grouping
=conv
['grouping']
if not grouping
:return (s
, 0)
# if grouping is -1, we are done
if grouping
[0]==CHAR_MAX
:
# 0: re-use last group ad infinitum
result
=s
[-group
:]+conv
['thousands_sep']+result
if s
and s
[-1] not in "0123456789":
# the leading string is only spaces and signs
return s
+result
+spaces
,seps
result
=s
+conv
['thousands_sep']+result
return result
+spaces
,seps
def format(f
,val
,grouping
=0):
"""Formats a value in the same way that the % formatting would use,
but takes the current locale into account.
Grouping is applied if the third parameter is true."""
fields
= result
.split(".")
fields
[0],seps
=_group(fields
[0])
result
= fields
[0]+localeconv()['decimal_point']+fields
[1]
raise Error
, "Too many decimal points in result string"
# If the number was formatted for a specific width, then it
# might have been filled with spaces to the left or right. If
# so, kill as much spaces as there where separators.
# Leading zeroes as fillers are not yet dealt with, as it is
# not clear how they should interact with grouping.
result
= result
[:sp
]+result
[sp
+1:]
"""Convert float to integer, taking the locale into account."""
return format("%.12g",val
)
def atof(string
,func
=float):
"Parses a string as a float according to the locale settings."
#First, get rid of the grouping
ts
= localeconv()['thousands_sep']
string
= string
.replace(ts
, '')
#next, replace the decimal point with a dot
dd
= localeconv()['decimal_point']
string
= string
.replace(dd
, '.')
#finally, parse the string
"Converts a string to an integer according to the locale settings."
s1
=format("%d", 123456789,1)
### Locale name aliasing engine
# Author: Marc-Andre Lemburg, mal@lemburg.com
# Various tweaks by Fredrik Lundh <fredrik@pythonware.com>
# store away the low-level version of setlocale (it's
def normalize(localename
):
""" Returns a normalized locale code for the given locale
The returned locale code is formatted for use with
If normalization fails, the original name is returned
If the given encoding is not known, the function defaults to
the default encoding for the locale code just like setlocale()
# Normalize the locale name and extract the encoding
fullname
= localename
.lower()
# ':' is sometimes used as encoding delimiter.
fullname
= fullname
.replace(':', '.')
langname
, encoding
= fullname
.split('.')[:2]
fullname
= langname
+ '.' + encoding
# First lookup: fullname (possibly with encoding)
code
= locale_alias
.get(fullname
, None)
# Second try: langname (without encoding)
code
= locale_alias
.get(langname
, None)
langname
, defenc
= code
.split('.')
encoding
= encoding_alias
.get(encoding
, encoding
)
return langname
+ '.' + encoding
def _parse_localename(localename
):
""" Parses the locale code for localename and returns the
result as tuple (language code, encoding).
The localename is normalized and passed through the locale
alias engine. A ValueError is raised in case the locale name
The language code corresponds to RFC 1766. code and encoding
can be None in case the values cannot be determined or are
unknown to this implementation.
code
= normalize(localename
)
# Deal with locale modifiers
code
, modifier
= code
.split('@')
if modifier
== 'euro' and '.' not in code
:
# Assume Latin-9 for @euro locales. This is bogus,
# since some systems may use other encodings for these
# locales. Also, we ignore other modifiers.
return code
, 'iso-8859-15'
return tuple(code
.split('.')[:2])
raise ValueError, 'unknown locale: %s' % localename
def _build_localename(localetuple
):
""" Builds a locale code from the given tuple (language code,
No aliasing or normalizing takes place.
language
, encoding
= localetuple
return language
+ '.' + encoding
def getdefaultlocale(envvars
=('LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE')):
""" Tries to determine the default locale settings and returns
them as tuple (language code, encoding).
According to POSIX, a program which has not called
setlocale(LC_ALL, "") runs using the portable 'C' locale.
Calling setlocale(LC_ALL, "") lets it use the default locale as
defined by the LANG variable. Since we don't want to interfere
with the current locale setting we thus emulate the behavior
in the way described above.
To maintain compatibility with other platforms, not only the
LANG variable is tested, but a list of variables given as
envvars parameter. The first found to be defined will be
used. envvars defaults to the search path used in GNU gettext;
it must always contain the variable name 'LANG'.
Except for the code 'C', the language code corresponds to RFC
1766. code and encoding can be None in case the values cannot
# check if it's supported by the _locale module
code
, encoding
= _locale
._getdefaultlocale
()
except (ImportError, AttributeError):
# make sure the code/encoding values are valid
if sys
.platform
== "win32" and code
and code
[:2] == "0x":
# map windows language identifier to language name
code
= windows_locale
.get(int(code
, 0))
# ...add other platform-specific processing here, if
# fall back on POSIX behaviour
localename
= lookup(variable
,None)
if variable
== 'LANGUAGE':
localename
= localename
.split(':')[0]
return _parse_localename(localename
)
def getlocale(category
=LC_CTYPE
):
""" Returns the current setting for the given locale category as
tuple (language code, encoding).
category may be one of the LC_* value except LC_ALL. It
Except for the code 'C', the language code corresponds to RFC
1766. code and encoding can be None in case the values cannot
localename
= _setlocale(category
)
if category
== LC_ALL
and ';' in localename
:
raise TypeError, 'category LC_ALL is not supported'
return _parse_localename(localename
)
def setlocale(category
, locale
=None):
""" Set the locale for the given category. The locale can be
a string, a locale tuple (language code, encoding), or None.
Locale tuples are converted to strings the locale aliasing
engine. Locale strings are passed directly to the C lib.
category may be given as one of the LC_* values.
if locale
and type(locale
) is not type(""):
locale
= normalize(_build_localename(locale
))
return _setlocale(category
, locale
)
def resetlocale(category
=LC_ALL
):
""" Sets the locale for category to the default setting.
The default setting is determined by calling
getdefaultlocale(). category defaults to LC_ALL.
_setlocale(category
, _build_localename(getdefaultlocale()))
if sys
.platform
in ('win32', 'darwin', 'mac'):
# On Win32, this will return the ANSI code page
# On the Mac, it should return the system encoding;
# it might return "ascii" instead
def getpreferredencoding(do_setlocale
= True):
"""Return the charset that the user is likely using."""
return _locale
._getdefaultlocale
()[1]
# On Unix, if CODESET is available, use that.
# Fall back to parsing environment variables :-(
def getpreferredencoding(do_setlocale
= True):
"""Return the charset that the user is likely using,
by looking at environment variables."""
return getdefaultlocale()[1]
def getpreferredencoding(do_setlocale
= True):
"""Return the charset that the user is likely using,
according to the system configuration."""
oldloc
= setlocale(LC_CTYPE
)
result
= nl_langinfo(CODESET
)
setlocale(LC_CTYPE
, oldloc
)
return nl_langinfo(CODESET
)
# The following data was extracted from the locale.alias file which
# comes with X11 and then hand edited removing the explicit encoding
# definitions and adding some more aliases. The file is usually
# available as /usr/lib/X11/locale/locale.alias.
# The encoding_alias table maps lowercase encoding alias names to C
# locale encoding names (case-sensitive).
'iso_8859-1': 'ISO8859-1',
'iso885915': 'ISO8859-15',
'iso_8859-15': 'ISO8859-15',
'iso8859-2': 'ISO8859-2',
'iso_8859-2': 'ISO8859-2',
# The locale_alias table maps lowercase alias names to C locale names
# (case-sensitive). Encodings are always separated from the locale
# name using a dot ('.'); they should only be given in case the
# language name is needed to interpret the given encoding alias
# correctly (CJK codes often have this need).
'american': 'en_US.ISO8859-1',
'ar_aa': 'ar_AA.ISO8859-6',
'ar_sa': 'ar_SA.ISO8859-6',
'arabic': 'ar_AA.ISO8859-6',
'bg_bg': 'bg_BG.ISO8859-5',
'bulgarian': 'bg_BG.ISO8859-5',
'c-french': 'fr_CA.ISO8859-1',
'cextend': 'en_US.ISO8859-1',
'chinese-s': 'zh_CN.eucCN',
'chinese-t': 'zh_TW.eucTW',
'croatian': 'hr_HR.ISO8859-2',
'cs_cs': 'cs_CZ.ISO8859-2',
'cs_cz': 'cs_CZ.ISO8859-2',
'cz_cz': 'cz_CZ.ISO8859-2',
'czech': 'cs_CS.ISO8859-2',
'da_dk': 'da_DK.ISO8859-1',
'danish': 'da_DK.ISO8859-1',
'de_at': 'de_AT.ISO8859-1',
'de_ch': 'de_CH.ISO8859-1',
'de_de': 'de_DE.ISO8859-1',
'dutch': 'nl_BE.ISO8859-1',
'el_gr': 'el_GR.ISO8859-7',
'en_au': 'en_AU.ISO8859-1',
'en_ca': 'en_CA.ISO8859-1',
'en_gb': 'en_GB.ISO8859-1',
'en_ie': 'en_IE.ISO8859-1',
'en_nz': 'en_NZ.ISO8859-1',
'en_uk': 'en_GB.ISO8859-1',
'en_us': 'en_US.ISO8859-1',
'eng_gb': 'en_GB.ISO8859-1',
'english': 'en_EN.ISO8859-1',
'english_uk': 'en_GB.ISO8859-1',
'english_united-states': 'en_US.ISO8859-1',
'english_us': 'en_US.ISO8859-1',
'es_ar': 'es_AR.ISO8859-1',
'es_bo': 'es_BO.ISO8859-1',
'es_cl': 'es_CL.ISO8859-1',
'es_co': 'es_CO.ISO8859-1',
'es_cr': 'es_CR.ISO8859-1',
'es_ec': 'es_EC.ISO8859-1',
'es_es': 'es_ES.ISO8859-1',
'es_gt': 'es_GT.ISO8859-1',
'es_mx': 'es_MX.ISO8859-1',
'es_ni': 'es_NI.ISO8859-1',
'es_pa': 'es_PA.ISO8859-1',
'es_pe': 'es_PE.ISO8859-1',
'es_py': 'es_PY.ISO8859-1',
'es_sv': 'es_SV.ISO8859-1',
'es_uy': 'es_UY.ISO8859-1',
'es_ve': 'es_VE.ISO8859-1',
'et_ee': 'et_EE.ISO8859-4',
'fi_fi': 'fi_FI.ISO8859-1',
'finnish': 'fi_FI.ISO8859-1',
'fr_be': 'fr_BE.ISO8859-1',
'fr_ca': 'fr_CA.ISO8859-1',
'fr_ch': 'fr_CH.ISO8859-1',
'fr_fr': 'fr_FR.ISO8859-1',
'fre_fr': 'fr_FR.ISO8859-1',
'french': 'fr_FR.ISO8859-1',
'french_france': 'fr_FR.ISO8859-1',
'ger_de': 'de_DE.ISO8859-1',
'german': 'de_DE.ISO8859-1',
'german_germany': 'de_DE.ISO8859-1',
'greek': 'el_GR.ISO8859-7',
'hebrew': 'iw_IL.ISO8859-8',
'hr_hr': 'hr_HR.ISO8859-2',
'hu_hu': 'hu_HU.ISO8859-2',
'hungarian': 'hu_HU.ISO8859-2',
'icelandic': 'is_IS.ISO8859-1',
'id_id': 'id_ID.ISO8859-1',
'is_is': 'is_IS.ISO8859-1',
'iso-8859-1': 'en_US.ISO8859-1',
'iso-8859-15': 'en_US.ISO8859-15',
'iso8859-1': 'en_US.ISO8859-1',
'iso8859-15': 'en_US.ISO8859-15',
'iso_8859_1': 'en_US.ISO8859-1',
'iso_8859_15': 'en_US.ISO8859-15',
'it_ch': 'it_CH.ISO8859-1',
'it_it': 'it_IT.ISO8859-1',
'italian': 'it_IT.ISO8859-1',
'iw_il': 'iw_IL.ISO8859-8',
'ja_jp.ajec': 'ja_JP.eucJP',
'ja_jp.euc': 'ja_JP.eucJP',
'ja_jp.eucjp': 'ja_JP.eucJP',
'ja_jp.iso-2022-jp': 'ja_JP.JIS7',
'ja_jp.jis': 'ja_JP.JIS7',
'ja_jp.jis7': 'ja_JP.JIS7',
'ja_jp.mscode': 'ja_JP.SJIS',
'ja_jp.sjis': 'ja_JP.SJIS',
'ja_jp.ujis': 'ja_JP.eucJP',
'japanese': 'ja_JP.SJIS',
'japanese-euc': 'ja_JP.eucJP',
'japanese.euc': 'ja_JP.eucJP',
'ko_kr.euc': 'ko_KR.eucKR',
'mk_mk': 'mk_MK.ISO8859-5',
'nl_be': 'nl_BE.ISO8859-1',
'nl_nl': 'nl_NL.ISO8859-1',
'no_no': 'no_NO.ISO8859-1',
'norwegian': 'no_NO.ISO8859-1',
'pl_pl': 'pl_PL.ISO8859-2',
'polish': 'pl_PL.ISO8859-2',
'portuguese': 'pt_PT.ISO8859-1',
'portuguese_brazil': 'pt_BR.ISO8859-1',
'pt_br': 'pt_BR.ISO8859-1',
'pt_pt': 'pt_PT.ISO8859-1',
'ro_ro': 'ro_RO.ISO8859-2',
'ru_ru': 'ru_RU.ISO8859-5',
'rumanian': 'ro_RO.ISO8859-2',
'russian': 'ru_RU.ISO8859-5',
'serbocroatian': 'sh_YU.ISO8859-2',
'sh_hr': 'sh_HR.ISO8859-2',
'sh_sp': 'sh_YU.ISO8859-2',
'sh_yu': 'sh_YU.ISO8859-2',
'sk_sk': 'sk_SK.ISO8859-2',
'sl_cs': 'sl_CS.ISO8859-2',
'sl_si': 'sl_SI.ISO8859-2',
'slovak': 'sk_SK.ISO8859-2',
'slovene': 'sl_CS.ISO8859-2',
'sp_yu': 'sp_YU.ISO8859-5',
'spanish': 'es_ES.ISO8859-1',
'spanish_spain': 'es_ES.ISO8859-1',
'sr_sp': 'sr_SP.ISO8859-2',
'sv_se': 'sv_SE.ISO8859-1',
'swedish': 'sv_SE.ISO8859-1',
'tr_tr': 'tr_TR.ISO8859-9',
'turkish': 'tr_TR.ISO8859-9',
'universal': 'en_US.utf',
'zh_cn.big5': 'zh_TW.eucTW',
'zh_cn.euc': 'zh_CN.eucCN',
'zh_tw.euc': 'zh_TW.eucTW',
# this maps windows language identifiers (as used on Windows 95 and
# earlier) to locale strings.
# NOTE: this mapping is incomplete. If your language is missing, please
# submit a bug report to Python bug manager, which you can find via:
# http://www.python.org/dev/
# Make sure you include the missing language identifier and the suggested
0x0404: "zh_TW", # Chinese (Taiwan)
0x0804: "zh_CN", # Chinese (PRC)
0x0406: "da_DK", # Danish
0x0413: "nl_NL", # Dutch (Netherlands)
0x0409: "en_US", # English (United States)
0x0809: "en_UK", # English (United Kingdom)
0x0c09: "en_AU", # English (Australian)
0x1009: "en_CA", # English (Canadian)
0x1409: "en_NZ", # English (New Zealand)
0x1809: "en_IE", # English (Ireland)
0x1c09: "en_ZA", # English (South Africa)
0x040b: "fi_FI", # Finnish
0x040c: "fr_FR", # French (Standard)
0x080c: "fr_BE", # French (Belgian)
0x0c0c: "fr_CA", # French (Canadian)
0x100c: "fr_CH", # French (Switzerland)
0x0407: "de_DE", # German (Standard)
0x040d: "iw_IL", # Hebrew
0x040f: "is_IS", # Icelandic
0x0410: "it_IT", # Italian (Standard)
0x0411: "ja_JA", # Japanese
0x0414: "no_NO", # Norwegian (Bokmal)
0x0816: "pt_PT", # Portuguese (Standard)
0x0c0a: "es_ES", # Spanish (Modern Sort)
0x0441: "sw_KE", # Swahili (Kenya)
0x041d: "sv_SE", # Swedish
0x081d: "sv_FI", # Swedish (Finland)
0x041f: "tr_TR", # Turkish
def _init_categories(categories
=categories
):
for k
,v
in globals().items():
print 'Locale defaults as determined by getdefaultlocale():'
lang
, enc
= getdefaultlocale()
print 'Language: ', lang
or '(undefined)'
print 'Encoding: ', enc
or '(undefined)'
print 'Locale settings on startup:'
for name
,category
in categories
.items():
lang
, enc
= getlocale(category
)
print ' Language: ', lang
or '(undefined)'
print ' Encoding: ', enc
or '(undefined)'
print 'Locale settings after calling resetlocale():'
for name
,category
in categories
.items():
lang
, enc
= getlocale(category
)
print ' Language: ', lang
or '(undefined)'
print ' Encoding: ', enc
or '(undefined)'
print 'setlocale(LC_ALL, "") does not support the default locale'
print 'given in the OS environment variables.'
print 'Locale settings after calling setlocale(LC_ALL, ""):'
for name
,category
in categories
.items():
lang
, enc
= getlocale(category
)
print ' Language: ', lang
or '(undefined)'
print ' Encoding: ', enc
or '(undefined)'
__all__
.append("LC_MESSAGES")
print 'Number formatting:'