picop.cycodecs#

Codec registry helpers.

picop.cycodecs.codec_backslashreplace_errors(exc)#

Backslash replace handler. :type exc: object :param exc:

Return type:

object

picop.cycodecs.codec_decode(o, encoding, errors)#
picop.cycodecs.codec_decoder(encoding)#

Return the decoder for encoding (PyCodec_Decoder).

Notes

encoding must be bytes, not str.

Parameters:

encoding (bytes)

Return type:

object

picop.cycodecs.codec_encode(o, encoding, errors)#
picop.cycodecs.codec_encoder(encoding)#

Return the encoder for encoding (PyCodec_Encoder).

Notes

encoding must be bytes, not str.

Parameters:

encoding (bytes)

Return type:

object

picop.cycodecs.codec_ignore_errors(exc)#

Ignore error handler (PyCodec_IgnoreErrors). :type exc: object :param exc:

Return type:

object

picop.cycodecs.codec_incremental_decoder(encoding, errors)#

Return an incremental decoder (PyCodec_IncrementalDecoder).

Notes

encoding / errors must be bytes when provided, not str.

Parameters:
Return type:

object

picop.cycodecs.codec_incremental_encoder(encoding, errors)#

Return an incremental encoder (PyCodec_IncrementalEncoder).

Notes

encoding / errors must be bytes when provided, not str.

Parameters:
Return type:

object

picop.cycodecs.codec_known(encoding)#

Return True if encoding is a known codec (PyCodec_KnownEncoding).

Notes

encoding must be bytes, not str. See Safety.

Parameters:

encoding (bytes)

Return type:

bool

picop.cycodecs.codec_lookup_error(name)#

Lookup a codec error callback (PyCodec_LookupError).

Notes

name must be bytes, not str.

Parameters:

name (bytes)

Return type:

object

picop.cycodecs.codec_namereplace_errors(exc)#

Name replace handler. :type exc: object :param exc:

Return type:

object

picop.cycodecs.codec_register(search_function)#

Register a codec search function (PyCodec_Register).

Notes

Returns 0 on success; errors raise — do not use the status as a bool.

Parameters:

search_function (object)

Return type:

int

picop.cycodecs.codec_register_error(name, error)#

Register a codec error callback (PyCodec_RegisterError).

Notes

name must be bytes. Returns 0 on success; errors raise — do not use the status as a bool.

Parameters:
Return type:

int

picop.cycodecs.codec_replace_errors(exc)#

Replace error handler (PyCodec_ReplaceErrors). :type exc: object :param exc:

Return type:

object

picop.cycodecs.codec_stream_reader(encoding, stream, errors)#

Return a stream reader (PyCodec_StreamReader).

Notes

encoding / errors must be bytes when provided, not str.

Parameters:
Return type:

object

picop.cycodecs.codec_stream_writer(encoding, stream, errors)#

Return a stream writer (PyCodec_StreamWriter).

Notes

encoding / errors must be bytes when provided, not str.

Parameters:
Return type:

object

picop.cycodecs.codec_strict_errors(exc)#

Strict error handler (PyCodec_StrictErrors). :type exc: object :param exc:

Return type:

object

picop.cycodecs.codec_xmlcharrefreplace_errors(exc)#

XML charref replace handler. :type exc: object :param exc:

Return type:

object