Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[WIP] gh-129813: Add PyBytesWriter C API #129814

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

Closed
vstinner wants to merge 8 commits into from
Closed

[WIP] gh-129813: Add PyBytesWriter C API #129814

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
490222f
gh-129813: Add PyBytesWriter C API
vstinner Feb 3, 2025
8f8aeb8
Add documentation
vstinner Feb 13, 2025
68d2fe7
Add PyBytesWriter_GetRemaining()
vstinner Feb 14, 2025
e582385
Optimize bytes_fromformat()
vstinner Feb 14, 2025
7cb444b
Remove PyBytesWriter_GetAllocated()
vstinner Feb 14, 2025
486d7cd
Add 'center' example
vstinner Feb 14, 2025
c4f4c07
Change PyBytesWriter_WriteBytes() argument type to void*
vstinner Feb 16, 2025
18ec24d
Documentation
vstinner Feb 18, 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
Next Next commit
Add documentation
  • Loading branch information
@vstinner
vstinner committed Feb 13, 2025
commit 8f8aeb8a9a5dc6c9d9a1a59aa1a45ae0c7cebbfd
68 changes: 68 additions & 0 deletions Doc/c-api/bytes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,71 @@ called with a non-bytes parameter.
reallocation fails, the original bytes object at *\*bytes* is deallocated,
*\*bytes* is set to ``NULL``, :exc:`MemoryError` is set, and ``-1`` is
returned.

PyBytesWriter
^^^^^^^^^^^^^

.. versionadded:: next

.. c:type:: PyBytesWriter

A Python :class:`bytes` writer instance created by
:c:func:`PyBytesWriter_Create`.

The instance must be destroyed by :c:func:`PyBytesWriter_Finish` or
:c:func:`PyBytesWriter_Discard`.

.. c:function:: void* PyBytesWriter_Create(PyBytesWriter **writer, Py_ssize_t alloc)

Create a :c:type:`PyBytesWriter` to write *alloc* bytes.

On success, return non-``NULL`` buffer where bytes can be written.
On error, set an exception and return ``NULL``.

*alloc* must be positive or zero.

.. c:function:: void PyBytesWriter_Discard(PyBytesWriter *writer)

Discard a :c:type:`PyBytesWriter` created by :c:func:`PyBytesWriter_Create`.

The writer instance is invalid after the call.

.. c:function:: PyObject* PyBytesWriter_Finish(PyBytesWriter *writer, void *buf)

Finish a :c:type:`PyBytesWriter` created by :c:func:`PyBytesWriter_Create`.

On success, return a Python :class:`bytes` object.
On error, set an exception and return ``NULL``.

The writer instance is invalid after the call.

.. c:function:: void* PyBytesWriter_Extend(PyBytesWriter *writer, void *buf, Py_ssize_t extend)

Extend the buffer by *extend* bytes.

On success, return non-``NULL`` buffer where bytes can be written.
On error, set an exception and return ``NULL``.

*extend* must be positive or zero.

.. c:function:: void* PyBytesWriter_WriteBytes(PyBytesWriter *writer, void *buf, const char *bytes, Py_ssize_t size)

Extend the buffer by *size* bytes and write *bytes* into the writer.

If *size* is equal to ``-1``, call ``strlen(bytes)`` to get the
string length.

On success, return non-``NULL`` buffer.
On error, set an exception and return ``NULL``.

.. c:function:: void* PyBytesWriter_Format(PyBytesWriter *writer, void *buf, const char *format, ...)

Similar to ``PyBytes_FromFormat()``, but write the output directly
into the writer.

On success, return non-``NULL`` buffer.
On error, set an exception and return ``NULL``.

.. c:function:: Py_ssize_t PyBytesWriter_GetAllocated(PyBytesWriter *writer)

Get the number of allocated bytes.