mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-11 13:17:07 +00:00
Adds six more rule families to the strict ruleset: - ``T10`` — committed ``breakpoint()`` / ``pdb`` calls - ``PGH`` — pygrep-hooks (blanket ``# type: ignore`` without code) - ``EXE`` — shebang/executable-bit consistency - ``RSE`` — ``raise X()`` style cleanups - ``ICN`` — standard import aliases - ``DTZ`` — tz-naive ``datetime`` bugs Fixes (99 violations cleared) ============================= EXE001 (68): every file with a Python shebang now has the executable bit set. Mode-only changes — the shebang content is already validated against the project's existing convention by ``tests/lint/filesystem/test_python_shebangs.py`` (``#\!/usr/bin/env python3`` for portable scripts, ``#\!/usr/bin/python`` for Ansible custom modules in ``library/``). PGH003 (17): removed blanket ``# type: ignore`` markers. The project doesn't run mypy/pyright in CI, so these were decoration only. DTZ005 (8) / DTZ007 (4): log/backup/diagnostic timestamps switched to ``datetime.now(tz=timezone.utc)`` so cross-host log correlation doesn't depend on each host's local TZ. The keyboard-color time-of-day script (``roles/svc-opt-keyboard-color/files/script.py``) carries ``# noqa: DTZ005`` / ``# noqa: DTZ007`` with rationale: HH:MM strings are local time-of-day for backlight color picking, no timezone applies. The OpenSSL date parser in ``utils/cert_utils.py`` anchors the parsed naive datetime to UTC explicitly via ``.replace(tzinfo=UTC)`` (openssl always emits the literal "GMT"). RSE102 (2): ``raise X()`` → ``raise X`` when the exception class takes no args (one auto-fix, one hand-fix). Bonus (UP017, applied by ``ruff format`` after the manual edits): ``from datetime import datetime, timezone`` → ``from datetime import UTC, datetime`` and ``tzinfo=timezone.utc`` → ``tzinfo=UTC`` (Python 3.11+ shorthand). Verification ============ - ``ruff check .`` → All checks passed - ``ruff format --check .`` → 894 files formatted - 1621 unit tests → all pass - Integration suite: 44 baseline failures, 1 skipped (unchanged) 86 files changed, +55 / −37 content lines, plus 68 mode-only changes (``chmod +x``). Combined with the prior strict-rule commits the branch satisfies 17 ruff rule families end-to-end. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
84 lines
2.3 KiB
Python
84 lines
2.3 KiB
Python
from __future__ import annotations
|
|
|
|
import contextlib
|
|
import os
|
|
import pty
|
|
import subprocess
|
|
from dataclasses import dataclass
|
|
from datetime import UTC, datetime
|
|
from pathlib import Path
|
|
from typing import TextIO
|
|
|
|
from cli.core.colors import Fore, color_text
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class RunConfig:
|
|
log_enabled: bool
|
|
|
|
|
|
def open_log_file(log_dir: Path) -> tuple[TextIO, Path]:
|
|
"""
|
|
Create/open a timestamped log file inside log_dir.
|
|
|
|
- log_dir is mandatory (provided via --log <LOG_DIR>)
|
|
- log_dir is created with parents=True if missing
|
|
"""
|
|
log_dir = log_dir.expanduser()
|
|
log_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Best-effort permission hardening (ignore failures on non-POSIX / special FS).
|
|
with contextlib.suppress(Exception):
|
|
os.chmod(log_dir, 0o700)
|
|
|
|
timestamp = datetime.now(tz=UTC).strftime("%Y%m%dT%H%M%S")
|
|
log_file_path = log_dir / f"{timestamp}.log"
|
|
fd = os.open(str(log_file_path), os.O_WRONLY | os.O_CREAT | os.O_APPEND, 0o600)
|
|
return os.fdopen(fd, "a", encoding="utf-8"), log_file_path
|
|
|
|
|
|
def run_command_once(
|
|
full_cmd: list[str], cfg: RunConfig, log_file: TextIO | None
|
|
) -> bool:
|
|
try:
|
|
if cfg.log_enabled and log_file is not None:
|
|
master_fd, slave_fd = pty.openpty()
|
|
proc = subprocess.Popen(
|
|
full_cmd,
|
|
stdin=slave_fd,
|
|
stdout=slave_fd,
|
|
stderr=slave_fd,
|
|
text=True,
|
|
)
|
|
os.close(slave_fd)
|
|
|
|
import errno
|
|
|
|
with os.fdopen(master_fd) as master:
|
|
try:
|
|
for line in master:
|
|
ts = datetime.now(tz=UTC).strftime("%Y-%m-%dT%H:%M:%S")
|
|
log_file.write(f"{ts} {line}")
|
|
log_file.flush()
|
|
print(line, end="")
|
|
except OSError as e:
|
|
if e.errno != errno.EIO:
|
|
raise
|
|
|
|
proc.wait()
|
|
rc = proc.returncode
|
|
else:
|
|
proc = subprocess.Popen(full_cmd)
|
|
proc.wait()
|
|
rc = proc.returncode
|
|
|
|
if rc != 0:
|
|
raise SystemExit(rc)
|
|
return True
|
|
|
|
except SystemExit:
|
|
raise
|
|
except Exception as e:
|
|
print(color_text(f"Exception running command: {e}", Fore.RED))
|
|
raise SystemExit(1) from e
|