Merge branch 'main' into lazy-stuff

Author: pablogsal

.github/workflows/reusable-check-html-ids.yml

@@ -15,36 +15,45 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - name: 'Check out base commit'
+      - name: 'Check out PR head'
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
-          ref: ${{ github.event.pull_request.base.sha }}
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: 'Find merge base'
+        id: merge-base
+        run: |
+          BASE="${{ github.event.pull_request.base.sha }}"
+          HEAD="${{ github.event.pull_request.head.sha }}"
+          git fetch --depth=$((${{ github.event.pull_request.commits }} + 10)) --no-tags origin "$BASE" "$HEAD"
+
+          if ! MERGE_BASE=$(git merge-base "$BASE" "$HEAD" 2>/dev/null); then
+            git fetch --deepen=1 --no-tags origin "$BASE" "$HEAD"
+
+            OLDEST=$(git rev-list --reflog --max-parents=0 --reverse "${BASE}^" "${HEAD}^" | head -1)
+            TIMESTAMP=$(git show --format=%at --no-patch "$OLDEST")
+
+            git fetch --shallow-since="$TIMESTAMP" --no-tags origin "$BASE" "$HEAD"
+
+            MERGE_BASE=$(git merge-base "$BASE" "$HEAD")
+          fi
+          echo "sha=$MERGE_BASE" >> "$GITHUB_OUTPUT"
+      - name: 'Create worktree at merge base'
+        env:
+          MERGE_BASE: ${{ steps.merge-base.outputs.sha }}
+        run: git worktree add /tmp/merge-base "$MERGE_BASE" --detach
       - name: 'Set up Python'
         uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
         with:
           python-version: '3'
           cache: 'pip'
           cache-dependency-path: 'Doc/requirements.txt'
       - name: 'Install build dependencies'
-        run: make -C Doc/ venv
+        run: make -C /tmp/merge-base/Doc/ venv
       - name: 'Build HTML documentation'
-        run: make -C Doc/ SPHINXOPTS="--quiet" html
-      - name: 'Check out PR head tools'
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-          sparse-checkout: |
-            Doc/tools/check-html-ids.py
-            Doc/tools/removed-ids.txt
-          sparse-checkout-cone-mode: false
-          path: pr-head
-      - name: 'Use PR head tools'
-        run: |
-          cp pr-head/Doc/tools/check-html-ids.py Doc/tools/check-html-ids.py
-          [ -f pr-head/Doc/tools/removed-ids.txt ] && cp pr-head/Doc/tools/removed-ids.txt Doc/tools/removed-ids.txt
+        run: make -C /tmp/merge-base/Doc/ SPHINXOPTS="--quiet" html
       - name: 'Collect HTML IDs'
-        run: python Doc/tools/check-html-ids.py collect Doc/build/html -o /tmp/html-ids-base.json.gz
+        run: python Doc/tools/check-html-ids.py collect /tmp/merge-base/Doc/build/html -o /tmp/html-ids-base.json.gz
       - name: 'Download PR head HTML IDs'
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:

Doc/conf.py

@@ -73,6 +73,7 @@
 # General substitutions.
 project = 'Python'
 copyright = "2001 Python Software Foundation"
+_doc_authors = 'Python documentation authors'
 
 # We look for the Include/patchlevel.h file in the current Python source tree
 # and replace the values accordingly.
