py-pdf/pypdf

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

Open

#2,020 opened on Jul 26, 2023

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)Python (1,258 forks)batch import
Easyhelp wantednf-documentation

Repository metrics

Stars
 (6,413 stars)
PR merge metrics
 (Avg merge 8d) (49 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Read the pypdf documentation on logging and the logger warning function in utils.py. Identify the best approach to customize logs without relying on internal implementation details. Propose a solution that exposes a public API for logging customization.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70