py-pdf/pypdf

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

Aperta

#2020 aperta il 26 lug 2023

Vedi su GitHubGuida contributor
 (8 commenti) (0 reazioni) (0 assegnatari)Python (1258 fork)batch import
Easyhelp wantednf-documentation

Metriche repository

Star
 (6413 stelle)
Metriche merge PR
 (Merge medio 8g) (49 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la funzione logger warning in pypdf/ utils.py (righe 433-449) e le sue importazioni dirette nel codice, ad esempio pypdf/filters.py (riga 46). Rivedi gli 8 commenti nell'issue #2020 per le soluzioni proposte e il feedback dei maintainer. Crea una pagina di documentazione che spieghi come gli utenti possono personalizzare i record di log sovrascrivendo logger warning, includendo i passaggi per applicare patch alle importazioni e affrontando la limitazione dell'implementazione interna.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70