@@ -361,69 +362,74 @@
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
-_stdauthor = 'The Python development team'
 latex_documents = [
-    ('c-api/index', 'c-api.tex', 'The Python/C API', _stdauthor, 'manual'),
+    ('c-api/index', 'c-api.tex', 'The Python/C API', _doc_authors, 'manual'),
     (
         'extending/index',
         'extending.tex',
         'Extending and Embedding Python',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'installing/index',
         'installing.tex',
         'Installing Python Modules',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'library/index',
         'library.tex',
         'The Python Library Reference',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'reference/index',
         'reference.tex',
         'The Python Language Reference',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'tutorial/index',
         'tutorial.tex',
         'Python Tutorial',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'using/index',
         'using.tex',
         'Python Setup and Usage',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'faq/index',
         'faq.tex',
         'Python Frequently Asked Questions',
-        _stdauthor,
+        _doc_authors,
         'manual',
     ),
     (
         'whatsnew/' + version,
         'whatsnew.tex',
         'What\'s New in Python',
-        'A. M. Kuchling',
+        _doc_authors,
         'howto',
     ),
 ]
 # Collect all HOWTOs individually
 latex_documents.extend(
-    ('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex', '', _stdauthor, 'howto')
+    (
+        'howto/' + fn[:-4],
+        'howto-' + fn[:-4] + '.tex',
+        '',
+        _doc_authors,
+        'howto',
+    )
     for fn in os.listdir('howto')
     if fn.endswith('.rst') and fn != 'index.rst'
 )
@@ -434,7 +440,7 @@
 # Options for Epub output
 # -----------------------
 
-epub_author = 'Python Documentation Authors'
+epub_author = _doc_authors
 epub_publisher = 'Python Software Foundation'
 epub_exclude_files = (
     'index.xhtml',

Doc/library/base64.rst

@@ -51,7 +51,7 @@ The :rfc:`4648` encodings are suitable for encoding binary data so that it can b
 safely sent by email, used as parts of URLs, or included as part of an HTTP
 POST request.
 
-.. function:: b64encode(s, altchars=None, *, wrapcol=0)
+.. function:: b64encode(s, altchars=None, *, padded=True, wrapcol=0)
 
    Encode the :term:`bytes-like object` *s* using Base64 and return the encoded
    :class:`bytes`.
@@ -61,6 +61,10 @@ POST request.
    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.
 
+   If *padded* is true (default), pad the encoded data with the '='
+   character to a size multiple of 4.
+   If *padded* is false, do not add the pad characters.
+
    If *wrapcol* is non-zero, insert a newline (``b'\n'``) character
    after at most every *wrapcol* characters.
    If *wrapcol* is zero (default), do not insert any newlines.
@@ -69,11 +73,11 @@ POST request.
    :exc:`TypeError` if *altchars* is not a :term:`bytes-like object`.
 
    .. versionchanged:: 3.15
-      Added the *wrapcol* parameter.
+      Added the *padded* and *wrapcol* parameters.
 
 
-.. function:: b64decode(s, altchars=None, validate=False)
-              b64decode(s, altchars=None, validate=True, *, ignorechars)
+.. function:: b64decode(s, altchars=None, validate=False, *, padded=True)
+              b64decode(s, altchars=None, validate=True, *, ignorechars, padded=True)
 
    Decode the Base64 encoded :term:`bytes-like object` or ASCII string
    *s* and return the decoded :class:`bytes`.
@@ -82,6 +86,11 @@ POST request.
    of length 2 which specifies the alternative alphabet used instead of the
    ``+`` and ``/`` characters.
 
+   If *padded* is true, the last group of 4 base 64 alphabet characters must
+   be padded with the '=' character.
+   If *padded* is false, the '=' character is treated as other non-alphabet
+   characters (depending on the value of *validate* and *ignorechars*).
+
    A :exc:`binascii.Error` exception is raised
    if *s* is incorrectly padded.
 
@@ -106,7 +115,7 @@ POST request.
    For more information about the strict base64 check, see :func:`binascii.a2b_base64`
 
    .. versionchanged:: 3.15
-      Added the *ignorechars* parameter.
+      Added the *ignorechars* and *padded* parameters.
 
    .. deprecated:: 3.15
       Accepting the ``+`` and ``/`` characters with an alternative alphabet
@@ -125,41 +134,52 @@ POST request.
    Base64 alphabet and return the decoded :class:`bytes`.
 
 
-.. function:: urlsafe_b64encode(s)
+.. function:: urlsafe_b64encode(s, *, padded=True)
 
    Encode :term:`bytes-like object` *s* using the
    URL- and filesystem-safe alphabet, which
    substitutes ``-`` instead of ``+`` and ``_`` instead of ``/`` in the
    standard Base64 alphabet, and return the encoded :class:`bytes`.  The result
-   can still contain ``=``.
+   can still contain ``=`` if *padded* is true (default).
+
+   .. versionchanged:: next
+      Added the *padded* parameter.
 
 
-.. function:: urlsafe_b64decode(s)
+.. function:: urlsafe_b64decode(s, *, padded=False)
 
    Decode :term:`bytes-like object` or ASCII string *s*
    using the URL- and filesystem-safe
    alphabet, which substitutes ``-`` instead of ``+`` and ``_`` instead of
    ``/`` in the standard Base64 alphabet, and return the decoded
    :class:`bytes`.
 
+   .. versionchanged:: next
+      Added the *padded* parameter.
+      Padding of input is no longer required by default.
+
    .. deprecated:: 3.15
       Accepting the ``+`` and ``/`` characters is now deprecated.
 
 
-.. function:: b32encode(s, *, wrapcol=0)
+.. function:: b32encode(s, *, padded=True, wrapcol=0)
 
    Encode the :term:`bytes-like object` *s* using Base32 and return the
    encoded :class:`bytes`.
 
+   If *padded* is true (default), pad the encoded data with the '='
+   character to a size multiple of 8.
+   If *padded* is false, do not add the pad characters.
+
    If *wrapcol* is non-zero, insert a newline (``b'\n'``) character
    after at most every *wrapcol* characters.
    If *wrapcol* is zero (default), do not add any newlines.
 
    .. versionchanged:: next
-      Added the *wrapcol* parameter.
+      Added the *padded* and *wrapcol* parameters.
 
 
-.. function:: b32decode(s, casefold=False, map01=None, *, ignorechars=b'')
+.. function:: b32decode(s, casefold=False, map01=None, *, padded=True, ignorechars=b'')
 
    Decode the Base32 encoded :term:`bytes-like object` or ASCII string *s* and
    return the decoded :class:`bytes`.
@@ -175,6 +195,11 @@ POST request.
    digit 0 is always mapped to the letter O).  For security purposes the default is
    ``None``, so that 0 and 1 are not allowed in the input.
 
