astral-sh/ruff

Make logger object name patterns configurable

Open

#12.613 aberto em 1 de ago. de 2024

Ver no GitHub
 (6 comments) (3 reactions) (0 assignees)Rust (2.088 forks)batch import
help wantedtype-inference

Métricas do repositório

Stars
 (47.527 stars)
Métricas de merge de PR
 (Mesclagem média 5d 4h) (463 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
Examine os padrões atualmente embutidos em código em `crates/ruff python semantic/src/analyze/logging.rs` (linhas 60-74). Revise como outras configurações são definidas no Ruff (por exemplo, em `crates/ruff workspace/src/settings.rs`). Projete uma nova opção configurável (por exemplo, uma lista de padrões regex) e atualize a lógica de detecção de logger. Adicione testes na suíte de testes existente para verificar se a nova configuração funciona. Atualize a documentação no livro do Ruff, se necessário.
Pilha de tecnologia
pythonrust
Domain
tooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50