Simplify complex logging in Python with customizable, color-coded, and thread-safe outputs.
Project description
Tasks Logger
Overview
tasks-logger
is a versatile Python logging library designed to facilitate detailed and color-coded logging for applications that manage multiple tasks, such as those operating across various threads or processes. It extends the basic functionality of Python’s built-in logging module to include dynamic log levels, thread-safe output, conditional file logging, and vivid color outputs for better clarity and monitoring.
Check also tasks-loader
Table Of Contents
Features
- Dynamic Log Levels: Easily define new log levels on the fly.
- Color-coded Output: Enhance log visibility with configurable color outputs for each log level.
- Conditional File Logging: Decide which log level messages are important enough to save to files.
- Thread Safety: Ensure logs are thread-safe using locks to prevent text scrambling when used in multi-threaded applications.
Installation
Install tasks-logger
via pip:
pip install tasks-logger
How It Works
tasks-logger
utilizes the Colorama library to add color to log messages depending on their severity. You can set up different log levels and specify whether these should be output to the console, saved to a file, or both. The logger also supports dynamic addition of new log levels with specific properties.
Usage
Basic Setup
Here's how to set up and use the tasks-logger
:
from tasks_logger import Logger
logger = Logger(level='INFO', file_level='ERROR', filename='app.log')
logger.info("This is an informational message.")
logger.error("This error message will also be saved to a file.")
Adding New Log Levels
You can add new log levels dynamically:
logger.add_level('VERBOSE', 15, Fore.LIGHTBLUE_EX)
logger.verbose("This is a verbose message with custom log level.")
Thread-Safe Logging
tasks-logger
is designed to be safe for use in multi-threaded environments:
import threading
def task():
logger.info("Log from a thread.")
thread = threading.Thread(target=task)
thread.start()
thread.join()
Conditional File Logging
Control which log levels are logged to files:
# Only ERROR and above levels will be saved to the file.
logger = Logger(level='DEBUG', file_level='ERROR', filename='important.log')
logger.debug("This message will not be logged in the file.")
logger.error("This error will be logged in the file.")
Example Application: Sneakers/Tickets Bot
Here is an example showing how tasks-logger
might be used in a sneakers/tickets purchasing bot, which operates with multiple tasks:
class MyTask:
def __init__(self, task_id: str, mail: str, ...):
self.logger = Logger(
level='INFO',
task_id=task_id,
mail=mail,
formatting="[{timestamp}] [{level}] ({task_id}) {mail} - {message}"
)
Stay in touch with me
For any inquiries or further information, please reach out:
Feel free to contact for collaborations, questions, or feedback any of my projects.
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
Hashes for tasks_logger-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea4e35d66e921b5423c06980748e5ae7f7d1392b850a5c5f98fd72669474b101 |
|
MD5 | 4784a5871e3407a90afd3a9ce3c5708d |
|
BLAKE2b-256 | c58bc4c0bfaa0984811c2776f2ecacd3faf36bb4f0a1fe93ea7b93d906bf9fbd |