Rename internal modules and replace "from _ import _" statements

This also avoids having both a module named "escape_codes" and a dict named "escape_codes" in the same top-level module.
borntyping · Jun 14, 2021 · 164d120 · 164d120
1 parent 4dc03c6
commit 164d120
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 12 deletions.
diff --git a/colorlog/__init__.py b/colorlog/__init__.py
@@ -3,8 +3,7 @@
 import sys
 import warnings
 
-from colorlog.colorlog import (
-    escape_codes,
+from colorlog.formatter import (
     default_log_colors,
     ColoredFormatter,
     LevelFormatter,
@@ -28,7 +27,6 @@
 __all__ = (
     "ColoredFormatter",
     "default_log_colors",
-    "escape_codes",
     "basicConfig",
     "root",
     "getLogger",

diff --git a/colorlog/colorlog.py → colorlog/formatter.py b/colorlog/colorlog.py → colorlog/formatter.py
@@ -5,10 +5,9 @@
 import sys
 import typing
 
-from colorlog.escape_codes import escape_codes, parse_colors
+import colorlog.escape_codes
 
 __all__ = (
-    "escape_codes",
     "default_log_colors",
     "ColoredFormatter",
     "LevelFormatter",
@@ -128,7 +127,7 @@ def _escape_code_map(self, item: str) -> EscapeCodes:
 
         If _blank_escape_codes() returns True, all values will be an empty string.
         """
-        codes = {**escape_codes}
+        codes = {**colorlog.escape_codes.escape_codes}
         codes.setdefault("log_color", self._get_escape_code(self.log_colors, item))
         for name, colors in self.secondary_log_colors.items():
             codes.setdefault("%s_log_color" % name, self._get_escape_code(colors, item))
@@ -152,7 +151,7 @@ def _blank_escape_codes(self):
     @staticmethod
     def _get_escape_code(log_colors: LogColors, item: str) -> str:
         """Extract a color sequence from a mapping, and return escape codes."""
-        return parse_colors(log_colors.get(item, ""))
+        return colorlog.escape_codes.parse_colors(log_colors.get(item, ""))
 
     def _append_reset(self, message: str, escapes: EscapeCodes) -> str:
         """Add a reset code to the end of the message, if it's not already there."""

diff --git a/colorlog/logging.py b/colorlog/logging.py
@@ -4,16 +4,16 @@
 import logging
 import typing
 
-from colorlog.colorlog import ColoredFormatter, LogColors, SecondaryLogColors
+import colorlog.formatter
 
 BASIC_FORMAT = "%(log_color)s%(levelname)s%(reset)s:%(name)s:%(message)s"
 
 
 def basicConfig(
     style: str = "%",
-    log_colors: typing.Optional[LogColors] = None,
+    log_colors: typing.Optional[colorlog.formatter.LogColors] = None,
     reset: bool = True,
-    secondary_log_colors: typing.Optional[SecondaryLogColors] = None,
+    secondary_log_colors: typing.Optional[colorlog.formatter.SecondaryLogColors] = None,
     format: str = BASIC_FORMAT,
     datefmt: typing.Optional[str] = None,
     **kwargs
@@ -24,7 +24,7 @@ def basicConfig(
     try:
         handler = logging.root.handlers[0]
         handler.setFormatter(
-            ColoredFormatter(
+            colorlog.formatter.ColoredFormatter(
                 fmt=format,
                 datefmt=datefmt,
                 style=style,

diff --git a/colorlog/tests/test_exports.py b/colorlog/tests/test_exports.py
@@ -7,7 +7,6 @@ def test_exports():
     assert {
         "ColoredFormatter",
         "default_log_colors",
-        "escape_codes",
         "basicConfig",
         "root",
         "getLogger",