mirror of
https://github.com/python/cpython
synced 2024-10-14 22:49:50 +00:00
[3.12] gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105185) (#105218)
gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105185)
(cherry picked from commit ee26ca13a1
)
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
This commit is contained in:
parent
e6d5e63614
commit
46cc4f0f76
|
@ -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
|
||||
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)
|
||||
|
||||
Marshal a Python object, *value*, to *file*.
|
||||
*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)
|
||||
|
||||
|
|
|
@ -625,6 +625,10 @@ w_clear_refs(WFILE *wf)
|
|||
}
|
||||
|
||||
/* 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
|
||||
PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue