py-pdf/pypdf

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

Offen

#2.020 geöffnet am 26.07.2023

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.258 Forks)batch import
Easyhelp wantednf-documentation

Repository-Metriken

Stars
 (6.413 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (49 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche die Funktion logger warning in pypdf/ utils.py (Zeilen 433-449) und ihre direkten Importe im Codebase, z.B. pypdf/filters.py (Zeile 46). Überprüfe die 8 Kommentare in Issue #2020 für vorgeschlagene Lösungen und Feedback der Maintainer. Erstelle eine Dokumentationsseite, die erklärt, wie Benutzer Log Einträge anpassen können, indem sie logger warning überschreiben, einschließlich Schritten zum Patchen von Importen und dem Umgang mit der internen Implementierungseinschränkung.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70