Suporte a marshalling de dados

Essas rotinas permitem que o código C trabalhe com objetos serializados usando o mesmo formato de dados que o módulo marshal. Existem funções para gravar dados no formato de serialização e funções adicionais que podem ser usadas para ler os dados novamente. Os arquivos usados para armazenar dados empacotados devem ser abertos no modo binário.

Os valores numéricos são armazenados primeiro com o byte menos significativo.

O módulo oferece suporte a várias versões do formato de dados; consulte a documentação do módulo Python para obter detalhes.

The following exceptions can be raised by these functions: ValueError if the value cannot be marshalled, ValueError or TypeError if the data is malformed, EOFError if the end of the data is reached before the value is complete, OSError if reading from or writing to a FILE* fails, KeyboardInterrupt if reading or writing is interrupted by a signal, and MemoryError if memory allocation fails.

Alterado na versão 3.16.0a0 (unreleased): Previously, in functions taking a FILE*, the reading functions raised EOFError instead of OSError and KeyboardInterrupt, and the writing functions ignored I/O errors and interruptions.

Py_MARSHAL_VERSION

A versão atual do formato. Veja marshal.version.

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

Aplica marshalling em um inteiro long, value, para file. Isso escreverá apenas os 32 bits menos significativos de value; independentemente do tamanho do tipo nativo long. version indica o formato do arquivo.

Esta função pode falhar, caso em que define o indicador de erro. Use PyErr_Occurred() para verificar isso.

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

Aplica marshalling em um objeto Python, value, para file. version indica o formato do arquivo.

Esta função pode falhar, caso em que define o indicador de erro. Use PyErr_Occurred() para verificar isso.

PyObject *PyMarshal_WriteObjectToString(PyObject *value, int version)

Retorna valor: Nova referência.

Retorna um objeto de bytes que contém a representação pós-marshalling de value. version indica o formato do arquivo.

On error, raises an exception and returns NULL.

As seguintes funções permitem que os valores pós-marshalling sejam lidos novamente.

long PyMarshal_ReadLongFromFile(FILE *file)

Retorna um long C do fluxo de dados em um FILE* aberto para leitura. Somente um valor de 32 bits pode ser lido usando essa função, independentemente do tamanho nativo de long.

On error, raises an exception and returns -1.

int PyMarshal_ReadShortFromFile(FILE *file)

Retorna um short C do fluxo de dados em um FILE* aberto para leitura. Somente um valor de 16 bits pode ser lido usando essa função, independentemente do tamanho nativo de short.

On error, raises an exception and returns -1.

PyObject *PyMarshal_ReadObjectFromFile(FILE *file)

Retorna valor: Nova referência.

Retorna um objeto Python do fluxo de dados em um FILE* aberto para leitura.

On error, raises an exception and returns NULL.

PyObject *PyMarshal_ReadLastObjectFromFile(FILE *file)

Retorna valor: Nova referência.

Retorna um objeto Python do fluxo de dados em um FILE* aberto para leitura. Diferentemente de PyMarshal_ReadObjectFromFile(), essa função presume que nenhum objeto adicional será lido do arquivo, permitindo que ela carregue agressivamente os dados do arquivo na memória, para que a desserialização possa operar a partir de dados na memória em vez de ler um byte por vez do arquivo. Use essa variante apenas se tiver certeza de que não estará lendo mais nada do arquivo.

On error, raises an exception and returns NULL.

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

Retorna valor: Nova referência.

Retorna um objeto Python do fluxo de dados em um buffer de bytes contendo len bytes apontados por data.

On error, raises an exception and returns NULL.