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