fix: Explicitly export top-level functions and make the logger object typed attributes.

Author: DanCardin

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "setuplog"
-version = "0.2.3"
+version = "0.3.0"
 description = ""
 authors = []
 license = "MIT"
@@ -22,6 +22,7 @@ python = ">=3.3, !=3.3.*, !=3.4.*, !=3.5.*, <4"
 bandit = "*"
 black = { version = "19.3b0", allow-prereleases = true, python = ">=3.6" }
 coverage = ">=5"
+mypy = ">=0.931"
 flake8 = "^3.7"
 isort = "^4.3"
 pydocstyle = "*"
@@ -43,6 +44,13 @@ order_by_type = false
 known_first_party = 'tests'
 use_parentheses = true
 
+[tool.mypy]
+strict_optional = true
+ignore_missing_imports = true
+warn_unused_ignores = true
+implicit_reexport = true
+incremental = true
+
 [build-system]
 requires = [ "poetry>=0.12" ]
 build-backend = "poetry.masonry.api"

pyproject.toml

@@ -2,12 +2,6 @@
 ignore = D1,D200,D202,D203,D204,D213,D406,D407,D413
 match_dir = ^[^\.{]*
 
-[mypy]
-strict_optional = True
-ignore_missing_imports = True
-warn_unused_ignores = True
-incremental = True
-
 [tool:pytest]
 doctest_optionflags = NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS
 addopts = --ff --doctest-modules

setup.cfg

@@ -1,5 +1,14 @@
-# flake8: noqa
 from setuplog.adaptors import M, StyleAdapter
 from setuplog.decorator import log_duration, log_exceptions
 from setuplog.logger import create_log_handler, log
 from setuplog.setup import setup_logging
+
+__all__ = [
+    "create_log_handler",
+    "log",
+    "log_duration",
+    "log_exceptions",
+    "M",
+    "setup_logging",
+    "StyleAdapter",
+]

src/setuplog/__init__.py

@@ -3,6 +3,7 @@
 https://docs.python.org/3/howto/logging-cookbook.html#use-of-alternative-formatting-styles
 """
 import logging
+from typing import Any, Optional
 
 
 class M:
@@ -12,7 +13,7 @@ class M:
     >>> logging.info(M('foo={foo}', foo=1))
     """
 
-    def __init__(self, fmt, *args, **kwargs):
+    def __init__(self, fmt: str, *args: Any, **kwargs: Any):
         self.fmt = fmt
         self.args = args
         self.kwargs = kwargs
@@ -25,7 +26,7 @@ def __str__(self):
 
 
 class StyleAdapter(logging.LoggerAdapter):
-    def __init__(self, logger, extra=None):
+    def __init__(self, logger: logging.Logger, extra: Optional[dict] = None):
         super(StyleAdapter, self).__init__(logger, extra or {})
 
     def log(self, level, msg, *args, **kwargs):

src/setuplog/adaptors.py

@@ -20,7 +20,7 @@ def log_exceptions(func):
     def decorator(*args, **kwargs):
         try:
             return func(*args, **kwargs)
-        except Exception as e:
+        except Exception:
             log.exception("")
             raise
 

src/setuplog/decorator.py

@@ -13,6 +13,9 @@
 import logging.config
 import sys
 from functools import lru_cache
+from typing import Any, Union
+
+from setuplog.adaptors import M
 
 
 def create_log_handler(name, log_level=None, style_adaptor=None):
@@ -29,22 +32,51 @@ def create_log_handler(name, log_level=None, style_adaptor=None):
     return log
 
 
+def get_logger() -> logging.Logger:
+    segments = []
+    namespace = getattr(logging.config, "namespace", "")
+    if namespace:
+        segments.append(namespace)
+
+    style_adaptor = getattr(logging.config, "style_adaptor", None)
+
+    # Ensure the logger name is pulled from 2 frames up rather than from the local frame. One frame for this function, and one for the
+    # `_Logging` function calls.
+    frame_name = sys._getframe(2).f_globals["__name__"]
+    segments.append(frame_name)
+
+    name = ".".join(segments)
+    return _cached_logger(name, style_adaptor=style_adaptor)
+
+
 class _Logging(object):
-    def __getattr__(self, attr):
-        segments = []
-        namespace = getattr(logging.config, "namespace", "")
-        if namespace:
-            segments.append(namespace)
+    def debug(self, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.debug(msg, *args, **kwargs)
+
+    def info(self, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.info(msg, *args, **kwargs)
+
+    def warning(self, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.warning(msg, *args, **kwargs)
+
+    def error(self, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.error(msg, *args, **kwargs)
 
-        style_adaptor = getattr(logging.config, "style_adaptor", None)
+    def exception(self, msg: Union[str, M], *args: Any, exc_info=True, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.exception(msg, *args, exc_info=exc_info, **kwargs)
 
-        # Ensure the logger name is pulled from 1 frame up rather than from the local frame.
-        frame_name = sys._getframe(1).f_globals["__name__"]
-        segments.append(frame_name)
+    def critical(self, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.critical(msg, *args, **kwargs)
 
-        name = ".".join(segments)
-        logger = _cached_logger(name, style_adaptor=style_adaptor)
-        return getattr(logger, attr)
+    def log(self, level: int, msg: Union[str, M], *args: Any, **kwargs: Any) -> None:
+        logger = get_logger()
+        logger.log(level, msg, *args, **kwargs)
 
 
 _cached_logger = lru_cache()(create_log_handler)

src/setuplog/logger.py

@@ -1,3 +1,5 @@
+import logging
+
 from setuplog import log, M, setup_logging
 
 
@@ -51,3 +53,12 @@ def __repr__(self):
     log.info(Foo())
     console_out, _ = capsys.readouterr()
     assert " - INFO - Foo(1, 2, 3)" in console_out
+
+
+def test_level_filter(caplog):
+    caplog.set_level(logging.INFO)
+
+    setup_logging(style="format")
+
+    log.debug("asdf")
+    assert len(caplog.records) == 0

tests/test_adaptor.py

@@ -1,12 +1,16 @@
+import logging
 import tempfile
 
-from setuplog import log, M, setup_logging, create_log_handler
+from setuplog import create_log_handler, log, M, setup_logging
 
 
 def log_levels(logger):
     logger.info("")
     logger.warning("")
     logger.error("")
+    logger.exception("")
+    logger.critical("")
+    logger.log(logging.INFO, "")
 
 
 def log_multiple_lines(logger):