logly
v0.0.6
Pythonアプリケーション用のカスタムロギングコードを作成するのにうんざりしていませんか？
Loglyは、さまざまなレベル、色、多くのカスタムオプションでメッセージを簡単にログにログインする簡単な方法を提供するロギングユーティリティに移行する準備ができています。柔軟性があるように設計されており、アプリケーションのニーズに基づいてログメッセージをカスタマイズできます。 Loglyは、コンソールとファイルの両方へのロギングをサポートし、可視性を向上させるために組み込みのカラーコーディングログレベルが付属しています。
このプロジェクトが気に入ったら、必ず主演してください。リポジトリで、貢献したい場合は、このリポジトリをフォークするようにしてください。
pip install logly # 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 )loglyモジュールからLoglyクラスをインポートします。Loglyのインスタンスを作成します。start_logging()メソッドを使用してロギングを開始します。stop_logging()メソッドを使用してログを停止します。詳細については、リポジトリを確認してください
デフォルトのファイルパスに関連するエラーが発生した場合、次のコードスニペットを使用してデフォルトのパスを設定できます。
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 )これにより、デフォルトのファイルパスが設定され、要件に応じてカスタマイズできます。
ログファイルのデフォルトパスを設定する場合は、次のコードスニペットを使用できます
from logly import Logly
logly = Logly ()
logly . set_default_file_path ( "log.txt" ) FileNotFoundError: [Errno 2] No such file or directory: 'log.txt'次のコードスニペットを使用してデフォルトのパスを設定できます
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 )詳細については、リポジトリを確認してください。
| レベル | カラーコード |
|---|---|
| 情報 | シアン |
| 警告 | 黄色 |
| エラー | 赤 |
| デバッグ | 青 |
| 致命的 | 明るい赤 |
| トレース | 青 |
| デフォルト | 白 |
カスタムカラーリングには、次のカラーコードのいずれかを使用できます。
| 名前 | カラーコード |
|---|---|
| シアン | シアン |
| 黄色 | 黄色 |
| 赤 | 赤 |
| 青 | 青 |
| 明るい赤 | 致命的 |
| 白 | 白 |
たとえば、赤色にcolor=logly.COLOR.RED使用できます。
各Pythonファイルまたはクラスで新しいオブジェクトを作成せずにプロジェクトファイルでLoglyを使用する場合は、logly.pyという名前のファイルを作成できます。このファイルでは、loglyを初期化し、デフォルトを構成します。これで、プロジェクト全体で簡単にインポートして使用できます。
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 ()これで、logly byを使用できます
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 [XXXX-XX-XX XX:XX: XX] INFo: msg: hello this is logly
貢献は大歓迎です！貢献する前に、貢献ガイドラインを読んで、スムーズで共同開発プロセスを確保してください。
このプロジェクトの貢献者とユーザーに期待される行動の基準を理解するために、行動規範を確認してください。
このプロジェクトは、MITライセンスの下でライセンスされています。詳細については、ライセンスを参照してください。
Githubのスポンサーになることで、プロジェクトをサポートします
