FM / c-api

/usr/share/doc/python3-docs/html/_sources/c-api/

/usr/share/doc/python3-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	715	0644	edit dl rm
allocation.rst.txt	2653	0644	edit dl rm
apiabiversion.rst.txt	2242	0644	edit dl rm
arg.rst.txt	30651	0644	edit dl rm
bool.rst.txt	1200	0644	edit dl rm
buffer.rst.txt	22267	0644	edit dl rm
bytearray.rst.txt	2250	0644	edit dl rm
bytes.rst.txt	9211	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
code.rst.txt	1666	0644	edit dl rm
codec.rst.txt	4799	0644	edit dl rm
complex.rst.txt	3946	0644	edit dl rm
concrete.rst.txt	2046	0644	edit dl rm
conversion.rst.txt	5516	0644	edit dl rm
coro.rst.txt	820	0644	edit dl rm
datetime.rst.txt	6415	0644	edit dl rm
descriptor.rst.txt	1111	0644	edit dl rm
dict.rst.txt	7952	0644	edit dl rm
exceptions.rst.txt	47814	0644	edit dl rm
file.rst.txt	3248	0644	edit dl rm
float.rst.txt	2243	0644	edit dl rm
function.rst.txt	3348	0644	edit dl rm
gcsupport.rst.txt	6057	0644	edit dl rm
gen.rst.txt	1301	0644	edit dl rm
import.rst.txt	12825	0644	edit dl rm
index.rst.txt	613	0644	edit dl rm
init.rst.txt	52383	0644	edit dl rm
intro.rst.txt	28751	0644	edit dl rm
iter.rst.txt	1129	0644	edit dl rm
iterator.rst.txt	1640	0644	edit dl rm
list.rst.txt	4735	0644	edit dl rm
long.rst.txt	10436	0644	edit dl rm
mapping.rst.txt	2871	0644	edit dl rm
marshal.rst.txt	3561	0644	edit dl rm
memory.rst.txt	21369	0644	edit dl rm
memoryview.rst.txt	2348	0644	edit dl rm
method.rst.txt	2818	0644	edit dl rm
module.rst.txt	18266	0644	edit dl rm
none.rst.txt	740	0644	edit dl rm
number.rst.txt	10583	0644	edit dl rm
objbuffer.rst.txt	2198	0644	edit dl rm
object.rst.txt	17420	0644	edit dl rm
objimpl.rst.txt	304	0644	edit dl rm
refcounting.rst.txt	2909	0644	edit dl rm
reflection.rst.txt	1417	0644	edit dl rm
sequence.rst.txt	6547	0644	edit dl rm
set.rst.txt	6144	0644	edit dl rm
slice.rst.txt	2404	0644	edit dl rm
stable.rst.txt	1969	0644	edit dl rm
structures.rst.txt	13787	0644	edit dl rm
sys.rst.txt	9944	0644	edit dl rm
tuple.rst.txt	8031	0644	edit dl rm
type.rst.txt	3963	0644	edit dl rm
typeobj.rst.txt	60184	0644	edit dl rm
unicode.rst.txt	68074	0644	edit dl rm
utilities.rst.txt	414	0644	edit dl rm
veryhigh.rst.txt	16655	0644	edit dl rm
weakref.rst.txt	2635	0644	edit dl rm

Edit: /usr/share/doc/python3-docs/html/_sources/c-api/marshal.rst.txt (3561B)

.. 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 shares interned strings in the file, and upon
unmarshalling.  Version 2 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.  *version* indicates the file format.

.. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version)

Marshal a Python object, *value*, to *file*.
   *version* indicates the file format.

.. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version)

Return a bytes object containing the marshalled representation of *value*.
   *version* indicates the file format.

The following functions allow marshalled values to be read back in.

.. 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`.

On error, sets the appropriate exception (:exc:`EOFError`) and returns
   ``-1``.

.. 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`.

On error, sets the appropriate exception (:exc:`EOFError`) and returns
   ``-1``.

.. 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`, :exc:`ValueError`
   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`, :exc:`ValueError`
   or :exc:`TypeError`) and returns *NULL*.

.. c:function:: PyObject* PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)

Return a Python object from the data stream in a byte buffer
   containing *len* bytes pointed to by *data*.

On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError`
   or :exc:`TypeError`) and returns *NULL*.

cmd: