Merge branch 'adafruit:main' into main

Author: furbrain

.github/workflows/build.yml

@@ -12,3 +12,5 @@ jobs:
     steps:
     - name: Run Build CI workflow
       uses: adafruit/workflows-circuitpython-libs/build@main
+      with:
+        package-prefix: "asyncio"

.github/workflows/release_gh.yml

@@ -15,4 +15,6 @@ jobs:
     - name: Run GitHub Release CI workflow
       uses: adafruit/workflows-circuitpython-libs/release-gh@main
       with:
+        package-prefix: "asyncio"
         github-token: ${{ secrets.GITHUB_TOKEN }}
+        upload-url: ${{ github.event.release.upload_url }}

.gitignore

@@ -37,6 +37,7 @@ _build
 
 # Virtual environment-specific files
 .env
+.venv
 
 # MacOS-specific files
 *.DS_Store

.pre-commit-config.yaml

@@ -4,21 +4,21 @@
 
 repos:
   - repo: https://github.com/python/black
-    rev: 22.3.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v0.14.0
+    rev: v1.1.2
     hooks:
       - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.15.5
+    rev: v2.17.4
     hooks:
       - id: pylint
         name: pylint (library code)

.pylintrc

@@ -396,4 +396,4 @@ min-public-methods=1
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception

README.rst

@@ -73,7 +73,7 @@ Or the following command to update an existing version:
 Documentation
 =============
 
-API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/en/latest/docs/library/asyncio.html>`_.
+API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/asyncio/en/latest/>`_.
 
 For information on building library documentation, please check out
 `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

asyncio/core.py

@@ -94,11 +94,11 @@ def sleep(t):
 
 ################################################################################
 # "Never schedule" object"
-# Don't re-schedule the object that awaits the _never singleton.
+# Don't re-schedule the object that awaits _never().
 # For internal use only. Some constructs, like `await event.wait()`,
 # work by NOT re-scheduling the task which calls wait(), but by
 # having some other task schedule it later.
-class _Never:
+class _NeverSingletonGenerator:
     def __init__(self):
         self.state = None
         self.exc = StopIteration()
@@ -117,7 +117,10 @@ def __next__(self):
            self.exc.__traceback__ = None
            raise self.exc
 
-_never = _Never()
+def _never(sgen=_NeverSingletonGenerator()):
+    # assert sgen.state is None, "Check for a missing `await` in your code"
+    sgen.state = False
+    return sgen
 
 
 ################################################################################
@@ -150,13 +153,11 @@ def _dequeue(self, s):
 
     async def queue_read(self, s):
         self._enqueue(s, 0)
-        _never.state = False
-        await _never
+        await _never()
 
     async def queue_write(self, s):
         self._enqueue(s, 1)
-        _never.state = False
-        await _never
+        await _never()
 
     def remove(self, task):
         while True:

asyncio/event.py

@@ -62,8 +62,7 @@ async def wait(self):
             self.waiting.push_head(core.cur_task)
             # Set calling task's data to the event's queue so it can be removed if needed
             core.cur_task.data = self.waiting
-            core._never.state = False
-            await core._never
+            await core._never()
         return True
 
 

asyncio/lock.py

@@ -69,8 +69,7 @@ async def acquire(self):
             # Set calling task's data to the lock's queue so it can be removed if needed
             core.cur_task.data = self.waiting
             try:
-                core._never.state = False
-                await core._never
+                await core._never()
             except core.CancelledError as er:
                 if self.state == core.cur_task:
                     # Cancelled while pending on resume, schedule next waiting Task

docs/conf.py

@@ -17,6 +17,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",

docs/requirements.txt

@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: Unlicense
 
 sphinx>=4.0.0
+sphinxcontrib-jquery

examples/asyncio_displayio_button.py

@@ -98,6 +98,7 @@
     label_color=BUTTON_LABEL_COLOR,
 )
 
+
 # Button state data object. Will hold either true of false whether button is currently pressed
 class ButtonState:
     # pylint: disable=too-few-public-methods
@@ -146,7 +147,6 @@ async def blink(palette, interval, count, button_state):  # Don't forget the asy
     :param ButtonState button_state: The ButtonState data object for the invert color button
     """
     while count < 0 or count > 0:
-
         # if the color button is pressed
         if button_state.state:
             # if the color is still on default
@@ -187,7 +187,6 @@ def handle_color_button(touch_event, color_button, button_state):
 
     # if there is a touch event
     if touch_event:
-
         # if the color button is being touched
         if color_button.contains(touch_event):
             # set selected to change button color

examples/serial_examples.py

@@ -22,7 +22,6 @@
     import usb_cdc
 
     async def usb_client():
-
         usb_cdc.data.timeout = 0
         s = asyncio.StreamReader(usb_cdc.data)
         while True:
@@ -34,7 +33,6 @@ async def usb_client():
     import board
 
     async def uart_client():
-
         uart = board.UART()
         uart.timeout = 0
         s = asyncio.StreamReader(board.UART())