feat: Added argument to function with will be passed to the formatter

Author: MPCodeWriter21

CHANGES-LOG.md CHANGELOG.mdCHANGES-LOG.md renamed to CHANGELOG.md

@@ -3,8 +3,14 @@ log21
 
 Help this project by [Donation](DONATE.md)
 
-Changes log
+Changes
 -----------
+### 2.5.0
+
+Added `level_colors` argument to `log21.get_logger` function with will be passed to the formatter and allows
+user to set custom level colors while making a new logger.
+Also changed most `Dict` type hints to be `Mapping` and `list` to `Sequence` to make the functions more general
+and less strict.
 
 ### 2.4.7
 

LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [2021-2022] [CodeWriter21]
+   Copyright [2021-2023] [CodeWriter21]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -53,14 +53,12 @@ python setup.py install
 Changes
 -------
 
-### 2.4.7
+### 2.5.0
 
-Added `extra_values` argument to `CrashReporter.Formatter` which will let you pass extra static or dynamic values to the
-report formatter.
-They can be used in the format string. For dynamic values you can pass a function that takes no
-arguments as the value.
+Added `level_colors` argument to `log21.get_logger` function with will be passed to the formatter and allows
+user to set custom level colors while making a new logger.
 
-[Full Changes Log](https://github.com/MPCodeWriter21/log21/blob/master/CHANGES-LOG.md)
+[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 
 
 Usage Examples:

log21/Argparse.py

@@ -5,7 +5,7 @@
 import sys as _sys
 import log21 as _log21
 import argparse as _argparse
-from typing import Dict as _Dict
+from typing import Mapping as _Mapping
 from gettext import gettext as _gettext
 from textwrap import TextWrapper as _TextWrapper
 from log21.Colors import get_colors as _gc
@@ -27,7 +27,7 @@ class ColorizingHelpFormatter(_argparse.HelpFormatter):
         'choices': 'LightGreen'
     }
 
-    def __init__(self, prog, indent_increment=2, max_help_position=24, width=None, colors: _Dict[str, str] = None):
+    def __init__(self, prog, indent_increment=2, max_help_position=24, width=None, colors: _Mapping[str, str] = None):
         super().__init__(prog, indent_increment, max_help_position, width)
         if colors:
             for key, value in colors.items():
@@ -477,7 +477,7 @@ def _wrap_chunks(self, chunks):  # noqa: C901
 
 
 class ColorizingArgumentParser(_argparse.ArgumentParser):
-    def __init__(self, formatter_class=ColorizingHelpFormatter, colors: _Dict[str, str] = None, **kwargs):
+    def __init__(self, formatter_class=ColorizingHelpFormatter, colors: _Mapping[str, str] = None, **kwargs):
         self.logger = _log21.Logger('ArgumentParser')
         self.colors = colors
         super().__init__(formatter_class=formatter_class, **kwargs)

log21/CrashReporter/Formatters.py

@@ -4,7 +4,7 @@
 import traceback
 
 from datetime import datetime as _datetime
-from typing import Dict as _Dict, Union as _Union, Callable as _Callable, Any as _Any
+from typing import Mapping as _Mapping, Union as _Union, Callable as _Callable, Any as _Any
 
 __all__ = ['Formatter', 'CONSOLE_REPORTER_FORMAT', 'FILE_REPORTER_FORMAT', 'EMAIL_REPORTER_FORMAT']
 
@@ -23,7 +23,7 @@
 
 class Formatter:
     def __init__(self, format_: str, style: str = '%', datefmt: str = '%Y-%m-%d %H:%M:%S',
-                 extra_values: _Dict[str, _Union[str, _Callable, _Any]] = None):
+                 extra_values: _Mapping[str, _Union[str, _Callable, _Any]] = None):
         self._format = format_
 
         if style in ['%', '{']:

log21/Formatters.py

@@ -3,15 +3,15 @@
 
 import time as _time
 from logging import Formatter as __Formatter
-from typing import Dict as _Dict, Tuple as _Tuple
+from typing import Mapping as _Mapping, Tuple as _Tuple
 from log21.Colors import get_colors as _gc, ansi_escape
 from log21.Levels import INPUT, CRITICAL, ERROR, WARNING, INFO, DEBUG, PRINT
 
 __all__ = ['ColorizingFormatter', 'DecolorizingFormatter']
 
 
 class _Formatter(__Formatter):
