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