Name	Size	Mode	Actions
abstract.rst.txt	702	0644	editdlrm
allocation.rst.txt	4796	0644	editdlrm
arg.rst.txt	26004	0644	editdlrm
bool.rst.txt	1304	0644	editdlrm
buffer.rst.txt	22965	0644	editdlrm
bytearray.rst.txt	2181	0644	editdlrm
capsule.rst.txt	5741	0644	editdlrm
cell.rst.txt	1940	0644	editdlrm
class.rst.txt	1866	0644	editdlrm
cobject.rst.txt	1870	0644	editdlrm
code.rst.txt	1635	0644	editdlrm
codec.rst.txt	4643	0644	editdlrm
complex.rst.txt	4079	0644	editdlrm
concrete.rst.txt	1963	0644	editdlrm
conversion.rst.txt	7092	0644	editdlrm
datetime.rst.txt	6413	0644	editdlrm
descriptor.rst.txt	1296	0644	editdlrm
dict.rst.txt	7757	0644	editdlrm
exceptions.rst.txt	35304	0644	editdlrm
file.rst.txt	6198	0644	editdlrm
float.rst.txt	3371	0644	editdlrm
function.rst.txt	2421	0644	editdlrm
gcsupport.rst.txt	6587	0644	editdlrm
gen.rst.txt	920	0644	editdlrm
import.rst.txt	11221	0644	editdlrm
index.rst.txt	578	0644	editdlrm
init.rst.txt	49160	0644	editdlrm
int.rst.txt	4578	0644	editdlrm
intro.rst.txt	28473	0644	editdlrm
iter.rst.txt	1390	0644	editdlrm
iterator.rst.txt	1796	0644	editdlrm
list.rst.txt	6362	0644	editdlrm
long.rst.txt	7987	0644	editdlrm
mapping.rst.txt	2874	0644	editdlrm
marshal.rst.txt	3985	0644	editdlrm
memory.rst.txt	11556	0644	editdlrm
method.rst.txt	2099	0644	editdlrm
module.rst.txt	3867	0644	editdlrm
none.rst.txt	697	0644	editdlrm
number.rst.txt	11939	0644	editdlrm
objbuffer.rst.txt	2516	0644	editdlrm
object.rst.txt	17491	0644	editdlrm
objimpl.rst.txt	305	0644	editdlrm
refcounting.rst.txt	2934	0644	editdlrm
reflection.rst.txt	1567	0644	editdlrm
sequence.rst.txt	8716	0644	editdlrm
set.rst.txt	6588	0644	editdlrm
slice.rst.txt	2979	0644	editdlrm
string.rst.txt	15422	0644	editdlrm
structures.rst.txt	14966	0644	editdlrm
sys.rst.txt	5714	0644	editdlrm
tuple.rst.txt	5491	0644	editdlrm
type.rst.txt	2761	0644	editdlrm
typeobj.rst.txt	66936	0644	editdlrm
unicode.rst.txt	45126	0644	editdlrm
utilities.rst.txt	415	0644	editdlrm
veryhigh.rst.txt	13363	0644	editdlrm
weakref.rst.txt	2820	0644	editdlrm

.. highlightlang:: c .. _marshalling-utils: Data marshalling support ======================== These routines allow C code to work with serialized objects using the same data format as the :mod:`marshal` module. There are functions to write data into the serialization format, and additional functions that can be used to read the data back. Files used to store marshalled data must be opened in binary mode. Numeric values are stored with the least significant byte first. The module supports two versions of the data format: version ``0`` is the historical version, version ``1`` (new in Python 2.4) shares interned strings in the file, and upon unmarshalling. Version 2 (new in Python 2.5) uses a binary format for floating point numbers. *Py_MARSHAL_VERSION* indicates the current file format (currently 2). .. c:function:: void PyMarshal_WriteLongToFile(long value, FILE *file, int version) Marshal a :c:type:`long` integer, *value*, to *file*. This will only write the least-significant 32 bits of *value*; regardless of the size of the native :c:type:`long` type. .. versionchanged:: 2.4 *version* indicates the file format. .. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version) Marshal a Python object, *value*, to *file*. .. versionchanged:: 2.4 *version* indicates the file format. .. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version) Return a string object containing the marshalled representation of *value*. .. versionchanged:: 2.4 *version* indicates the file format. The following functions allow marshalled values to be read back in. XXX What about error detection? It appears that reading past the end of the file will always result in a negative numeric value (where that's relevant), but it's not clear that negative values won't be handled properly when there's no error. What's the right way to tell? Should only non-negative values be written using these routines? .. c:function:: long PyMarshal_ReadLongFromFile(FILE *file) Return a C :c:type:`long` from the data stream in a :c:type:`FILE\*` opened for reading. Only a 32-bit value can be read in using this function, regardless of the native size of :c:type:`long`. .. c:function:: int PyMarshal_ReadShortFromFile(FILE *file) Return a C :c:type:`short` from the data stream in a :c:type:`FILE\*` opened for reading. Only a 16-bit value can be read in using this function, regardless of the native size of :c:type:`short`. .. c:function:: PyObject* PyMarshal_ReadObjectFromFile(FILE *file) Return a Python object from the data stream in a :c:type:`FILE\*` opened for reading. On error, sets the appropriate exception (:exc:`EOFError` or :exc:`TypeError`) and returns *NULL*. .. c:function:: PyObject* PyMarshal_ReadLastObjectFromFile(FILE *file) Return a Python object from the data stream in a :c:type:`FILE\*` opened for reading. Unlike :c:func:`PyMarshal_ReadObjectFromFile`, this function assumes that no further objects will be read from the file, allowing it to aggressively load file data into memory so that the de-serialization can operate from data in memory rather than reading a byte at a time from the file. Only use these variant if you are certain that you won't be reading anything else from the file. On error, sets the appropriate exception (:exc:`EOFError` or :exc:`TypeError`) and returns *NULL*. .. c:function:: PyObject* PyMarshal_ReadObjectFromString(char *string, Py_ssize_t len) Return a Python object from the data stream in a character buffer containing *len* bytes pointed to by *string*. On error, sets the appropriate exception (:exc:`EOFError` or :exc:`TypeError`) and returns *NULL*. .. versionchanged:: 2.5 This function used an :c:type:`int` type for *len*. This might require changes in your code for properly supporting 64-bit systems.