TimeGuardian

Zeitgänger

TimeGuardian ist ein Python -Paket, das für die Messung und Protokollierung der Ausführungszeit und zum Speicherverbrauch von Funktionen entwickelt wurde. Dieses Paket ist besonders nützlich für die Leistungsüberwachung und -optimierung in Python -Anwendungen.

Merkmale

• Dekorateure für Timing -Funktionen und die Verwendung von Speicherverbrauch.
• Anpassbare Protokollierung für die Ausführungszeit und den Speicherverbrauch mit reichhaltiger Formatierung.
• Bedingte Protokollierung basierend auf Ausführungszeit und Speicherverbrauchsschwellen.

Installation

Installieren Sie den Zeitgänger direkt von PIP:

pip install timeguardian

Oder installieren Sie aus dem Quellcode:

 cd path/to/TimeGuardian
pip install . 

Verwendung

Importieren Sie TimeGuardian aus dem timeguardian -Paket und verwenden Sie es als Dekorateur in Ihren Funktionen, um ihre Ausführungszeit und den Speicherverbrauch zu messen.

Grundnutzung

 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

Erweiterte Verwendung

Überwachen Sie die Leistung mit bedingter Protokollierung:

 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 

Globale Einheiten für Zeit- und Speichermessung einstellen

Mit dem Zeitgüterpaket können Sie globale Einheiten für Zeit- und Speichermessungen festlegen. Mit dieser Funktion können Sie anpassen, wie die Ausführungszeit und die Speicherverwendung gemeldet werden.

Verwendung

1. Setzen Sie die Einheiten : Verwenden Sie TimeGuardian.set_time_unit(unit) und TimeGuardian.set_memory_unit(unit) um die globalen Einheiten für Zeit- und Speichermessung festzulegen. Der unit sollte eine Zeichenfolge sein, die die gewünschte Einheit angibt (z. B. 'MS' für Millisekunden, 's' für Sekunden, 'Bytes' für Bytes, 'KB' für Kilobytes, 'MB' für Megabyte).

2. Funktionen dekorieren : Wenden Sie den Dekorateur @TimeGuardian.measure auf Ihre Funktionen an. Dieser Dekorateur verwendet die global festgelegten Einheiten, um die Ausführungszeit und den Speicherverbrauch zu messen und zu protokollieren.

Beispiel

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

In diesem Beispiel wird sample_function gemessen und in Millisekunden für Zeit und Megabyte für den Speicherverbrauch angemessen.

Beitragen

Beiträge zu TimeGuardian sind willkommen!

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.