astral-sh/ruff

Make logger object name patterns configurable

Open

#12,613 opened on Aug 1, 2024

View on GitHub
 (6 comments) (3 reactions) (0 assignees)Rust (47,527 stars) (2,088 forks)batch import
help wantedtype-inference

Description

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

Tech stack
pythonrust
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.
Make logger object name patterns configurable · astral-sh/ruff#12613 | Good First Issue