Visitar URL original
gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred by iritkatriel · Pull Request #105185 · python/cpython · GitHub
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iritkatriel merged 3 commits into from
Jun 2, 2023
Merged

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
212c72e
gh-105184: document that marshal functions can fail and need to be ch…
iritkatriel Jun 1, 2023
df93125
add comment
iritkatriel Jun 1, 2023
a2c72fb
Apply suggestions from code review
iritkatriel Jun 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-105184: document that marshal functions can fail and need to be ch… 
…ecked with PyErr_Occurred
  • Loading branch information
@iritkatriel
iritkatriel committed Jun 1, 2023
commit 212c72eddd98429e534df4b44a07eb283dde2581
4 changes: 4 additions & 0 deletions Doc/c-api/marshal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ``PyErr_Occurred()`` to check for that.
Comment thread
iritkatriel marked this conversation as resolved.
Outdated

.. 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 ``PyErr_Occurred()`` to check for that.
Comment thread
iritkatriel marked this conversation as resolved.
Outdated

.. c:function:: PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version)

Expand Down