summaryrefslogtreecommitdiffstats
path: root/Python
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-06-05 15:41:14 (GMT)
committerGitHub <noreply@github.com>2023-06-05 15:41:14 (GMT)
commitc43c50e07ec35e4f66b6893fd940b8e098a12eb2 (patch)
treed5b2e569986ee558f368b03f090f0669eb3e0802 /Python
parentb28acfa396efc73c11aaf6387bed807684d446f7 (diff)
downloadcpython-c43c50e07ec35e4f66b6893fd940b8e098a12eb2.zip
cpython-c43c50e07ec35e4f66b6893fd940b8e098a12eb2.tar.gz
cpython-c43c50e07ec35e4f66b6893fd940b8e098a12eb2.tar.bz2
[3.8] gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105185) (#105222)
(cherry picked from commit ee26ca13a129da8cf549409d0a1b2e892ff2b4ec) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Diffstat (limited to 'Python')
-rw-r--r--Python/marshal.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/Python/marshal.c b/Python/marshal.c
index a9ba7a4..99075b1 100644
--- a/Python/marshal.c
+++ b/Python/marshal.c
@@ -601,6 +601,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)
{