logly Download - logly Source Code herunterladen

Meiden Sie, dass Sie einen benutzerdefinierten Protokollierungscode für Ihre Python -Anwendungen schreiben?

Logly ist ein protokolliertes Dienstprogramm zur Aufgabe, das eine einfache Möglichkeit bietet, Nachrichten mit unterschiedlichen Ebenen, Farben und vielen benutzerdefinierten Optionen zu protokollieren. Es ist so konzipiert, dass es flexibel ist, sodass Sie die Protokollnachrichten basierend auf den Anforderungen Ihrer Anwendung anpassen können. Logy unterstützt die Anmeldung sowohl bei der Konsole als auch bei einer Datei und verfügt über integrierte farbcodierte Protokollpegel, um eine bessere Sichtbarkeit zu erhalten.

Wenn Ihnen dieses Projekt gefällt, stellen Sie sicher, dass Sie mitspielen? Es im Repository und wenn Sie einen Beitrag leisten möchten, stellen Sie dieses Repository ❤ auf.

Inhaltsverzeichnis

Einführung
Installation
Merkmale
Verwendung
- Erste Schritte
- Erläuterung
Setzen Sie den Standardpfad
Farboptionen
- Standardfarbe
- Benutzerdefinierte Farboptionen
Tipps und Tricks
Beitragen
Verhaltenskodex
Lizenz
Unterstützen Sie das Projekt
Glückliche Codierung

Merkmale

Einfach zu bedienende Protokollierung für Python-Anwendungen.
Anpassbare Protokollebenen und Formatierung.
Anpassbare Protokollfarben.
Protokollieren Sie bei Datei und/oder Konsole.
Anmelden bei der Datei mit automatischer Dateirotation.
Anmelden bei der Datei mit automatischer Dateigrößenverwaltung.
Anmelden bei der Datei mit automatischer Datei -Löschung.
Protokollieren Sie bei der Datei mit automatischer Löschung und Umschreiben der Datei, wenn sie max_file_size erreicht.
Open Source: Logly ist ein Open-Source-Projekt, und wir begrüßen Beiträge der Community.
Community -Unterstützung: Schließen Sie sich einer Community von Entwicklern an, die Logly für ihre Protokollierungsbedürfnisse verwenden.
Viele weitere Funktionen!

Erste Schritte

Installation

pip install logly

Verwendung

 # Import Logly
from logly import Logly

# Create a Logly instance
logly = Logly ()
# logly = Logly(show_time=False)  # Include timestamps in log messages default is  true, and you can set it to false will not show the time in all log messages

# Start logging will store the log in text file
logly . start_logging () #make sure to include this or else the log will only display without storing it in file

logly . info ( "hello this is log" )
logly . info ( "hello this is log" , color = logly . COLOR . RED ) # with custom color

# Log messages with different levels and colors
logly . info ( "Key1" , "Value1" , color = logly . COLOR . CYAN )
logly . warn ( "Key2" , "Value2" , color = logly . COLOR . YELLOW )
logly . error ( "Key3" , "Value3" , color = logly . COLOR . RED )
logly . debug ( "Key4" , "Value4" , color = logly . COLOR . BLUE )
logly . critical ( "Key5" , "Value5" , color = logly . COLOR . CRITICAL )
logly . fatal ( "Key6" , "Value6" , color = logly . COLOR . CRITICAL )
logly . trace ( "Key7" , "Value7" , color = logly . COLOR . BLUE )
logly . log ( "Key8" , "Value8" , color = logly . COLOR . WHITE )

# Stop logging (messages will be displayed but not logged in file after this point)
logly . stop_logging ()

# Log more messages after stopping logging (messages will be displayed but not logged in file after this point)
logly . info ( "AnotherKey1" , "AnotherValue1" , color = logly . COLOR . CYAN )
logly . warn ( "AnotherKey2" , "AnotherValue2" , color = logly . COLOR . YELLOW )
logly . error ( "AnotherKey3" , "AnotherValue3" , color = logly . COLOR . RED )


logly . info ( "hello this is log" , color = logly . COLOR . RED , show_time = False ) # with custom color and without time

# Start logging again
logly . start_logging () 

# Set the default file path and max file size
logly . set_default_file_path ( "log.txt" ) # Set the default file path is "log.txt" if you want to set the file path where you want to save the log file.
logly . set_default_max_file_size ( 50 ) # set default max file size is 50 MB

# Log messages with default settings (using default file path and max file size)
logly . info ( "DefaultKey1" , "DefaultValue1" )
logly . warn ( "DefaultKey2" , "DefaultValue2" )
logly . error ( "DefaultKey3" , "DefaultValue3" , log_to_file = False )

#The DEFAULT FILE SIZE IS 100 MB in the txt file
# Log messages with custom file path and max file size(optional)
logly . info ( "CustomKey1" , "CustomValue1" , file_path = "path/c.txt" , max_file_size = 25 ) # max_file_size is in MB and create a new file when the file size reaches max_file_size
logly . warn ( "CustomKey2" , "CustomValue2" , file_path = "path/c.txt" , max_file_size = 25 , auto = True ) # auto=True will automatically delete the file data when it reaches max_file_size

# Access color constants directly
logly . info ( "Accessing color directly" , "DirectColorValue" , color = logly . COLOR . RED )

