TimeGuardian

Gardien de temps

TimeGuardian est un package Python conçu pour mesurer et enregistrer le temps d'exécution et l'utilisation de la mémoire des fonctions. Ce package est particulièrement utile pour la surveillance et l'optimisation des performances dans les applications Python.

Caractéristiques

• Décorateurs pour les fonctions de synchronisation et utilisation de la mémoire de l'exploitation forestière.
• Journalisation personnalisable pour le temps d'exécution et l'utilisation de la mémoire avec un formatage riche.
• Journalisation conditionnelle basée sur le temps d'exécution et les seuils d'utilisation de la mémoire.

Installation

Installez TimeGuardian directement de PIP:

pip install timeguardian

Ou, installez à partir du code source:

 cd path/to/TimeGuardian
pip install . 

Usage

Importez TimeGuardian du package timeguardian et utilisez-le comme décorateur sur vos fonctions pour mesurer leur temps d'exécution et leur utilisation de la mémoire.

Utilisation de base

 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

Utilisation avancée

Surveiller les performances avec journalisation conditionnelle:

 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 

Définition des unités globales pour la mesure du temps et de la mémoire

Le package TimeGuardien vous permet de définir des unités mondiales pour les mesures de temps et de mémoire. Cette fonctionnalité vous permet de personnaliser la façon dont le temps d'exécution et l'utilisation de la mémoire sont signalés.

Usage

1. Définissez les unités : utilisez TimeGuardian.set_time_unit(unit) et TimeGuardian.set_memory_unit(unit) pour définir les unités globales pour la mesure du temps et de la mémoire. Le paramètre unit doit être une chaîne indiquant l'unité souhaitée (par exemple, «MS» pour les millisecondes, «s» pour les secondes, les «octets» pour les octets, «KB» pour les kilo-dystes, «MB» pour les mégaoctes).

2. Fonctions de décorer : appliquez le décorateur @TimeGuardian.measure à vos fonctions. Ce décorateur utilisera les unités de réglage mondial pour mesurer et enregistrer le temps d'exécution et l'utilisation de la mémoire.

Exemple

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

Dans cet exemple, sample_function est mesuré et connecté en millisecondes pour le temps et les mégaoctets pour l'utilisation de la mémoire.

Contributif

Les contributions à TimeGuardian sont les bienvenues!

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.