Commitee26ca1

authored

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

1 parent77d2579 commitee26ca1Copy full SHA for ee26ca1

File tree

-0

lines changed

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,16 @@ unmarshalling. Version 2 uses a binary format for floating point numbers.`
`25`	`25`	`the least-significant 32 bits of value; regardless of the size of the`
`26`	`26`	native:c:expr:`long` type. version indicates the file format.
`27`	`27`
	`28`	`+ This function can fail, in which case it sets the error indicator.`
	`29`	+ Use:c:func:`PyErr_Occurred` to check for that.
`28`	`30`
`29`	`31`	`..c:function::voidPyMarshal_WriteObjectToFile(PyObject value, FILE file, int version)`
`30`	`32`
`31`	`33`	`Marshal a Python object, value, to file.`
`32`	`34`	`version indicates the file format.`
`33`	`35`
	`36`	`+ This function can fail, in which case it sets the error indicator.`
	`37`	+ Use:c:func:`PyErr_Occurred` to check for that.
`34`	`38`
`35`	`39`	`..c:function:: PyObjectPyMarshal_WriteObjectToString(PyObject value, int version)`
`36`	`40`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -625,6 +625,10 @@ w_clear_refs(WFILE *wf)`
`625`	`625`	`}`
`626`	`626`
`627`	`627`	`/* version currently has no effect for writing ints. */`
	`628`	`+/* Note that while the documentation states that this function`
	`629`	`+ * can error, currently it never does. Setting an exception in`
	`630`	`+ * this function should be regarded as an API-breaking change.`
	`631`	`+ */`
`628`	`632`	`void`
`629`	`633`	`PyMarshal_WriteLongToFile(longx,FILE*fp,intversion)`
`630`	`634`	`{`

Comments

(0)