Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 4fc6105451fd2aa82565d1c5d3ae548173257130
commit4fc6105451fd2aa82565d1c5d3ae548173257130[log] [tgz]
authorAnthony DiGirolamo <tonymd@pigweed.infra.roller.google.com>Thu Oct 10 22:56:41 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Oct 10 22:56:41 2024 +0000
tree03d1261fcfa9aa32713fa12f73324e8eca2db53d
parented9b85b2cc7c32a04e2f20462ce3d1ec0c36da1e [diff]
roll: pigweed python: Add ruff linting

- Add GN Python static analysis tool support for
  ruff. E.g. python.lint.ruff. This is ommited from the default build
  until rules are stablized.
- Create a .ruff.toml, add to all Python targets.
- Add a GN arg to control which Python static analysis tools are run
  by default: pw_build_PYTHON_STATIC_ANALYSIS_TOOLS.
- Set pw_build_PYTHON_STATIC_ANALYSIS_TOOLS to just "mypy" and
  "pylint".

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/159050
Original-Revision: ebf33f56b6b693aa8e705829fea2c97b0b63c743

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: d44807b36fed50..ebf33f56b6b693
Roller-URL: https://ci.chromium.org/b/8734424436419404721
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I43091076f51089a109d74e22dacba21624f0c6d1
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/241300
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 03d1261fcfa9aa32713fa12f73324e8eca2db53d
  1. .github/
  2. .vscode/
  3. apps/
  4. modules/
  5. system/
  6. targets/
  7. tools/
  8. .bazelignore
  9. .bazelrc
  10. .bazelversion
  11. .buildifier.json
  12. .clang-format
  13. .clangd.shared
  14. .gitignore
  15. .pw_console.yaml
  16. AUTHORS
  17. BUILD.bazel
  18. CONTRIBUTING.md
  19. LICENSE
  20. MODULE.bazel
  21. OWNERS
  22. pigweed.json
  23. README.md
README.md

Pigweed: minimal Bazel example

This repository contains a minimal example of a Bazel-based Pigweed project. It is a LED-blinking service (featuring RPC control!) for the Raspberry Pi Pico. It can also be run on any computer using the included simulator.

Getting the code

git clone https://pigweed.googlesource.com/pigweed/quickstart/bazel pw_bazel_quickstart
cd pw_bazel_quickstart

Dependencies

The only dependency that must be installed is Bazelisk.

Bazelisk is a launcher for the Bazel build system that allows for easy management of multiple Bazel versions.

Instructions for installing Bazelisk can be found here.

Running on the simulator

To run the simulator, type: bazelisk run //apps/blinky:simulator_blinky Then, in a new console, connect to the simulator using: bazelisk run //apps/blinky:simulator_console

Running on hardware

To start, connect a Raspberry Pi Pico, Pico 2, or debug probe via USB.

To run on the Raspberry Pi Pico, type: bazelisk run //apps/blinky:flash_rp2040 Then, in a new console, connect to the device using: bazelisk run //apps/blinky:rp2040_console

Controlling the LED

Once connected with a console, RPCs can be sent to control the LED. Try running:

device.set_led(True)
device.set_led(False)
device.toggle_led()
device.blink(blink_count=3)

Running unit tests on the host device

bazelisk test //... will run the unit tests defined in this project, such as the ones in modules/blinky/blinky_test.cc.

Running unit tests on hardware

bazelisk run @pigweed//targets/rp2040/py:unit_test_server in one console followed by bazelisk test //... --config=rp2040 will also allow running the unit tests on-device.

Next steps

Try poking around the codebase for inspiration about how Pigweed projects can be organized. Most of the relevant code in this quickstart (including RPC definitions) is inside modules/blinky, with some client-side Python code in tools/console.py.