Skip to content

gh-136278: Add documentation for codecs.escape_encode() and codecs.escape_decode() #136310

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
wants to merge 1 commit into from
Closed

gh-136278: Add documentation for codecs.escape_encode() and codecs.escape_decode() #136310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 32 additions & 0 deletions Doc/library/codecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1579,3 +1579,35 @@ This module implements a variant of the UTF-8 codec. On encoding, a UTF-8 encode
BOM will be prepended to the UTF-8 encoded bytes. For the stateful encoder this
is only done once (on the first write to the byte stream). On decoding, an
optional UTF-8 encoded BOM at the start of the data will be skipped.



Escape Encoding and Decoding
----------------------------

The functions ``codecs.escape_encode()`` and ``codecs.escape_decode()`` provide
a mechanism to encode and decode byte sequences with escape sequences. This is
similar in behavior to how ``str(bytes)`` and ``repr(bytes)`` produce escaped
string representations of bytes.

These APIs are primarily used by the ``pickle`` module to safely handle
escaped byte sequences.

Example usage:

.. code-block:: python

import codecs
b = b"example\nbytes\tdata"
encoded_bytes, _ = codecs.escape_encode(b)
decoded_bytes, _ = codecs.escape_decode(encoded_bytes)
assert decoded_bytes == b

Background:
~~~~~~~~~~~
In Python 2, these functions were part of the now-removed ``string_escape`` codec.
There is consideration to revive this functionality under a new codec called
``bytes_escape``.

References:
- Related discussion: https://bugs.python.org/issue136278
Loading