Bazel rules py by GrayHoang · Pull Request #3542 · UBC-Thunderbots/Software

GrayHoang · 2025-12-23T17:43:17Z

Description

Commit history is cooked again and idk why. This PR switches us over to using a different version of py_binary and py_library in bazel, to fix some of our hermeticity issues and accommodate PyQt in a less cooked manner.

We can probably clean up setup software to remove a few more libraries from the local installation, since they got moved to the hermetic build. I'll look into this further.

https://github.com/aspect-build/rules_py
bazel-contrib/rules_python#508

Testing Done

Thunderscope compiles (finally)

Resolved Issues

Resolves #3533

Length Justification and Key Files to Review

Review Checklist

It is the reviewers responsibility to also make sure every item here has been covered

Function & Class comments: All function definitions (usually in the .h file) should have a javadoc style comment at the start of them. For examples, see the functions defined in thunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class.
Remove all commented out code
Remove extra print statements: for example, those just used for testing
Resolve all TODO's: All TODO (or similar) statements should either be completed or associated with a github issue

GrayHoang · 2025-12-23T17:44:36Z

I need someone to check that this works on ubuntu arm computers as there was something wrong with the pyqt distribution through pip last time we tried something like this.

Lmh-java

I ran thunderscope on my arm VM and it worked fine (after setup_software). Seems like you have fixed the pyqt mess. Left a few comments.

Lmh-java · 2025-12-24T02:05:19Z

environment_setup/setup_software.sh

-    host_software_packages+=(pyqt6-dev-tools)
-    host_software_packages+=(python3-pyqt6.qtsvg)
-
    virtualenv_opt_args="--system-site-packages"


I am guessing these will contaminate the dependency tree?

These are installations of pyqt6 into the local computer, which we no longer need. I think I need to write an additional line to uninstall an existing version of pyqt6 as well so it doesn't contaminate the tree.

Lmh-java · 2025-12-24T02:11:23Z

src/software/thunderscope/BUILD

