astral-sh/ruff

Make logger object name patterns configurable

Open

#12,613 创建于 2024年8月1日

在 GitHub 查看
 (6 评论) (3 反应) (0 负责人)Rust (2,088 fork)batch import
help wantedtype-inference

仓库指标

Star
 (47,527 star)
PR 合并指标
 (平均合并 5天 4小时) (30 天内合并 463 个 PR)

描述

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?

贡献者指南

研究方向
检查 `crates/ruff python semantic/src/analyze/logging.rs` 中当前硬编码的模式（第 60-74 行）。回顾 Ruff 中其他设置是如何定义的（例如在 `crates/ruff workspace/src/settings.rs` 中）。设计一个新的可配置选项（例如一个正则表达式模式列表）并更新日志记录器检测逻辑。在现有测试套件中添加测试以验证新设置是否有效。如有需要，更新 Ruff 文档中的相关内容。
技术栈
pythonrust
领域
tooling
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50