tooling: Enable ruff A, B, E722, and PERF rules. by nedseb · Pull Request #294 · steamicc/micropython-steami-lib

nedseb · 2026-03-28T17:40:35Z

Summary

Enable 4 new ruff rule sets and fix all violations:

Rules enabled

A (flake8-builtins): prevent shadowing Python builtins
B (flake8-bugbear): catch common bug patterns
E722: re-enabled bare except detection (was ignored, 0 violations)
PERF (Perflint): detect performance anti-patterns

Fixes applied

id → device_id in apds9960 exception (A002)
format → fmt in bq27441 read_word (A002)
dir → direction in ism330dl example (A001)
lambda: accel → lambda a=accel: a to bind loop variable (B023)
for i in → for _ in for unused loop variables (B007 ×2)
raise ... from err for exception chaining (B904)
PERF203 ignored in examples (try/except in I2C bus scan is intentional)

Rules investigated but not enabled

ERA (commented-out code): too many false positives on register comments
SIM (simplify): some rules incompatible with MicroPython (deferred to tooling: Enable ruff SIM (simplify) rules. #287)

Closes #286, closes #288, closes #290, closes #292

Test plan

make ci passes (196 mock tests + 271 example validations)
ruff check passes with all new rules

Copilot

Pull request overview

Enables additional Ruff lint rule sets (A, B, E722, PERF) and updates code/examples to resolve newly-detected violations across the repository.

Changes:

Updated pyproject.toml Ruff configuration to select A, B, and PERF rules, and to stop ignoring E722.
Refactored a few drivers/tests to avoid builtin-shadowing and improve exception chaining.
Cleaned up examples to address bugbear/perf warnings (unused loop variables, closure binding, builtin-shadowing).

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/runner/mpremote_bridge.py	Adds exception chaining for JSON decode failures.
pyproject.toml	Enables new Ruff rule sets and adjusts per-file ignores for examples.
lib/ssd1327/examples/random_pixels.py	Fixes unused loop variable warning.
lib/ssd1327/examples/framebuf_scroll.py	Fixes unused loop variable warning.
lib/lis2mdl/examples/tilt_compensated_heading.py	Binds loop variable in lambda to satisfy bugbear closure rule.
lib/ism330dl/examples/static_orientation.py	Renames `dir` to avoid builtin shadowing.
lib/bq27441/bq27441/device.py	Renames `format` parameter to avoid builtin shadowing.
lib/apds9960/apds9960/exceptions.py	Renames `id` parameter to avoid builtin shadowing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-28T17:43:36Z


    # Read a 16 - bit command word from the BQ27441-G1A, def format = little endian int16
-    def read_word(self, sub_address, format="<h"):
+    def read_word(self, sub_address, fmt="<h"):


read_word() renamed its second parameter from format to fmt. This avoids shadowing the builtin, but it is a breaking change for any callers using the format= keyword. Consider keeping backward compatibility (e.g., accept format via **kwargs/alias with a deprecation path) or making this an explicitly private helper if it’s not intended as public API.

Suggested change

def read_word(self, sub_address, fmt="<h"):

def read_word(self, sub_address, fmt="<h", **kwargs):

# Backward compatibility: accept legacy 'format=' keyword argument

if "format" in kwargs:

fmt = kwargs["format"]

Copilot · 2026-03-28T17:43:37Z

@@ -470,9 +470,9 @@ def soft_reset(self):
        return self.execute_control_word(BQ27441_CONTROL_SOFT_RESET)

    # Read a 16 - bit command word from the BQ27441-G1A, def format = little endian int16


The comment above read_word() still refers to the parameter name format, but the argument is now called fmt. Update the comment to match the new signature to avoid confusing readers.

Suggested change

# Read a 16 - bit command word from the BQ27441-G1A, def format = little endian int16

# Read a 16-bit command word from the BQ27441-G1A, default fmt = little-endian int16

Copilot · 2026-03-28T17:43:37Z

 class APDS9960InvalidDevId(ValueError):
-    def __init__(self, id, valid_ids):
+    def __init__(self, device_id, valid_ids):
        Exception.__init__(
            self,
            "Device id 0x{} is not a valid one (valid: {})!".format(
-                format(id, "02x"),
+                format(device_id, "02x"),


APDS9960InvalidDevId.__init__ renamed the parameter from id to device_id. If any external code instantiates this exception using the id= keyword, it will now fail. Consider accepting the old keyword as an alias (with a deprecation note) or documenting this as an intentional API break.

Copilot · 2026-03-28T17:43:37Z

 # manifest.py files are evaluated with some global names pre-defined
 "**/manifest.py" = ["F821"]
-"**/examples/*.py" = ["T20", "N806"]
+"**/examples/*.py" = ["T20", "N806", "PERF203"]


PERF203 is now ignored for all **/examples/*.py. Since the known violation is localized (e.g. lib/mcp23009e/examples/i2c_scan.py has a try/except inside a loop), consider scoping the ignore to just that file (or adding an inline # noqa: PERF203) so future examples can still benefit from PERF203 feedback.

Suggested change

"**/examples/*.py" = ["T20", "N806", "PERF203"]

"**/examples/*.py" = ["T20", "N806"]

"lib/mcp23009e/examples/i2c_scan.py" = ["PERF203"]

nedseb · 2026-03-28T17:45:57Z

Commentaires Copilot traités dans 0735ba9 :

read_word comment obsolète — mis à jour pour refléter le nouveau nom fmt.
read_word format→fmt breaking — non modifié. Vérifié : aucun appel avec format= en keyword dans la codebase. Le paramètre n'est jamais passé par nom.
APDS9960InvalidDevId id→device_id breaking — non modifié. Exception interne, jamais instanciée avec id= en keyword.
PERF203 scope trop large — corrigé. Restreint à lib/mcp23009e/examples/i2c_scan.py uniquement au lieu de tous les exemples.

semantic-release-updater · 2026-03-28T17:47:14Z

🎉 This PR is included in version 0.2.3 🎉

The release is available on:

v0.2.3
GitHub release

Your semantic-release bot 📦🚀

tooling: Enable ruff A, B, E722, and PERF rules.

7201506

Copilot AI review requested due to automatic review settings March 28, 2026 17:40

github-actions Bot assigned nedseb Mar 28, 2026

Copilot started reviewing on behalf of nedseb March 28, 2026 17:40 View session

Copilot AI reviewed Mar 28, 2026

View reviewed changes

tooling: Fix Copilot review comments on ruff rules PR.

0735ba9

nedseb merged commit 3f2bc44 into main Mar 28, 2026
9 checks passed

nedseb deleted the tooling/ruff-e722-perf branch March 28, 2026 17:46

semantic-release-updater Bot added the released label Mar 28, 2026

nedseb mentioned this pull request Mar 29, 2026

docs: Update CONTRIBUTING.md linting section to match current ruff configuration #310

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tooling: Enable ruff A, B, E722, and PERF rules.#294

tooling: Enable ruff A, B, E722, and PERF rules.#294
nedseb merged 2 commits into
mainfrom
tooling/ruff-e722-perf

nedseb commented Mar 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 28, 2026

Uh oh!

Copilot AI Mar 28, 2026

Uh oh!

Copilot AI Mar 28, 2026

Uh oh!

Copilot AI Mar 28, 2026

Uh oh!

nedseb commented Mar 28, 2026

Uh oh!

Uh oh!

semantic-release-updater Bot commented Mar 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-    def read_word(self, sub_address, fmt="<h"):
+    def read_word(self, sub_address, fmt="<h", **kwargs):
+        # Backward compatibility: accept legacy 'format=' keyword argument
+        if "format" in kwargs:
+            fmt = kwargs["format"]

		@@ -470,9 +470,9 @@ def soft_reset(self):
		return self.execute_control_word(BQ27441_CONTROL_SOFT_RESET)

		# Read a 16 - bit command word from the BQ27441-G1A, def format = little endian int16

	# Read a 16 - bit command word from the BQ27441-G1A, def format = little endian int16
	# Read a 16-bit command word from the BQ27441-G1A, default fmt = little-endian int16

	"*/examples/.py" = ["T20", "N806", "PERF203"]
	"*/examples/.py" = ["T20", "N806"]
	"lib/mcp23009e/examples/i2c_scan.py" = ["PERF203"]

Conversation

nedseb commented Mar 28, 2026

Summary

Rules enabled

Fixes applied

Rules investigated but not enabled

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

Uh oh!

nedseb commented Mar 28, 2026

Uh oh!

Uh oh!

semantic-release-updater Bot commented Mar 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants