Break up logging so everything isn't coming off the root

[danielquinn]

As discussed earlier, here's the code snippet I was talking about to make logging easier project-wide:

# logger.py

import logging


class LogMixin:
    """
    Use this mixin to do logging:
      self.logger.debug("My debugging message")
    """

    __logger = None

    @property
    def logger(self) -> logging.Logger:

        if self.__logger:
            return self.__logger
        self.__logger = logging.getLogger(self.__class__.__module__)

        return self.logger

To use it, just do this:

from logger import LogMixin


class MyClass(LogMixin, AnyOtherParent):
    ...
    def my_method(self):
        self.logger.debug("This is my debug message with %s", some_variable)

This will produce log entries attached to the class and file path rather than the root.

[cgmcintyr]

Nice, going to steal this mixin for a project I'm working on.

You can get a speedup using a try/except block, as the except block will only run on the first call to self.logger.

class LogMixin:

    @property
    def logger(self) -> logging.Logger:
        try:
            return self.__logger
        except AttributeError:
            self.__logger = logging.getLogger(self.__class__.__module__)
            return self.__logger

Whether it's cleaner is another question...

[danielquinn]

Ooh handy tip, thanks!

[cgmcintyr]

No worries :) It's explained here