[3.7] gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105223)

miss-islington · iritkatriel · web-flow · commit 32590d5fbd29 · 2023-06-05T00:08:36.000-04:00
(cherry picked from commit ee26ca1) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
diff --git a/Doc/c-api/marshal.rst b/Doc/c-api/marshal.rst
@@ -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:type:`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)
 
diff --git a/Python/marshal.c b/Python/marshal.c
@@ -619,6 +619,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)
 {

Original file line number	Diff line number	Diff line change
`@@ -619,6 +619,10 @@ w_clear_refs(WFILE *wf)`
`619`	`619`	`}`
`620`	`620`
`621`	`621`	`/* version currently has no effect for writing ints. */`
	`622`	`+/* Note that while the documentation states that this function`
	`623`	`+ * can error, currently it never does. Setting an exception in`
	`624`	`+ * this function should be regarded as an API-breaking change.`
	`625`	`+ */`
`622`	`626`	`void`
`623`	`627`	`PyMarshal_WriteLongToFile(long x, FILE *fp, int version)`
`624`	`628`	`{`