Skip to content

gh-141004: Document the PyPickleBuffer_* C API #141630

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
ZeroIntensity merged 4 commits into from
Nov 16, 2025
+60 −0
Merged

gh-141004: Document the PyPickleBuffer_* C API #141630

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f68a90
Commit
StanFromIreland Nov 16, 2025
f8bb55d
Review
StanFromIreland Nov 16, 2025
1512ebd
Update Doc/c-api/picklebuffer.rst
StanFromIreland Nov 16, 2025
1076cfb
Tweaks
StanFromIreland Nov 16, 2025
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
Prev Previous commit
Tweaks
  • Loading branch information
@StanFromIreland
StanFromIreland committed Nov 16, 2025
commit 1076cfb5b5ffb40a0b9b41bb3cdcb02b89b8cbd4
7 changes: 4 additions & 3 deletions Doc/c-api/picklebuffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
.. index::
pair: object; PickleBuffer

PickleBuffer objects
--------------------
Pickle buffer objects
---------------------

.. versionadded:: 3.8

Expand All @@ -29,6 +29,7 @@ A :class:`pickle.PickleBuffer` object wraps a :ref:`buffer-providing object
.. c:function:: PyObject *PyPickleBuffer_FromObject(PyObject *obj)

Create a pickle buffer from the object *obj*.

This function will fail if *obj* doesn't support the :ref:`buffer protocol <bufferobjects>`.
Comment thread
StanFromIreland marked this conversation as resolved.

On success, return a new pickle buffer instance.
Expand All @@ -43,10 +44,10 @@ A :class:`pickle.PickleBuffer` object wraps a :ref:`buffer-providing object

The returned pointer is valid as long as *picklebuf* is alive and has not been
released. The caller must not modify or free the returned :c:type:`Py_buffer`.
If the pickle buffer has been released, raise :exc:`ValueError`.

On success, return a pointer to the buffer view.
On failure, set an exception and return ``NULL``.
If the pickle buffer has been released, raise :exc:`ValueError`.


.. c:function:: int PyPickleBuffer_Release(PyObject *picklebuf)
Expand Down
Loading