log21 2.9.2__tar.gz → 2.10.1__tar.gz

{log21-2.9.2/src/log21.egg-info → log21-2.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: log21
-Version: 2.9.2
+Version: 2.10.1
 Summary: A simple logging package that helps you log colorized messages in Windows console.
 Author-email: "CodeWriter21(Mehrad Pooryoussof)" <CodeWriter21@gmail.com>
 License: Apache License 2.0
@@ -92,10 +92,11 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
 
-### 2.9.2
+### 2.10.0
 
-+ Added `Sequence[T]` as a supported type to the ColorizingArgumentParser.
-+ Bug fixes.
++ Added some exception classes to raise in the "argumentified" functions to show 
+  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
+  `RequiredArgument`, `TooFewArguments`
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 

{log21-2.9.2 → log21-2.10.1}/README.md

@@ -61,10 +61,11 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
 
-### 2.9.2
+### 2.10.0
 
-+ Added `Sequence[T]` as a supported type to the ColorizingArgumentParser.
-+ Bug fixes.
++ Added some exception classes to raise in the "argumentified" functions to show 
+  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
+  `RequiredArgument`, `TooFewArguments`
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 

{log21-2.9.2 → log21-2.10.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "log21"
 authors = [
-  {name = "CodeWriter21(Mehrad Pooryoussof)", email = "CodeWriter21@gmail.com"}
+    {name = "CodeWriter21(Mehrad Pooryoussof)", email = "CodeWriter21@gmail.com"}
 ]
 description = "A simple logging package that helps you log colorized messages in Windows console."
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -13,20 +13,20 @@ requires-python = ">=3.8"
 keywords = ['python', 'log', 'colorize', 'color', 'logging', 'Python3', 'CodeWriter21']
 license = {text = "Apache License 2.0"}
 classifiers = [
-  "Intended Audience :: Developers",
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.7",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Operating System :: Unix",
-  "Operating System :: Microsoft :: Windows",
-  "Operating System :: MacOS :: MacOS X"
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: Unix",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS :: MacOS X"
 ]
 dependencies = [
-  "webcolors",
-  "docstring-parser"
+    "webcolors",
+    "docstring-parser"
 ]
-version = "2.9.2"
+version = "2.10.1"
 
 [tool.setuptools.packages.find]
 where = ["src"]
@@ -43,11 +43,11 @@ dev = ["yapf", "isort", "docformatter", "pylint", "json5", "pytest"]
 max-line-length = 88
 
 disable = [
-  "too-few-public-methods",
-  "too-many-arguments",
-  "protected-access",
-  "too-many-locals",
-  "fixme",
+    "too-few-public-methods",
+    "too-many-arguments",
+    "protected-access",
+    "too-many-locals",
+    "fixme",
 ]
 
 [tool.pylint.design]

{log21-2.9.2 → log21-2.10.1}/src/log21/Argparse.py

@@ -280,15 +280,28 @@ class ColorizingHelpFormatter(_argparse.HelpFormatter):
         group_actions = set()
         inserts = {}
         for group in groups:
+            if not group._group_actions:
+                raise ValueError(f'empty group {group}')
+
             try:
                 start = actions.index(group._group_actions[0])
             except ValueError:
                 continue
             else:
-                end = start + len(group._group_actions)
+                group_action_count = len(group._group_actions)
+                end = start + group_action_count
                 if actions[start:end] == group._group_actions:
+
+                    suppressed_actions_count = 0
                     for action in group._group_actions:
                         group_actions.add(action)
+                        if action.help is _argparse.SUPPRESS:
+                            suppressed_actions_count += 1
+
+                    exposed_actions_count = group_action_count - suppressed_actions_count
+                    if not exposed_actions_count:
+                        continue
+
                     if not group.required:
                         if start in inserts:
                             inserts[start] += ' ['
@@ -298,7 +311,7 @@ class ColorizingHelpFormatter(_argparse.HelpFormatter):
                             inserts[end] += ']'
                         else:
                             inserts[end] = ']'
-                    else:
+                    elif exposed_actions_count > 1:
                         if start in inserts:
                             inserts[start] += ' ('
                         else:
@@ -941,7 +954,22 @@ class ColorizingArgumentParser(_argparse.ArgumentParser, _ActionsContainer):
 
             # get the optional identified at this index
             option_tuple = option_string_indices[start_index]
-            action, option_string, explicit_arg = option_tuple
+            if len(option_tuple) == 3:
+                action, option_string, explicit_arg = option_tuple
+                sep = None
+            elif len(option_tuple) == 4:
+                action, option_string, sep, explicit_arg = option_tuple
+            else:
+                # Tell the user that there seem to have been a change in argparse module
+                # and if they see this error they should immediately report it in an
+                # issue at GitHub.com/MPCodeWriter21/log21 with their Python version
+                raise ValueError(
+                    'Unknown option tuple length, please report this issue at: '
+                    'https://GitHub.com/MPCodeWriter21/log21\n'
+                    f'Python version: {_sys.version}'
+                    f'Option tuple: {option_tuple}'
+                    f'log21 version: {_log21.__version__}'
+                )
 
             # identify additional optionals in the same arg string
             # (e.g. -xyz is the same as -x -y -z if no args are required)
@@ -964,20 +992,27 @@ class ColorizingArgumentParser(_argparse.ArgumentParser, _ActionsContainer):
                     # of the tail of the option string
                     chars = self.prefix_chars
                     if arg_count == 0 and option_string[1] not in chars:
+                        if sep or explicit_arg[0] in chars:
+                            msg = _gettext('ignored explicit argument %r')
+                            raise _argparse.ArgumentError(action, msg % explicit_arg)
                         action_tuples.append((action, [], option_string))
                         char = option_string[0]
                         option_string = char + explicit_arg[0]
-                        new_explicit_arg = explicit_arg[1:] or None
                         optionals_map = self._option_string_actions
                         if option_string in optionals_map:
                             action = optionals_map[option_string]
-                            explicit_arg = new_explicit_arg
+                            explicit_arg = explicit_arg[1:]
+                            if not explicit_arg:
+                                sep = explicit_arg = None
+                            elif explicit_arg[0] == '=':
+                                sep = '='
+                                explicit_arg = explicit_arg[1:]
+                            else:
+                                sep = ''
                         else:
-                            msg = _gettext(
-                                f'ignored explicit argument {explicit_arg!r}'
-                            )
-                            raise _argparse.ArgumentError(action, msg)
-
+                            extras.append(char + explicit_arg)
+                            stop = start_index + 1
+                            break
                     # if the action expect exactly one argument, we've
                     # successfully matched the option; exit the loop
                     elif arg_count == 1:
@@ -989,8 +1024,8 @@ class ColorizingArgumentParser(_argparse.ArgumentParser, _ActionsContainer):
                     # error if a double-dash option did not use the
                     # explicit argument
                     else:
-                        msg = _gettext(f'ignored explicit argument {explicit_arg!r}')
-                        raise _argparse.ArgumentError(action, msg)
+                        msg = _gettext('ignored explicit argument %r')
+                        raise _argparse.ArgumentError(action, msg % explicit_arg)
 
                 # if there is no explicit argument, try to match the
                 # optional's string arguments with the following strings

{log21-2.9.2 → log21-2.10.1}/src/log21/Argumentify.py

@@ -18,7 +18,8 @@ import log21.Argparse as _Argparse
 __all__ = [
     'argumentify', 'ArgumentifyError', 'ArgumentTypeError', 'FlagGenerationError',
     'RESERVED_FLAGS', 'Callable', 'Argument', 'FunctionInfo', 'generate_flag',
-    'normalize_name', 'normalize_name_to_snake_case'
+    'normalize_name', 'normalize_name_to_snake_case', 'ArgumentError',
+    'IncompatibleArguments', 'RequiredArgument', 'TooFewArguments'
 ]
 
 Callable = _Union[_Callable[..., _Any], _Callable[..., _Coroutine[_Any, _Any, _Any]]]
@@ -76,6 +77,90 @@ class FlagGenerationError(ArgumentifyError, RuntimeError):
         self.arg_name = arg_name
 
 
+class ArgumentError(ArgumentifyError):
+    """Base of errors to raise in the argumentified functions to raise parser errors."""
+
+    def __init__(self, *args, message: _Optional[str] = None):
+        """Initialize the exception.
+
+        :param args: The arguments that have a problem.
+        :param message: The error message to show.
+        """
+        if message is None:
+            if args:
+                if len(args) > 1:
+                    message = "There is a problem with the arguments: " + ', '.join(
+                        f"`{arg}`" for arg in args
+                    )
+                else:
+                    message = "The argument `" + args[0] + "` is invalid."
+        self.message = message
+        self.arguments = args
+
+
+class IncompatibleArguments(ArgumentError):
+    """Raise when the user has used arguments that are incompatible with each other."""
+
+    def __init__(self, *args, message: _Optional[str] = None):
+        """Initialize the exception.
+
+        :param args: The arguments that are incompatible.
+        :param message: The error message to show.
+        """
+        super().__init__(*args, message)
+        if message is None:
+            if args:
+                if len(args) > 1:
+                    message = "You cannot use all these together: " + ', '.join(
+                        f"`{arg}`" for arg in args
+                    )
+                else:
+                    message = "The argument `" + args[0] + "` is not compatible."
+        self.message = message
+
+
+class RequiredArgument(ArgumentError):
+    """Raise this when there is a required argument missing."""
+
+    def __init__(self, *args, message: _Optional[str] = None):
+        """Initialize the exception.
+
+        :param args: The arguments that are required.
+        :param message: The error message to show.
+        """
+        super().__init__(*args, message)
+        if message is None:
+            if args:
+                if len(args) > 1:
+                    message = "These arguments are required: " + ', '.join(
+                        f"`{arg}`" for arg in args
+                    )
+                else:
+                    message = "The argument `" + args[0] + "` is required."
+        self.message = message
+
+
+class TooFewArguments(ArgumentError):
+    """Raise this when there were not enough arguments passed."""
+
+    def __init__(self, *args, message: _Optional[str] = None):
+        """Initialize the exception.
+
+        :param args: The arguments that should be passed.
+        :param message: The error message to show.
+        """
+        super().__init__(*args, message)
+        if message is None:
+            if args:
+                if len(args) > 1:
+                    message = "You should use these arguments: " + ', '.join(
+                        f"`{arg}`" for arg in args
+                    )
+                else:
+                    message = "The argument `" + args[0] + "` should be used."
+        self.message = message
+
+
 def normalize_name_to_snake_case(name: str, sep_char: str = '_') -> str:
     """Returns the normalized name a class.
 
@@ -278,8 +363,7 @@ def _add_arguments(
 
 
 def _argumentify_one(func: Callable):
-    """This function argumentifies one function as the entry point of the
-    script.
+    """This function argumentifies one function as the entry point of the script.
 
     :param function: The function to argumentify.
     """
@@ -312,15 +396,18 @@ def _argumentify_one(func: Callable):
             args.extend(getattr(cli_args, argument.name) or [])
         else:
             kwargs[argument.name] = getattr(cli_args, argument.name)
-    result = func(*args, **kwargs)
-    # Check if the result is a coroutine
-    if isinstance(result, (_Coroutine, _Awaitable)):
-        _asyncio.run(result)
+    try:
+        result = func(*args, **kwargs)
+        # Check if the result is a coroutine
+        if isinstance(result, (_Coroutine, _Awaitable)):
+            _asyncio.run(result)
+    except ArgumentError as error:
+        parser.error(error.message)
 
 
 def _argumentify(functions: _Dict[str, Callable]):
-    """This function argumentifies one or more functions as the entry point of
-    the script.
+    """This function argumentifies one or more functions as the entry point of the
+    script.
 
     :param functions: A dictionary of functions to argumentify.
     :raises RuntimeError:
@@ -361,15 +448,18 @@ def _argumentify(functions: _Dict[str, Callable]):
             args.extend(getattr(cli_args, argument.name) or [])
         else:
             kwargs[argument.name] = getattr(cli_args, argument.name)
-    result = function(*args, **kwargs)
-    # Check if the result is a coroutine
-    if isinstance(result, (_Coroutine, _Awaitable)):
-        _asyncio.run(result)
+    try:
+        result = function(*args, **kwargs)
+        # Check if the result is a coroutine
+        if isinstance(result, (_Coroutine, _Awaitable)):
+            _asyncio.run(result)
+    except ArgumentError as error:
+        parser.error(error.message)
 
 
 def argumentify(entry_point: _Union[Callable, _List[Callable], _Dict[str, Callable]]):
-    """This function argumentifies one or more functions as the entry point of
-    the script.
+    """This function argumentifies one or more functions as the entry point of the
+    script.
 
      1 #!/usr/bin/env python
      2 # argumentified.py

{log21-2.9.2 → log21-2.10.1}/src/log21/__init__.py

@@ -16,14 +16,15 @@ from .Manager import Manager
 from .Argparse import ColorizingArgumentParser
 from .TreePrint import TreePrint, tree_format
 from .Formatters import ColorizingFormatter, DecolorizingFormatter, _Formatter
-from .Argumentify import argumentify
+from .Argumentify import (ArgumentError, TooFewArguments, RequiredArgument,
+                          IncompatibleArguments, argumentify)
 from .FileHandler import FileHandler, DecolorizingFileHandler
 from .ProgressBar import ProgressBar
 from .LoggingWindow import LoggingWindow, LoggingWindowHandler
 from .StreamHandler import StreamHandler, ColorizingStreamHandler
 
 __author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
-__version__ = '2.9.2'
+__version__ = '2.10.1'
 __github__ = 'Https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',
@@ -35,7 +36,8 @@ __all__ = [
     'debug', 'info', 'warning', 'warn', 'error', 'critical', 'fatal', 'exception',
     'log', 'basic_config', 'basicConfig', 'ProgressBar', 'progress_bar',
     'LoggingWindow', 'LoggingWindowHandler', 'get_logging_window', 'CrashReporter',
-    'console_reporter', 'file_reporter', 'argumentify'
+    'console_reporter', 'file_reporter', 'argumentify', 'ArgumentError',
+    'IncompatibleArguments', 'RequiredArgument', 'TooFewArguments'
 ]
 
 _manager = Manager()

{log21-2.9.2 → log21-2.10.1/src/log21.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: log21
-Version: 2.9.2
+Version: 2.10.1
 Summary: A simple logging package that helps you log colorized messages in Windows console.
 Author-email: "CodeWriter21(Mehrad Pooryoussof)" <CodeWriter21@gmail.com>
 License: Apache License 2.0
@@ -92,10 +92,11 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
 
-### 2.9.2
+### 2.10.0
 
-+ Added `Sequence[T]` as a supported type to the ColorizingArgumentParser.
-+ Bug fixes.
++ Added some exception classes to raise in the "argumentified" functions to show 
+  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
+  `RequiredArgument`, `TooFewArguments`
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)