mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-07 19:32:17 +00:00
kevinveenbirkenbachandClaude Opus 4.7
16e292e805
Extends ``[tool.ruff.lint].select`` with six additional rule families:
``RUF`` (ruff-specific), ``SIM`` (flake8-simplify), ``C4``
(flake8-comprehensions), ``PERF`` (perflint), ``RET`` (flake8-return),
``PIE`` (flake8-pie). Adds ``RUF001/002/003`` to ``ignore`` because
those exist for homoglyph-attack detection, not English typography —
the project uses em/en-dashes and ``ℹ`` as a UI-hint glyph in CLI help
output deliberately.
Auto-fixed (~225, mechanical & behavior-preserving)
====================================================
- RUF005: ``a + [b]`` → ``[*a, b]``
- C408: ``dict(k=v)`` → ``{"k": v}``
- C420: ``dict.fromkeys(seq)`` shape simplifications
- SIM103/SIM110/SIM118: truthy-return / dict-key / dict-method
idiom simplifications
- RET504/RET505: drop unneeded final assigns / ``else`` after
``return``
- PIE810: combine ``str.startswith(a) or .startswith(b)``
into one call with a tuple
- RUF010: ``f"{str(x)}"`` → ``f"{x\!s}"``
- RUF100: removed unused ``# noqa`` directives that
became stale (mostly old ``# noqa: E402``
markers that ruff's smart E402 implementation
no longer flags after ``sys.path`` shims)
- RUF015 / RUF013 / RUF022 / RUF046 / RUF059: misc small wins
- I001: re-sorted import blocks where the new
imports above shifted them
Hand-fixed (~140, scripted where mechanical)
============================================
PERF401 (42): scripted AST rewrite of
``for x in iter: target.append(expr)`` (with optional ``if`` guard)
→ ``target.extend(expr for x in iter [if cond])``.
``list.extend(genexp)`` consumes the generator immediately, so the
rewrite is semantically equivalent to the original eager loop.
SIM117 (41): scripted AST combiner for nested ``with`` blocks where
the inner is the only statement of the outer (38 sites). The remaining
3 multi-line ``patch.object(...)`` chains were combined by hand using
the parenthesised ``with (\\n A,\\n B,\\n):`` form.
SIM102 (14): scripted AST combiner for nested ``if`` (10 sites). The
remaining 4 carry an inline ``# noqa: SIM102`` with rationale —
combining would either change semantics (the outer body has siblings
beyond the inner ``if``, e.g. ``cli/encrypt/inventory/__main__.py``
where ``encrypted_value = …`` runs regardless of ``ask_confirmation``)
or hurt readability (long literal whitelists).
RUF012 (9): annotated mutable class attributes with ``ClassVar[…]``
and added ``from typing import ClassVar``.
SIM105 (6): ``try/except: pass`` → ``with contextlib.suppress(…):``
with the necessary ``import contextlib`` added. Verified on
``utils/templating.py`` (3 occurrences in a ``finally`` block) —
cleanup behaviour is identical.
SIM115 (4): wrapped ``tempfile.NamedTemporaryFile(..., delete=False)``
call patterns in a ``with`` block; ``delete=False`` keeps the file
on disk after the block, so callers' ``return f.name`` still works.
PERF402, PERF403, B007, SIM108, SIM103: 5 misc fixes (loop→list-copy,
loop→dict-comprehension, unused-loop-var rename, ternary, return
expression).
Verification
============
- ``ruff check .`` → All checks passed
- ``ruff format --check .`` → 894 files already formatted
- 1621 unit tests → all pass
- Integration suite: 44 baseline failures, 1 skipped (unchanged)
- Sample-audited PERF401 rewrites in ``resolver.py``, ``inventory.py``,
``cache/files.py``, ``ressources/__main__.py``; SIM117 in
``test_main.py``; SIM105 in ``utils/templating.py``; SIM102 noqa
rationales in ``cli/encrypt/inventory/__main__.py``.
182 files changed, +993 / −960. With this and the prior strict-rule
commit the branch satisfies 11 ruff rule families end-to-end.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
117 lines
4.0 KiB
Python
117 lines
4.0 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import unittest
|
|
from io import StringIO
|
|
from unittest.mock import patch
|
|
|
|
from utils.annotations.message import error, error_each, notice, warning, warning_each
|
|
|
|
GHA_ENV = {"GITHUB_ACTIONS": "true"}
|
|
NO_GHA_ENV = {"GITHUB_ACTIONS": ""}
|
|
|
|
|
|
class TestAnnotationsInGHA(unittest.TestCase):
|
|
"""Tests for GHA annotation format (GITHUB_ACTIONS=true)."""
|
|
|
|
def _capture(self, fn, *args, **kwargs) -> str:
|
|
with (
|
|
patch.dict(os.environ, GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
fn(*args, **kwargs)
|
|
return mock_out.getvalue().strip()
|
|
|
|
def test_warning_no_props(self) -> None:
|
|
out = self._capture(warning, "something went wrong")
|
|
self.assertEqual(out, "::warning::something went wrong")
|
|
|
|
def test_warning_with_title(self) -> None:
|
|
out = self._capture(warning, "msg", title="My Title")
|
|
self.assertEqual(out, "::warning title=My Title::msg")
|
|
|
|
def test_warning_with_file_and_line(self) -> None:
|
|
out = self._capture(warning, "msg", file="foo.py", line=42)
|
|
self.assertEqual(out, "::warning file=foo.py,line=42::msg")
|
|
|
|
def test_error_with_title(self) -> None:
|
|
out = self._capture(error, "bad", title="Oops")
|
|
self.assertEqual(out, "::error title=Oops::bad")
|
|
|
|
def test_notice_no_props(self) -> None:
|
|
out = self._capture(notice, "info")
|
|
self.assertEqual(out, "::notice::info")
|
|
|
|
def test_warning_each_emits_one_per_item(self) -> None:
|
|
with (
|
|
patch.dict(os.environ, GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
warning_each(["alpha", "beta", "gamma"], title="T")
|
|
lines = mock_out.getvalue().splitlines()
|
|
self.assertEqual(len(lines), 3)
|
|
self.assertIn("alpha", lines[0])
|
|
self.assertIn("beta", lines[1])
|
|
self.assertIn("gamma", lines[2])
|
|
|
|
def test_error_each_emits_one_per_item(self) -> None:
|
|
with (
|
|
patch.dict(os.environ, GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
error_each(["x", "y"], title="E")
|
|
lines = mock_out.getvalue().splitlines()
|
|
self.assertEqual(len(lines), 2)
|
|
self.assertTrue(all("::error" in line for line in lines))
|
|
|
|
def test_warning_each_empty(self) -> None:
|
|
with (
|
|
patch.dict(os.environ, GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
warning_each([])
|
|
self.assertEqual(mock_out.getvalue(), "")
|
|
|
|
|
|
class TestAnnotationsPlainText(unittest.TestCase):
|
|
"""Tests for plain text format (no GITHUB_ACTIONS)."""
|
|
|
|
def _capture(self, fn, *args, **kwargs) -> str:
|
|
with (
|
|
patch.dict(os.environ, NO_GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
fn(*args, **kwargs)
|
|
return mock_out.getvalue().strip()
|
|
|
|
def test_warning_no_props(self) -> None:
|
|
out = self._capture(warning, "something went wrong")
|
|
self.assertEqual(out, "[WARNING]: something went wrong")
|
|
|
|
def test_warning_with_title(self) -> None:
|
|
out = self._capture(warning, "msg", title="My Title")
|
|
self.assertEqual(out, "[WARNING] My Title: msg")
|
|
|
|
def test_error_with_title(self) -> None:
|
|
out = self._capture(error, "bad", title="Oops")
|
|
self.assertEqual(out, "[ERROR] Oops: bad")
|
|
|
|
def test_notice_no_props(self) -> None:
|
|
out = self._capture(notice, "info")
|
|
self.assertEqual(out, "[NOTICE]: info")
|
|
|
|
def test_warning_each_emits_one_per_item(self) -> None:
|
|
with (
|
|
patch.dict(os.environ, NO_GHA_ENV),
|
|
patch("sys.stdout", new_callable=StringIO) as mock_out,
|
|
):
|
|
warning_each(["alpha", "beta"], title="T")
|
|
lines = mock_out.getvalue().splitlines()
|
|
self.assertEqual(len(lines), 2)
|
|
self.assertIn("alpha", lines[0])
|
|
self.assertIn("beta", lines[1])
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|