# Disable color
logly . color_enabled = False
logly . info ( "ColorDisabledKey" , "ColorDisabledValue" , color = logly . COLOR . RED )
logly . info ( "ColorDisabledKey1" , "ColorDisabledValue1" , color = logly . COLOR . RED , color_enabled = True ) # This will enable the color for this one log message
logly . color_enabled = True
# this will enable the color again
logly . info ( "ColorDisabledKey1" , "ColorDisabledValue1" , color = logly . COLOR . RED , color_enabled = False ) # this will disable the color for this one log message


# Display logged messages (this will display all the messages logged so far)
print ( "Logged Messages:" )
for message in logly . logged_messages :
    print ( message )

Erläuterung:

Importieren Sie die Logly -Klasse aus dem logly Modul.
Erstellen Sie eine Instanz von Logly .
Starten Sie die Protokollierung mit der Methode start_logging() .
Protokollieren Sie Nachrichten mit verschiedenen Ebenen (Info, Warn, Fehler, Debuggen, kritisch, tödlich, Spur) und Farben.
Stoppen Sie die Protokollierung mit der Methode stop_logging() .
Protokollieren Sie zusätzliche Nachrichten, nachdem Sie die Protokollierung gestoppt haben.
Melden Sie sich erneut an.
Protokollieren Sie Nachrichten mit Standardeinstellungen, benutzerdefinierten Dateipfad und Max -Dateigröße.
Zugang zu Farbkonstanten direkt.
Zeigen Sie protokollierte Nachrichten an.
Aktivieren/deaktivieren Sie die Timestamp -Unterstützung
Aktivieren/deaktivieren Sie Farbe für die Protokollunterstützung

Weitere Informationen finden Sie im Repository

Legen Sie den Standardpfad ein

Wenn Sie auf einen Fehler in Bezug auf den Standarddateipfad stoßen, können Sie den folgenden Code -Snippet verwenden, um den Standardpfad festzulegen:

 import os
from logly import Logly

logly = Logly ()
logly . start_logging ()

# Set the default file path and maximum file size
logly . set_default_max_file_size ( 50 )
logger = os . path . join ( os . path . dirname ( os . path . abspath ( __file__ )), "log.txt" )
logly . set_default_file_path ( logger )

Dadurch wird der Standarddateipfad festgelegt und Sie können ihn entsprechend Ihren Anforderungen anpassen.

Wenn Sie den Standardpfad für die Protokolldatei festlegen möchten, können Sie den folgenden Code -Snippet verwenden

 from logly import Logly
logly = Logly ()
logly . set_default_file_path ( "log.txt" )

Wenn Sie einem Fehler wie FileNotFoundError: [Errno 2] No such file or directory: 'log.txt' Sie können das folgende Code -Snippet verwenden, um den Standardpfad festzulegen

 import os
from logly import Logly

logly = Logly () # initialize the logly
logly . start_logging () # make sure to include this or else the log will only display without storing it

logly . set_default_max_file_size ( 50 ) # optional
logger = os . path . join ( os . path . dirname ( os . path . abspath ( __file__ )), "log.txt" ) # This will ensure the path location to create the log.txt on current directory
logly . set_default_file_path ( logger )

Weitere Informationen finden Sie im Repository.

Farboptionen:

Standardfarbene Optionen:

Ebene	Farbcode
INFO	Cyan
WARNUNG	GELB
FEHLER	ROT
DEBUGGEN	BLAU
KRITISCH	Leuchtend rot
VERFOLGEN	BLAU
STANDARD	WEISS

Benutzerdefinierte Farboptionen:

Sie können die folgenden Farbcodes für benutzerdefinierte Färben verwenden:

NAME	Farbcode
Cyan	Cyan
GELB	GELB
ROT	ROT
BLAU	BLAU
Leuchtend rot	KRITISCH
WEISS	WEISS

Sie können beispielsweise color=logly.COLOR.RED für die rote Farbe verwenden.

Tipps und Tricks

Wenn Sie in Ihren Projektdateien Logy verwenden möchten, ohne in jeder Python -Datei oder -klasse ein neues Objekt zu erstellen, können Sie eine Datei namens Logly.py erstellen. In dieser Datei logy initialisieren und die Standardeinstellungen konfigurieren. Jetzt können Sie es einfach im Laufe Ihres Projekts importieren und verwenden:

logly.py

 # logly.py in your root or custom path
# Import Logly

from logly import Logly
import os
logly = Logly ()
logly . start_logging ()

# Set the default file path and maximum file size
logly . set_default_max_file_size ( 50 )
logger = os . path . join ( os . path . dirname ( os . path . abspath ( __file__ )), "log.txt" ) # This will ensure the path location to create the log.txt 
logly . set_default_file_path ( logger )

# Start logging again
logly . start_logging ()

Sie können jetzt das Logy von verwenden

main.py

 from logly import logly # make sure to import it some IDE may automatically import it on top

logly . info ( "msg" , "hello this is logly" , color = logly . COLOR . RED ) # with custom color of red

Ausgabe

 [XXXX-XX-XX XX:XX: XX] INFo: msg: hello this is logly

Beitragen

Beiträge sind willkommen! Lesen Sie vor dem Beitrag unsere beitragenden Richtlinien, um einen reibungslosen und kollaborativen Entwicklungsprozess zu gewährleisten.

Verhaltenskodex

Bitte überprüfen Sie unseren Verhaltenskodex, um die Verhaltensstandards zu verstehen, die wir von Mitwirkenden und Benutzern dieses Projekts erwarten.