gh-105184: document that marshal functions can fail and need to be ch… · python/cpython@ee26ca1

Original file line numberDiff line numberDiff line change

@@ -25,12 +25,16 @@ unmarshalling. Version 2 uses a binary format for floating point numbers.

2525

the least-significant 32 bits of *value*; regardless of the size of the

2626

native :c:expr:`long` type. *version* indicates the file format.

2727
28+

This function can fail, in which case it sets the error indicator.

29+

Use :c:func:`PyErr_Occurred` to check for that.

2830
2931

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

3032
3133

Marshal a Python object, *value*, to *file*.

3234

*version* indicates the file format.

3335
36+

This function can fail, in which case it sets the error indicator.

37+

Use :c:func:`PyErr_Occurred` to check for that.

3438
3539

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

3640