Merge branch 'main' into fix/ubsan/socket-111178

picnixz · Jan 18, 2025 · 54665bf · 54665bf
2 parents 4675afd + d5e9aa6
commit 54665bf
Show file tree

Hide file tree

Showing 242 changed files with 5,488 additions and 2,443 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -231,10 +231,14 @@ jobs:
     name: >-
       Ubuntu
       ${{ fromJSON(matrix.free-threading) && '(free-threading)' || '' }}
+      ${{ fromJSON(matrix.bolt) && '(bolt)' || '' }}
     needs: check_source
     if: needs.check_source.outputs.run_tests == 'true'
     strategy:
       matrix:
+        bolt:
+        - false
+        - true
         free-threading:
         - false
         - true
@@ -246,9 +250,16 @@ jobs:
         exclude:
         - os: ubuntu-24.04-aarch64
           is-fork: true
+        # Do not test BOLT with free-threading, to conserve resources
+        - bolt: true
+          free-threading: true
+        # BOLT currently crashes during instrumentation on aarch64
+        - os: ubuntu-24.04-aarch64
+          bolt: true
     uses: ./.github/workflows/reusable-ubuntu.yml
     with:
       config_hash: ${{ needs.check_source.outputs.config_hash }}
+      bolt-optimizations: ${{ matrix.bolt }}
       free-threading: ${{ matrix.free-threading }}
       os: ${{ matrix.os }}
 

diff --git a/.github/workflows/reusable-ubuntu.yml b/.github/workflows/reusable-ubuntu.yml
@@ -6,6 +6,11 @@ on:
       config_hash:
         required: true
         type: string
+      bolt-optimizations:
+        description: Whether to enable BOLT optimizations
+        required: false
+        type: boolean
+        default: false
       free-threading:
         description: Whether to use free-threaded mode
         required: false
@@ -34,6 +39,12 @@ jobs:
       run: echo "::add-matcher::.github/problem-matchers/gcc.json"
     - name: Install dependencies
       run: sudo ./.github/workflows/posix-deps-apt.sh
+    - name: Install Clang and BOLT
+      if: ${{ fromJSON(inputs.bolt-optimizations) }}
+      run: |
+        sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)" ./llvm.sh 19
+        sudo apt-get install bolt-19
+        echo PATH="$(llvm-config-19 --bindir):$PATH" >> $GITHUB_ENV
     - name: Configure OpenSSL env vars
       run: |
         echo "MULTISSL_DIR=${GITHUB_WORKSPACE}/multissl" >> "$GITHUB_ENV"
@@ -73,14 +84,18 @@ jobs:
         key: ${{ github.job }}-${{ runner.os }}-${{ env.IMAGE_VERSION }}-${{ inputs.config_hash }}
     - name: Configure CPython out-of-tree
       working-directory: ${{ env.CPYTHON_BUILDDIR }}
+      # `test_unpickle_module_race` writes to the source directory, which is
+      # read-only during builds — so we exclude it from profiling with BOLT.
       run: >-
+        PROFILE_TASK='-m test --pgo --ignore test_unpickle_module_race'
         ../cpython-ro-srcdir/configure
         --config-cache
         --with-pydebug
         --enable-slower-safety
         --enable-safety
         --with-openssl="$OPENSSL_DIR"
         ${{ fromJSON(inputs.free-threading) && '--disable-gil' || '' }}
+        ${{ fromJSON(inputs.bolt-optimizations) && '--enable-bolt' || '' }}
     - name: Build CPython out-of-tree
       if: ${{ inputs.free-threading }}
       working-directory: ${{ env.CPYTHON_BUILDDIR }}

diff --git a/Doc/c-api/sys.rst b/Doc/c-api/sys.rst
@@ -234,7 +234,7 @@ Operating System Utilities
 
    The caller must hold the GIL.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 
 .. c:function:: int Py_fclose(FILE *file)
@@ -246,7 +246,7 @@ Operating System Utilities
    In either case, any further access (including another call to
    :c:func:`Py_fclose`) to the stream results in undefined behavior.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 
 .. _systemfunctions:

diff --git a/Doc/glossary.rst b/Doc/glossary.rst
@@ -115,7 +115,7 @@ Glossary
       :keyword:`yield` expression.
 
       Each :keyword:`yield` temporarily suspends processing, remembering the
