This Python package provides a robust and customizable logger that simplifies the process of recording messages and events in your applications. It leverages the power of the `colorlog` library to enhance readability and debugging capabilities.
Project description
Custom Logger: Enhanced Logging for Your Python Applications
Introduction
This Python package provides a robust and customizable logger that simplifies the process of recording messages and events in your applications. It leverages the power of the colorlog
library to enhance readability and debugging capabilities.
Key Features
- Flexible Log Levels: Supports standard logging levels (
DEBUG
,INFO
,WARNING
,ERROR
, andCRITICAL
) to categorize messages based on severity. - Colorized Output: Leverages
colorlog
to display log messages in distinct colors, improving visual clarity. - File and Console Logging: Logs messages to a specified file and optionally to the console for immediate feedback.
- Customizable Formatting: Control the appearance of log messages using formatters for both file and console output.
- Dynamic Console Logging: Enable or disable console logging at runtime to manage verbosity during development.
- Handler Management: Add, remove, or adjust logging handlers to tailor logging behavior.
- Default Loggers: Provides convenient wrappers for standard logging methods (
debug
,info
,warning
,error
,critical
, andexception
). - Session Logging: Decorator function
log_session
to enclose a block of code with logging messages for session tracking. - Log File Reading: Utility function
read_log_file
to conveniently read and display the contents of the log file. - Log File Clearing: Optional
clear_log_file
method to clear existing log data.
Installation
From pypi.org
To install the ultra_logger
package from PyPI (the Python Package Index), use the following command in your terminal:
pip install ultra_logger
Usage
-
Import the Logger Class:
from ultra_logger import Logger
-
Create a Logger Instance:
logger = Logger(log_name='my_logger', log_file='app.log', log_to_console=True)
log_name
: A descriptive name for your logger (e.g., 'my_logger').log_file
: The path to the log file where messages will be saved.log_to_console
(optional, defaults toTrue
): Whether to log messages to the console.
-
Log Messages:
logger.log_message('info', 'This is an informative message.') logger.warning('This is a warning message.') logger.error('This is an error message.') logger.critical('This is a critical message.')
-
Default Loggers:
logger.info('This is a general message.') logger.warning('This requires attention.') logger.exception('An exception occurred!', exc_info=True) # Optional exception info
-
Session Logging:
@logger.log_session def my_function(): # Your code here logger.info('Processing completed.')
The
log_session
decorator automatically logs the start and end of the function execution. -
Read Log File:
logger.read_log_file()
-
Clear Log File (optional):
logger.clear_log_file() # Use with caution
Advanced Usage
-
Dynamic Console Logging:
logger.disable_console_logging() # Disable console logging logger.enable_console_logging() # Re-enable console logging
-
Handler Management:
Refer to the source code for details on adding, removing, or modifying logging handlers.
Customization
For advanced customization, consult the source code to modify formatting options for file and console output or create custom handlers.
Contributing
We welcome contributions to improve this logger. Feel free to submit pull requests on GitHub!
License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ultra_logger-0.1.2.tar.gz
.
File metadata
- Download URL: ultra_logger-0.1.2.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7852b9917fd8087bb75282cfe09a97de82b8f7a8c7b18e7f14eb707ae91c278 |
|
MD5 | 7b8d9e80cc37ae1280094bbf942ff96a |
|
BLAKE2b-256 | 4479fbc557056981d71827e213a53789fc6118e311848c5a6a62b50e95b7757f |
File details
Details for the file ultra_logger-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: ultra_logger-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e84b3195a08d0213c18ac32851cb789f70433b83d476e13431900d71ed46322 |
|
MD5 | 5c12f8371523a2b3d24187c0810026b9 |
|
BLAKE2b-256 | b40882a598cb188739753121f52ac1ab27f277020bbc5e40e13673b29490fa6b |