]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-72798: Add mapping example to str.translate documentation (#144454)
authorkovan <xaum.io@gmail.com>
Tue, 10 Feb 2026 10:13:40 +0000 (11:13 +0100)
committerGitHub <noreply@github.com>
Tue, 10 Feb 2026 10:13:40 +0000 (11:13 +0100)
Add an example showing how to use str.translate() with a dictionary
mapping directly, demonstrating character replacement and deletion.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Doc/library/stdtypes.rst

index b8c079faa93d6d229135e4462f3ce29f2aa77ddd..ffb5a053a6dce80e5d019b89090248b00ff0a4f3 100644 (file)
@@ -2870,6 +2870,14 @@ expression support in the :mod:`re` module).
    You can use :meth:`str.maketrans` to create a translation map from
    character-to-character mappings in different formats.
 
+   The following example uses a mapping to replace ``'a'`` with ``'X'``,
+   ``'b'`` with ``'Y'``, and delete ``'c'``:
+
+   .. doctest::
+
+      >>> 'abc123'.translate({ord('a'): 'X', ord('b'): 'Y', ord('c'): None})
+      'XY123'
+
    See also the :mod:`codecs` module for a more flexible approach to custom
    character mappings.