Switch to use ruff

.pre-commit-config.yaml

@@ -13,27 +13,20 @@ repos:
     rev: 23.9.1
     hooks:
       - id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.291
     hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - "flake8-pyproject==1.2.3"
+      - id: ruff
         types: [file]
-        types_or: [python, pyi]
+        types_or: [python, pyi, toml]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.5
     hooks:
       - id: codespell
 
 ci:
   autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
-  autofix_prs: true
+  autofix_prs: false
   autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
   autoupdate_schedule: weekly
-  skip: [black,isort]
   submodules: false

check.sh

@@ -2,11 +2,13 @@
 
 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
@@ -22,7 +24,7 @@ echo "::endgroup::"
 # pyupgrade --py3-plus $(find . -name "*.py")
 echo "::group::Black"
 if ! black --check setup.py trio; then
-    echo "* Black found issues" >> $GITHUB_STEP_SUMMARY
+    echo "* Black found issues" >> "$GITHUB_STEP_SUMMARY"
     EXIT_STATUS=1
     black --diff setup.py trio
     echo "::endgroup::"
@@ -31,22 +33,22 @@ 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 --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
@@ -56,12 +58,12 @@ 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; }
+    || { 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; }
+    || { 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; }
+    || { 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
@@ -85,9 +87,9 @@ 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
@@ -96,7 +98,7 @@ 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 "* 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
     EXIT_STATUS=1
@@ -123,5 +125,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

ci.sh

@@ -120,9 +120,6 @@ else
     INSTALLDIR=$(python -c "import os, trio; print(os.path.dirname(trio.__file__))")
     cp ../pyproject.toml $INSTALLDIR
 
-    # TODO: remove this once we have a py.typed file
-    touch "$INSTALLDIR/py.typed"
-
     # get mypy tests a nice cache
     MYPYPATH=".." mypy --config-file= --cache-dir=./.mypy_cache -c "import trio" >/dev/null 2>/dev/null || true
 

docs/source/local_customization.py

@@ -1,7 +1,7 @@
-from docutils.parsers.rst import directives as directives  # noqa: F401
+from docutils.parsers.rst import directives as directives
 from sphinx import addnodes
 from sphinx.domains.python import PyClasslike
-from sphinx.ext.autodoc import (  # noqa: F401
+from sphinx.ext.autodoc import (
     ClassLevelDocumenter as ClassLevelDocumenter,
     FunctionDocumenter as FunctionDocumenter,
     MethodDocumenter as MethodDocumenter,

docs/source/typevars.py

@@ -7,13 +7,12 @@
 import re
 from pathlib import Path
 
+import trio
 from sphinx.addnodes import Element, pending_xref
 from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
 from sphinx.errors import NoUri
 
-import trio
-
 
 def identify_typevars(trio_folder: Path) -> None:
     """Record all typevars in trio."""

notes-to-self/aio-guest-test.py

@@ -27,7 +27,7 @@ async def trio_main():
     to_trio, from_aio = trio.open_memory_channel(float("inf"))
     from_trio = asyncio.Queue()
 
-    asyncio.create_task(aio_pingpong(from_trio, to_trio))
+    _task_ref = asyncio.create_task(aio_pingpong(from_trio, to_trio))
 
     from_trio.put_nowait(0)
 

notes-to-self/atomic-local.py

@@ -20,7 +20,7 @@ def f():
     f.__code__.co_code,
     f.__code__.co_consts,
     f.__code__.co_names,
-    f.__code__.co_varnames + (sentinel,),
+    (*f.__code__.co_varnames, sentinel),
     f.__code__.co_filename,
     f.__code__.co_name,
     f.__code__.co_firstlineno,

notes-to-self/graceful-shutdown-idea.py

@@ -1,3 +1,6 @@
+import signal
+
+import gsm
 import trio
 
 

notes-to-self/how-does-windows-so-reuseaddr-work.py

@@ -62,11 +62,11 @@ def table_entry(mode1, bind_type1, mode2, bind_type2):
     #            default | wildcard |    INUSE |  Success |   ACCESS |  Success |    INUSE |  Success
 )
 
-for i, mode1 in enumerate(modes):
-    for j, bind_type1 in enumerate(bind_types):
+for mode1 in modes:
+    for bind_type1 in bind_types:
         row = []
-        for k, mode2 in enumerate(modes):
-            for l, bind_type2 in enumerate(bind_types):
+        for mode2 in modes:
+            for bind_type2 in bind_types:
                 entry = table_entry(mode1, bind_type1, mode2, bind_type2)
                 row.append(entry)
                 # print(mode1, bind_type1, mode2, bind_type2, entry)

notes-to-self/manual-signal-handler.py

@@ -1,5 +1,7 @@
 # How to manually call the SIGINT handler on Windows without using raise() or
 # similar.
+import os
+import sys
 
 if os.name == "nt":
     import cffi

notes-to-self/win-waitable-timer.py

@@ -27,7 +27,6 @@
 from datetime import datetime, timedelta, timezone
 
 import cffi
-
 import trio
 from trio._core._windows_cffi import ffi, kernel32, raise_winerror
 

pyproject.toml

@@ -10,27 +10,50 @@ force-exclude = '''
 [tool.codespell]
 ignore-words-list = 'astroid,crasher,asend'
 
-[tool.flake8]
-extend-ignore = ['D', 'E', 'W', 'F403', 'F405', 'F821', 'F822']
-per-file-ignores = [
-  'trio/__init__.py: F401',
-  'trio/_core/__init__.py: F401',
-  'trio/_core/_tests/test_multierror_scripts/*: F401',
-  'trio/abc.py: F401',
-  'trio/lowlevel.py: F401',
-  'trio/socket.py: F401',
-  'trio/testing/__init__.py: F401'
+[tool.ruff]
+target-version = "py38"
+respect-gitignore = true
+fix = true
+
+allowed-confusables = ["–"]
+
+# The directories to consider when resolving first vs. third-party imports.
+# Does not control what files to include/exclude!
+src = ["trio", "notes-to-self"]
+
+select = [
+  "RUF",  # Ruff-specific rules
+  "E",  # Error
+  "F",  # pyflakes
+  "I",  # isort
+  "YTT",  # flake8-2020
 ]
+extend-ignore = [
+    'F403',  # undefined-local-with-import-star
+    'F405',  # undefined-local-with-import-star-usage
+    'E402',  # module-import-not-at-top-of-file (usually OS-specific)
+    'E501',  # line-too-long
+]
+
+include = ["*.py", "*.pyi", "**/pyproject.toml"]
 
-[tool.isort]
-combine_as_imports = true
-profile = "black"
-skip_gitignore = true
-skip_glob = [
+extend-exclude = [
   "docs/source/reference-*",
-  "docs/source/tutorial/*"
+  "docs/source/tutorial/*",
 ]
 
+[tool.ruff.per-file-ignores]
+'trio/__init__.py' = ['F401']
+'trio/_core/__init__.py' = ['F401']
+'trio/_core/_tests/test_multierror_scripts/*' = ['F401']
+'trio/abc.py' = ['F401']
+'trio/lowlevel.py' = ['F401']
+'trio/socket.py' = ['F401']
+'trio/testing/__init__.py' = ['F401']
+
+[tool.ruff.isort]
+combine-as-imports = true
+
 [tool.mypy]
 python_version = "3.8"
 

setup.py

@@ -1,5 +1,7 @@
 from setuptools import find_packages, setup
 
+__version__ = "0.0.0"  # Overwritten from _version.py below
+
 exec(open("trio/_version.py", encoding="utf-8").read())
 
 LONG_DESC = """\

test-requirements.in

@@ -13,8 +13,7 @@ cryptography>=41.0.0  # cryptography<41 segfaults on pypy3.10
 black; implementation_name == "cpython"
 mypy; implementation_name == "cpython"
 types-pyOpenSSL; implementation_name == "cpython" # and annotations
-flake8
-flake8-pyproject
+ruff
 astor          # code generation
 pip-tools >= 6.13.0
 codespell

test-requirements.txt

@@ -40,12 +40,6 @@ exceptiongroup==1.1.3 ; python_version < "3.11"
     # via
     #   -r test-requirements.in
     #   pytest
-flake8==6.1.0
-    # via
-    #   -r test-requirements.in
-    #   flake8-pyproject
-flake8-pyproject==1.2.3
-    # via -r test-requirements.in
 idna==3.4
     # via
     #   -r test-requirements.in
@@ -59,9 +53,7 @@ jedi==0.19.0
 lazy-object-proxy==1.9.0
     # via astroid
 mccabe==0.7.0
-    # via
-    #   flake8
-    #   pylint
+    # via pylint
 mypy==1.5.1 ; implementation_name == "cpython"
     # via -r test-requirements.in
 mypy-extensions==1.0.0 ; implementation_name == "cpython"
@@ -90,12 +82,8 @@ platformdirs==3.10.0
     #   pylint
 pluggy==1.3.0
     # via pytest
-pycodestyle==2.11.0
-    # via flake8
 pycparser==2.21
     # via cffi
-pyflakes==3.1.0
-    # via flake8
 pylint==2.17.5
     # via -r test-requirements.in
 pyopenssl==23.2.0
@@ -106,6 +94,8 @@ pyright==1.1.325
     # via -r test-requirements.in
 pytest==7.4.0
     # via -r test-requirements.in
+ruff==0.0.287
+    # via -r test-requirements.in
 sniffio==1.3.0
     # via -r test-requirements.in
 sortedcontainers==2.4.0
@@ -114,7 +104,6 @@ tomli==2.0.1
     # via
     #   black
     #   build
-    #   flake8-pyproject
     #   mypy
     #   pip-tools
     #   pylint

trio/__init__.py

@@ -15,7 +15,7 @@
 # innocuous bits of the _core API + the higher-level tools from trio/*.py.
 #
 # Uses `from x import y as y` for compatibility with `pyright --verifytypes` (#2625)
-
+#
 # must be imported early to avoid circular import
 from ._core import TASK_STATUS_IGNORED as TASK_STATUS_IGNORED  # isort: split
 

trio/_channel.py

@@ -3,8 +3,11 @@
 from collections import OrderedDict, deque
 from math import inf
 from types import TracebackType
-from typing import Tuple  # only needed for typechecking on <3.9
-from typing import TYPE_CHECKING, Generic
+from typing import (
+    TYPE_CHECKING,
+    Generic,
+    Tuple,  # only needed for typechecking on <3.9
+)
 
 import attr
 from outcome import Error, Value