# 编解码器注册与支持功能

int PyCodec_Register(PyObject *search_function)
  属于 稳定 ABI.

  注册一个新的编解码器搜索函数。

  作为附带影响，这将尝试加载 `encodings` 包，如果还没有加载的话，以确保它始终位于搜索函数列表的第一位。

int PyCodec_Unregister(PyObject *search_function)
  属于 稳定 ABI 自 3.10 版起.

  注销一个编解码器搜索函数并清空注册表缓存。如果指定搜索函数未被注册，则不做任何操作。成功时返回 0。出错时引发一个异常并返回 -1。

  Added in version 3.10.

int PyCodec_KnownEncoding(const char *encoding)
  属于 稳定 ABI.

  根据注册的给定 encoding 的编解码器是否已存在而返回 `1` 或 `0`。此函数总能成功。

PyObject *PyCodec_Encode(PyObject *object, const char *encoding, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  通用的基于编解码器的编码 API。

  object 使用由 errors 所定义的错误处理方法传递给定 encoding 的编码器函数。 errors 可以为 `NULL` 表示使用为编码器所定义的默认方法。如果找不到编码器则会引发 `LookupError`。

PyObject *PyCodec_Decode(PyObject *object, const char *encoding, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  通用的基于编解码器的解码 API。

  object 使用由 errors 所定义的错误处理方法传递给定 encoding 的解码器函数。 errors 可以为 `NULL` 表示使用为编解码器所定义的默认方法。如果找不到编解码器则会引发 `LookupError`。

## Codec 查找 API

在下列函数中，encoding 字符串会被查找并转换为小写字母形式，这使得通过此机制查找编码格式实际上对大小写不敏感。 如果未找到任何编解码器，则将设置 `KeyError` 并返回 `NULL`。

PyObject *PyCodec_Encoder(const char *encoding)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个编码器函数。

PyObject *PyCodec_Decoder(const char *encoding)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个解码器函数。

PyObject *PyCodec_IncrementalEncoder(const char *encoding, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个 `IncrementalEncoder` 对象。

PyObject *PyCodec_IncrementalDecoder(const char *encoding, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个 `IncrementalDecoder` 对象。

PyObject *PyCodec_StreamReader(const char *encoding, PyObject *stream, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个 `StreamReader` 工厂函数。

PyObject *PyCodec_StreamWriter(const char *encoding, PyObject *stream, const char *errors)
  返回值：新的引用。 属于 稳定 ABI.

  为给定的 encoding 获取一个 `StreamWriter` 工厂函数。

## 用于 Unicode 编码错误处理程序的注册表 API

int PyCodec_RegisterError(const char *name, PyObject *error)
  属于 稳定 ABI.

  在给定的 name 之下注册错误处理回调函数 error。该回调函数将在一个编解码器遇到无法编码的字符/无法解码的字节数据并且 name 被指定为 encode/decode 函数调用的 error 形参时由该编解码器来调用。

  该回调函数会接受一个 `UnicodeEncodeError`, `UnicodeDecodeError` 或 `UnicodeTranslateError` 的实例作为单独参数，其中包含关于有问题的字符或字节序列及其在原始字符串中的偏移量信息（请参阅 Unicode 异常对象 了解提取此信息的函数详情）。 该回调函数必须引发给定的异常，或者返回一个二元组，其中包含有问题序列的替换内容以及一个整数，该整数给出应在原始字符串中恢复编码/解码操作的偏移量。

  成功则返回 `0`，失败则返回 `-1`。

PyObject *PyCodec_LookupError(const char *name)
  返回值：新的引用。 属于 稳定 ABI.

  查找在 name 之下注册的错误处理回调函数。作为特例还可以传入 `NULL`，在此情况下将返回针对 "strict" 的错误处理回调函数。

PyObject *PyCodec_StrictErrors(PyObject *exc)
  返回值：恒为 NULL。 属于 稳定 ABI.

  引发 exc 作为异常。

PyObject *PyCodec_IgnoreErrors(PyObject *exc)
  返回值：新的引用。 属于 稳定 ABI.

  忽略 unicode 错误，跳过错误的输入。

PyObject *PyCodec_ReplaceErrors(PyObject *exc)
  返回值：新的引用。 属于 稳定 ABI.

  使用 `?` 或 `U+FFFD` 替换 unicode 编码错误。

PyObject *PyCodec_XMLCharRefReplaceErrors(PyObject *exc)
  返回值：新的引用。 属于 稳定 ABI.

  使用 XML 字符引用替换 unicode 编码错误。

PyObject *PyCodec_BackslashReplaceErrors(PyObject *exc)
  返回值：新的引用。 属于 稳定 ABI.

  使用反斜杠转义符 (`\x`, `\u` 和 `\U`) 替换 unicode 编码错误。

PyObject *PyCodec_NameReplaceErrors(PyObject *exc)
  返回值：新的引用。 属于 稳定 ABI 自 3.7 版起.

  使用 `\N{...}` 转义符替换 unicode 编码错误。

  Added in version 3.5.

## 编解码器工具变量

const char *Py_hexdigits

  一个包含小写形式十六进制数位的字符串: `"0123456789abcdef"`。

  Added in version 3.3.