Merge pull request #10109 from jepler/any-display-union

Add typing shorthand for display-related types

Author: tannewt

Makefile

@@ -265,9 +265,8 @@ stubs:
 	@mkdir circuitpython-stubs
 	@$(PYTHON) tools/extract_pyi.py shared-bindings/ $(STUBDIR)
 	@$(PYTHON) tools/extract_pyi.py extmod/ulab/code/ $(STUBDIR)/ulab
-	@$(PYTHON) tools/extract_pyi.py ports/atmel-samd/bindings $(STUBDIR)
-	@$(PYTHON) tools/extract_pyi.py ports/espressif/bindings $(STUBDIR)
-	@$(PYTHON) tools/extract_pyi.py ports/raspberrypi/bindings $(STUBDIR)
+	@for d in ports/*/bindings; do \
+	    $(PYTHON) tools/extract_pyi.py "$$d" $(STUBDIR); done
 	@sed -e "s,__version__,`python -msetuptools_scm`," < setup.py-stubs > circuitpython-stubs/setup.py
 	@cp README.rst-stubs circuitpython-stubs/README.rst
 	@cp MANIFEST.in-stubs circuitpython-stubs/MANIFEST.in

ports/zephyr-cp/bindings/zephyr_serial/UART.c

@@ -24,7 +24,7 @@
 
 //| class UART:
 //|     """A bidirectional serial protocol. Already initialized for Zephyr defined
-//|        busses in `board`.
+//|        busses in :py:mod:`board`.
 //|
 //|     .. raw:: html
 //|

shared-bindings/displayio/__init__.c

@@ -45,6 +45,23 @@
 //| """
 //|
 
+//| AnyDisplayBus = fourwire.FourWire | i2cdisplaybus.I2CDisplayBus | is31fl3741.IS31FL3741
+//| """Type-checking shorthand for any kind of display bus. Not actually defined in CircuitPython."""
+//|
+//| AnyFramebuffer = (
+//|     rgbmatrix.RGBMatrix
+//|     | is31fl3741.IS31FL3741_FrameBuffer
+//|     | sharpdisplay.SharpMemoryFramebuffer
+//|     | videocore.Framebuffer
+//|     | picodvi.Framebuffer
+//|     | aurora_epaper.AuroraMemoryFramebuffer
+//| )
+//| """Type-checking shorthand for any kind of framebuffer. Not actually defined in CircuitPython."""
+//|
+//| AnyDisplay = (
+//|     busdisplay.BusDisplay | epaperdisplay.EPaperDisplay | framebufferio.FramebufferDisplay
+//| )
+//| """Type-checking shorthand for any kind of display. Not actually defined in CircuitPython."""
 //| CIRCUITPYTHON_TERMINAL: Group
 //| """The `displayio.Group` that is the displayed serial terminal (REPL)."""
 //|

shared-bindings/supervisor/Runtime.c

@@ -208,12 +208,12 @@ MP_PROPERTY_GETSET(supervisor_runtime_rgb_status_brightness_obj,
     (mp_obj_t)&supervisor_runtime_set_rgb_status_brightness_obj);
 
 #if CIRCUITPY_DISPLAYIO
-//|     display: Any
+//|     display: displayio.AnyDisplay | None
 //|     """The primary configured displayio display, if any.
 //|
 //|     If the board has a display that is hard coded, or that was explicitly set
 //|     in boot.py or code.py (including a previous run of code.py), it is
-//|     available here until it is released with ``displayio.releasee_displays()``.
+//|     available here until it is released with ``displayio.release_displays()``.
 //|
 //|     The display can be of any supported display type, such as `busdisplay.BusDisplay`.
 //|