Merge remote-tracking branch 'origin/main' into drop-3.8-support

Author: CoolCat467

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

@@ -79,7 +79,7 @@ sphinx-codeautolink==0.15.2
     # via -r docs-requirements.in
 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

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

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

@@ -49,12 +49,15 @@ def table_entry(mode1, bind_type1, mode2, bind_type2):
     """
                                                        second bind
                                | """
-    + " | ".join(["%-19s" % mode for mode in modes]),
+    + " | ".join(f"{mode:<19}" for mode in modes),
 )
 
 print("""                              """, end="")
 for _ in modes:
-    print(" | " + " | ".join(["%8s" % bind_type for bind_type in bind_types]), end="")
+    print(
+        " | " + " | ".join(f"{bind_type:>8}" for bind_type in bind_types),
+        end="",
+    )
 
 print(
     """
@@ -72,5 +75,5 @@ def table_entry(mode1, bind_type1, mode2, bind_type2):
                 # print(mode1, bind_type1, mode2, bind_type2, entry)
         print(
             f"{mode1:>19} | {bind_type1:>8} | "
-            + " | ".join(["%8s" % entry for entry in row]),
+            + " | ".join(f"{entry:>8}" for entry in row),
         )

notes-to-self/socket-scaling.py

@@ -32,7 +32,7 @@ def pt(desc, *, count=total, item="socket"):
             now = time.perf_counter()
             total_ms = (now - last_time) * 1000
             per_us = total_ms * 1000 / count
-            print(f"{desc}: {total_ms:.2f} ms total, {per_us:.2f} µs/{item}")
+            print(f"{desc}: {total_ms:.2f} ms total, {per_us:.2f} μs/{item}")
             last_time = now
 
         print(f"\n-- {total} sockets --")

notes-to-self/thread-dispatch-bench.py

@@ -30,7 +30,7 @@ def main():
             in_q.put(lambda: None)
             out_q.get()
         end = time.monotonic()
-        print(f"{(end - start) / COUNT * 1e6:.2f} µs/job")
+        print(f"{(end - start) / COUNT * 1e6:.2f} μs/job")
 
 
 main()

notes-to-self/trivial-err.py

@@ -5,7 +5,7 @@
 sys.stderr = sys.stdout
 
 
-async def child1():
+async def child1():  # noqa: RUF029  # async not required
     raise ValueError
 
 
@@ -15,11 +15,11 @@ async def child2():
         nursery.start_soon(grandchild2)
 
 
-async def grandchild1():
+async def grandchild1():  # noqa: RUF029  # async not required
     raise KeyError
 
 
-async def grandchild2():
+async def grandchild2():  # noqa: RUF029  # async not required
     raise NameError("Bob")
 
 

notes-to-self/trivial.py

@@ -1,7 +1,7 @@
 import trio
 
 
-async def foo():
+async def foo():  # noqa: RUF029  # await not used
     print("in foo!")
     return 3
 

pyproject.toml

@@ -100,6 +100,7 @@ extend-exclude = [
 ]
 
 [tool.ruff.lint]
+preview = true
 allowed-confusables = ["–"]
 
 select = [
@@ -145,10 +146,20 @@ extend-ignore = [
 # to export for public use.
 'src/trio/__init__.py' = ['F401']
 'src/trio/_core/__init__.py' = ['F401']
-'src/trio/abc.py' = ['F401']
+'src/trio/abc.py' = ['F401', 'A005']
 'src/trio/lowlevel.py' = ['F401']
-'src/trio/socket.py' = ['F401']
+'src/trio/socket.py' = ['F401', 'A005']
 'src/trio/testing/__init__.py' = ['F401']
+# RUF029 is ignoring tests that are marked as async functions but
+# do not use an await in their function bodies. There are several
+# places where internal trio synchronous code relies on being
+# called from an async function, where current task is set up.
+'src/trio/_tests/*.py' = ['RUF029']
+'src/trio/_core/_tests/*.py' = ['RUF029']
+# A005 is ignoring modules that shadow stdlib modules.
+'src/trio/_abc.py' = ['A005']
+'src/trio/_socket.py' = ['A005']
+'src/trio/_ssl.py' = ['A005']
 
 [tool.ruff.lint.isort]
 combine-as-imports = true

src/trio/_core/_entry_queue.py

@@ -65,7 +65,9 @@ def run_cb(job: Job) -> None:
                 sync_fn(*args)
             except BaseException as exc:
 
-                async def kill_everything(exc: BaseException) -> NoReturn:
+                async def kill_everything(  # noqa: RUF029  # await not used
+                    exc: BaseException,
+                ) -> NoReturn:
                     raise exc
 
                 try:
@@ -140,7 +142,7 @@ def run_sync_soon(
             # wakeup call might trigger an OSError b/c the IO manager has
             # already been shut down.
             if idempotent:
-                self.idempotent_queue[(sync_fn, args)] = None
+                self.idempotent_queue[sync_fn, args] = None
             else:
                 self.queue.append((sync_fn, args))
             self.wakeup.wakeup_thread_and_signal_safe()