sphinx.ext.duration – Mede durações de processamento do Sphinx

Adicionado na versão 2.4.

Esta extensão mede a duração do processamento do Sphinx durante a leitura de documentos e é útil para inspecionar quais documentos são construídos lentamente. As durações são exibidas no console ao final da construção e salvas em um arquivo JSON no diretório de saída por padrão.

Habilite esta extensão adicionando 'sphinx.ext.duration' à lista extensions no seu conf.py:

extensions = [
    ...
    'sphinx.ext.duration',
]

Configuração

duration_print_total
Tipo:
bool
Padrão:
True

Mostra a duração total da leitura no resumo da construção, por exemplo:

====================== total reading duration ==========================
Total time reading 31 files: 0m 3.142s

Adicionado na versão 9.0.

duration_print_slowest
Tipo:
bool
Padrão:
True

Exibe as durações mais lentas no resumo de construção. As durações são classificadas em ordem crescente de lentidão. Isso exibe até duration_n_slowest durações, por exemplo:

====================== slowest 5 reading durations =======================
0.012s spam
0.011s ham
0.011s eggs
0.006s lobster
0.005s beans

Adicionado na versão 9.0.

duration_n_slowest
Tipo:
int
Padrão:
5

Número máximo de durações mais lentas a serem exibidas no resumo da construção quando duration_print_slowest está ativado. Por padrão, apenas as 5 durações mais lentas são exibidas. Defina este valor como 0 para exibir todas as durações.

Adicionado na versão 9.0.

duration_write_json
Tipo:
str | None
Padrão:
'sphinx-reading-durations.json'

Grava todas as durações de leitura em um arquivo JSON no diretório de saída. O conteúdo do arquivo é um mapeamento dos nomes dos documentos para as durações de leitura, onde os nomes dos documentos são strings e as durações são números de ponto flutuante em segundos. Defina este valor como uma string vazia ou None para desativar a gravação do arquivo, ou defina-o como um caminho relativo para personalizá-lo.

Isso pode ser útil para testar e definir um limite de tempo de leitura.

Adicionado na versão 9.0.

duration_limit
Tipo:
float | int | None
Padrão:
None

Define um limite de duração (em segundos) para a leitura de um documento. Se a duração exceder esse valor, um aviso será exibido.

Adicionado na versão 9.0.