From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 9 Jul 2025 08:07:18 +0000 (+0200)
Subject: [3.14] gh-53243: Document `codecs.readbuffer_encode()` (GH-136284) (#136452)
X-Git-Tag: v3.14.0rc1~116
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=85df16b7fa6db7dc0a389ecff9119f72716cee02;p=thirdparty%2FPython%2Fcpython.git

[3.14] gh-53243: Document `codecs.readbuffer_encode()` (GH-136284) (#136452)

gh-53243: Document `codecs.readbuffer_encode()` (GH-136284)

Closes GH-53243
(cherry picked from commit f1dcf3c7bf90961b8d5475154d3f28cfef0a054f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
---

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index b231fa568cf3..a527d6746b5d 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: