Поддержка сериализации данных

Эти функции позволяют коду C работать с сериализованными объектами, используя тот же формат данных, что и модуль marshal. Существуют функции для записи данных в формате сериализации, а также дополнительные функции для чтения данных обратно. Файлы, используемые для хранения сериализованных данных, должны быть открыты в двоичном режиме.

Числовые значения хранятся с младшим байтом первым.

Модуль поддерживает две версии формата данных: версия 0 — историческая версия, версия 1 использует интернированные строки в файле и при распаковке. Версия 2 использует двоичный формат для чисел с плавающей точкой. Py_MARSHAL_VERSION указывает текущий формат файла (в настоящее время 2).

void PyMarshal_WriteLongToFile(long value, FILE *file, int version)

Сериализует целое число long, value, в file. Это запишет только младшие 32 бита value; независимо от размера родного типа long. version указывает формат файла.

Эта функция может завершиться ошибкой, в этом случае она установит индикатор ошибки. Используйте PyErr_Occurred() для проверки этого.

void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version)

Сериализует объект Python, value, в file. version указывает формат файла.

PyObject *PyMarshal_WriteObjectToString(PyObject *value, int version): Возвращаемое значение: Новая ссылка.
Возвращает объект bytes, содержащий сериализованное представление value. version указывает формат файла.

Следующие функции позволяют повторно читать сериализованные значения.

long PyMarshal_ReadLongFromFile(FILE *file)

Возвращает целое число C long из потока данных в FILE* открытом для чтения. С помощью этой функции можно считать только значение с 32 битами, независимо от размера родного типа long.

При ошибке устанавливается соответствующее исключение (EOFError) и возвращается -1.

int PyMarshal_ReadShortFromFile(FILE *file)

Возвращает целое число C short из потока данных в FILE* открытом для чтения. С помощью этой функции можно считать только значение с 16 битами, независимо от размера родного типа short.

При ошибке устанавливается соответствующее исключение (EOFError) и возвращается -1.

PyObject *PyMarshal_ReadObjectFromFile(FILE *file)

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

Возвращает объект Python из потока данных в FILE* открытом для чтения.

При ошибке устанавливается соответствующее исключение (EOFError, ValueError или TypeError) и возвращается NULL.

PyObject *PyMarshal_ReadLastObjectFromFile(FILE *file)

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

Возвращает объект Python из потока данных в FILE* открытом для чтения. В отличие от PyMarshal_ReadObjectFromFile(), эта функция предполагает, что из файла не будут читаться другие объекты, что позволяет агрессивно загружать данные файла в память, чтобы десериализация могла работать с данными в памяти, а не читать байт за байтом из файла. Используйте эту разновидность только в том случае, если вы уверены, что больше ничего не будете читать из файла.

При ошибке устанавливается соответствующее исключение (EOFError, ValueError или TypeError) и возвращается NULL.

PyObject *PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)

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

Возвращает объект Python из потока данных в буфере байтов, содержащем len байт, на которые указывает data.

При ошибке устанавливается соответствующее исключение (EOFError, ValueError или TypeError) и возвращается NULL.