https://github.com/python/cpython/commit/f1dcf3c7bf90961b8d5475154d3f28cfef0a054f
commit: f1dcf3c7bf90961b8d5475154d3f28cfef0a054f
branch: main
author: Stan Ulbrych <89152624+stanfromirel...@users.noreply.github.com>
committer: malemburg <m...@lemburg.com>
date: 2025-07-09T09:39:55+02:00
summary:
gh-53243: Document `codecs.readbuffer_encode()` (#136284)
Closes #53243
files:
M Doc/library/codecs.rst
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index efe211cd2db6c8..0e84f18dd4d5d5 100644
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -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:
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: arch...@mail-archive.com
