list extensions instead of macros names ("bin,uf2" not BIN_UF2)

Neradoc · Neradoc · commit dfe465c936b5 · 2022-07-21T03:21:46.000+02:00
the modules_support_matrix usees a dictionnary per board instead of a list
optionally include the frozen modules URLs in it
diff --git a/conf.py b/conf.py
@@ -71,8 +71,8 @@ def _format_args(args_info, include_annotations=True, ignore_self=None):
 #modules_support_matrix = shared_bindings_matrix.support_matrix_excluded_boards()
 modules_support_matrix = shared_bindings_matrix.support_matrix_by_board()
 modules_support_matrix_reverse = defaultdict(list)
-for board, modules in modules_support_matrix.items():
-    for module in modules[0]:
+for board, matrix_info in modules_support_matrix.items():
+    for module in matrix_info["modules"]:
         modules_support_matrix_reverse[module].append(board)
 
 modules_support_matrix_reverse = dict(
diff --git a/docs/shared_bindings_matrix.py b/docs/shared_bindings_matrix.py
@@ -204,7 +204,7 @@ def get_repository_url(directory):
     repository_urls[directory] = path
     return path
 
-def frozen_modules_from_dirs(frozen_mpy_dirs):
+def frozen_modules_from_dirs(frozen_mpy_dirs, withurl):
     """
     Go through the list of frozen directories and extract the python modules.
     Paths are of the type:
@@ -221,10 +221,16 @@ def frozen_modules_from_dirs(frozen_mpy_dirs):
             if sub.name in frozen_excludes:
                 continue
             if sub.name.endswith(".py"):
-                frozen_modules.append((sub.name[:-3], url_repository))
+                if withurl:
+                    frozen_modules.append((sub.name[:-3], url_repository))
+                else:
+                    frozen_modules.append(sub.name[:-3])
                 continue
             if next(sub.glob("**/*.py"), None): # tests if not empty
-                frozen_modules.append((sub.name, url_repository))
+                if withurl:
+                    frozen_modules.append((sub.name, url_repository))
+                else:
+                    frozen_modules.append(sub.name)
     return frozen_modules
 
 def lookup_setting(settings, key, default=''):
@@ -244,7 +250,7 @@ def all_ports_all_boards(ports=SUPPORTED_PORTS):
                 continue
             yield (port, entry)
 
-def support_matrix_by_board(use_branded_name=True):
+def support_matrix_by_board(use_branded_name=True, withurl=True):
     """ Compiles a list of the available core modules available for each
         board.
     """
@@ -275,17 +281,21 @@ def support_matrix(arg):
         if "CIRCUITPY_BUILD_EXTENSIONS" in settings:
             board_extensions = settings["CIRCUITPY_BUILD_EXTENSIONS"]
         else:
-            raise "Board extensions undefined."
+            raise OSError(f"Board extensions undefined: {board_name}.")
 
         frozen_modules = []
         if "FROZEN_MPY_DIRS" in settings:
-            frozen_modules = frozen_modules_from_dirs(settings["FROZEN_MPY_DIRS"])
+            frozen_modules = frozen_modules_from_dirs(settings["FROZEN_MPY_DIRS"], withurl)
             if frozen_modules:
                 frozen_modules.sort()
 
         # generate alias boards too
         board_matrix = [(
-            board_name, (board_modules, frozen_modules, board_extensions)
+            board_name, {
+                "modules": board_modules,
+                "frozen_libraries": frozen_modules,
+                "extensions": board_extensions,
+            }
         )]
         if entry.name in aliases_by_board:
             for alias in aliases_by_board[entry.name]:
@@ -295,15 +305,19 @@ def support_matrix(arg):
                     else:
                         alias = alias.replace("_"," ").title()
                 board_matrix.append((
-                    alias, (board_modules, frozen_modules, board_extensions),
+                    alias, {
+                        "modules": board_modules,
+                        "frozen_libraries": frozen_modules,
+                        "extensions": board_extensions,
+                    },
                 ))
 
         return board_matrix # this is now a list of (board,modules)
 
     executor = ThreadPoolExecutor(max_workers=os.cpu_count())
     mapped_exec = executor.map(support_matrix, all_ports_all_boards())
     # flatmap with comprehensions
-    boards = dict(sorted([board for matrix in mapped_exec for board in matrix]))
+    boards = dict(sorted([board for matrix in mapped_exec for board in matrix], key=lambda x: x[0]))
 
     return boards
 
diff --git a/ports/atmel-samd/boards/arduino_mkr1300/mpconfigboard.mk b/ports/atmel-samd/boards/arduino_mkr1300/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Arduino"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/arduino_mkrzero/mpconfigboard.mk b/ports/atmel-samd/boards/arduino_mkrzero/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Arduino"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/arduino_nano_33_iot/mpconfigboard.mk b/ports/atmel-samd/boards/arduino_nano_33_iot/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Arduino"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/arduino_zero/mpconfigboard.mk b/ports/atmel-samd/boards/arduino_zero/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Arduino"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/feather_m0_adalogger/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_adalogger/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Adafruit Industries LLC"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/feather_m0_basic/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_basic/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Adafruit Industries LLC"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/feather_m0_rfm69/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_rfm69/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Adafruit Industries LLC"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/feather_m0_rfm9x/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_rfm9x/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Adafruit Industries LLC"
 CHIP_VARIANT = SAMD21G18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/boards/uchip/mpconfigboard.mk b/ports/atmel-samd/boards/uchip/mpconfigboard.mk
@@ -6,7 +6,7 @@ USB_MANUFACTURER = "Itaca Innovation"
 CHIP_VARIANT = SAMD21E18A
 CHIP_FAMILY = samd21
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
 LONGINT_IMPL = NONE
diff --git a/ports/atmel-samd/mpconfigport.mk b/ports/atmel-samd/mpconfigport.mk
@@ -134,4 +134,4 @@ CIRCUITPY_RGBMATRIX ?= $(CIRCUITPY_FRAMEBUFFERIO)
 endif # same51
 ######################################################################
 
-CIRCUITPY_BUILD_EXTENSIONS ?= BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS ?= bin,uf2
diff --git a/ports/broadcom/boards/raspberrypi_zero/mpconfigboard.mk b/ports/broadcom/boards/raspberrypi_zero/mpconfigboard.mk
@@ -5,4 +5,4 @@ USB_MANUFACTURER = "Raspberry Pi"
 
 CHIP_VARIANT = "bcm2835"
 
-CIRCUITPY_BUILD_EXTENSIONS = KERNEL_IMG
+CIRCUITPY_BUILD_EXTENSIONS = disk.img.zip,kernel.img
diff --git a/ports/broadcom/boards/raspberrypi_zero_w/mpconfigboard.mk b/ports/broadcom/boards/raspberrypi_zero_w/mpconfigboard.mk
@@ -5,4 +5,4 @@ USB_MANUFACTURER = "Raspberry Pi"
 
 CHIP_VARIANT = "bcm2835"
 
-CIRCUITPY_BUILD_EXTENSIONS = KERNEL_IMG
+CIRCUITPY_BUILD_EXTENSIONS = disk.img.zip,kernel.img
diff --git a/ports/broadcom/mpconfigport.mk b/ports/broadcom/mpconfigport.mk
@@ -25,4 +25,4 @@ INTERNAL_FLASH_FILESYSTEM = 1
 USB_NUM_ENDPOINT_PAIRS = 8
 USB_HIGHSPEED = 1
 
-CIRCUITPY_BUILD_EXTENSIONS ?= KERNEL8_IMG
+CIRCUITPY_BUILD_EXTENSIONS ?= disk.img.zip,kernel8.img
diff --git a/ports/cxd56/mpconfigport.mk b/ports/cxd56/mpconfigport.mk
@@ -26,4 +26,4 @@ CIRCUITPY_USB_HID = 0
 CIRCUITPY_USB_MIDI = 0
 INTERNAL_LIBM = 1
 
-CIRCUITPY_BUILD_EXTENSIONS ?= SPK
+CIRCUITPY_BUILD_EXTENSIONS ?= spk
diff --git a/ports/espressif/mpconfigport.mk b/ports/espressif/mpconfigport.mk
@@ -40,7 +40,7 @@ CIRCUITPY_PARALLELDISPLAY = 0
 # Protomatter needs to support ESP32.
 CIRCUITPY_RGBMATRIX = 0
 CIRCUITPY_USB = 0
-CIRCUITPY_BUILD_EXTENSIONS ?= BIN
+CIRCUITPY_BUILD_EXTENSIONS ?= bin
 
 else ifeq ($(IDF_TARGET),esp32c3)
 CIRCUITPY_AESIO = 0
@@ -58,7 +58,7 @@ CIRCUITPY_ROTARYIO = 0
 CIRCUITPY_TOUCHIO ?= 1
 CIRCUITPY_TOUCHIO_USE_NATIVE = 0
 CIRCUITPY_USB = 0
-CIRCUITPY_BUILD_EXTENSIONS ?= BIN
+CIRCUITPY_BUILD_EXTENSIONS ?= bin
 
 else ifeq ($(IDF_TARGET),esp32s3)
 CIRCUITPY_BLEIO = 1
@@ -72,7 +72,7 @@ CIRCUITPY_BLEIO = 0
 CIRCUITPY_BLEIO_HCI = 0
 endif
 
-CIRCUITPY_BUILD_EXTENSIONS ?= BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS ?= bin,uf2
 
 # From ESP32-S2/S3 Technical Reference Manual:
 #
diff --git a/ports/litex/mpconfigport.mk b/ports/litex/mpconfigport.mk
@@ -30,4 +30,4 @@ CIRCUITPY_SDCARDIO = 0
 CIRCUITPY_USB_HID = 1
 CIRCUITPY_USB_MIDI = 1
 
-CIRCUITPY_BUILD_EXTENSIONS ?= DFU
+CIRCUITPY_BUILD_EXTENSIONS ?= dfu
diff --git a/ports/mimxrt10xx/mpconfigport.mk b/ports/mimxrt10xx/mpconfigport.mk
@@ -22,4 +22,4 @@ CIRCUITPY_ROTARYIO = 0
 CIRCUITPY_USB_MIDI = 1
 LONGINT_IMPL = MPZ
 
-CIRCUITPY_BUILD_EXTENSIONS ?= HEX_UF2
+CIRCUITPY_BUILD_EXTENSIONS ?= hex,uf2
diff --git a/ports/nrf/boards/electronut_labs_blip/mpconfigboard.mk b/ports/nrf/boards/electronut_labs_blip/mpconfigboard.mk
@@ -5,7 +5,7 @@ USB_MANUFACTURER = "Electronut Labs"
 
 MCU_CHIP = nrf52840
 
-CIRCUITPY_BUILD_EXTENSIONS = HEX
+CIRCUITPY_BUILD_EXTENSIONS = hex
 
 INTERNAL_FLASH_FILESYSTEM = 1
 CIRCUITPY_AUDIOIO = 0
diff --git a/ports/nrf/boards/makerdiary_nrf52840_mdk/mpconfigboard.mk b/ports/nrf/boards/makerdiary_nrf52840_mdk/mpconfigboard.mk
@@ -5,7 +5,7 @@ USB_MANUFACTURER = "makerdiary"
 
 MCU_CHIP = nrf52840
 
-CIRCUITPY_BUILD_EXTENSIONS = HEX
+CIRCUITPY_BUILD_EXTENSIONS = hex
 
 QSPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "MX25R6435F"
diff --git a/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/mpconfigboard.mk b/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/mpconfigboard.mk
@@ -5,6 +5,6 @@ USB_MANUFACTURER = "makerdiary"
 
 MCU_CHIP = nrf52840
 
-CIRCUITPY_BUILD_EXTENSIONS = HEX_UF2
+CIRCUITPY_BUILD_EXTENSIONS = hex,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/nrf/boards/microbit_v2/mpconfigboard.mk b/ports/nrf/boards/microbit_v2/mpconfigboard.mk
@@ -3,7 +3,7 @@ CIRCUITPY_CREATION_ID = 0x80D8
 
 MCU_CHIP = nrf52833
 
-CIRCUITPY_BUILD_EXTENSIONS = COMBINED_HEX
+CIRCUITPY_BUILD_EXTENSIONS = combined.hex
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/nrf/boards/pca10056/mpconfigboard.mk b/ports/nrf/boards/pca10056/mpconfigboard.mk
@@ -5,7 +5,7 @@ USB_MANUFACTURER = "Nordic Semiconductor"
 
 MCU_CHIP = nrf52840
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 QSPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "MX25R6435F"
diff --git a/ports/nrf/boards/pca10059/mpconfigboard.mk b/ports/nrf/boards/pca10059/mpconfigboard.mk
@@ -5,6 +5,6 @@ USB_MANUFACTURER = "Nordic Semiconductor"
 
 MCU_CHIP = nrf52840
 
-CIRCUITPY_BUILD_EXTENSIONS = BIN_UF2
+CIRCUITPY_BUILD_EXTENSIONS = bin,uf2
 
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/nrf/mpconfigport.mk b/ports/nrf/mpconfigport.mk
@@ -4,7 +4,7 @@ LD_TEMPLATE_FILE = boards/common.template.ld
 
 INTERNAL_LIBM = 1
 
-CIRCUITPY_BUILD_EXTENSIONS ?= UF2
+CIRCUITPY_BUILD_EXTENSIONS ?= uf2
 
 # Number of USB endpoint pairs.
 USB_NUM_ENDPOINT_PAIRS = 8
diff --git a/ports/raspberrypi/mpconfigport.mk b/ports/raspberrypi/mpconfigport.mk
@@ -1,6 +1,6 @@
 # All raspberrypi ports have longints.
 LONGINT_IMPL = MPZ
-CIRCUITPY_BUILD_EXTENSIONS ?= UF2
+CIRCUITPY_BUILD_EXTENSIONS ?= uf2
 CIRCUITPY_OPTIMIZE_PROPERTY_FLASH_SIZE ?= 1
 
 CIRCUITPY_OPTIMIZE_PROPERTY_FLASH_SIZE ?= 1
diff --git a/ports/stm/boards/meowbit_v121/mpconfigboard.mk b/ports/stm/boards/meowbit_v121/mpconfigboard.mk
@@ -13,7 +13,7 @@ MCU_SERIES = F4
 MCU_VARIANT = STM32F401xE
 MCU_PACKAGE = LQFP64
 
-CIRCUITPY_BUILD_EXTENSIONS = UF2
+CIRCUITPY_BUILD_EXTENSIONS = uf2
 
 OPTIMIZATION_FLAGS = -Os
 
diff --git a/ports/stm/mpconfigport.mk b/ports/stm/mpconfigport.mk
@@ -1,7 +1,7 @@
 LONGINT_IMPL ?= MPZ
 INTERNAL_LIBM ?= 1
 
-CIRCUITPY_BUILD_EXTENSIONS ?= BIN
+CIRCUITPY_BUILD_EXTENSIONS ?= bin
 
 ifeq ($(MCU_VARIANT),$(filter $(MCU_VARIANT),STM32F405xx STM32F407xx))
         CIRCUITPY_ALARM = 1
diff --git a/shared-bindings/support_matrix.rst b/shared-bindings/support_matrix.rst
@@ -21,9 +21,9 @@ capable board, as well as each :term:`frozen module` included on it.
    {% for key, value in support_matrix|dictsort %}
        {{ '.. _' ~ key|replace(" ", "-") ~ ':' }}
    * - {{ key }}
-     - {{ ':py:mod:`' ~ value[0]|join("`, :py:mod:`") ~ '`' }}
+     - {{ ':py:mod:`' ~ value.modules|join("`, :py:mod:`") ~ '`' }}
 
-       {% for module in value[1] %}\
+       {% for module in value.frozen_libraries %}\
        {% if loop.index == 1 %}**Frozen Modules:** {% endif %}\
        {% if loop.index > 1 %}, {% endif %}\
        {% if module[1] %}{{ '`' ~ module[0] ~ ' <' ~ module[1] ~ '>`__' }}\
diff --git a/tools/build_board_info.py b/tools/build_board_info.py
diff --git a/tools/build_release_files.py b/tools/build_release_files.py

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ USB_MANUFACTURER = "Raspberry Pi"`
`5`	`5`
`6`	`6`	`CHIP_VARIANT = "bcm2835"`
`7`	`7`
`8`		`-CIRCUITPY_BUILD_EXTENSIONS = KERNEL_IMG`
	`8`	`+CIRCUITPY_BUILD_EXTENSIONS = disk.img.zip,kernel.img`