-      location execution state (including local variables and pending
+      execution state (including local variables and pending
       try-statements).  When the *asynchronous generator iterator* effectively
       resumes with another awaitable returned by :meth:`~object.__anext__`, it
       picks up where it left off.  See :pep:`492` and :pep:`525`.
@@ -564,7 +564,7 @@ Glossary
       An object created by a :term:`generator` function.
 
       Each :keyword:`yield` temporarily suspends processing, remembering the
-      location execution state (including local variables and pending
+      execution state (including local variables and pending
       try-statements).  When the *generator iterator* resumes, it picks up where
       it left off (in contrast to functions which start fresh on every
       invocation).

diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
@@ -73,7 +73,7 @@ an event loop:
 
    Set *loop* as the current event loop for the current OS thread.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :func:`set_event_loop` function is deprecated and will be removed
       in Python 3.16.
 

diff --git a/Doc/library/asyncio-policy.rst b/Doc/library/asyncio-policy.rst
@@ -48,7 +48,7 @@ for the current process:
 
    Return the current process-wide policy.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :func:`get_event_loop_policy` function is deprecated and
       will be removed in Python 3.16.
 
@@ -58,7 +58,7 @@ for the current process:
 
    If *policy* is set to ``None``, the default policy is restored.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :func:`set_event_loop_policy` function is deprecated and
       will be removed in Python 3.16.
 
@@ -95,7 +95,7 @@ The abstract event loop policy base class is defined as follows:
 
       This method should never return ``None``.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :class:`AbstractEventLoopPolicy` class is deprecated and
       will be removed in Python 3.16.
 
@@ -121,7 +121,7 @@ asyncio ships with the following built-in policies:
       The :meth:`get_event_loop` method of the default asyncio policy now
       raises a :exc:`RuntimeError` if there is no set event loop.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :class:`DefaultEventLoopPolicy` class is deprecated and
       will be removed in Python 3.16.
 
@@ -133,7 +133,7 @@ asyncio ships with the following built-in policies:
 
    .. availability:: Windows.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :class:`WindowsSelectorEventLoopPolicy` class is deprecated and
       will be removed in Python 3.16.
 
@@ -145,7 +145,7 @@ asyncio ships with the following built-in policies:
 
    .. availability:: Windows.
 
-   .. deprecated:: next
+   .. deprecated:: 3.14
       The :class:`WindowsProactorEventLoopPolicy` class is deprecated and
       will be removed in Python 3.16.
 

diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
@@ -173,7 +173,7 @@ interpreted as prescribed by the ISO 8601 standard.  Year 0 is 1 BC, year -1 is
       on the first weekday as specified in the constructor or set by the
       :meth:`setfirstweekday` method.
 
-      .. versionchanged:: next
+      .. versionchanged:: 3.14
          If *highlight_day* is given, this date is highlighted in color.
          This can be :ref:`controlled using environment variables
          <using-on-controlling-color>`.
@@ -201,7 +201,7 @@ interpreted as prescribed by the ISO 8601 standard.  Year 0 is 1 BC, year -1 is
       on the first weekday as specified in the constructor or set by the
       :meth:`setfirstweekday` method.
 
-      .. versionchanged:: next
+      .. versionchanged:: 3.14
          If *highlight_day* is given, this date is highlighted in color.
          This can be :ref:`controlled using environment variables
          <using-on-controlling-color>`.
@@ -229,7 +229,7 @@ interpreted as prescribed by the ISO 8601 standard.  Year 0 is 1 BC, year -1 is
       :meth:`setfirstweekday` method.  The earliest year for which a calendar
       can be generated is platform-dependent.
 
-      .. versionchanged:: next
+      .. versionchanged:: 3.14
          If *highlight_day* is given, this date is highlighted in color.
          This can be :ref:`controlled using environment variables
          <using-on-controlling-color>`.
@@ -727,7 +727,7 @@ The following options are accepted:
    The number of months printed per row.
    Defaults to 3.
 
-.. versionchanged:: next
+.. versionchanged:: 3.14
    By default, today's date is highlighted in color and can be
    :ref:`controlled using environment variables <using-on-controlling-color>`.
 

diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
@@ -2233,7 +2233,7 @@ Utility functions
 
    .. audit-event:: ctypes.memoryview_at address,size,readonly
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 
 .. _ctypes-data-types:

diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst
@@ -91,7 +91,7 @@ Fault handler state
       The dump now mentions if a garbage collector collection is running
       if *all_threads* is true.
 
-   .. versionchanged:: next
+   .. versionchanged:: 3.14
       Only the current thread is dumped if the :term:`GIL` is disabled to
       prevent the risk of data races.
 

diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
@@ -380,13 +380,15 @@ ABC hierarchy::
 
 .. class:: ResourceLoader
 
+   *Superseded by TraversableResources*
+
     An abstract base class for a :term:`loader` which implements the optional
     :pep:`302` protocol for loading arbitrary resources from the storage
     back-end.
 
     .. deprecated:: 3.7
        This ABC is deprecated in favour of supporting resource loading
-       through :class:`importlib.resources.abc.ResourceReader`.
+       through :class:`importlib.resources.abc.TraversableResources`.
 
     .. abstractmethod:: get_data(path)
 

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
@@ -5424,7 +5424,7 @@ operating system.
 
    Scheduling policy for tasks with deadline constraints.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 .. data:: SCHED_IDLE
 
@@ -5434,7 +5434,7 @@ operating system.
 
    Alias for :data:`SCHED_OTHER`.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 .. data:: SCHED_SPORADIC
 

diff --git a/Doc/library/pyexpat.rst b/Doc/library/pyexpat.rst
@@ -945,7 +945,7 @@ The ``errors`` module has the following attributes:
 
    The parser was tried to be stopped or suspended before it started.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 
 .. rubric:: Footnotes

diff --git a/Doc/library/re.rst b/Doc/library/re.rst
@@ -572,7 +572,7 @@ character ``'$'``.
    Word boundaries are determined by the current locale
    if the :py:const:`~re.LOCALE` flag is used.
 
-   .. versionchanged:: next
+   .. versionchanged:: 3.14
       ``\B`` now matches empty input string.
 
 .. index:: single: \d; in regular expressions

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
@@ -678,7 +678,7 @@ Constants
 
    Constant to enable duplicate address and port bindings with load balancing.
 
-  .. versionadded:: next
+  .. versionadded:: 3.14
 
   .. availability:: FreeBSD >= 12.0
 

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
@@ -938,7 +938,7 @@ Constants
 
    Whether the OpenSSL library has built-in support for TLS-PHA.
 
-   .. versionadded:: next
+   .. versionadded:: 3.14
 
 .. data:: CHANNEL_BINDING_TYPES
 

diff --git a/Doc/library/string.rst b/Doc/library/string.rst
@@ -59,11 +59,18 @@ The constants defined in this module are:
    String of ASCII characters which are considered punctuation characters
    in the ``C`` locale: ``!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``.
 
+
 .. data:: printable
 
-   String of ASCII characters which are considered printable.  This is a
-   combination of :const:`digits`, :const:`ascii_letters`, :const:`punctuation`,
-   and :const:`whitespace`.
+   String of ASCII characters which are considered printable by Python.
+   This is a combination of :const:`digits`, :const:`ascii_letters`,
+   :const:`punctuation`, and :const:`whitespace`.
+
+   .. note::
+
+      By design, :meth:`string.printable.isprintable() <str.isprintable>`
+      returns :const:`False`. In particular, ``string.printable`` is not
+      printable in the POSIX sense (see :manpage:`LC_CTYPE <locale(5)>`).
 
 
 .. data:: whitespace

diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
@@ -8,7 +8,7 @@
 
 This module provides access to some variables used or maintained by the
 interpreter and to functions that interact strongly with the interpreter. It is
-always available.
+always available. Unless explicitly noted otherwise, all variables are read-only.
 
 
 .. data:: abiflags

diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
@@ -380,6 +380,13 @@ since it is impossible to detect the termination of alien threads.
       This method will raise a :exc:`RuntimeError` if called more than once
       on the same thread object.
 
+      If supported, set the operating system thread name to
+      :attr:`threading.Thread.name`. The name can be truncated depending on the
+      operating system thread name limits.
+
+      .. versionchanged:: 3.14
+         Set the operating system thread name.
+
    .. method:: run()
 
       Method representing the thread's activity.
@@ -443,9 +450,6 @@ since it is impossible to detect the termination of alien threads.
       running thread is renamed. (Setting the *name* attribute of a
       different thread only updates the Python Thread object.)
 
-      .. versionchanged:: 3.14
-         Set the operating system thread name.
-
    .. method:: getName()
                setName()