Skip to content

Tidy the repo: lint in CI, cleaner .gitignore, README dev docs - #21

Merged
mlstr0m merged 7 commits into
mainfrom
agent/funny-dirac-vjofbi
Sep 28, 2026
Merged

mlstr0m merged 7 commits into
mainfrom
agent/funny-dirac-vjofbi

Conversation

@mlstr0m

@mlstr0m mlstr0m commented Sep 28, 2026

Copy link
Copy Markdown
Owner

Lint

  • ruff.toml enables ruff with pyflakes, syntax errors, bugbear and pyupgrade.
  • New Lint (ruff) CI job, which runs on Ubuntu.
  • Fixed its four findings:
    • raise … from None in config validation
    • socket.timeout → TimeoutError, its alias since Python 3.10, in dsu_server.py and tests/test_dsu.py

No unused imports or dead variables were found.

Housekeeping

  • .gitignore: removed duplicated entries (__pycache__ and *.pyc were listed twice), translated the comments to English, and now ignores .ruff_cache/.
  • README:
    • The project structure now lists .github/ (CI, release workflow, release notes) and ruff.toml.
    • New Development section covering tests, lint and the release steps.
    • DriverKit is described accurately: a system extension that needs a paid developer account to sign. The README previously said "kernel-level / not possible".

The ruff config lives in ruff.toml rather than pyproject.toml, so setuptools never picks it up during the py2app build.

The branch also carries a merge of its previous head, which was already squash-merged in #20. The diff against main is only this cleanup.

Tests pass locally; ruff check . is clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs


Generated by Claude Code

Protocol (sources cited in code and README):
- Byte 4 of the input report: Capture is 0x02 and C is 0x10, not the
  reverse. Agreed by ndeadly/switch2_controller_research (hid_reports.md),
  esp-cpp/espp PR #765 (switch2_pro_report.hpp) and the hardware capture
  in issue #14. Also fixes Capture -> DSU Touch.
- Read the factory stick calibration over the command channel
  (649d4ac9-...f005 / replies c765a961-...) and light player LED 1.
  Frame format, SPI addresses 0x130A8/0x130E8 and block layout adapted
  from kennethreitz/switch2bridge-macos@975f329 (issue #14, MIT), based on
  darthcloud/BlueRetro#1249; addresses match SDL's Switch 2 driver.
  Best effort: a silent controller keeps the nominal 2048 range.
- README: 7492866c-...c0f8 is notify-only, document the command channel.

Hardening:
- mappings.json written atomically (temp file + os.replace)
- "dsu.enabled" must be a boolean (bool("false") was True)
- warn when the DSU server is bound to a non-loopback address
- DSU socket: drop SO_REUSEADDR (useless for UDP; on Linux it let a
  second server silently share the port)
- worker -> UI messages taken atomically; stick hysteresis read under lock
- asyncio.get_running_loop(); logging set up at startup, not import

Build: Python 3.10+ (bleak 3 requires it), major-version upper bounds,
py2app moved to requirements-build.txt, CI matrix 3.10/3.12/3.13,
DMG README explains the macOS 15+ Gatekeeper "Open Anyway" flow.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs
Actions → Release → Run workflow (tag input): checks the tag matches
APP_VERSION and doesn't exist yet, runs the tests, builds the DMG, then
creates the tag and the GitHub release with the DMG attached, using
.github/release-notes/<tag>.md as the body with {{SHA256}} replaced by
the DMG checksum.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs
Follow-up to #17:
- the setup_logging tests now point LOG_DIR at a temp dir and detach
  their handler afterwards, instead of creating controller2.log in the
  real ~/Library/Logs/Switch2Bridge and leaving a handler on bridge.log
- Mappings.set_address() had no caller outside its own test

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs
- ruff (pyflakes, bugbear, pyupgrade) configured in ruff.toml and run as
  a CI job; fixed its four findings: `raise ... from None` in config
  validation, `socket.timeout` -> `TimeoutError` (alias since 3.10)
- .gitignore: drop duplicated entries, English comments, ignore .ruff_cache
- README: project structure lists .github/ (CI, release workflow, notes)
  and ruff.toml; new Development section (tests, lint, release steps);
  DriverKit is a system extension needing a paid developer account, not
  "kernel-level" / "not possible"

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs
@mlstr0m
mlstr0m merged commit 13e7322 into main Sep 28, 2026
5 checks passed
mlstr0m pushed a commit that referenced this pull request Sep 28, 2026
mlstr0m pushed a commit that referenced this pull request Sep 28, 2026
Covers #17 (--config, ble.address, per-config logs), #20, #21 (lint in
CI) and #22 (…f8 known input characteristic).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SGsFjHBorX2mfsanZhFyzs
@mlstr0m mlstr0m mentioned this pull request Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants