Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 07:31:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (#105185)

Browse source
This commit is contained in:
Irit Katriel 2023-06-02 08:59:18 +01:00 • committed by GitHub
parent 77d2579586
commit ee26ca13a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/c-api/marshal.rst
View file

@ -25,12 +25,16 @@ unmarshalling. Version 2 uses a binary format for floating point numbers.
the least-significant 32 bits of *value*; regardless of the size of the the least-significant 32 bits of *value*; regardless of the size of the
native :c:expr:`long` type. *version* indicates the file format. native :c:expr:`long` type. *version* indicates the file format.
This function can fail, in which case it sets the error indicator.
Use :c:func:`PyErr_Occurred` to check for that.
.. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version) .. c:function:: void PyMarshal_WriteObjectToFile(PyObject *value, FILE *file, int version)
Marshal a Python object, *value*, to *file*. Marshal a Python object, *value*, to *file*.
*version* indicates the file format. *version* indicates the file format.
This function can fail, in which case it sets the error indicator.
Use :c:func:`PyErr_Occurred` to check for that.
.. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version) .. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version)

4
Python/marshal.c
View file

@ -625,6 +625,10 @@ w_clear_refs(WFILE *wf)
} }
/* version currently has no effect for writing ints. */ /* version currently has no effect for writing ints. */
/* Note that while the documentation states that this function
* can error, currently it never does. Setting an exception in
* this function should be regarded as an API-breaking change.
*/
void void
PyMarshal_WriteLongToFile(long x, FILE *fp, int version) PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
{ {