Build CI fails when running tests

[EGJ-Moorington]

As exposed by #30, the Build CI workflow fails when running tests/test_button_handler.py. The error message:

==================================== ERRORS ====================================
________________ ERROR collecting tests/test_button_handler.py _________________
ImportError while importing test module '/home/runner/work/CircuitPython_Button_Handler/CircuitPython_Button_Handler/tests/test_button_handler.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/importlib/init.py:90: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/test_button_handler.py:10: in
from button_handler import *
button_handler.py:26: in
from keypad import Event, EventQueue
/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/keypad.py:15: in
import digitalio
/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/digitalio.py:12: in
from adafruit_blinka.agnostic import board_id, detector
E ModuleNotFoundError: No module named 'adafruit_blinka'
=========================== short test summary info ============================
ERROR tests/test_button_handler.py
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 0.15s ===============================
Error: Process completed with exit code 2.

No changes were made in this repository regarding workflows or tests on that branch, and this issue did not arise on other branches before.

[EGJ-Moorington]

Adafruit-Blinka is not downloaded properly as of release 8.60.0. This issue is tracked on adafruit/Adafruit_Blinka#974.

[FoamyGuy]

Definitely strange. I think this is different from the python 3.13 issue, but very likely related to the change-over to pyproject.toml that came with 8.60.0.

It's worth re-trying the action if possible under 8.60.1. I'm not sure if that can happen on already merged PR, but if you have anything else to commit you could try it. Honestly I'm not sure if that will resolve the problem though, I suspect not.

This error is a bit weird because it seems like adafruit-blinka did install successfully: https://github.com/EGJ-Moorington/CircuitPython_Button_Handler/actions/runs/15757726352/job/44416837828#step:2:441

but then during the test run it's unable to import it.

[EGJ-Moorington]

Read the Docs also fails to build with a similar error message:

Building wheels for collected packages: lgpio, sysv_ipc
--
46 | DEPRECATION: Building 'lgpio' using the legacy setup.py bdist_wheel mechanism, which will be removed in a future version. pip 25.3 will enforce this behaviour change. A possible replacement is to use the standardized build interface by setting the `--use-pep517` option, (possibly combined with `--no-build-isolation`), or adding a `pyproject.toml` file to the source tree of 'lgpio'. Discussion can be found at https://github.com/pypa/pip/issues/6334
47 | Building wheel for lgpio (setup.py): started
48 | Building wheel for lgpio (setup.py): finished with status 'error'
49 | error: subprocess-exited-with-error
50 |  
51 | × python setup.py bdist_wheel did not run successfully.
52 | │ exit code: 1
53 | ╰─> [8 lines of output]
54 | running bdist_wheel
55 | running build
56 | running build_py
57 | running build_ext
58 | building '_lgpio' extension
59 | swigging lgpio.i to lgpio_wrap.c
60 | swig -python -o lgpio_wrap.c lgpio.i
61 | error: command 'swig' failed: No such file or directory
62 | [end of output]
63 |  
64 | note: This error originates from a subprocess, and is likely not a problem with pip.
65 | ERROR: Failed building wheel for lgpio
66 | Running setup.py clean for lgpio
67 | DEPRECATION: Building 'sysv_ipc' using the legacy setup.py bdist_wheel mechanism, which will be removed in a future version. pip 25.3 will enforce this behaviour change. A possible replacement is to use the standardized build interface by setting the `--use-pep517` option, (possibly combined with `--no-build-isolation`), or adding a `pyproject.toml` file to the source tree of 'sysv_ipc'. Discussion can be found at https://github.com/pypa/pip/issues/6334
68 | Building wheel for sysv_ipc (setup.py): started
69 | Building wheel for sysv_ipc (setup.py): finished with status 'done'
70 | Created wheel for sysv_ipc: filename=sysv_ipc-1.1.0-cp313-cp313-linux_x86_64.whl size=74047 sha256=2f8e1314876241ccb4ae7866eebf485ec1bd9884332fd826073ae42b6f2d5d67
71 | Stored in directory: /tmp/pip-ephem-wheel-cache-xjeobd3q/wheels/0d/1a/84/e928fcee2420c31e26381d3e5ebcc6fdb65f1c9221cfb8c9ca
72 | Successfully built sysv_ipc
73 | Failed to build lgpio
74 | ERROR: Failed to build installable wheels for some pyproject.toml based projects (lgpio)

