From 6e5d8261ff967c5acf25778d2f7bcdab5207464c Mon Sep 17 00:00:00 2001 From: Peter van Arkel Date: Wed, 11 Aug 2021 15:09:57 +0200 Subject: [PATCH 1/2] add log.py and imports in cog-files to that. Part of #26 --- __init__.py | 0 cogs/admin.py | 12 ++++-------- cogs/games.py | 13 ++++++------- cogs/gif.py | 12 +++++------- cogs/links.py | 14 ++++++-------- cogs/moderator.py | 13 +++++-------- cogs/random.py | 13 +++++-------- jeeves.py | 12 +++++------- log.py | 28 ++++++++++++++++++++++++++++ 9 files changed, 64 insertions(+), 53 deletions(-) create mode 100644 __init__.py create mode 100644 log.py diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cogs/admin.py b/cogs/admin.py index 2d220ad..f39e095 100644 --- a/cogs/admin.py +++ b/cogs/admin.py @@ -1,16 +1,12 @@ import discord from discord.ext import commands -import logging +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + +embed = discord.Embed() class Admin(commands.Cog): diff --git a/cogs/games.py b/cogs/games.py index fbb635a..538b953 100644 --- a/cogs/games.py +++ b/cogs/games.py @@ -2,16 +2,14 @@ import discord from discord.ext import commands import logging from jeevesbot import functions, babbelbingo +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + + +e = discord.Embed() class Games(commands.Cog): @@ -45,5 +43,6 @@ class Games(commands.Cog): async def on_ready(self): print('##### GAMES module active') + def setup(bot): bot.add_cog(Games(bot)) \ No newline at end of file diff --git a/cogs/gif.py b/cogs/gif.py index b584e2d..6fd94b8 100644 --- a/cogs/gif.py +++ b/cogs/gif.py @@ -2,16 +2,14 @@ import discord from discord.ext import commands import logging from jeevesbot import functions +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + + +e = discord.Embed() class Gif(commands.Cog): diff --git a/cogs/links.py b/cogs/links.py index 155883c..59d833f 100644 --- a/cogs/links.py +++ b/cogs/links.py @@ -1,16 +1,13 @@ import discord from discord.ext import commands -import logging +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + + +e = discord.Embed() class Links(commands.Cog): @@ -34,6 +31,7 @@ class Links(commands.Cog): async def on_ready(self): print('##### LINKS module active') + def setup(bot): bot.add_cog(Links(bot)) diff --git a/cogs/moderator.py b/cogs/moderator.py index fcbdbce..afa2112 100644 --- a/cogs/moderator.py +++ b/cogs/moderator.py @@ -1,16 +1,13 @@ import discord from discord.ext import commands -import logging +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + + +e = discord.Embed() class Moderator(commands.Cog): diff --git a/cogs/random.py b/cogs/random.py index d96c525..6be7034 100644 --- a/cogs/random.py +++ b/cogs/random.py @@ -1,16 +1,13 @@ import discord from discord.ext import commands -import logging +import log -e = discord.Embed() # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + + +e = discord.Embed() class Misc(commands.Cog): diff --git a/jeeves.py b/jeeves.py index ba96ad4..3b7dfc1 100755 --- a/jeeves.py +++ b/jeeves.py @@ -2,17 +2,14 @@ import discord from discord.ext import commands -import logging from jeevesbot import env import os +import log + # setup logging -logging.basicConfig(level=logging.INFO) -logger = logging.getLogger('jeeves') -logger.setLevel(logging.INFO) -handler = logging.FileHandler(filename='jeeves.log', encoding='utf-8', mode='a') -handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')) -logger.addHandler(handler) +logger = log.get_logger(__name__) + # setup discord.py bot intents = discord.Intents().all() @@ -56,3 +53,4 @@ for filename in os.listdir('./cogs'): if __name__ == '__main__': bot.run(env.TOKEN) + diff --git a/log.py b/log.py new file mode 100644 index 0000000..732e4f5 --- /dev/null +++ b/log.py @@ -0,0 +1,28 @@ +import logging +import sys + +FORMATTER = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") +LOG_FILE = "jeeves.log" + +def get_console_handler(): + console_handler = logging.StreamHandler(sys.stdout) + console_handler.setFormatter(FORMATTER) + return console_handler + +def get_file_handler(): + file_handler = logging.FileHandler(LOG_FILE, encoding='utf-8', mode='a') + file_handler.setFormatter(FORMATTER) + return file_handler + +def get_logger(logger_name): + logger = logging.getLogger(logger_name) + + logger.setLevel(logging.DEBUG) # better to have too much log than not enough + + logger.addHandler(get_console_handler()) + logger.addHandler(get_file_handler()) + + # with this pattern, it's rarely necessary to propagate the error up to parent + logger.propagate = False + + return logger \ No newline at end of file From 2d69abbd377e9b80f2986ad1f0e5ebadaed62ef4 Mon Sep 17 00:00:00 2001 From: Peter van Arkel Date: Wed, 11 Aug 2021 20:02:47 +0200 Subject: [PATCH 2/2] add log.py and set logger handlers correctly in all files. --- cogs/admin.py | 9 +++--- cogs/games.py | 8 ++--- cogs/gif.py | 12 ++++---- cogs/links.py | 6 ++-- cogs/{random.py => misc.py} | 6 ++-- cogs/moderator.py | 8 ++--- jeeves.py | 14 ++++++--- log.py | 60 ++++++++++++++++++++----------------- 8 files changed, 67 insertions(+), 56 deletions(-) rename cogs/{random.py => misc.py} (82%) diff --git a/cogs/admin.py b/cogs/admin.py index f39e095..32c18a6 100644 --- a/cogs/admin.py +++ b/cogs/admin.py @@ -1,10 +1,11 @@ import discord from discord.ext import commands -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) + embed = discord.Embed() @@ -20,12 +21,12 @@ class Admin(commands.Cog): @commands.is_owner() async def clear(self, ctx, amount=1): await ctx.channel.purge(limit=amount) - logger.warn(f'{ctx.message.author.name} cleared {amount} messages') + log.warn(f'{ctx.message.author.name} cleared {amount} messages') @commands.Cog.listener() async def on_ready(self): - print('##### ADMIN module active') + log.info(f'module active') def setup(bot): diff --git a/cogs/games.py b/cogs/games.py index 538b953..ec3a3b4 100644 --- a/cogs/games.py +++ b/cogs/games.py @@ -2,11 +2,11 @@ import discord from discord.ext import commands import logging from jeevesbot import functions, babbelbingo -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) e = discord.Embed() @@ -27,7 +27,7 @@ class Games(commands.Cog): roll,result = functions.roll(param) msg = f'Rolling %s for {ctx.message.author.mention}: `%s`'.format(roll) % (param,roll) logline = f'Rolling %s for {ctx.message.author}: `%s`'.format(roll) % (param,roll) - logger.info(logline) + log.info(logline) await ctx.send(msg) @@ -41,7 +41,7 @@ class Games(commands.Cog): @commands.Cog.listener() async def on_ready(self): - print('##### GAMES module active') + log.info(f'module active') def setup(bot): diff --git a/cogs/gif.py b/cogs/gif.py index 6fd94b8..edd28fc 100644 --- a/cogs/gif.py +++ b/cogs/gif.py @@ -2,11 +2,11 @@ import discord from discord.ext import commands import logging from jeevesbot import functions -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) e = discord.Embed() @@ -33,7 +33,7 @@ class Gif(commands.Cog): if roles is not True: await message.channel.send(embed=embed) logline = (str(message.author) + ' requested a gif: ' + str(gif_url)) - logger.info(logline) + log.info(logline) if message.content.endswith('.gif'): roles = functions.checkrole(message.author.roles) channel = functions.checkchannel(message.channel.id) @@ -43,7 +43,7 @@ class Gif(commands.Cog): if roles is not True: await message.channel.send(embed=embed) logline = (str(message.author) + ' requested a gif: ' + str(embed_url)) - logger.info(logline) + log.info(logline) if message.content.startswith('https://giphy.com/'): roles = functions.checkrole(message.author.roles) channel = functions.checkchannel(message.channel.id) @@ -55,12 +55,12 @@ class Gif(commands.Cog): if roles is not True: await message.channel.send(embed=embed) logline = (str(message.author) + ' requested a gif: ' + str(gif_url)) - logger.info(logline) + log.info(logline) @commands.Cog.listener() async def on_ready(self): - print('##### GIF module active') + log.info(f'module active') def setup(bot): diff --git a/cogs/links.py b/cogs/links.py index 59d833f..d786036 100644 --- a/cogs/links.py +++ b/cogs/links.py @@ -1,10 +1,10 @@ import discord from discord.ext import commands -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) e = discord.Embed() @@ -29,7 +29,7 @@ class Links(commands.Cog): @commands.Cog.listener() async def on_ready(self): - print('##### LINKS module active') + log.info(f'module active') def setup(bot): diff --git a/cogs/random.py b/cogs/misc.py similarity index 82% rename from cogs/random.py rename to cogs/misc.py index 6be7034..c3d0137 100644 --- a/cogs/random.py +++ b/cogs/misc.py @@ -1,10 +1,10 @@ import discord from discord.ext import commands -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) e = discord.Embed() @@ -30,7 +30,7 @@ class Misc(commands.Cog): @commands.Cog.listener() async def on_ready(self): - print('##### RANDOM module active') + log.info(f'module active') def setup(bot): diff --git a/cogs/moderator.py b/cogs/moderator.py index afa2112..5515552 100644 --- a/cogs/moderator.py +++ b/cogs/moderator.py @@ -1,10 +1,10 @@ import discord from discord.ext import commands -import log +from logging import getLogger # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) e = discord.Embed() @@ -19,8 +19,8 @@ class Moderator(commands.Cog): @commands.Cog.listener() async def on_ready(self): - print('##### MODERATOR module active') - + log.info(f'module active') + def setup(bot): bot.add_cog(Moderator(bot)) \ No newline at end of file diff --git a/jeeves.py b/jeeves.py index 3b7dfc1..4de70fc 100755 --- a/jeeves.py +++ b/jeeves.py @@ -5,10 +5,16 @@ from discord.ext import commands from jeevesbot import env import os import log +import logging.config +from logging import getLogger + +# setup root logger handlers +logging.config.dictConfig(log.LOGGING) + # setup logging -logger = log.get_logger(__name__) +log = getLogger(__name__) # setup discord.py bot @@ -21,14 +27,14 @@ e = discord.Embed() @commands.has_permissions(administrator=True) async def load(ctx, extension): bot.load_extension(f'cogs.{extension}') - print(extension, 'module loaded') + log.info(f'{extension} module loaded') @bot.command() @commands.has_permissions(administrator=True) async def unload(ctx, extension): bot.unload_extension(f'cogs.{extension}') - print(extension, 'module unloaded') + log.info(f'{extension} module unloaded') @bot.command() @@ -36,7 +42,7 @@ async def unload(ctx, extension): async def reload(ctx, extension): bot.unload_extension(f'cogs.{extension}') bot.load_extension(f'cogs.{extension}') - print(extension, 'module reloaded') + log.info(f'{extension} module reloaded') @bot.event diff --git a/log.py b/log.py index 732e4f5..a2512f3 100644 --- a/log.py +++ b/log.py @@ -1,28 +1,32 @@ -import logging -import sys - -FORMATTER = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") -LOG_FILE = "jeeves.log" - -def get_console_handler(): - console_handler = logging.StreamHandler(sys.stdout) - console_handler.setFormatter(FORMATTER) - return console_handler - -def get_file_handler(): - file_handler = logging.FileHandler(LOG_FILE, encoding='utf-8', mode='a') - file_handler.setFormatter(FORMATTER) - return file_handler - -def get_logger(logger_name): - logger = logging.getLogger(logger_name) - - logger.setLevel(logging.DEBUG) # better to have too much log than not enough - - logger.addHandler(get_console_handler()) - logger.addHandler(get_file_handler()) - - # with this pattern, it's rarely necessary to propagate the error up to parent - logger.propagate = False - - return logger \ No newline at end of file +LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'formatters': { + 'standard': { + 'format': '[%(asctime)s - %(name)s - %(levelname)s - %(message)s' + } + }, + 'handlers': { + 'console': { + 'level': 'INFO', + 'class': 'logging.StreamHandler', + 'formatter': 'standard', + 'stream': 'ext://sys.stdout' + }, + 'file': { + 'level' : 'INFO', + 'class': 'logging.handlers.RotatingFileHandler', + 'formatter': 'standard', + 'filename': 'jeeves.log', + 'maxBytes': 4096, + 'backupCount': 7 + } + }, + 'loggers': { + '': { # root logger + 'handlers': ['console','file'], + 'level': 'DEBUG', + 'propagate': False + } + } +}