py-pdf/pypdf

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

Aberta

#2.020 aberto em 26 de jul. de 2023

Ver no GitHubGuia do colaborador
 (8 comentários) (0 reação) (0 responsável)Python (1.258 forks)batch import
Easyhelp wantednf-documentation

Métricas do repositório

Stars
 (6.413 estrelas)
Métricas de merge de PR
 (Mesclagem média 8d) (49 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Examine a função logger warning em pypdf/ utils.py (linhas 433-449) e suas importações diretas na base de código, por exemplo, pypdf/filters.py (linha 46). Revise os 8 comentários na issue #2020 para ver as soluções propostas e o feedback dos mantenedores. Crie uma página de documentação explicando como os usuários podem personalizar registros de log sobrescrevendo logger warning, incluindo etapas para aplicar patches nas importações e abordando a ressalva de implementação interna.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70