+   If *padded* is true, the last group of 8 base 32 alphabet characters must
+   be padded with the '=' character.
+   If *padded* is false, the '=' character is treated as other non-alphabet
+   characters (depending on the value of *ignorechars*).
+
    *ignorechars* should be a :term:`bytes-like object` containing characters
    to ignore from the input.
 
@@ -183,21 +208,21 @@ POST request.
    input.
 
    .. versionchanged:: next
-      Added the *ignorechars* parameter.
+      Added the *ignorechars* and *padded* parameters.
 
 
-.. function:: b32hexencode(s, *, wrapcol=0)
+.. function:: b32hexencode(s, *, padded=True, wrapcol=0)
 
    Similar to :func:`b32encode` but uses the Extended Hex Alphabet, as defined in
    :rfc:`4648`.
 
    .. versionadded:: 3.10
 
    .. versionchanged:: next
-      Added the *wrapcol* parameter.
+      Added the *padded* and *wrapcol* parameters.
 
 
-.. function:: b32hexdecode(s, casefold=False, *, ignorechars=b'')
+.. function:: b32hexdecode(s, casefold=False, *, padded=True, ignorechars=b'')
 
    Similar to :func:`b32decode` but uses the Extended Hex Alphabet, as defined in
    :rfc:`4648`.
@@ -210,7 +235,7 @@ POST request.
    .. versionadded:: 3.10
 
    .. versionchanged:: next
-      Added the *ignorechars* parameter.
+      Added the *ignorechars* and *padded* parameters.
 
 
 .. function:: b16encode(s, *, wrapcol=0)