codecs
index
/usr/local/lib/python2.4/codecs.py
Module Docs

codecs -- Python Codec Registry, API and helpers.
 
 
Written by Marc-Andre Lemburg (mal@lemburg.com).
 
(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.

 
Modules
       
__builtin__
sys

 
Functions
       
EncodedFile(file, data_encoding, file_encoding=None, errors='strict')
Return a wrapped version of file which provides transparent
encoding translation.
 
Strings written to the wrapped file are interpreted according
to the given data_encoding and then written to the original
file as string using file_encoding. The intermediate encoding
will usually be Unicode but depends on the specified codecs.
 
Strings are read from the file using file_encoding and then
passed back to the caller as string using data_encoding.
 
If file_encoding is not given, it defaults to data_encoding.
 
errors may be given to define the error handling. It defaults
to 'strict' which causes ValueErrors to be raised in case an
encoding error occurs.
 
The returned wrapped file object provides two extra attributes
.data_encoding and .file_encoding which reflect the given
parameters of the same name. The attributes can be used for
introspection by Python programs.
ignore_errors(...)
lookup(...)
lookup(encoding) -> (encoder, decoder, stream_reader, stream_writer)
 
Looks up a codec tuple in the Python codec registry and returns
a tuple of functions.
lookup_error(...)
lookup_error(errors) -> handler
 
Return the error handler for the specified error handling name
or raise a LookupError, if no handler exists under this name.
open(filename, mode='rb', encoding=None, errors='strict', buffering=1)
Open an encoded file using the given mode and return
a wrapped version providing transparent encoding/decoding.
 
Note: The wrapped version will only accept the object format
defined by the codecs, i.e. Unicode objects for most builtin
codecs. Output is also codec dependent and will usually by
Unicode as well.
 
Files are always opened in binary mode, even if no binary mode
was specified. This is done to avoid data loss due to encodings
using 8-bit values. The default file mode is 'rb' meaning to
open the file in binary read mode.
 
encoding specifies the encoding which is to be used for the
file.
 
errors may be given to define the error handling. It defaults
to 'strict' which causes ValueErrors to be raised in case an
encoding error occurs.
 
buffering has the same meaning as for the builtin open() API.
It defaults to line buffered.
 
The returned wrapped file object provides an extra attribute
.encoding which allows querying the used encoding. This
attribute is only available if an encoding was specified as
parameter.
register(...)
register(search_function)
 
Register a codec search function. Search functions are expected to take
one argument, the encoding name in all lower case letters, and return
a tuple of functions (encoder, decoder, stream_reader, stream_writer).
register_error(...)
register_error(errors, handler)
 
Register the specified error handler under the name
errors. handler must be a callable object, that
will be called with an exception instance containing
information about the location of the encoding/decoding
error and must return a (replacement, new position) tuple.
replace_errors(...)
strict_errors(...)
xmlcharrefreplace_errors(...)

 
Data
        BOM = '\xff\xfe'
BOM32_BE = '\xfe\xff'
BOM32_LE = '\xff\xfe'
BOM64_BE = '\x00\x00\xfe\xff'
BOM64_LE = '\xff\xfe\x00\x00'
BOM_BE = '\xfe\xff'
BOM_LE = '\xff\xfe'
BOM_UTF16 = '\xff\xfe'
BOM_UTF16_BE = '\xfe\xff'
BOM_UTF16_LE = '\xff\xfe'
BOM_UTF32 = '\xff\xfe\x00\x00'
BOM_UTF32_BE = '\x00\x00\xfe\xff'
BOM_UTF32_LE = '\xff\xfe\x00\x00'
BOM_UTF8 = '\xef\xbb\xbf'
__all__ = ['register', 'lookup', 'open', 'EncodedFile', 'BOM', 'BOM_BE', 'BOM_LE', 'BOM32_BE', 'BOM32_LE', 'BOM64_BE', 'BOM64_LE', 'BOM_UTF8', 'BOM_UTF16', 'BOM_UTF16_LE', 'BOM_UTF16_BE', 'BOM_UTF32', 'BOM_UTF32_LE', 'BOM_UTF32_BE', 'strict_errors', 'ignore_errors', ...]