Skip to content

gh-48181: Document codecs.charmap_build #135997

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

Merged
merged 6 commits into from
Jun 30, 2025
Merged

gh-48181: Document codecs.charmap_build #135997

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f6b9710
Document
StanFromIreland Jun 26, 2025
367bdf2
Simplify
StanFromIreland Jun 26, 2025
d748c22
Un-simplify
StanFromIreland Jun 30, 2025
bc6a2f9
Note name, link dict
StanFromIreland Jun 30, 2025
fc2a0f7
Wrap text
StanFromIreland Jun 30, 2025
6a1facc
Switch-up
StanFromIreland Jun 30, 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
8 changes: 8 additions & 0 deletions Doc/library/codecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ any codec:
:exc:`UnicodeDecodeError`). Refer to :ref:`codec-base-classes` for more
information on codec error handling.

.. function:: charmap_build(string)

Return a mapping suitable for encoding with a custom single-byte encoding.
Given a :class:`str` *string* of up to 256 characters representing a
decoding table, returns either a compact internal mapping object
``EncodingMap`` or a :class:`dictionary <dict>` mapping character ordinals
to byte values. Raises a :exc:`TypeError` on invalid input.

The full details for each codec can also be looked up directly:

.. function:: lookup(encoding, /)
Expand Down
Loading