Merge branch 'master' into dependabot/pip/urllib3-1.26.13

Author: harahu

docs/source/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # Trio documentation build configuration file, created by
 # sphinx-quickstart on Sat Jan 21 19:11:14 2017.
@@ -19,17 +18,20 @@
 #
 import os
 import sys
+
 # For our local_customization module
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("."))
 # For trio itself
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # https://docs.readthedocs.io/en/stable/builds.html#build-environment
 if "READTHEDOCS" in os.environ:
     import glob
+
     if glob.glob("../../newsfragments/*.*.rst"):
         print("-- Found newsfragments; running towncrier --", flush=True)
         import subprocess
+
         subprocess.run(
             ["towncrier", "--yes", "--date", "not released yet"],
             cwd="../..",
@@ -66,6 +68,7 @@
 def setup(app):
     app.add_css_file("hackrtd.css")
 
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -76,45 +79,46 @@ def setup(app):
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.coverage',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib_trio',
-    'local_customization',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinxcontrib_trio",
+    "local_customization",
 ]
 
 intersphinx_mapping = {
-    "python": ('https://docs.python.org/3', None),
-    "outcome": ('https://outcome.readthedocs.io/en/latest/', None),
-    "pyopenssl": ('https://www.pyopenssl.org/en/stable/', None),
+    "python": ("https://docs.python.org/3", None),
+    "outcome": ("https://outcome.readthedocs.io/en/latest/", None),
+    "pyopenssl": ("https://www.pyopenssl.org/en/stable/", None),
 }
 
 autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Trio'
-copyright = '2017, Nathaniel J. Smith'
-author = 'Nathaniel J. Smith'
+project = "Trio"
+copyright = "2017, Nathaniel J. Smith"
+author = "Nathaniel J. Smith"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
 import trio
+
 version = trio.__version__
 # The full version, including alpha/beta/rc tags.
 release = version
@@ -136,9 +140,9 @@ def setup(app):
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'default'
+pygments_style = "default"
 
-highlight_language = 'python3'
+highlight_language = "python3"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -153,13 +157,14 @@ def setup(app):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'alabaster'
+# html_theme = 'alabaster'
 
 # 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 = "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
@@ -174,19 +179,19 @@ def setup(app):
     # versions/settings...
     "navigation_depth": 4,
     "logo_only": True,
-    'prev_next_buttons_location': 'both'
+    "prev_next_buttons_location": "both",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Triodoc'
+htmlhelp_basename = "Triodoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -195,15 +200,12 @@ def setup(app):
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -213,19 +215,15 @@ def setup(app):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Trio.tex', 'Trio Documentation',
-     'Nathaniel J. Smith', 'manual'),
+    (master_doc, "Trio.tex", "Trio Documentation", "Nathaniel J. Smith", "manual"),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'trio', 'Trio Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "trio", "Trio Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -234,7 +232,13 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Trio', 'Trio Documentation',
-     author, 'Trio', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "Trio",
+        "Trio Documentation",
+        author,
+        "Trio",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

docs/source/local_customization.py

@@ -2,7 +2,10 @@
 from sphinx import addnodes
 from sphinx.domains.python import PyClasslike
 from sphinx.ext.autodoc import (
-    FunctionDocumenter, MethodDocumenter, ClassLevelDocumenter, Options,
+    FunctionDocumenter,
+    MethodDocumenter,
+    ClassLevelDocumenter,
+    Options,
 )
 
 """
@@ -13,13 +16,15 @@
 
 """
 
+
 class Interface(PyClasslike):
     def handle_signature(self, sig, signode):
         signode += addnodes.desc_name(sig, sig)
         return sig, ""
 
     def get_index_text(self, modname, name_cls):
-        return "{} (interface in {})".format(name_cls[0], modname)
+        return f"{name_cls[0]} (interface in {modname})"
+
 
 def setup(app):
     app.add_directive_to_domain("py", "interface", Interface)

docs/source/reference-core/channels-backpressure.py

