astral-sh/ruff

Make logger object name patterns configurable

Open

#12 613 ouverte le 1 août 2024

Voir sur GitHub
 (6 commentaires) (3 réactions) (0 assignés)Rust (2 088 forks)batch import
help wantedtype-inference

Métriques du dépôt

Stars
 (47 527 stars)
Métriques de merge PR
 (Merge moyen 5j 4h) (463 PRs mergées en 30 j)

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?

Guide contributeur

Direction de recherche
Examinez les motifs actuellement codés en dur dans `crates/ruff python semantic/src/analyze/logging.rs` (lignes 60-74). Passez en revue la façon dont les autres paramètres sont définis dans Ruff (par exemple dans `crates/ruff workspace/src/settings.rs`). Concevez une nouvelle option configurable (par exemple une liste de motifs regex) et mettez à jour la logique de détection des loggers. Ajoutez des tests dans la suite de tests existante pour vérifier que le nouveau paramètre fonctionne. Mettez à jour la documentation dans le livre Ruff si nécessaire.
Stack technique
pythonrust
Domaine
tooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50