Rename colorlog.logging to colorlog.wrappers

Author: borntyping

colorlog/__init__.py

@@ -3,36 +3,32 @@
 import sys
 import warnings
 
-from logging import (
-    CRITICAL,
-    FATAL,
-    ERROR,
-    WARNING,
-    WARN,
-    INFO,
-    DEBUG,
-    NOTSET,
-)
-
 from colorlog.formatter import (
-    default_log_colors,
     ColoredFormatter,
     LevelFormatter,
     TTYColoredFormatter,
+    default_log_colors,
 )
-
-from colorlog.logging import (
+from colorlog.wrappers import (
+    CRITICAL,
+    DEBUG,
+    ERROR,
+    FATAL,
+    INFO,
+    NOTSET,
+    StreamHandler,
+    WARN,
+    WARNING,
     basicConfig,
-    root,
-    getLogger,
-    log,
+    critical,
     debug,
-    info,
-    warning,
     error,
     exception,
-    critical,
-    StreamHandler,
+    getLogger,
+    info,
+    log,
+    root,
+    warning,
 )
 
 __all__ = (

colorlog/tests/test_logging.py

@@ -0,0 +1,43 @@
+"""Test the colorlog.wrappers module."""
+
+import logging
+
+import colorlog
+
+
+def test_logging_module(test_logger):
+    test_logger(logging)
+
+
+def test_colorlog_module(test_logger):
+    test_logger(colorlog)
+
+
+def test_colorlog_basicConfig(test_logger):
+    colorlog.basicConfig()
+    test_logger(colorlog.getLogger())
+
+
+def test_reexports():
+    assert colorlog.root is logging.root
+    assert colorlog.getLogger is logging.getLogger
+    assert colorlog.StreamHandler is logging.StreamHandler
+
+    assert colorlog.CRITICAL is logging.CRITICAL
+    assert colorlog.FATAL is logging.FATAL
+    assert colorlog.ERROR is logging.ERROR
+    assert colorlog.WARNING is logging.WARNING
+    assert colorlog.WARN is logging.WARN
+    assert colorlog.INFO is logging.INFO
+    assert colorlog.DEBUG is logging.DEBUG
+    assert colorlog.NOTSET is logging.NOTSET
+
+
+def test_wrappers():
+    assert colorlog.debug is not logging.debug
+    assert colorlog.info is not logging.info
+    assert colorlog.warning is not logging.warning
+    assert colorlog.error is not logging.error
+    assert colorlog.critical is not logging.critical
+    assert colorlog.log is not logging.log
+    assert colorlog.exception is not logging.exception

colorlog/tests/test_wrappers.py

@@ -3,18 +3,29 @@
 import functools
 import logging
 import typing
+from logging import (
+    CRITICAL,
+    DEBUG,
+    ERROR,
+    FATAL,
+    INFO,
+    NOTSET,
+    StreamHandler,
+    WARN,
+    WARNING,
+    getLogger,
+    root,
+)
 
 import colorlog.formatter
 
-BASIC_FORMAT = "%(log_color)s%(levelname)s%(reset)s:%(name)s:%(message)s"
-
 
 def basicConfig(
     style: str = "%",
     log_colors: typing.Optional[colorlog.formatter.LogColors] = None,
     reset: bool = True,
     secondary_log_colors: typing.Optional[colorlog.formatter.SecondaryLogColors] = None,
-    format: str = BASIC_FORMAT,
+    format: str = "%(log_color)s%(levelname)s%(reset)s:%(name)s:%(message)s",
     datefmt: typing.Optional[str] = None,
     **kwargs
 ) -> None:
@@ -39,7 +50,7 @@ def basicConfig(
 
 
 def ensure_configured(func):
-    """Modify a function to call ``basicConfig`` first if no handlers exist."""
+    """Modify a function to call our basicConfig() first if no handlers exist."""
 
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
@@ -50,14 +61,10 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-root = logging.root
-getLogger = logging.getLogger
 debug = ensure_configured(logging.debug)
 info = ensure_configured(logging.info)
 warning = ensure_configured(logging.warning)
 error = ensure_configured(logging.error)
 critical = ensure_configured(logging.critical)
 log = ensure_configured(logging.log)
 exception = ensure_configured(logging.exception)
-
-StreamHandler = logging.StreamHandler