@@ -4,6 +4,7 @@
 import trio
 import math
 
+
 async def producer(send_channel):
     count = 0
     while True:
@@ -14,17 +15,20 @@ async def producer(send_channel):
         print("Sent message:", count)
         count += 1
 
+
 async def consumer(receive_channel):
     async for value in receive_channel:
         print("Received message:", value)
         # Pretend that we have to do some work to handle this message, and it
         # takes 1 second
         await trio.sleep(1)
 
+
 async def main():
     send_channel, receive_channel = trio.open_memory_channel(math.inf)
     async with trio.open_nursery() as nursery:
         nursery.start_soon(producer, send_channel)
         nursery.start_soon(consumer, receive_channel)
 
+
 trio.run(main)

docs/source/reference-core/channels-mpmc-broken.py

@@ -3,6 +3,7 @@
 import trio
 import random
 
+
 async def main():
     async with trio.open_nursery() as nursery:
         send_channel, receive_channel = trio.open_memory_channel(0)
@@ -13,18 +14,21 @@ async def main():
         nursery.start_soon(consumer, "X", receive_channel)
         nursery.start_soon(consumer, "Y", receive_channel)
 
+
 async def producer(name, send_channel):
     async with send_channel:
         for i in range(3):
             await send_channel.send(f"{i} from producer {name}")
             # Random sleeps help trigger the problem more reliably
             await trio.sleep(random.random())
 
+
 async def consumer(name, receive_channel):
     async with receive_channel:
         async for value in receive_channel:
             print(f"consumer {name} got value {value!r}")
             # Random sleeps help trigger the problem more reliably
             await trio.sleep(random.random())
 
+
 trio.run(main)

docs/source/reference-core/channels-mpmc-fixed.py

@@ -1,6 +1,7 @@
 import trio
 import random
 
+
 async def main():
     async with trio.open_nursery() as nursery:
         send_channel, receive_channel = trio.open_memory_channel(0)
@@ -12,18 +13,21 @@ async def main():
             nursery.start_soon(consumer, "X", receive_channel.clone())
             nursery.start_soon(consumer, "Y", receive_channel.clone())
 
+
 async def producer(name, send_channel):
     async with send_channel:
         for i in range(3):
             await send_channel.send(f"{i} from producer {name}")
             # Random sleeps help trigger the problem more reliably
             await trio.sleep(random.random())
 
+
 async def consumer(name, receive_channel):
     async with receive_channel:
         async for value in receive_channel:
             print(f"consumer {name} got value {value!r}")
             # Random sleeps help trigger the problem more reliably
             await trio.sleep(random.random())
 
+
 trio.run(main)

docs/source/reference-core/channels-shutdown.py

@@ -1,19 +1,23 @@
 import trio
 
+
 async def main():
     async with trio.open_nursery() as nursery:
         send_channel, receive_channel = trio.open_memory_channel(0)
         nursery.start_soon(producer, send_channel)
         nursery.start_soon(consumer, receive_channel)
 
+
 async def producer(send_channel):
     async with send_channel:
         for i in range(3):
             await send_channel.send(f"message {i}")
 
+
 async def consumer(receive_channel):
     async with receive_channel:
         async for value in receive_channel:
             print(f"got value {value!r}")
 
+
 trio.run(main)

docs/source/reference-core/channels-simple.py

@@ -1,5 +1,6 @@
 import trio
 
+
 async def main():
     async with trio.open_nursery() as nursery:
         # Open a channel:
@@ -9,15 +10,18 @@ async def main():
         nursery.start_soon(producer, send_channel)
         nursery.start_soon(consumer, receive_channel)
 
+
 async def producer(send_channel):
     # Producer sends 3 messages
     for i in range(3):
         # The producer sends using 'await send_channel.send(...)'
         await send_channel.send(f"message {i}")
 
+
 async def consumer(receive_channel):
     # The consumer uses an 'async for' loop to receive the values:
     async for value in receive_channel:
         print(f"got value {value!r}")
 
+
 trio.run(main)