+        "QTWEBENGINEPROCESS_PATH": "../.thunderscope_main.venv/lib/python3.12/site-packages/PyQt6/Qt6/libexec/QtWebEngineProcess",
+    },
+    package_collisions = "warning",
    deps = [


Who is managing this virtual environment? Is it bazel?

Yes, I believe it is Bazel by way of the aspect_rules_py reworking. Basically, the new aspect_rules_py pylibrary/ pybinary rules build the dependencies in a venv, instead of doing whatever Bazel did before, which was less rigorous and safe.

annieisawesome2 · 2025-12-24T05:38:07Z

I also tested on my arm VM. Set up software and ran thunderscope. Everything looks good to me!

GrayHoang · 2025-12-24T05:53:34Z

Ok so I'll need to refine the testing a bit further so that I can see exactly what I need to, I'll post a procedure in a sec

GrayHoang · 2025-12-24T05:54:06Z

I ran thunderscope on my arm VM and it worked fine (after setup_software). Seems like you have fixed the pyqt mess. Left a few comments.

Are you certain that pyqt was uninstalled from the local machine properly?

GrayHoang · 2025-12-26T20:14:16Z

Ok, so I updated some things and made the script uninstall the old pyqt libraries off the local machine. The output when running thunderscope should have this line saying PyQt is 6.10.0. If it is any other version, tell me, cause then things need fixing.

williamckha · 2026-01-06T02:21:35Z

environment_setup/ubuntu24_requirements.txt

-PyOpenGL==3.1.6
+
 ruff==0.5.5
 pyqt-toast-notification==1.3.2


pyqt-toast-notification can probably be removed here since it is already in software/thunderscope/requirements.in

williamckha · 2026-01-06T02:23:55Z

environment_setup/ubuntu24_requirements.txt

-pyqtgraph==0.13.7
 thefuzz==0.19.0
 iterfzf==0.5.0.20.0
 python-Levenshtein==0.25.1


I think python-Levenshtein can be safely removed here, I don't see any usages of Levenshtein in our code

python-Levenshtein is used for thefuzz.

oh interesting, I wonder why it isn't installed as a dependency of thefuzz

williamckha · 2026-01-06T02:24:59Z

environment_setup/ubuntu24_requirements.txt

 thefuzz==0.19.0
 iterfzf==0.5.0.20.0
 python-Levenshtein==0.25.1
 psutil==5.9.0


We can probably remove psutil here since it is in software/thunderscope/requirements.in and we don't need it to run tbots.py

williamckha · 2026-01-06T04:35:01Z

src/software/thunderscope/thunderscope.py

+from PyQt6.QtCore import PYQT_VERSION_STR, QT_VERSION_STR
+
+print(f"PyQt6 Version: {PYQT_VERSION_STR}")
+print(f"Qt Version (underlying C++ library): {QT_VERSION_STR}")
+


It would be better to put these logging statements in a function somewhere (maybe in initialize_application) and avoid running top-level code

that is true, I did it mostly for testing purposes so that I could assess if the pr was actually doing what it should be. It would be removed in the future, before this gets merged

williamckha · 2026-01-06T05:35:37Z

src/software/thunderscope/BUILD

+    env = {
+        "LD_LIBRARY_PATH": "../.thunderscope_main.venv/lib/python3.12/site-packages/PyQt6/Qt6/lib",
+        "QTWEBENGINEPROCESS_PATH": "../.thunderscope_main.venv/lib/python3.12/site-packages/PyQt6/Qt6/libexec/QtWebEngineProcess",
+    },


You may want to consider setting these environment variables in Python at runtime so you don't have to copy this for every py_binary and py_test. You'd have to do this before importing PyQt, so maybe at the top of thunderscope.py would be a good place. Something like:

# PyQt6 bundles Qt as native shared libraries and helper binaries that are not # discoverable when running under Bazel's sandboxed environment. In particular, # the dynamic linker cannot find Qt's .so files and QtWebEngine cannot locate its # QtWebEngineProcess helper unless explicitly told where they live. # Since the aspect_rules_py virtual env lives in the runfiles tree and its # location is only known at runtime, we derive these paths from $VIRTUAL_ENV # here and set the required env vars before importing PyQt6. qt_path = ( Path(os.environ["VIRTUAL_ENV"]) / "lib" / f"python{sys.version_info.major}.{sys.version_info.minor}" / "site-packages" / "PyQt6" / "Qt6" ) os.environ["LD_LIBRARY_PATH"] = str(qt_path / "lib") os.environ["QTWEBENGINEPROCESS_PATH"] = str(qt_path / "libexec" / "QtWebEngineProcess")

This seems to work fine as is, without needing to copy paste this to every py_binary and py_test. I think perhaps under the hood aspect_rules is doing the same thing?

williamckha · 2026-01-06T05:54:28Z

src/software/thunderscope/BUILD

@@ -1,3 +1,4 @@
+load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")


Should you be loading py_binary and py_library from aspect_rules_py in every BUILD file? Some BUILD files don't load them in, so I assume they're using the rules_python versions.

I think for consistency you are probably correct. I would also assume that if I don't explicitly load it, it uses the rules_python version. I just knew that specifically this was broken, and otherwise I didn't want to touch the other parts that seemed to work fine.

As a matter of fact, I believe that once this rule has been loaded, it will use aspect_build in every single BUILD file. This is shown by other BUILD files not compiling when the necessary libraries aren't explicitly listed as requirements, even in files where py_binary and py_library are not loaded. So it is consistent in usage.

…azel_rules_py

GrayHoang · 2026-02-08T05:12:31Z

I don't think tests are because of this pr...?

GrayHoang and others added 10 commits August 1, 2025 23:47

Add files via upload

33c20b5

Rename image.png to sml-error-msg.png

d251d7f

Merge branch 'master' of github.com:UBC-Thunderbots/Software

7e66688

remove image

75f220e

make all thunderscope dependencies hermetic, use rules_py

3911d26

merge conflict

98a4131

remove debugging tools

bff3e51

clean unneeded dependencies

45fd8cd

more cleaning

4d48707

clean setup_software

d462dec

GrayHoang requested review from Andrewyx, sauravbanna and williamckha as code owners December 23, 2025 17:43

[pre-commit.ci lite] apply automatic fixes

0d4b3b2

Lmh-java reviewed Dec 24, 2025

View reviewed changes

fix some bash scripting issue and add some debug

d8ba7be

GrayHoang and others added 2 commits January 3, 2026 11:50

retrigger checks

496a037

[pre-commit.ci lite] apply automatic fixes

3c269af

williamckha reviewed Jan 6, 2026

View reviewed changes

GrayHoang mentioned this pull request Jan 10, 2026

Add macOS ARM support for Thunderscope #3496

Merged

7 tasks

GrayHoang and others added 5 commits January 10, 2026 13:40

remove libraries and bugfix

9fce33a

Merge branch 'master' into bazel_rules_py

ee7630e

[pre-commit.ci lite] apply automatic fixes

911dc36

merge master

ceb6f6b

Merge branch 'bazel_rules_py' of github.com:GrayHoang/Software into b…

598a193

…azel_rules_py

[pre-commit.ci lite] apply automatic fixes

83a2178

		@@ -1,3 +1,4 @@
		load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")

Conversation

GrayHoang commented Dec 23, 2025

Description

Testing Done

Resolved Issues

Length Justification and Key Files to Review

Review Checklist

Uh oh!

GrayHoang commented Dec 23, 2025

Uh oh!

Lmh-java left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

annieisawesome2 commented Dec 24, 2025

Uh oh!

GrayHoang commented Dec 24, 2025

Uh oh!

GrayHoang commented Dec 24, 2025

Uh oh!

GrayHoang commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GrayHoang commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GrayHoang commented Dec 26, 2025 •

edited

Loading