TimeGuardian

Horario de tiempo

TimeGuardian es un paquete de Python diseñado para medir y registrar el tiempo de ejecución y el uso de las funciones de la memoria. Este paquete es particularmente útil para el monitoreo y la optimización del rendimiento en las aplicaciones de Python.

Características

• Decoradores para funciones de tiempo y uso de la memoria de registro.
• Registro personalizable para el tiempo de ejecución y el uso de la memoria con un rico formato.
• Registro condicional basado en el tiempo de ejecución y los umbrales de uso de la memoria.

Instalación

Instale TimeGuardian directamente desde PIP:

pip install timeguardian

O instalar desde el código fuente:

 cd path/to/TimeGuardian
pip install . 

Uso

Importe TimeGuardian desde el paquete timeguardian y úselo como decorador en sus funciones para medir su tiempo de ejecución y uso de la memoria.

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 avanzado

Monitorear el rendimiento con 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 

Establecer unidades globales para la medición de tiempo y memoria

El paquete TimeGuardian le permite establecer unidades globales para las mediciones de tiempo y memoria. Esta característica le permite personalizar cómo se informa el tiempo de ejecución y el uso de la memoria.

Uso

1. Establezca las unidades : use TimeGuardian.set_time_unit(unit) y TimeGuardian.set_memory_unit(unit) para establecer las unidades globales para la medición de tiempo y memoria. El parámetro unit debe ser una cadena que indique la unidad deseada (por ejemplo, 'ms' para milisegundos, 's' para segundos, 'bytes' para bytes, 'kb' para kilobytes, 'mb' para megabytes).

2. Decorar funciones : aplique el decorador @TimeGuardian.measure a sus funciones. Este decorador utilizará las unidades establecidas globalmente para medir y registrar el tiempo de ejecución y el uso de la memoria.

Ejemplo

 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 ()

En este ejemplo, sample_function se mide y registra en milisegundos para el tiempo y los megabytes para el uso de la memoria.

Que contribuye

¡Las contribuciones a TimeGuardian son bienvenidas!

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.