encodings Namespace Reference

Namespaces
namespace	aliases
namespace	ascii
namespace	base64_codec
namespace	big5
namespace	big5hkscs
namespace	bz2_codec
namespace	charmap
namespace	cp037
namespace	cp1006
namespace	cp1026
namespace	cp1140
namespace	cp1250
namespace	cp1251
namespace	cp1252
namespace	cp1253
namespace	cp1254
namespace	cp1255
namespace	cp1256
namespace	cp1257
namespace	cp1258
namespace	cp424
namespace	cp437
namespace	cp500
namespace	cp720
namespace	cp737
namespace	cp775
namespace	cp850
namespace	cp852
namespace	cp855
namespace	cp856
namespace	cp857
namespace	cp858
namespace	cp860
namespace	cp861
namespace	cp862
namespace	cp863
namespace	cp864
namespace	cp865
namespace	cp866
namespace	cp869
namespace	cp874
namespace	cp875
namespace	cp932
namespace	cp949
namespace	cp950
namespace	euc_jis_2004
namespace	euc_jisx0213
namespace	euc_jp
namespace	euc_kr
namespace	gb18030
namespace	gb2312
namespace	gbk
namespace	hex_codec
namespace	hp_roman8
namespace	hz
namespace	idna
namespace	iso2022_jp
namespace	iso2022_jp_1
namespace	iso2022_jp_2
namespace	iso2022_jp_2004
namespace	iso2022_jp_3
namespace	iso2022_jp_ext
namespace	iso2022_kr
namespace	iso8859_1
namespace	iso8859_10
namespace	iso8859_11
namespace	iso8859_13
namespace	iso8859_14
namespace	iso8859_15
namespace	iso8859_16
namespace	iso8859_2
namespace	iso8859_3
namespace	iso8859_4
namespace	iso8859_5
namespace	iso8859_6
namespace	iso8859_7
namespace	iso8859_8
namespace	iso8859_9
namespace	johab
namespace	koi8_r
namespace	koi8_u
namespace	latin_1
namespace	mac_arabic
namespace	mac_centeuro
namespace	mac_croatian
namespace	mac_cyrillic
namespace	mac_farsi
namespace	mac_greek
namespace	mac_iceland
namespace	mac_latin2
namespace	mac_roman
namespace	mac_romanian
namespace	mac_turkish
namespace	mbcs
namespace	palmos
namespace	ptcp154
namespace	punycode
namespace	quopri_codec
namespace	raw_unicode_escape
namespace	rot_13
namespace	shift_jis
namespace	shift_jis_2004
namespace	shift_jisx0213
namespace	string_escape
namespace	tis_620
namespace	undefined
namespace	unicode_escape
namespace	unicode_internal
namespace	utf_16
namespace	utf_16_be
namespace	utf_16_le
namespace	utf_32
namespace	utf_32_be
namespace	utf_32_le
namespace	utf_7
namespace	utf_8
namespace	utf_8_sig
namespace	uu_codec
namespace	zlib_codec

Classes
class	CodecRegistryError

Functions
def	normalize_encoding
def	search_function

Variables
dictionary	_cache = {}
string	_unknown = '--unknown--'
list	_import_tail = ['*']
tuple	_norm_encoding_map
	_aliases = aliases.aliases

Detailed Description

Standard "encodings" Package

    Standard Python encoding modules are stored in this package
    directory.

    Codec modules must have names corresponding to normalized encoding
    names as defined in the normalize_encoding() function below, e.g.
    'utf-8' must be implemented by the module 'utf_8.py'.

    Each codec module must export the following interface:

    * getregentry() -> codecs.CodecInfo object
    The getregentry() API must a CodecInfo object with encoder, decoder,
    incrementalencoder, incrementaldecoder, streamwriter and streamreader
    atttributes which adhere to the Python Codec Interface Standard.

    In addition, a module may optionally also define the following
    APIs which are then used by the package's codec search function:

    * getaliases() -> sequence of encoding name strings to use as aliases

    Alias names returned by getaliases() must be normalized encoding
    names as defined by normalize_encoding().

Written by Marc-Andre Lemburg (mal@lemburg.com).

(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.

Function Documentation

def encodings.normalize_encoding

(

encoding

)

Normalize an encoding name.

    Normalization works as follows: all non-alphanumeric
    characters except the dot used for Python package names are
    collapsed and replaced with a single underscore, e.g. '  -;#'
    becomes '_'. Leading and trailing underscores are removed.

    Note that encoding names should be ASCII only; if they do use
    non-ASCII characters, these must be Latin-1 compatible.

def encodings.search_function

(

encoding

)

Variable Documentation

encodings._aliases = aliases.aliases

dictionary encodings._cache = {}

list encodings._import_tail = ['*']

tuple encodings._norm_encoding_map

Initial value:

= ('                                              . '
                      '0123456789       ABCDEFGHIJKLMNOPQRSTUVWXYZ     '
                      ' abcdefghijklmnopqrstuvwxyz                     '
                      '                                                '
                      '                                                '
                      '                ')

string encodings._unknown = '--unknown--'