Merge branch 'master' into lsp_assets

.github/workflows/autodeps.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   Autodeps:
+    if: github.repository_owner == 'python-trio'
     name: Autodeps
     timeout-minutes: 10
     runs-on: 'ubuntu-latest'
@@ -34,7 +35,7 @@ jobs:
           # The new dependencies may contain a new black version.
           # Commit any changes immediately.
           python -m pip install -r test-requirements.txt
-          black setup.py trio
+          black src/trio
       - name: Commit changes and create automerge PR
         env:
           GH_TOKEN: ${{ github.token }}

.github/workflows/ci.yml

@@ -18,8 +18,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # pypy-3.10 is failing, see https://github.com/python-trio/trio/issues/2678
-        python: ['3.8', '3.9', '3.10', 'pypy-3.9-nightly'] #, 'pypy-3.10-nightly']
+        # pypy 3.9 and 3.10 are failing, see https://github.com/python-trio/trio/issues/2678 and https://github.com/python-trio/trio/issues/2776 respectively
+        python: ['3.8', '3.9', '3.10'] #, 'pypy-3.9-nightly', 'pypy-3.10-nightly']
         arch: ['x86', 'x64']
         lsp: ['']
         lsp_extract_file: ['']
@@ -96,11 +96,16 @@ jobs:
       matrix:
         python: ['pypy-3.9', 'pypy-3.10', '3.8', '3.9', '3.10', '3.11', '3.12-dev', 'pypy-3.9-nightly', 'pypy-3.10-nightly']
         check_formatting: ['0']
+        no_test_requirements: ['0']
         extra_name: ['']
         include:
           - python: '3.8'
             check_formatting: '1'
             extra_name: ', check formatting'
