refactor: Logger parse structure (#431)

* fix: set default logging handlers to NullHandlers

* fix: replace log instancing with new handler funct

* ref: pre-commit hook

* fix: pass errors and higher by default

* fix: add docstring and fix typo

* fix: reference conflicts with formatter

* pre-commit: fix complaint from isort

Author: V3ntus

interactions/api/dispatch.py

@@ -1,8 +1,10 @@
 from asyncio import get_event_loop
-from logging import Logger, getLogger
+from logging import Logger
 from typing import Coroutine, Optional
 
-log: Logger = getLogger("dispatch")
+from interactions.base import get_logger
+
+log: Logger = get_logger("dispatch")
 
 
 class Listener:

interactions/api/gateway.py

@@ -1,7 +1,7 @@
 import sys
 from asyncio import get_event_loop, run_coroutine_threadsafe
 from json import dumps
-from logging import Logger, getLogger
+from logging import Logger
 from random import random
 from threading import Event, Thread
 from typing import Any, List, Optional, Union
@@ -10,6 +10,7 @@
 from orjson import loads
 
 from interactions.api.models.gw import Presence
+from interactions.base import get_logger
 from interactions.enums import InteractionType, OptionType
 
 from .dispatch import Listener
@@ -18,7 +19,7 @@
 from .http import HTTPClient
 from .models.flags import Intents
 
-log: Logger = getLogger("gateway")
+log: Logger = get_logger("gateway")
 
 __all__ = ("Heartbeat", "WebSocket")
 

interactions/api/http.py

@@ -2,7 +2,7 @@
 import traceback
 from asyncio import AbstractEventLoop, Lock, get_event_loop, get_running_loop
 from json import dumps
-from logging import Logger, getLogger
+from logging import Logger
 from sys import version_info
 from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union
 from urllib.parse import quote
@@ -11,6 +11,7 @@
 from aiohttp import __version__ as http_version
 
 import interactions.api.cache
+from interactions.base import __version__, get_logger
 from interactions.models.misc import MISSING
 
 from ..api.cache import Cache, Item
@@ -31,9 +32,8 @@
     User,
     WelcomeScreen,
 )
-from ..base import __version__
 
-log: Logger = getLogger("http")
+log: Logger = get_logger("http")
 
 __all__ = ("Route", "Request", "HTTPClient")
 _session: ClientSession = ClientSession()

interactions/api/models/misc.py

@@ -4,11 +4,13 @@
 # TODO: Reorganise mixins to its own thing, currently placed here because circular import sucks.
 # also, it should be serialiser* but idk, fl0w'd say something if I left it like that. /shrug
 import datetime
-import logging
+from logging import Logger
 from math import floor
 from typing import Union
 
-log = logging.getLogger("mixin")
+from interactions.base import get_logger
+
+log: Logger = get_logger("mixin")
 
 
 class DictSerializerMixin(object):

interactions/base.py

@@ -1,5 +1,5 @@
 import logging
-from typing import ClassVar
+from typing import ClassVar, List, Optional, Union
 
 from colorama import Fore, Style, init
 
@@ -18,21 +18,44 @@
 
 
 class Data:
-    """A class representing constants for the library."""
+    """A class representing constants for the library.
 
-    LOGGER: ClassVar[int] = logging.WARNING
+    :ivar LOG_LEVEL ClassVar[int]: The default level of logging as an integer
+    :ivar LOGGERS List[str]: A list of all loggers registered from this library
+    """
+
+    LOG_LEVEL: ClassVar[int] = logging.ERROR
+    LOGGERS: List[str] = []
+
+
+def get_logger(
+    logger: Optional[Union[logging.Logger, str]] = None,
+    handler: Optional[logging.Handler] = logging.StreamHandler(),
+) -> logging.Logger:
+    _logger = logging.getLogger(logger) if isinstance(logger, str) else logger
+    _logger_name = logger if isinstance(logger, str) else logger.name
+    if len(_logger.handlers) > 1:
+        _logger.removeHandler(_logger.handlers[0])
+    _handler = handler
+    _handler.setFormatter(CustomFormatter)
+    _handler.setLevel(Data.LOG_LEVEL)
+    _logger.addHandler(_handler)
+    _logger.propagate = True
+
+    Data.LOGGERS.append(_logger_name)
+    return _logger
 
 
 class CustomFormatter(logging.Formatter):
     """A class that allows for customized logged outputs from the library."""
 
-    format: str = "%(levelname)s:%(name)s:(ln.%(lineno)d):%(message)s"
+    format_str: str = "%(levelname)s:%(name)s:(ln.%(lineno)d):%(message)s"
     formats: dict = {
-        logging.DEBUG: Fore.CYAN + format + Fore.RESET,
-        logging.INFO: Fore.GREEN + format + Fore.RESET,
-        logging.WARNING: Fore.YELLOW + format + Fore.RESET,
-        logging.ERROR: Fore.RED + format + Fore.RESET,
-        logging.CRITICAL: Style.BRIGHT + Fore.RED + format + Fore.RESET + Style.NORMAL,
+        logging.DEBUG: Fore.CYAN + format_str + Fore.RESET,
+        logging.INFO: Fore.GREEN + format_str + Fore.RESET,
+        logging.WARNING: Fore.YELLOW + format_str + Fore.RESET,
+        logging.ERROR: Fore.RED + format_str + Fore.RESET,
+        logging.CRITICAL: Style.BRIGHT + Fore.RED + format_str + Fore.RESET + Style.NORMAL,
     }
 
     def __init__(self):

interactions/client.py

@@ -2,7 +2,7 @@
 from asyncio import get_event_loop
 from importlib import import_module
 from importlib.util import resolve_name
-from logging import Logger, getLogger
+from logging import Logger
 from typing import Any, Callable, Coroutine, Dict, List, Optional, Union
 
 from .api.cache import Cache
@@ -15,14 +15,15 @@
 from .api.models.guild import Guild
 from .api.models.misc import Snowflake
 from .api.models.team import Application
+from .base import get_logger
 from .decor import command
 from .decor import component as _component
 from .enums import ApplicationCommandType
 from .models.command import ApplicationCommand, Option
 from .models.component import Button, Modal, SelectMenu
 from .models.misc import MISSING
 
-log: Logger = getLogger("client")
+log: Logger = get_logger("client")
 _token: str = ""  # noqa
 _cache: Optional[Cache] = None
 

interactions/context.py

@@ -1,4 +1,4 @@
-from logging import Logger, getLogger
+from logging import Logger
 from typing import List, Optional, Union
 
 from .api.models.channel import Channel
@@ -7,12 +7,13 @@
 from .api.models.message import Embed, Message, MessageInteraction, MessageReference
 from .api.models.misc import DictSerializerMixin, Snowflake
 from .api.models.user import User
+from .base import get_logger
 from .enums import InteractionCallbackType, InteractionType
 from .models.command import Choice
 from .models.component import ActionRow, Button, Modal, SelectMenu
 from .models.misc import InteractionData
 
-log: Logger = getLogger("context")
+log: Logger = get_logger("context")
 
 
 class Context(DictSerializerMixin):