intPyCodec_Register(
*search_function)
Part of the
.Register a new codec search function.
As a side effect, this tries to load the encodings package, if not yet done, to make sure that it is always first in the list of search functions.
intPyCodec_Unregister(
*search_function)
Part of the
since version 3.10.Unregister a codec search function and clear the registry’s cache. If the search function is not registered, do nothing. Return 0 on success. Raise an exception and return -1 on error.
Added in version 3.10.
intPyCodec_KnownEncoding(constchar*encoding)
Part of the
.Return 1 or 0 depending on whether there is a registered codec for the given encoding. This function always succeeds.
*PyCodec_Encode(
*object, constchar*encoding, constchar*errors)
Return value: New reference. Part of the
.Generic codec based encoding API.
object is passed through the encoder function found for the given encoding using the error handling method defined by errors. errors may be NULL to use the default method defined for the codec. Raises a
if no encoder can be found.
*PyCodec_Decode(
*object, constchar*encoding, constchar*errors)
Return value: New reference. Part of the
.Generic codec based decoding API.
object is passed through the decoder function found for the given encoding using the error handling method defined by errors. errors may be NULL to use the default method defined for the codec. Raises a
if no decoder can be found.
Codec lookup API
In the following functions, the encoding string is looked up converted to all lower-case characters, which makes encodings looked up through this mechanism effectively case-insensitive. If no codec is found, a
is set and NULL returned.
*PyCodec_Encoder(constchar*encoding)
Return value: New reference. Part of the
.Get an encoder function for the given encoding.
*PyCodec_Decoder(constchar*encoding)
Return value: New reference. Part of the
.Get a decoder function for the given encoding.
*PyCodec_IncrementalEncoder(constchar*encoding, constchar*errors)
Return value: New reference. Part of the
.Get an
object for the given encoding.
*PyCodec_IncrementalDecoder(constchar*encoding, constchar*errors)
Return value: New reference. Part of the
.Get an
object for the given encoding.
*PyCodec_StreamReader(constchar*encoding,
*stream, constchar*errors)
Return value: New reference. Part of the
.Get a
factory function for the given encoding.
*PyCodec_StreamWriter(constchar*encoding,
*stream, constchar*errors)
Return value: New reference. Part of the
.Get a
factory function for the given encoding.
Registry API for Unicode encoding error handlers
intPyCodec_RegisterError(constchar*name,
*error)
Part of the
.Register the error handling callback function error under the given name. This callback function will be called by a codec when it encounters unencodable characters/undecodable bytes and name is specified as the error parameter in the call to the encode/decode function.
The callback gets a single argument, an instance of
,
or
that holds information about the problematic sequence of characters or bytes and their offset in the original string (see
for functions to extract this information). The callback must either raise the given exception, or return a two-item tuple containing the replacement for the problematic sequence, and an integer giving the offset in the original string at which encoding/decoding should be resumed.
Return 0 on success, -1 on error.
*PyCodec_LookupError(constchar*name)
Return value: New reference. Part of the
.Lookup the error handling callback function registered under name. As a special case NULL can be passed, in which case the error handling callback for “strict” will be returned.
*PyCodec_StrictErrors(
*exc)
Return value: Always NULL. Part of the
.Raise exc as an exception.
*PyCodec_IgnoreErrors(
*exc)
Return value: New reference. Part of the
.Ignore the unicode error, skipping the faulty input.
*PyCodec_ReplaceErrors(
*exc)
Return value: New reference. Part of the
.Replace the unicode encode error with ? or U+FFFD.
*PyCodec_XMLCharRefReplaceErrors(
*exc)
Return value: New reference. Part of the
.Replace the unicode encode error with XML character references.
*PyCodec_BackslashReplaceErrors(
*exc)
Return value: New reference. Part of the
.Replace the unicode encode error with backslash escapes (\x, \u and \U).
*PyCodec_NameReplaceErrors(
*exc)
Return value: New reference. Part of the
since version 3.7.Replace the unicode encode error with \N{...} escapes.
Added in version 3.5.
Codec utility variables
constchar*Py_hexdigits
A string constant containing the lowercase hexadecimal digits: "0123456789abcdef".
Added in version 3.3.