+          # separate test run that doesn't install test-requirements.txt
+          - python: '3.8'
+            no_test_requirements: '1'
+            extra_name: ', no test-requirements'
     continue-on-error: >-
       ${{
         (
@@ -129,6 +134,7 @@ jobs:
         run: ./ci.sh
         env:
           CHECK_FORMATTING: '${{ matrix.check_formatting }}'
+          NO_TEST_REQUIREMENTS: '${{ matrix.no_test_requirements }}'
       - if: always()
         uses: codecov/codecov-action@v3
         with:

.pre-commit-config.yaml

@@ -1,6 +1,13 @@
+ci:
+  autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
+  autofix_prs: false
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: weekly
+  submodules: false
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -9,31 +16,20 @@ repos:
       - id: check-merge-conflict
       - id: mixed-line-ending
       - id: check-case-conflict
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
+      - id: sort-simple-yaml
+        files: .pre-commit-config.yaml
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.12.1
     hooks:
       - id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.11
     hooks:
-      - id: flake8
-        additional_dependencies:
-          - "flake8-pyproject==1.2.3"
+      - id: ruff
         types: [file]
-        types_or: [python, pyi]
+        types_or: [python, pyi, toml]
+        args: ["--show-fixes"]
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.2.6
     hooks:
       - id: codespell
-
-ci:
-  autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
-  autofix_prs: true
-  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
-  autoupdate_schedule: weekly
-  skip: [black,isort]
-  submodules: false

setup.py → LONG_DESCRIPTION.rst

@@ -1,8 +1,3 @@
-from setuptools import find_packages, setup
-
-exec(open("trio/_version.py", encoding="utf-8").read())
-
-LONG_DESC = """\
 .. image:: https://raw.githubusercontent.com/python-trio/trio/9b0bec646a31e0d0f67b8b6ecc6939726faf3e17/logo/logo-with-background.svg
    :width: 200px
    :align: right
@@ -44,7 +39,7 @@
 Vital statistics:
 
 * Supported environments: Linux, macOS, or Windows running some kind of Python
-  3.8-or-better (either CPython or PyPy3 is fine). \\*BSD and illumos likely
+  3.8-or-better (either CPython or PyPy3 is fine). \*BSD and illumos likely
   work too, but are not tested.
 
 * Install: ``python3 -m pip install -U trio`` (or on Windows, maybe
@@ -68,60 +63,3 @@
   conduct
   <https://trio.readthedocs.io/en/latest/code-of-conduct.html>`_
   in all project spaces.
-"""
-
-setup(
-    name="trio",
-    version=__version__,
-    description="A friendly Python library for async concurrency and I/O",
-    long_description=LONG_DESC,
-    long_description_content_type="text/x-rst",
-    author="Nathaniel J. Smith",
-    author_email="[email protected]",
-    url="https://github.com/python-trio/trio",
-    license="MIT OR Apache-2.0",
-    packages=find_packages(),
-    install_requires=[
-        # attrs 19.2.0 adds `eq` option to decorators
-        # attrs 20.1.0 adds @frozen
-        "attrs >= 20.1.0",
-        "sortedcontainers",
-        "idna",
-        "outcome",
-        "sniffio >= 1.3.0",
-        # cffi 1.12 adds from_buffer(require_writable=True) and ffi.release()
-        # cffi 1.14 fixes memory leak inside ffi.getwinerror()
-        # cffi is required on Windows, except on PyPy where it is built-in
-        "cffi>=1.14; os_name == 'nt' and implementation_name != 'pypy'",
-        "exceptiongroup >= 1.0.0rc9; python_version < '3.11'",
-    ],
-    # This means, just install *everything* you see under trio/, even if it
-    # doesn't look like a source file, so long as it appears in MANIFEST.in:
-    include_package_data=True,
-    python_requires=">=3.8",
-    keywords=["async", "io", "networking", "trio"],
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "License :: OSI Approved :: Apache Software License",
-        "Operating System :: POSIX :: Linux",
-        "Operating System :: MacOS :: MacOS X",
-        "Operating System :: POSIX :: BSD",
-        "Operating System :: Microsoft :: Windows",
-        "Programming Language :: Python :: Implementation :: CPython",
-        "Programming Language :: Python :: Implementation :: PyPy",
-        "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Topic :: System :: Networking",
-        "Framework :: Trio",
-    ],
-    project_urls={
-        "Documentation": "https://trio.readthedocs.io/",
-        "Changelog": "https://trio.readthedocs.io/en/latest/history.html",
-    },
-)

MANIFEST.in

@@ -1,8 +1,9 @@
 include LICENSE LICENSE.MIT LICENSE.APACHE2
 include README.rst
+include LONG_DESCRIPTION.rst
 include CODE_OF_CONDUCT.md CONTRIBUTING.md
 include test-requirements.txt
-include trio/py.typed
-recursive-include trio/_tests/test_ssl_certs *.pem
+include src/trio/py.typed
+recursive-include src/trio/_tests/test_ssl_certs *.pem
 recursive-include docs *
 prune docs/build

README.rst

@@ -92,8 +92,8 @@ 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
-PyPy3](https://doc.pypy.org/en/latest/faq.html#which-python-versions-does-pypy-implement)
+some kind of Python 3.8-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
 are the ones we test on. And all of our dependencies are pure Python,

check.sh

@@ -2,16 +2,18 @@
 
 set -ex
 
+ON_GITHUB_CI=true
 EXIT_STATUS=0
 
 # If not running on Github's CI, discard the summaries
 if [ -z "${GITHUB_STEP_SUMMARY+x}" ]; then
     GITHUB_STEP_SUMMARY=/dev/null
+    ON_GITHUB_CI=false
 fi
 
 # Test if the generated code is still up to date
 echo "::group::Generate Exports"
-python ./trio/_tools/gen_exports.py --test \
+python ./src/trio/_tools/gen_exports.py --test \
     || EXIT_STATUS=$?
 echo "::endgroup::"
 
@@ -21,32 +23,32 @@ echo "::endgroup::"
 # autoflake --recursive --in-place .
 # pyupgrade --py3-plus $(find . -name "*.py")
 echo "::group::Black"
-if ! black --check setup.py trio; then
-    echo "* Black found issues" >> $GITHUB_STEP_SUMMARY
+if ! black --check src/trio; then
+    echo "* Black found issues" >> "$GITHUB_STEP_SUMMARY"
     EXIT_STATUS=1
-    black --diff setup.py trio
+    black --diff src/trio
     echo "::endgroup::"
     echo "::error:: Black found issues"
 else
     echo "::endgroup::"
 fi
 
-echo "::group::ISort"
-if ! isort --check setup.py trio; then
-    echo "* isort found issues." >> $GITHUB_STEP_SUMMARY
+# Run ruff, configured in pyproject.toml
+echo "::group::Ruff"
+if ! ruff check .; then
+    echo "* ruff found issues." >> "$GITHUB_STEP_SUMMARY"
     EXIT_STATUS=1
-    isort --diff setup.py trio
+    if $ON_GITHUB_CI; then
+        ruff check --output-format github --diff .
+    else
+        ruff check --diff .
+    fi
     echo "::endgroup::"
-    echo "::error:: isort found issues"
+    echo "::error:: ruff found issues"
 else
     echo "::endgroup::"
 fi
 
-# Run flake8, configured in pyproject.toml
-echo "::group::Flake8"
-flake8 trio/ || EXIT_STATUS=$?
-echo "::endgroup::"
-
 # Run mypy on all supported platforms
 # MYPY is set if any of them fail.
 MYPY=0
@@ -55,16 +57,16 @@ echo "::group::Mypy"
 rm -f mypy_annotate.dat
 # Pipefail makes these pipelines fail if mypy does, even if mypy_annotate.py succeeds.
 set -o pipefail
-mypy trio --show-error-end --platform linux | python ./trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Linux \
-    || { echo "* Mypy (Linux) found type errors." >> $GITHUB_STEP_SUMMARY; MYPY=1; }
+mypy --show-error-end --platform linux | python ./src/trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Linux \
+    || { echo "* Mypy (Linux) found type errors." >> "$GITHUB_STEP_SUMMARY"; MYPY=1; }
 # Darwin tests FreeBSD too
-mypy trio --show-error-end --platform darwin | python ./trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Mac \
-    || { echo "* Mypy (Mac) found type errors." >> $GITHUB_STEP_SUMMARY; MYPY=1; }
-mypy trio --show-error-end --platform win32 | python ./trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Windows \
-    || { echo "* Mypy (Windows) found type errors." >> $GITHUB_STEP_SUMMARY; MYPY=1; }
+mypy --show-error-end --platform darwin | python ./src/trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Mac \
+    || { echo "* Mypy (Mac) found type errors." >> "$GITHUB_STEP_SUMMARY"; MYPY=1; }
+mypy --show-error-end --platform win32 | python ./src/trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat --platform Windows \
+    || { echo "* Mypy (Windows) found type errors." >> "$GITHUB_STEP_SUMMARY"; MYPY=1; }
 set +o pipefail
 # Re-display errors using Github's syntax, read out of mypy_annotate.dat
-python ./trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat
+python ./src/trio/_tools/mypy_annotate.py --dumpfile mypy_annotate.dat
 # Then discard.
 rm -f mypy_annotate.dat
 echo "::endgroup::"
@@ -85,23 +87,32 @@ echo "::endgroup::"
 if git status --porcelain | grep -q "requirements.txt"; then
     echo "::error::requirements.txt changed."
     echo "::group::requirements.txt changed"
-    echo "* requirements.txt changed" >> $GITHUB_STEP_SUMMARY
+    echo "* requirements.txt changed" >> "$GITHUB_STEP_SUMMARY"
     git status --porcelain
-    git --no-pager diff --color *requirements.txt
+    git --no-pager diff --color ./*requirements.txt
     EXIT_STATUS=1
     echo "::endgroup::"
 fi
 
 codespell || EXIT_STATUS=$?
 
-python trio/_tests/check_type_completeness.py --overwrite-file || EXIT_STATUS=$?
-if git status --porcelain trio/_tests/verify_types*.json | grep -q "M"; then
-    echo "* Type completeness changed, please update!" >> $GITHUB_STEP_SUMMARY
-    echo "::error::Type completeness changed, please update!"
-    git --no-pager diff --color trio/_tests/verify_types*.json
+PYRIGHT=0
+echo "::group::Pyright interface tests"
+pyright --verifytypes --ignoreexternal --pythonplatform=Linux --verifytypes=trio \
+    || { echo "* Pyright --verifytypes (Linux) found errors." >> "$GITHUB_STEP_SUMMARY"; PYRIGHT=1; }
+pyright --verifytypes --ignoreexternal --pythonplatform=Darwin --verifytypes=trio \
+    || { echo "* Pyright --verifytypes (Mac) found errors." >> "$GITHUB_STEP_SUMMARY"; PYRIGHT=1; }
+pyright --verifytypes --ignoreexternal --pythonplatform=Windows --verifytypes=trio \
+    || { echo "* Pyright --verifytypes (Windows) found errors." >> "$GITHUB_STEP_SUMMARY"; PYRIGHT=1; }
+if [ $PYRIGHT -ne 0 ]; then
+    echo "::error:: Pyright --verifytypes returned errors."
     EXIT_STATUS=1
 fi
 
+pyright src/trio/_tests/type_tests || EXIT_STATUS=$?
+pyright src/trio/_core/_tests/type_tests || EXIT_STATUS=$?
+echo "::endgroup::"
+
 # Finally, leave a really clear warning of any issues and exit
 if [ $EXIT_STATUS -ne 0 ]; then
     cat <<EOF
@@ -112,8 +123,8 @@ Problems were found by static analysis (listed above).
 To fix formatting and see remaining errors, run
 
     pip install -r test-requirements.txt
-    black setup.py trio
-    isort setup.py trio
+    black src/trio
+    ruff check src/trio
     ./check.sh
 
 in your local checkout.
@@ -123,5 +134,5 @@ in your local checkout.
 EOF
     exit 1
 fi
-echo "# Formatting checks succeeded." >> $GITHUB_STEP_SUMMARY
+echo "# Formatting checks succeeded." >> "$GITHUB_STEP_SUMMARY"
 exit 0