Building wheels for collected packages: lgpio, sysv_ipc
  DEPRECATION: Building 'lgpio' using the legacy setup.py bdist_wheel mechanism, which will be removed in a future version. pip 25.3 will enforce this behaviour change. A possible replacement is to use the standardized build interface by setting the `--use-pep517` option, (possibly combined with `--no-build-isolation`), or adding a `pyproject.toml` file to the source tree of 'lgpio'. Discussion can be found at https://github.com/pypa/pip/issues/6334
  Building wheel for lgpio (setup.py): started
  Building wheel for lgpio (setup.py): finished with status 'error'
  error: subprocess-exited-with-error
  
  × python setup.py bdist_wheel did not run successfully.
  │ exit code: 1
  ╰─> [8 lines of output]
      running bdist_wheel
      running build
      running build_py
      running build_ext
      building '_lgpio' extension
      swigging lgpio.i to lgpio_wrap.c
      swig -python -o lgpio_wrap.c lgpio.i
      error: command 'swig' failed: No such file or directory
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
  ERROR: Failed building wheel for lgpio
  Running setup.py clean for lgpio
  DEPRECATION: Building 'sysv_ipc' using the legacy setup.py bdist_wheel mechanism, which will be removed in a future version. pip 25.3 will enforce this behaviour change. A possible replacement is to use the standardized build interface by setting the `--use-pep517` option, (possibly combined with `--no-build-isolation`), or adding a `pyproject.toml` file to the source tree of 'sysv_ipc'. Discussion can be found at https://github.com/pypa/pip/issues/6334
  Building wheel for sysv_ipc (setup.py): started
  Building wheel for sysv_ipc (setup.py): finished with status 'done'
  Created wheel for sysv_ipc: filename=sysv_ipc-1.1.0-cp313-cp313-linux_x86_64.whl size=740[47](https://app.readthedocs.org/projects/circuitpython-button-handler/builds/28570946/#275362721--47) sha256=2f8e1314876241ccb4ae7866eebf485ec1bd9884332fd826073ae42b6f2d5d67
  Stored in directory: /tmp/pip-ephem-wheel-cache-xjeobd3q/wheels/0d/1a/84/e928fcee2420c31e26381d3e5ebcc6fdb65f1c9221cfb8c9ca
Successfully built sysv_ipc
Failed to build lgpio
ERROR: Failed to build installable wheels for some pyproject.toml based projects (lgpio)

[FoamyGuy]

The read the docs issue is more closely related to swig and the lgpio issue that we were talking about with the stubs. I'm not sure what the solution will be yet but we're working on it, and it should get fixed hopefully without needing any change in the library repos.

[EGJ-Moorington]

The Build CI does indeed still fail with the same error message with Adafruit-Blinka 8.60.1.

Read the Docs also fails with Adafruit-Blinka 8.60.1.

[FoamyGuy]

I have confirmed that the issue from test failures is a more general problem currently with latest Blinka releases. This is reproducable in the REPL by simply importing keypad

>>> from keypad import Event, EventQueue
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/timc/repos/circuitpython/.cpy_venv/lib/python3.12/site-packages/keypad.py", line 15, in <module>
    import digitalio
  File "/home/timc/repos/circuitpython/.cpy_venv/lib/python3.12/site-packages/digitalio.py", line 12, in <module>
    from adafruit_blinka.agnostic import board_id, detector
ModuleNotFoundError: No module named 'adafruit_blinka'

My guess is something about the adafruit_blinka module, which is a submodule within the full blinka library 😅, isn't declared correctly in the new config file. I'll try looking into it further.

[FoamyGuy]

I created an issue in blinka for this problem: adafruit/Adafruit_Blinka#975

[EGJ-Moorington]

Adafruit-Blinka 8.60.2 fixed the Build CI workflow, but not the Read the Docs building process.

[FoamyGuy]

Unfortunately I think this is going to require changing the RTD config in this repo (and all other libraries) to fix.

Here:

CircuitPython_Button_Handler/.readthedocs.yaml

Line 14 in 75caf19

python: "3"

I think it will need to change to 3.12. We're going to have to make this change in our libraries as well I believe.

[FoamyGuy]

Sorry that you're the first one to find this and thus are in the middle of so many different changes and proposed solutions.

Right now I am leaning toward adafruit/Adafruit_Blinka#977 as the solution to this problem. And counter to my previous post, I believe this should not require changing the config inside of library repos like this one.

[EGJ-Moorington]

Sorry that you're the first one to find this and thus are in the middle of so many different changes and proposed solutions.

No worries! It hasn't been that big of a deal for me, and it obviously wasn't anyone's fault, so everything's good :)

[EGJ-Moorington]

Adafruit-Blinka 8.60.3 fixed the issue and Read the Docs now builds the documentation successfully.

Thank you so much to @FoamyGuy for all the help and hard work! It is immensely appreciated.