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进行红色。
如果要在项目文件中使用Logly而不在每个Python文件或类中创建新对象，则可以创建一个名为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
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的赞助商来支持该项目
