Added Logurud class which exposes functions such as self.info(...) to classes with loguru as logger

Author: wolph

README.rst

@@ -36,16 +36,22 @@ Installation:
 
 The package can be installed through `pip` (this is the recommended method):
 
+.. code-block:: bash
+
     pip install python-utils
     
 Or if `pip` is not available, `easy_install` should work as well:
 
+.. code-block:: bash
+
     easy_install python-utils
     
 Or download the latest release from Pypi (https://pypi.python.org/pypi/python-utils) or Github.
 
 Note that the releases on Pypi are signed with my GPG key (https://pgp.mit.edu/pks/lookup?op=vindex&search=0xE81444E9CE1F695D) and can be checked using GPG:
 
+.. code-block:: bash
+
      gpg --verify python-utils-<version>.tar.gz.asc python-utils-<version>.tar.gz
 
 Quickstart
@@ -226,6 +232,22 @@ Or add a correclty named logger to your classes which can be easily accessed:
     import logging
     my_class.log(logging.ERROR, 'log')
 
+Alternatively loguru is also supported. It is largely a drop-in replacement for the logging module which is a bit more convenient to configure:
+
+First install the extra loguru package:
+
+.. code-block:: bash
+
+    pip install 'python-utils[loguru]'
+
+.. code-block:: python
+
+    class MyClass(Logurud):
+        ...
+
+Now you can use the `Logurud` class to make functions such as `self.info()`
+available. The benefit of this approach is that you can add extra context or
+options to you specific loguru instance (i.e. `self.logger`):
 
 Convenient type aliases and some commonly used types:
 

_python_utils_tests/test_logger.py

@@ -0,0 +1,19 @@
+import pytest
+
+from python_utils.loguru import Logurud
+
+
+loguru = pytest.importorskip('loguru')
+
+
+def test_logurud():
+    class MyClass(Logurud):
+        pass
+
+    my_class = MyClass()
+    my_class.debug('debug')
+    my_class.info('info')
+    my_class.warning('warning')
+    my_class.error('error')
+    my_class.exception('exception')
+    my_class.log(0, 'log')

python_utils/__init__.py

@@ -26,6 +26,7 @@
 from .time import timedelta_to_seconds
 from .time import timeout_generator
 from .time import aio_timeout_generator
+from .logger import Logged, LoggerBase
 
 __all__ = [
     'aio',
@@ -55,4 +56,6 @@
     'timeout_generator',
     'acount',
     'aio_timeout_generator',
+    'Logged',
+    'LoggerBase',
 ]

python_utils/logger.py

@@ -1,3 +1,4 @@
+import abc
 import functools
 import logging
 
@@ -6,15 +7,18 @@
 import typing
 
 
-class Logged(object):
-    '''Class which automatically adds a named logger to your class when
-    interiting
+class LoggerBase(abc.ABC):
+    '''Class which automatically adds logging utilities to your class when
+    interiting. Expects `logger` to be a logging.Logger or compatible instance.
 
     Adds easy access to debug, info, warning, error, exception and log methods
 
-    >>> class MyClass(Logged):
+    >>> class MyClass(LoggerBase):
+    ...     logger = logging.getLogger(__name__)
+    ...
     ...     def __init__(self):
     ...         Logged.__init__(self)
+
     >>> my_class = MyClass()
     >>> my_class.debug('debug')
     >>> my_class.info('info')
@@ -23,13 +27,9 @@ class Logged(object):
     >>> my_class.exception('exception')
     >>> my_class.log(0, 'log')
     '''
-
-    logger: logging.Logger
-
-    def __new__(cls, *args, **kwargs):
-        cls.logger = logging.getLogger(
-            cls.__get_name(cls.__module__, cls.__name__))
-        return super(Logged, cls).__new__(cls)
+    # Being a tad lazy here and not creating a Protocol.
+    # The actual classes define the correct type anyway
+    logger: typing.Any
 
     @classmethod
     def __get_name(cls, *name_parts: str) -> str:
@@ -64,3 +64,30 @@ def exception(cls, msg: str, *args: typing.Any, **kwargs: typing.Any):
     @functools.wraps(logging.log)
     def log(cls, lvl: int, msg: str, *args: typing.Any, **kwargs: typing.Any):
         cls.logger.log(lvl, msg, *args, **kwargs)
+
+
+class Logged(LoggerBase):
+    '''Class which automatically adds a named logger to your class when
+    interiting
+
+    Adds easy access to debug, info, warning, error, exception and log methods
+
+    >>> class MyClass(Logged):
+    ...     def __init__(self):
+    ...         Logged.__init__(self)
+    >>> my_class = MyClass()
+    >>> my_class.debug('debug')
+    >>> my_class.info('info')
+    >>> my_class.warning('warning')
+    >>> my_class.error('error')
+    >>> my_class.exception('exception')
+    >>> my_class.log(0, 'log')
+    '''
+
+    logger: logging.Logger
+
+    def __new__(cls, *args, **kwargs):
+        cls.logger = logging.getLogger(
+            cls._LoggerBase__get_name(cls.__module__, cls.__name__)
+        )
+        return super(Logged, cls).__new__(cls)

python_utils/loguru.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from . import logger
+
+import loguru
+
+__all__ = ['Logurud']
+
+
+class Logurud(logger.LoggerBase):
+    logger: loguru.Logger
+
+    def __new__(cls, *args, **kwargs):
+        # Import at runtime to make loguru an optional dependency
+        import loguru
+        cls.logger: loguru.Loguru = loguru.logger
+        return super().__new__(cls)

setup.py

@@ -29,6 +29,9 @@
         long_description=long_description,
         tests_require=['pytest'],
         extras_require={
+            'loguru': [
+                'loguru',
+            ],
             'docs': [
                 'mock',
                 'sphinx',
@@ -43,6 +46,7 @@
                 'pytest-asyncio',
                 'sphinx',
                 'types-setuptools',
+                'loguru',
             ],
         },
         classifiers=['License :: OSI Approved :: BSD License'],