Unduh logly - Unduh Kode Sumber logly

Bosan menulis kode logging khusus untuk aplikasi Python Anda?

Logly adalah utilitas logging yang siap digunakan yang menyediakan cara mudah untuk mencatat pesan dengan berbagai tingkat, warna, dan banyak opsi khusus. Ini dirancang agar fleksibel, memungkinkan Anda untuk menyesuaikan pesan log berdasarkan kebutuhan aplikasi Anda. Logly mendukung pencatatan ke konsol dan file, dan dilengkapi dengan level log kode warna bawaan untuk visibilitas yang lebih baik.

Jika Anda menyukai proyek ini, pastikan untuk membintangi? itu di repositori dan jika Anda ingin berkontribusi, pastikan untuk membayar repositori ini❤.

Daftar isi

Perkenalan
Instalasi
Fitur
Penggunaan
- Memulai
- Penjelasan
Atur jalur default
Opsi warna
- Opsi warna default
- Opsi warna khusus
Tips & Trik
Berkontribusi
Kode Etik
Lisensi
Mendukung proyek
Happy Coding

Fitur

Pencatatan yang mudah digunakan untuk aplikasi Python.
Level log dan pemformatan yang dapat disesuaikan.
Warna log yang dapat disesuaikan.
Log ke file dan/atau konsol.
Log ke file dengan rotasi file otomatis.
Log ke File dengan Manajemen Ukuran File Otomatis.
Log ke File dengan Penghapusan File Otomatis.
Log ke file dengan penghapusan otomatis dan penulisan ulang file saat mencapai max_file_size.
Open Source: Logly adalah proyek open-source, dan kami menyambut kontribusi dari masyarakat.
Dukungan Komunitas: Bergabunglah dengan komunitas pengembang yang menggunakan logly untuk kebutuhan logging mereka.
lebih banyak fitur!

Memulai

Instalasi

pip install logly

Penggunaan

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

Penjelasan:

Impor kelas Logly dari modul logly .
Buat instance Logly .
Mulai logging menggunakan metode start_logging() .
Pesan log dengan berbagai tingkatan (info, peringatan, kesalahan, debug, kritis, fatal, jejak) dan warna.
Stop Logging menggunakan metode stop_logging() .
Masuki pesan tambahan setelah berhenti logging.
Mulai logging lagi.
Pesan log dengan pengaturan default, jalur file khusus, dan ukuran file maks.
Akses konstanta warna secara langsung.
Tampilan pesan yang dicatat.
Aktifkan/Nonaktifkan Dukungan Timestamp
Aktifkan/Nonaktifkan Warna untuk Dukungan Log

Untuk informasi lebih lanjut, periksa repositori

Atur jalur default

Jika Anda mengalami kesalahan yang terkait dengan jalur file default, Anda dapat menggunakan cuplikan kode berikut untuk mengatur jalur default:

 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 )

Ini akan mengatur jalur file default, dan Anda dapat menyesuaikannya sesuai dengan kebutuhan Anda.

Jika Anda ingin mengatur jalur default untuk file log, Anda dapat menggunakan cuplikan kode berikut

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

Jika Anda menghadapi kesalahan seperti FileNotFoundError: [Errno 2] No such file or directory: 'log.txt' Anda dapat menggunakan cuplikan kode berikut untuk mengatur jalur default

 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 )

Untuk informasi lebih lanjut, periksa repositori.

Opsi Warna:

Opsi Warna Default:

Tingkat	Kode warna
Info	Cyan
PERINGATAN	KUNING
KESALAHAN	MERAH
Debug	BIRU
KRITIS	Merah cerah
JEJAK	BIRU
BAWAAN	PUTIH

Opsi Warna Kustom:

Anda dapat menggunakan salah satu kode warna berikut untuk pewarnaan khusus:

NAMA	Kode warna
Cyan	Cyan
KUNING	KUNING
MERAH	MERAH
BIRU	BIRU
Merah cerah	KRITIS
PUTIH	PUTIH

Misalnya, Anda dapat menggunakan color=logly.COLOR.RED untuk warna merah.

Tips & Trik

Jika Anda ingin menggunakan logly di file proyek Anda tanpa membuat objek baru di setiap file atau kelas Python, Anda dapat membuat file bernama logly.py. Dalam file ini, inisialisasi logly dan konfigurasikan default. Sekarang, Anda dapat dengan mudah mengimpor dan menggunakannya di seluruh proyek Anda:

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

Anda sekarang dapat menggunakan logly dengan

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

keluaran

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

Berkontribusi

Kontribusi dipersilakan! Sebelum berkontribusi, silakan baca pedoman yang berkontribusi kami untuk memastikan proses pengembangan yang lancar dan kolaboratif.