astral-sh/ruff

Make logger object name patterns configurable

Open

#12.613 geöffnet am 1. Aug. 2024

Auf GitHub ansehen
 (6 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)Rust (2.088 Forks)batch import
help wantedtype-inference

Repository-Metriken

Stars
 (47.527 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 4h) (463 gemergte PRs in 30 T)

Beschreibung

Currently, Ruff uses some hard-coded name "patterns" to determine whether a module-local object might be a logger (for the purposes of e.g. flake8-logging-format G rules).

https://github.com/astral-sh/ruff/blob/fc16d8d04d86aa94a8aac14bbb87089b64d443a1/crates/ruff_python_semantic/src/analyze/logging.rs#L60-L74

We've found that we have some loggers called _LOG which aren't matched, and I was disappointed to find that these aren't configurable. Maybe this should be a setting list of regular expressions or globs or something like that?

Contributor Guide

Research-Richtung
Untersuche die aktuellen hartkodierten Muster in `crates/ruff python semantic/src/analyze/logging.rs` (Zeilen 60-74). Überprüfe, wie andere Einstellungen in Ruff definiert sind (z. B. in `crates/ruff workspace/src/settings.rs`). Entwerfe eine neue konfigurierbare Option (z. B. eine Liste von Regex Mustern) und aktualisiere die Logger Erkennungslogik. Füge Tests in der bestehenden Testsuite hinzu, um zu überprüfen, ob die neue Einstellung funktioniert. Aktualisiere bei Bedarf die Dokumentation im Ruff Buch.
Tech Stack
pythonrust
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50