Merge branch 'python-trio:main' into dtls-2024

Author: CoolCat467

.github/workflows/autodeps.yml

@@ -24,13 +24,13 @@ jobs:
       - name: Setup python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: "3.9"
 
       - name: Bump dependencies
         run: |
           python -m pip install -U pip pre-commit
           python -m pip install -r test-requirements.txt
-          uv pip compile --universal --python-version=3.8 --upgrade test-requirements.in -o test-requirements.txt
+          uv pip compile --universal --python-version=3.9 --upgrade test-requirements.in -o test-requirements.txt
           uv pip compile --universal --python-version=3.11 --upgrade docs-requirements.in -o docs-requirements.txt
           pre-commit autoupdate --jobs 0
 
@@ -43,7 +43,7 @@ jobs:
 
       - name: uv
         run: |
-          uv pip compile --universal --python-version=3.8 test-requirements.in -o test-requirements.txt
+          uv pip compile --universal --python-version=3.9 test-requirements.in -o test-requirements.txt
           uv pip compile --universal --python-version=3.11 docs-requirements.in -o docs-requirements.txt
 
       - name: Commit changes and create automerge PR

.github/workflows/ci.yml

@@ -18,23 +18,23 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['pypy-3.10', '3.8', '3.9', '3.10', '3.11', '3.12']
+        python: ['pypy-3.10', '3.9', '3.10', '3.11', '3.12', '3.13']
         arch: ['x86', 'x64']
         lsp: ['']
         lsp_extract_file: ['']
         extra_name: ['']
         include:
-          - python: '3.8'
+          - python: '3.9'
             arch: 'x64'
             lsp: 'https://raw.githubusercontent.com/python-trio/trio-ci-assets/master/komodia-based-vpn-setup.zip'
             lsp_extract_file: 'komodia-based-vpn-setup.exe'
             extra_name: ', with Komodia LSP'
-          - python: '3.8'
+          - python: '3.9'
             arch: 'x64'
             lsp: 'https://www.proxifier.com/download/legacy/ProxifierSetup342.exe'
             lsp_extract_file: ''
             extra_name: ', with IFS LSP'
-          #- python: '3.8'
+          #- python: '3.9'
           #  arch: 'x64'
           #  lsp: 'http://download.pctools.com/mirror/updates/9.0.0.2308-SDavfree-lite_en.exe'
           #  lsp_extract_file: ''
