diff options
| author | Sam Ezeh <sam.z.ezeh@gmail.com> | 2022-11-29 16:21:01 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-29 16:21:01 (GMT) |
| commit | 05dfc539c2de34021e44f621f2b7b993682ee200 (patch) | |
| tree | 427a7f5097fa65d553429e44b81d0dcb7c7ffd9f /Doc/library/base64.rst | |
| parent | 74d5f61ebd1cb14907bf7dae1ad9c1e676707bc5 (diff) | |
| download | cpython-05dfc539c2de34021e44f621f2b7b993682ee200.zip cpython-05dfc539c2de34021e44f621f2b7b993682ee200.tar.gz cpython-05dfc539c2de34021e44f621f2b7b993682ee200.tar.bz2 | |
gh-90717: Update the documentation for the altchars paremeter in base64 library (GH-94187)
Diffstat (limited to 'Doc/library/base64.rst')
| -rw-r--r-- | Doc/library/base64.rst | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst index a02ba73..4ca3768 100644 --- a/Doc/library/base64.rst +++ b/Doc/library/base64.rst @@ -53,11 +53,13 @@ The modern interface provides: Encode the :term:`bytes-like object` *s* using Base64 and return the encoded :class:`bytes`. - Optional *altchars* must be a :term:`bytes-like object` of at least - length 2 (additional characters are ignored) which specifies an alternative - alphabet for the ``+`` and ``/`` characters. This allows an application to e.g. - generate URL or filesystem safe Base64 strings. The default is ``None``, for - which the standard Base64 alphabet is used. + Optional *altchars* must be a :term:`bytes-like object` of length 2 which + specifies an alternative alphabet for the ``+`` and ``/`` characters. + This allows an application to e.g. generate URL or filesystem safe Base64 + strings. The default is ``None``, for which the standard Base64 alphabet is used. + + May assert or raise a a :exc:`ValueError` if the length of *altchars* is not 2. Raises a + :exc:`TypeError` if *altchars* is not a :term:`bytes-like object`. .. function:: b64decode(s, altchars=None, validate=False) @@ -65,9 +67,9 @@ The modern interface provides: Decode the Base64 encoded :term:`bytes-like object` or ASCII string *s* and return the decoded :class:`bytes`. - Optional *altchars* must be a :term:`bytes-like object` or ASCII string of - at least length 2 (additional characters are ignored) which specifies the - alternative alphabet used instead of the ``+`` and ``/`` characters. + Optional *altchars* must be a :term:`bytes-like object` or ASCII string + of length 2 which specifies the alternative alphabet used instead of the + ``+`` and ``/`` characters. A :exc:`binascii.Error` exception is raised if *s* is incorrectly padded. @@ -80,6 +82,7 @@ The modern interface provides: For more information about the strict base64 check, see :func:`binascii.a2b_base64` + May assert or raise a :exc:`ValueError` if the length of *altchars* is not 2. .. function:: standard_b64encode(s) |