astral-sh/ruff

Make logger object name patterns configurable

Open

Aperta il 1 ago 2024

Vedi su GitHub
 (6 commenti) (3 reazioni) (0 assegnatari)Rust (47.527 star) (2088 fork)batch import
help wantedtype-inference

Descrizione

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?

Guida contributor

Tech stack
pythonrust
Dominio
tooling
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50
Direzione di ricerca
Examine the current hard coded patterns in `crates/ruff python semantic/src/analyze/logging.rs` (lines 60-74). Review how other settings are defined in Ruff (e.g., in `crates/ruff workspace/src/settings.rs`). Design a new configurable option (e.g., a list of regex patterns) and update the logger detection logic. Add tests in the existing test suite to verify the new setting works. Update documentation in the Ruff book if needed.