gh-53243: Document codecs.readbuffer_encode() (#136284)

Closes #53243
This commit is contained in:
Stan Ulbrych 2025-07-09 09:39:55 +02:00 committed by GitHub
parent 301b29dd30
commit f1dcf3c7bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -265,6 +265,20 @@ wider range of codecs when working with binary files:
:func:`iterencode`.
.. function:: readbuffer_encode(buffer, errors=None, /)
Return a :class:`tuple` containing the raw bytes of *buffer*, a
:ref:`buffer-compatible object <bufferobjects>` or :class:`str`
(encoded to UTF-8 before processing), and their length in bytes.
The *errors* argument is ignored.
.. code-block:: pycon
>>> codecs.readbuffer_encode(b"Zito")
(b'Zito', 4)
The module also provides the following constants which are useful for reading
and writing to platform dependent files: