py-pdf/pypdf

DOC: How to handle / customize log records emitted by pypdf

開放

#2,020 建立於 2023年7月26日

在 GitHub 查看貢獻者指南
 (8 則留言) (0 個反應) (0 位負責人)Python (1,258 個分叉)batch import
Easyhelp wantednf-documentation

倉庫指標

星標
 (6,413 顆星)
PR 合併指標
 (平均合併 8天) (30 天內合併 49 個 PR)

描述

Explanation

According to https://github.com/py-pdf/pypdf/blob/11ee6480a3f795d770da89944f32a977e3c110e2/pypdf/_utils.py#L433-L449

logger_warning is advertised to allow overwriting, but doing so proves to be more complicated than expected.

There basically are two reasons for this:

  1. The implementation is located at pypdf._utils.logger_warning, which usually marks an internal implementation and thus I would not assume this to be future-proof.
  2. The method usually is imported directly, as can be seen in https://github.com/py-pdf/pypdf/blob/11ee6480a3f795d770da89944f32a977e3c110e2/pypdf/filters.py#L46 for example. This requires patching each import separately.

貢獻者指南

研究方向
檢查 pypdf/ utils.py 中第 433-449 行的 logger warning 函數及其在程式碼庫中的直接導入，例如 pypdf/filters.py 第 46 行。查閱 issue #2020 中的 8 則評論，了解提議的解決方案和維護者回饋。建立一個文件頁面，解釋使用者如何透過覆寫 logger warning 來自訂日誌記錄，包括修補導入的步驟以及解決內部實作注意事項。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70