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

Эти процедуры позволяют коду 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 указывает формат файла.

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.