-    _level_names: _Dict[int, str] = {
+    _level_names: _Mapping[int, str] = {
         DEBUG: 'DEBUG',
         INFO: 'INFO',
         WARNING: 'WARNING',
@@ -21,7 +21,7 @@ class _Formatter(__Formatter):
         INPUT: 'INPUT'
     }
 
-    def __init__(self, fmt: str = None, datefmt: str = None, style: str = '%', level_names: _Dict[int, str] = None):
+    def __init__(self, fmt: str = None, datefmt: str = None, style: str = '%', level_names: _Mapping[int, str] = None):
         """
         `level_names` usage:
         >>> import log21
@@ -59,8 +59,8 @@ def level_names(self):
     @level_names.setter
     def level_names(self, level_names):
         if level_names:
-            if not isinstance(level_names, _Dict):
-                raise TypeError('`level_names` must be a dictionary!')
+            if not isinstance(level_names, _Mapping):
+                raise TypeError('`level_names` must be a Mapping, a dictionary like object!')
             self._level_names = level_names
         else:
             self._level_names = dict()
@@ -89,7 +89,7 @@ def format(self, record) -> str:
 
 class ColorizingFormatter(_Formatter):
     # Default color values
-    level_colors: _Dict[int, _Tuple[str, ...]] = {
+    level_colors: _Mapping[int, _Tuple[str, ...]] = {
         DEBUG: ('lightblue',),
         INFO: ('green',),
         WARNING: ('lightyellow',),
@@ -102,49 +102,49 @@ class ColorizingFormatter(_Formatter):
     name_color = pathname_color = filename_color = module_color = func_name_color = thread_name_color = \
         message_color = tuple()
 
-    def __init__(self, fmt: str = None, datefmt: str = None, style: str = '%', level_names: _Dict[int, str] = None,
-                 level_colors: _Dict[int, _Tuple[str]] = None,
+    def __init__(self, fmt: str = None, datefmt: str = None, style: str = '%', level_names: _Mapping[int, str] = None,
+                 level_colors: _Mapping[int, _Tuple[str]] = None,
                  time_color: _Tuple[str, ...] = None, name_color: _Tuple[str, ...] = None,
                  pathname_color: _Tuple[str, ...] = None, filename_color: _Tuple[str, ...] = None,
                  module_color: _Tuple[str, ...] = None, func_name_color: _Tuple[str, ...] = None,
                  thread_name_color: _Tuple[str, ...] = None, message_color: _Tuple[str, ...] = None):
         super().__init__(fmt=fmt, datefmt=datefmt, style=style, level_names=level_names)
         # Checks and sets colors
         if level_colors:
-            if type(level_colors) is not dict:
-                raise TypeError('`level_colors` must be a dictionary!')
+            if not isinstance(level_colors, _Mapping):
+                raise TypeError('`level_colors` must be a dictionary like object!')
             for level, color in level_colors.items():
                 self.level_colors[level] = (_gc(*color),)
         if time_color:
-            if type(time_color) is not tuple:
+            if not isinstance(time_color, tuple):
                 raise TypeError('`time_color` must be a tuple!')
             self.time_color = time_color
         if name_color:
-            if type(name_color) is not tuple:
+            if not isinstance(name_color, tuple):
                 raise TypeError('`name_color` must be a tuple!')
             self.name_color = name_color
         if pathname_color:
-            if type(pathname_color) is not tuple:
+            if not isinstance(pathname_color, tuple):
                 raise TypeError('`pathname_color` must be a tuple!')
             self.pathname_color = pathname_color
         if filename_color:
-            if type(filename_color) is not tuple:
+            if not isinstance(filename_color, tuple):
                 raise TypeError('`filename_color` must be a tuple!')
             self.filename_color = filename_color
         if module_color:
-            if type(module_color) is not tuple:
+            if not isinstance(module_color, tuple):
                 raise TypeError('`module_color` must be a tuple!')
             self.module_color = module_color
         if func_name_color:
-            if type(func_name_color) is not tuple:
+            if not isinstance(func_name_color, tuple):
                 raise TypeError('`func_name_color` must be a tuple!')
             self.func_name_color = func_name_color
         if thread_name_color:
-            if type(thread_name_color) is not tuple:
+            if not isinstance(thread_name_color, tuple):
                 raise TypeError('`thread_name_color` must be a tuple!')
             self.thread_name_color = thread_name_color
         if message_color:
-            if type(message_color) is not tuple:
+            if not isinstance(message_color, tuple):
                 raise TypeError('`message_color` must be a tuple!')
             self.message_color = message_color
 

log21/PPrint.py

@@ -7,7 +7,7 @@
 import collections as _collections
 import dataclasses as _dataclasses
 
-from typing import Dict as _Dict, Union as _Union
+from typing import Mapping as _Mapping, Union as _Union
 from pprint import PrettyPrinter as _PrettyPrinter
 
 from log21.Colors import get_colors as _gc
@@ -65,7 +65,7 @@ def __lt__(self, other):
 
 
 class PrettyPrinter(_PrettyPrinter):
-    signs_colors: _Dict[str, str] = {
+    signs_colors: _Mapping[str, str] = {
         'square-brackets': _gc('LightCyan'),
         'curly-braces': _gc('LightBlue'),
         'parenthesis': _gc('LightGreen'),
@@ -75,7 +75,7 @@ class PrettyPrinter(_PrettyPrinter):
         'data': _gc('Green')
     }
 
-    def __init__(self, indent=1, width=80, depth=None, stream=None, signs_colors: _Dict[str, str] = None, *,
+    def __init__(self, indent=1, width=80, depth=None, stream=None, signs_colors: _Mapping[str, str] = None, *,
                  compact=False, sort_dicts=True, underscore_numbers=False, **kwargs):
         super().__init__(indent=indent, width=width, depth=depth, stream=stream, compact=compact, **kwargs)
         self._depth = depth
@@ -562,7 +562,7 @@ def _pprint_user_string(self, obj, stream, indent, allowance, context, level):
     _dispatch[_collections.UserString.__repr__] = _pprint_user_string
 
 
-def pformat(obj, indent=1, width=80, depth=None, signs_colors: _Dict[str, str] = None, *, compact=False,
+def pformat(obj, indent=1, width=80, depth=None, signs_colors: _Mapping[str, str] = None, *, compact=False,
             sort_dicts=True, underscore_numbers=False, **kwargs):
     """Format a Python object into a pretty-printed representation."""
     return PrettyPrinter(indent=indent, width=width, depth=depth, compact=compact, signs_colors=signs_colors,

log21/ProgressBar.py

@@ -3,7 +3,7 @@
 
 import shutil as _shutil
 
-from typing import Dict as _Dict, Any as _Any
+from typing import Mapping as _Mapping, Any as _Any
 
 import log21 as _log21
 from log21.Logger import Logger as _Logger
@@ -42,7 +42,7 @@ class ProgressBar:
     def __init__(self, *args, width: int = None, show_percentage: bool = True, prefix: str = '|', suffix: str = '|',
                  fill: str = '█', empty: str = ' ', format_: str = None, style: str = '%',
                  new_line_when_complete: bool = True, colors: dict = None, no_color: bool = False,
-                 logger: '_log21.Logger' = _logger, additional_variables: _Dict[str, _Any] = None):
+                 logger: '_log21.Logger' = _logger, additional_variables: _Mapping[str, _Any] = None):
         """
         :param args: Prevents the use of positional arguments
         :param width: The width of the progress bar
@@ -87,8 +87,8 @@ def __init__(self, *args, width: int = None, show_percentage: bool = True, prefi
         if colors and no_color:
             raise PermissionError('You cannot use `no_color` and `colors` parameters together!')
         if additional_variables:
-            if not isinstance(additional_variables, dict):
-                raise TypeError('`additional_variables` must be a dictionary')
+            if not isinstance(additional_variables, _Mapping):
+                raise TypeError('`additional_variables` must be a dictionary like object.')
             for key, value in additional_variables.items():
                 if not isinstance(key, str):
                     raise TypeError('`additional_variables` keys must be strings')

log21/TreePrint.py

@@ -1,7 +1,7 @@
 # log21.TreePrint.py
 # CodeWriter21
 
-from typing import Union as _Union
+from typing import Union as _Union, Mapping as _Mapping, Sequence as _Sequence
 
 from log21.Colors import get_colors as _gc
 
@@ -13,8 +13,8 @@ class Node:
             'fruit': _gc('LightMagenta'),
         }
 
-        def __init__(self, value: _Union[str, int], children: list = None, indent: int = 4, colors: dict = None,
-                     mode='-'):
+        def __init__(self, value: _Union[str, int], children: list = None, indent: int = 4,
+                     colors: _Mapping[str, str] = None, mode='-'):
             self.value = str(value)
             if children:
                 self._children = children
@@ -106,9 +106,9 @@ def get_child(self, value: str = None, index: int = None):
                 return self._children[index]
 
         @staticmethod
-        def add_to(node: 'TreePrint.Node', data: _Union[dict, list, str, int], indent: int = 4, colors: dict = None,
-                   mode='-'):
-            if isinstance(data, dict):
+        def add_to(node: 'TreePrint.Node', data: _Union[_Mapping, _Sequence, str, int], indent: int = 4,
+                   colors: _Mapping[str, str] = None, mode='-'):
+            if isinstance(data, _Mapping):
                 if len(data) == 1:
                     child = TreePrint.Node(list(data.keys())[0], indent=indent, colors=colors, mode=mode)
                     TreePrint.Node.add_to(child, list(data.values())[0], indent=indent, colors=colors, mode=mode)
@@ -118,14 +118,14 @@ def add_to(node: 'TreePrint.Node', data: _Union[dict, list, str, int], indent: i
                         child = TreePrint.Node(key, indent=indent, colors=colors, mode=mode)
                         TreePrint.Node.add_to(child, value, indent=indent, colors=colors, mode=mode)
                         node.add_child(child)
-            elif isinstance(data, list):
+            elif isinstance(data, _Sequence):
                 for value in data:
-                    if isinstance(value, dict):
+                    if isinstance(value, _Mapping):
                         for key, dict_value in value.items():
                             child = TreePrint.Node(key, indent=indent, colors=colors, mode=mode)
                             TreePrint.Node.add_to(child, dict_value, indent=indent, colors=colors, mode=mode)
                             node.add_child(child)
-                    elif isinstance(value, list):
+                    elif isinstance(value, _Sequence):
                         child = TreePrint.Node('>', indent=indent, colors=colors, mode=mode)
                         TreePrint.Node.add_to(child, value, indent=indent, colors=colors, mode=mode)
                         node.add_child(child)
@@ -136,23 +136,24 @@ def add_to(node: 'TreePrint.Node', data: _Union[dict, list, str, int], indent: i
                 child = TreePrint.Node(str(data), indent=indent, colors=colors, mode=mode)
                 node.add_child(child)
 
-    def __init__(self, data: _Union[dict, list, str, int], indent: int = 4, colors: dict = None, mode='-'):
+    def __init__(self, data: _Union[_Mapping, _Sequence, str, int], indent: int = 4, 
+                 colors: _Mapping[str, str] = None, mode='-'):
         self.indent = indent
         self.mode = mode
-        if isinstance(data, dict):
+        if isinstance(data, _Mapping):
             if len(data) == 1:
                 self.root = self.Node(list(data.keys())[0], indent=indent, colors=colors)
                 self.add_to_root(list(data.values()), colors=colors)
             else:
                 self.root = self.Node('root', indent=indent, colors=colors)
                 self.add_to_root(data, colors=colors)
-        elif isinstance(data, list):
+        elif isinstance(data, _Sequence):
             self.root = self.Node('root', indent=indent, colors=colors)
             self.add_to_root(data, colors=colors)
         else:
             self.root = self.Node(str(data), indent=indent, colors=colors)
 
-    def add_to_root(self, data: _Union[dict, list, str, int], colors: dict = None):
+    def add_to_root(self, data: _Union[_Mapping, _Sequence, str, int], colors: _Mapping[str, str] = None):
         self.Node.add_to(self.root, data, indent=self.indent, colors=colors, mode=self.mode)
 
     def __str__(self, mode=None):
@@ -161,5 +162,6 @@ def __str__(self, mode=None):
         return self.root.__str__(mode=mode)
 
 
-def tree_format(data: _Union[dict, list, str, int], indent: int = 4, mode='-', colors: dict = None):
+def tree_format(data: _Union[_Mapping, _Sequence, str, int], indent: int = 4, mode='-',
+                colors: _Mapping[str, str] = None):
     return str(TreePrint(data, indent=indent, colors=colors, mode=mode))