logly Download - logly Source Code Скачать

Устали от написания пользовательского кода журнала для ваших приложений Python?

Logly - это готовая утилита для ведения журнала, которая предоставляет простой способ журнала сообщений с разными уровнями, цветами и множеством пользовательских вариантов. Он предназначен для того, чтобы быть гибким, что позволяет настроить сообщения журнала на основе потребностей вашего приложения. Logly поддерживает журнал как в консоли, так и в файл, и поставляется со встроенными уровнями журнала цветов для лучшей видимости.

Если вам нравится этот проект, убедитесь, что снимайтесь? Это в репозитории, и если вы хотите внести свой вклад, обязательно расколоть это хранилище.

Введение
Установка
Функции
Использование
- Начиная
- Объяснение
Установите путь по умолчанию
Варианты цвета
- Параметры цвета по умолчанию
- Пользовательские варианты цвета
Советы и хитрости
Внося
Нормы поведения
Лицензия
Поддержать проект
Счастливого кодирования

Функции

Простая в использовании регистрация для приложений Python.
Настраиваемые уровни журнала и форматирование.
Настраиваемые цвета журнала.
Войдите в файл и/или консоли.
Войдите в файл с помощью автоматического вращения файлов.
Войдите в файл с помощью автоматического управления размером файла.
Войдите в файл с помощью автоматического удаления файлов.
Войдите в файл с автоматическим удалением и переписыванием файла, когда он достигнет max_file_size.
Open Source: 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() .
Войдите за дополнительные сообщения после прекращения ведения журнала.
Начните регистрироваться снова.
Сообщения журнала с настройками по умолчанию, пользовательским путем файла и размером файла Max.
Получите доступ к константам цвета напрямую.
Отображать зарегистрированные сообщения.
Включить/отключить поддержку временной метки
Включить/отключить цвет для поддержки журнала

Для получения дополнительной информации проверьте репозиторий

Установите путь по умолчанию

Если вы столкнетесь с ошибкой, связанной с путем файла по умолчанию, вы можете использовать следующий фрагмент кода для установки пути по умолчанию:

 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.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

Внося

Взносы приветствуются! Прежде чем внести свой вклад, пожалуйста, прочитайте наши рекомендательные принципы, чтобы обеспечить плавный и совместный процесс разработки.