@@ -87,16 +87,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['pypy-3.10', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+        python: ['pypy-3.10', '3.9', '3.10', '3.11', '3.12', '3.13']
         check_formatting: ['0']
         no_test_requirements: ['0']
         extra_name: ['']
         include:
-          - python: '3.12'
+          - python: '3.13'
             check_formatting: '1'
             extra_name: ', check formatting'
           # separate test run that doesn't install test-requirements.txt
-          - python: '3.8'
+          - python: '3.9'
             no_test_requirements: '1'
             extra_name: ', no test-requirements'
     continue-on-error: >-
@@ -143,7 +143,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['pypy-3.10', '3.8', '3.9', '3.10', '3.11', '3.12']
+        python: ['pypy-3.10', '3.9', '3.10', '3.11', '3.12', '3.13']
     continue-on-error: >-
       ${{
         (
@@ -203,7 +203,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['3.8', '3.12']
+        include:
+          - python: '3.9'  # We support running on cython 2 and 3 for 3.9
+            cython: '<3'   # cython 2
+          - python: '3.9'
+            cython: '>=3'  # cython 3 (or greater)
+          - python: '3.11' # 3.11 is the last version Cy2 supports
+            cython: '<3'   # cython 2
+          - python: '3.13' # We support running cython3 on 3.13
+            cython: '>=3'  # cython 3 (or greater)
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -216,18 +224,11 @@ jobs:
       - name: install trio and setuptools
         run: python -m pip install --upgrade pip . setuptools
 
-      - name: install cython<3
-        run: python -m pip install "cython<3"
-      - name: compile pyx file
-        run: cythonize -i tests/cython/test_cython.pyx
-      - name: import & run module
-        run: python -c 'import tests.cython.test_cython'
+      - name: install cython & compile pyx file
+        run: |
+          python -m pip install "cython${{ matrix.cython }}"
+          cythonize --inplace tests/cython/test_cython.pyx
 
-      - name: install cython>=3
-        run: python -m pip install "cython>=3"
-      - name: compile pyx file
-        # different cython version should trigger a re-compile, but --force just in case
-        run: cythonize --inplace --force tests/cython/test_cython.pyx
       - name: import & run module
         run: python -c 'import tests.cython.test_cython'
 

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: "3.9"
       - run: python -m pip install build
       - run: python -m build
 

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -20,11 +20,11 @@ repos:
       - id: sort-simple-yaml
         files: .pre-commit-config.yaml
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.8.0
+    rev: 24.10.0
     hooks:
       - id: black
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.7
+    rev: v0.6.9
     hooks:
       - id: ruff
         types: [file]

README.rst

@@ -92,7 +92,7 @@ demonstration of implementing the "Happy Eyeballs" algorithm in an
 older library versus Trio.
 
 **Cool, but will it work on my system?** Probably! As long as you have
-some kind of Python 3.8-or-better (CPython or `currently maintained versions of
+some kind of Python 3.9-or-better (CPython or `currently maintained versions of
 PyPy3 <https://doc.pypy.org/en/latest/faq.html#which-python-versions-does-pypy-implement>`__
 are both fine), and are using Linux, macOS, Windows, or FreeBSD, then Trio
 will work. Other environments might work too, but those

check.sh

@@ -78,7 +78,7 @@ fi
 
 # Check pip compile is consistent
 echo "::group::Pip Compile - Tests"
-uv pip compile --universal --python-version=3.8 test-requirements.in -o test-requirements.txt
+uv pip compile --universal --python-version=3.9 test-requirements.in -o test-requirements.txt
 echo "::endgroup::"
 echo "::group::Pip Compile - Docs"
 uv pip compile --universal --python-version=3.11 docs-requirements.in -o docs-requirements.txt

docs-requirements.in

@@ -3,7 +3,7 @@
 sphinx >= 6.0
 jinja2
 # >= is necessary to prevent `uv` from selecting a `Sphinx` version this does not support
-sphinx_rtd_theme >= 2
+sphinx_rtd_theme >= 3
 sphinxcontrib-jquery
 sphinxcontrib-trio
 towncrier

docs-requirements.txt

@@ -12,7 +12,7 @@ beautifulsoup4==4.12.3
     # via sphinx-codeautolink
 certifi==2024.8.30
     # via requests
-cffi==1.17.0 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
+cffi==1.17.1 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
     # via
     #   -r docs-requirements.in
     #   cryptography
@@ -24,15 +24,15 @@ colorama==0.4.6 ; sys_platform == 'win32' or platform_system == 'Windows'
     # via
     #   click
     #   sphinx
-cryptography==43.0.0
+cryptography==43.0.1
     # via pyopenssl
 docutils==0.20.1
     # via
     #   sphinx
     #   sphinx-rtd-theme
 exceptiongroup==1.2.2
     # via -r docs-requirements.in
-idna==3.8
+idna==3.10
     # via
     #   -r docs-requirements.in
     #   requests
@@ -77,9 +77,9 @@ sphinx==7.4.7
     #   sphinxcontrib-trio
 sphinx-codeautolink==0.15.2
     # via -r docs-requirements.in
-sphinx-hoverxref==1.4.0
+sphinx-hoverxref==1.4.1
     # via -r docs-requirements.in
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.0
     # via -r docs-requirements.in
 sphinxcontrib-applehelp==2.0.0
     # via sphinx
@@ -102,5 +102,5 @@ sphinxcontrib-trio==1.1.2
     # via -r docs-requirements.in
 towncrier==24.8.0
     # via -r docs-requirements.in
-urllib3==2.2.2
+urllib3==2.2.3
     # via requests

docs/source/conf.py

@@ -201,6 +201,13 @@ def setup(app: Sphinx) -> None:
     app.connect("source-read", on_read_source)
 
 
+# Our docs use the READTHEDOCS variable, so copied from:
+# https://about.readthedocs.com/blog/2024/07/addons-by-default/
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -374,10 +381,7 @@ def add_mapping(
 # We have to set this ourselves, not only because it's useful for local
 # testing, but also because if we don't then RTD will throw away our
 # html_theme_options.
-import sphinx_rtd_theme
-
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/history.rst

@@ -5,6 +5,39 @@ Release history
 
 .. towncrier release notes start
 
+Trio 0.27.0 (2024-10-17)
+------------------------
+
+Breaking changes
+~~~~~~~~~~~~~~~~
+
+- :func:`trio.move_on_after` and :func:`trio.fail_after` previously set the deadline relative to initialization time, instead of more intuitively upon entering the context manager. This might change timeouts if a program relied on this behavior. If you want to restore previous behavior you should instead use ``trio.move_on_at(trio.current_time() + ...)``.
+  flake8-async has a new rule to catch this, in case you're supporting older trio versions. See :ref:`ASYNC122`. (`#2512 <https://github.com/python-trio/trio/issues/2512>`__)
+
+
+Features
+~~~~~~~~
+
+- :meth:`CancelScope.relative_deadline` and :meth:`CancelScope.is_relative` added, as well as a ``relative_deadline`` parameter to ``__init__``. This allows initializing scopes ahead of time, but where the specified relative deadline doesn't count down until the scope is entered. (`#2512 <https://github.com/python-trio/trio/issues/2512>`__)
+- :class:`trio.Lock` and :class:`trio.StrictFIFOLock` will now raise :exc:`trio.BrokenResourceError` when :meth:`trio.Lock.acquire` would previously stall due to the owner of the lock exiting without releasing the lock. (`#3035 <https://github.com/python-trio/trio/issues/3035>`__)
+- `trio.move_on_at`, `trio.move_on_after`, `trio.fail_at` and `trio.fail_after` now accept *shield* as a keyword argument. If specified, it provides an initial value for the `~trio.CancelScope.shield` attribute of the `trio.CancelScope` object created by the context manager. (`#3052 <https://github.com/python-trio/trio/issues/3052>`__)
+- Added :func:`trio.lowlevel.add_parking_lot_breaker` and :func:`trio.lowlevel.remove_parking_lot_breaker` to allow creating custom lock/semaphore implementations that will break their underlying parking lot if a task exits unexpectedly. :meth:`trio.lowlevel.ParkingLot.break_lot` is also added, to allow breaking a parking lot intentionally. (`#3081 <https://github.com/python-trio/trio/issues/3081>`__)
+
+
+Bugfixes
+~~~~~~~~
+
+- Allow sockets to bind any ``os.PathLike`` object. (`#3041 <https://github.com/python-trio/trio/issues/3041>`__)
+- Update ``trio.lowlevel.open_process``'s documentation to allow bytes. (`#3076 <https://github.com/python-trio/trio/issues/3076>`__)
+- Update :func:`trio.sleep_forever` to be `NoReturn`. (`#3095 <https://github.com/python-trio/trio/issues/3095>`__)
+
+
+Improved documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+- Add docstrings for memory channels' ``statistics()`` and ``aclose`` methods. (`#3101 <https://github.com/python-trio/trio/issues/3101>`__)
+
+
 Trio 0.26.2 (2024-08-08)
 ------------------------