> **Источник:** https://python-all.ru/3.8/c-api/codec.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# Реестр кодеков и вспомогательные функции

#### `int PyCodec_Register(PyObject *search_function)`

Регистрирует новую функцию поиска кодека.

В качестве побочного эффекта эта функция пытается загрузить пакет `encodings`, если он ещё не загружен, чтобы гарантировать, что он всегда будет первым в списке функций поиска.

#### `int PyCodec_KnownEncoding(const char *encoding)`

Возвращает `1` или `0` в зависимости от того, зарегистрирован ли кодек для заданной *encoding*. Эта функция всегда завершается успешно.

#### `PyObject* PyCodec_Encode(PyObject *object, const char *encoding, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Универсальный API кодирования на основе кодеков.

*object* передаётся в функцию кодировщика, найденную для заданной *encoding*, с использованием метода обработки ошибок, определённого в *errors*. Значение *errors* может быть `NULL` для использования метода по умолчанию, определённого для кодека. Возбуждает [`LookupError`](https://python-all.ru/3.8/library/exceptions.html#LookupError), если кодировщик не найден.

#### `PyObject* PyCodec_Decode(PyObject *object, const char *encoding, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Универсальный API декодирования на основе кодеков.

Объект *object* передаётся в функцию декодера, найденную для заданной *encoding*, с использованием метода обработки ошибок, определённого параметром *errors*. Параметр *errors* может быть `NULL`, чтобы использовать метод по умолчанию, определённый для кодека. Вызывает [`LookupError`](https://python-all.ru/3.8/library/exceptions.html#LookupError), если кодировщик не найден.

## API для поиска кодеков

В следующих функциях строка *encoding* при поиске приводится к нижнему регистру, что делает поиск кодировок через этот механизм нечувствительным к регистру. Если кодек не найден, устанавливается [`KeyError`](https://python-all.ru/3.8/library/exceptions.html#KeyError) и возвращается `NULL`.

#### `PyObject* PyCodec_Encoder(const char *encoding)`

*Возвращаемое значение: новая ссылка.*

Возвращает функцию кодировщика для заданной *encoding*.

#### `PyObject* PyCodec_Decoder(const char *encoding)`

*Возвращаемое значение: новая ссылка.*

Возвращает функцию декодера для заданной *encoding*.

#### `PyObject* PyCodec_IncrementalEncoder(const char *encoding, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Получить объект [`IncrementalEncoder`](https://python-all.ru/3.8/library/codecs.html#codecs.IncrementalEncoder) для указанной *кодировки*.

#### `PyObject* PyCodec_IncrementalDecoder(const char *encoding, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Получить объект [`IncrementalDecoder`](https://python-all.ru/3.8/library/codecs.html#codecs.IncrementalDecoder) для указанной *кодировки*.

#### `PyObject* PyCodec_StreamReader(const char *encoding, PyObject *stream, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Получить [`StreamReader`](https://python-all.ru/3.8/library/codecs.html#codecs.StreamReader) фабричную функцию для указанной *кодировки*.

#### `PyObject* PyCodec_StreamWriter(const char *encoding, PyObject *stream, const char *errors)`

*Возвращаемое значение: новая ссылка.*

Получить [`StreamWriter`](https://python-all.ru/3.8/library/codecs.html#codecs.StreamWriter) фабричную функцию для указанной *кодировки*.

## API реестра обработчиков ошибок кодирования Unicode

#### `int PyCodec_RegisterError(const char *name, PyObject *error)`

Зарегистрировать колбэк-функцию обработки ошибок *error* под указанным именем *name*. Эта колбэк-функция будет вызвана кодеком, когда он встретит некодируемые символы/недекодируемые байты, и *name* указан в качестве параметра error в вызове функции encode/decode.

Колбэк получает один аргумент – экземпляр [`UnicodeEncodeError`](https://python-all.ru/3.8/library/exceptions.html#UnicodeEncodeError), [`UnicodeDecodeError`](https://python-all.ru/3.8/library/exceptions.html#UnicodeDecodeError) или [`UnicodeTranslateError`](https://python-all.ru/3.8/library/exceptions.html#UnicodeTranslateError), который содержит информацию о проблемной последовательности символов или байтов и их смещении в исходной строке (см. [Объекты исключений Unicode](https://python-all.ru/3.8/c-api/exceptions.html#unicodeexceptions) для функций извлечения этой информации). Колбэк должен либо вызвать полученное исключение, либо вернуть кортеж из двух элементов, содержащий замену для проблемной последовательности и целое число, указывающее смещение в исходной строке, с которого следует продолжить кодирование/декодирование.

Возвращает `0` в случае успеха, `-1` при ошибке.

#### `PyObject* PyCodec_LookupError(const char *name)`

*Возвращаемое значение: новая ссылка.*

Найти колбэк-функцию обработки ошибок, зарегистрированную под именем *name*. В частном случае можно передать `NULL`, и тогда будет возвращён колбэк обработки ошибок для «strict».

#### `PyObject* PyCodec_StrictErrors(PyObject *exc)`

*Возвращаемое значение: всегда NULL.*

Возбудить *exc* как исключение.

#### `PyObject* PyCodec_IgnoreErrors(PyObject *exc)`

*Возвращаемое значение: новая ссылка.*

Игнорировать ошибку Unicode, пропуская некорректный ввод.

#### `PyObject* PyCodec_ReplaceErrors(PyObject *exc)`

*Возвращаемое значение: новая ссылка.*

Заменить ошибку кодирования Unicode на `?` или `U+FFFD`.

#### `PyObject* PyCodec_XMLCharRefReplaceErrors(PyObject *exc)`

*Возвращаемое значение: новая ссылка.*

Заменить ошибку кодирования Unicode на символьные ссылки XML.

#### `PyObject* PyCodec_BackslashReplaceErrors(PyObject *exc)`

*Возвращаемое значение: новая ссылка.*

Заменить ошибку кодирования Юникод на escape-последовательности с обратной косой чертой (`\x`, `\u` и `\U`).

#### `PyObject* PyCodec_NameReplaceErrors(PyObject *exc)`

*Возвращаемое значение: новая ссылка.*

Заменить ошибку кодирования Юникод на escape-последовательности `\N{...}`.

Новое в версии 3.5.
