mirror of
https://github.com/allthingslinux/tux.git
synced 2024-10-02 16:43:12 +00:00
fix
This commit is contained in:
ExploitDemon
parent
4319efe92b
commit
051f461aec
3 changed files with 2 additions and 139 deletions
5
.github/workflows/linting.yml
vendored
5
.github/workflows/linting.yml
vendored
|
|
@ -24,9 +24,8 @@ jobs:
|
|||
run: sudo snap install ruff
|
||||
|
||||
# Run Ruff linter
|
||||
- name: Run Ruff linter
|
||||
run: ruff check . && ruff fix .
|
||||
|
||||
- name: Run Ruff format
|
||||
run: ruff format && ruff check . --fix
|
||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
||||
with:
|
||||
commit_message: 'style fixes by ruff'
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@ import os
|
|||
|
||||
import discord
|
||||
from cog_loader import CogLoader
|
||||
from discord.ext import commands
|
||||
from dotenv import load_dotenv
|
||||
from utils.tux_logger import TuxLogger
|
||||
|
||||
|
|
|
|||
|
|
@ -1,135 +0,0 @@
|
|||
import os
|
||||
import logging
|
||||
import colorlog
|
||||
from discord.ext import commands
|
||||
|
||||
# ==================
|
||||
# Usage Instructions
|
||||
# ==================
|
||||
# Hey contributor, Ty here! To use the logger in your cog files, please follow these steps:
|
||||
#
|
||||
# 1. Import the logger by adding the following line at the top of your main bot file:
|
||||
#
|
||||
# from utils._tux_logger import TuxLogger
|
||||
#
|
||||
# logger = TuxLogger(__name__)
|
||||
#
|
||||
# 2. Once imported, you can use the logger to log messages in your code. For example:
|
||||
# logger.info("This is an information message.")
|
||||
# logger.warning("This is a warning message.")
|
||||
# logger.error("This is an error message.")
|
||||
# logger.debug("This is a debug message.")
|
||||
#
|
||||
# I love you all and thank you for contributing <3
|
||||
# =========================
|
||||
# End of Usage Instructions
|
||||
# =========================
|
||||
|
||||
|
||||
class TuxLogger(logging.Logger):
|
||||
def __init__(self, name, project_logging_level=logging.INFO):
|
||||
"""
|
||||
Constructor for the custom logger class.
|
||||
|
||||
Parameters:
|
||||
- name: The name of the logger.
|
||||
- project_logging_level: The logging level for the project (default is INFO).
|
||||
"""
|
||||
super().__init__(name, level=project_logging_level)
|
||||
self._setup_logging()
|
||||
|
||||
def _setup_logging(self):
|
||||
"""
|
||||
Set up the logging configuration for the custom logger.
|
||||
"""
|
||||
log_format = (
|
||||
"%(asctime)s [%(log_color)s%(levelname)s%(reset)s] [%(name)s]: %(message)s"
|
||||
)
|
||||
log_dir = "logs"
|
||||
os.makedirs(log_dir, exist_ok=True)
|
||||
|
||||
handler = colorlog.StreamHandler()
|
||||
handler.setFormatter(colorlog.ColoredFormatter(log_format))
|
||||
self.addHandler(handler)
|
||||
|
||||
file_handler = logging.FileHandler(os.path.join(log_dir, "bot.log"), mode="a")
|
||||
file_handler.setFormatter(
|
||||
logging.Formatter("%(asctime)s [%(levelname)s] [%(name)s]: %(message)s")
|
||||
)
|
||||
self.addHandler(file_handler)
|
||||
|
||||
def _log_to_file(self, level, message, caller_module):
|
||||
"""
|
||||
Log a message to a specific file.
|
||||
|
||||
Parameters:
|
||||
- level: The logging level (e.g., logging.DEBUG, logging.INFO, etc.).
|
||||
- message: The log message.
|
||||
- filename: The name of the file to log to.
|
||||
"""
|
||||
|
||||
file_handler = logging.FileHandler(
|
||||
os.path.join("logs", f"{caller_module}.log"), mode="a"
|
||||
)
|
||||
file_handler.setFormatter(
|
||||
logging.Formatter(
|
||||
f"%(asctime)s [%(levelname)s] [{caller_module}]: %(message)s"
|
||||
)
|
||||
)
|
||||
self.addHandler(file_handler)
|
||||
self.log(level, message)
|
||||
self.removeHandler(file_handler)
|
||||
|
||||
def exception(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.ERROR, message, filename, exc_info=True)
|
||||
|
||||
def debug(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.DEBUG, message, filename)
|
||||
|
||||
def info(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.INFO, message, filename)
|
||||
|
||||
def warning(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.WARNING, message, filename)
|
||||
|
||||
def error(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.ERROR, message, filename)
|
||||
|
||||
def critical(self, message, filename="unknown"):
|
||||
self._log_to_file(logging.CRITICAL, message, filename)
|
||||
|
||||
|
||||
class LoggingCog(commands.Cog):
|
||||
def __init__(self, bot, discord_logging_level=logging.WARNING):
|
||||
"""
|
||||
Constructor for the LoggingCog class.
|
||||
|
||||
Parameters:
|
||||
- bot: The Discord bot instance.
|
||||
- discord_logging_level: The logging level for the Discord library (default is WARNING).
|
||||
"""
|
||||
self.bot = bot
|
||||
self.discord_logging_level = discord_logging_level
|
||||
|
||||
discord_logger = logging.getLogger("discord")
|
||||
discord_logger.setLevel(self.discord_logging_level)
|
||||
|
||||
|
||||
logger = TuxLogger(__name__)
|
||||
|
||||
|
||||
async def setup(
|
||||
bot, project_logging_level=logging.DEBUG, discord_logging_level=logging.WARNING
|
||||
):
|
||||
"""
|
||||
Asynchronous function to set up the LoggingCog and add it to the Discord bot.
|
||||
|
||||
Parameters:
|
||||
- bot: The Discord bot instance.
|
||||
- project_logging_level: The logging level for the project (default is DEBUG).
|
||||
- discord_logging_level: The logging level for the Discord library (default is WARNING).
|
||||
"""
|
||||
global logger
|
||||
log_cog = LoggingCog(bot, discord_logging_level)
|
||||
logger.setLevel(project_logging_level)
|
||||
await bot.add_cog(log_cog)
|
||||
Loading…
Reference in a new issue