TimeGuardian

Timeguardian

O Timeguardian é um pacote Python projetado para medir e registrar o tempo de execução e o uso da memória das funções. Este pacote é particularmente útil para monitoramento e otimização de desempenho em aplicativos Python.

Características

• Decoradores para funções de tempo e uso de memória de registro.
• Registro personalizável para o tempo de execução e o uso da memória com formatação rica.
• O registro condicional com base no tempo de execução e nos limites de uso da memória.

Instalação

Instale o Timeguardian diretamente do PIP:

pip install timeguardian

Ou instale no código -fonte:

 cd path/to/TimeGuardian
pip install . 

Uso

Importar TimeGuardian do pacote timeguardian e use -o como decorador em suas funções para medir o tempo de execução e o uso da memória.

Uso básico

 from timeguardian import TimeGuardian

# To measure execution time and/or memory usage
@ TimeGuardian . measure
def my_function ():
    # function implementation

# Custom name logging
@ TimeGuardian . measure ( name = "CustomName" )
def another_function ():
    # function implementation


# Custom logging with name, time and memory
@ TimeGuardian . measure ( name = "CustomName" , elapsed = True , memory = True ) #(elapsed in ms, memory in bytes)
def another_function ():
    # function implementation

Uso avançado

Monitore o desempenho com registro condicional:

 from timeguardian import TimeGuardian

# Monitor and log only if execution time or memory usage exceeds the specified limits (time in ms, memory in bytes)
@ TimeGuardian . monitor ( elapsed = 200 , memory = 1024 )
def monitored_function ():
    # function implementation 

Definir unidades globais para medição de tempo e memória

O pacote Timeguardian permite definir unidades globais para medições de tempo e memória. Esse recurso permite personalizar como o tempo de execução e o uso da memória são relatados.

Uso

1. Defina as unidades : use TimeGuardian.set_time_unit(unit) e TimeGuardian.set_memory_unit(unit) para definir as unidades globais para medição de tempo e memória. O parâmetro unit deve ser uma sequência indicando a unidade desejada (por exemplo, 'ms' para milissegundos, 's' por segundos, 'bytes' para bytes, 'kb' para kilobytes, 'mb' para megabytes).

2. Funções de decorar : aplique o @TimeGuardian.measure Decorator às suas funções. Este decorador usará as unidades definidas globalmente para medir e registrar o tempo de execução e o uso da memória.

Exemplo

 from decorators import TimeGuardian

# Set the units for time and memory measurements
TimeGuardian . set_time_unit ( 'ms' )  # Set time unit to milliseconds
TimeGuardian . set_memory_unit ( 'MB' )  # Set memory unit to megabytes

@ TimeGuardian . measure ( elapsed = True , memory = True , name = "Sample Function" )
def sample_function ():
    # Function implementation
    ...

# Call the decorated function
sample_function ()

Neste exemplo, sample_function é medido e registrado em milissegundos por tempo e megabytes para uso de memória.

Contribuindo

As contribuições para o Timeguardian são bem -vindas!

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.