PyPI - log21 - Versions diffs - 2.10.0__tar.gz → 2.10.2__tar.gz - Mend

log21 2.10.0tar.gz → 2.10.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

{log21-2.10.0/src/log21.egg-info → log21-2.10.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: log21
-Version: 2.10.0
+Version: 2.10.2
 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
@@ -38,30 +38,37 @@ log21
 ![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
 [![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
-A simple logging package that helps you log colorized messages in Windows console and other operating systems.
+A simple logging package that helps you log colorized messages in Windows console and
+other operating systems.
 Features
 --------
-+ Colors : The main reason for this package was to log text in the Windows console with the support of ANSI colors.
-+ Argument parsing : log21's argument parser can be used like python's argparse but it also colorizes the output.
-+ Logging : A similar logger to logging. Logger but with colorized output and other options such as levelname
-  modifications. It can also decolorize the output if you want to log into a file.
-+ Pretty printing : Have you ever wanted to colorize the output of the pprint module? log21's pretty printer can do
-  that.
-+ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will print it in a tree-like
-  structure. It's also colorized XD.
-+ ProgressBar : log21's progress bar can be used to show progress of a process in a beautiful way.
-+ LoggingWindow : Helps you to log messages and debug your code in a window other than the console.
++ Colors : The main reason for this package was to log text in the Windows console with
+  the support of ANSI colors.
++ Argument parsing : log21's argument parser can be used like python's argparse but it
+  also colorizes the output.
++ Logging : A similar logger to logging. Logger but with colorized output and other
+  options such as levelname modifications. It can also decolorize the output if you want
+  to log into a file.
++ Pretty printing : Have you ever wanted to colorize the output of the pprint module?
+  log21's pretty printer can do that.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will
+  print it in a tree-like structure. It's also colorized XD.
++ ProgressBar : log21's progress bar can be used to show progress of a process in a
+  beautiful way.
++ LoggingWindow : Helps you to log messages and debug your code in a window other than
+  the console.
 + CrashReporter : log21's crash reporter can be used to report crashes in different
   ways. You can use it to log crashes to console or files or use it to receive crash
   reports of your program through email. And you can also define your own crash
   reporter functions and use them instead!
 + Argumentify : You can use the argumentify feature to decrease the number of lines you
   need to write to parse command-line arguments. It's colored by the way!
-+ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues) or submit a pull request.
++ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues)
+  or submit a pull request.
-![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
+![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
 ![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
 Installation
@@ -69,8 +76,8 @@ Installation
 Well, this is a python package so the first thing you need is python.
-If you don't have python installed, please visit [Python.org](https://python.org) and install the latest version of
-python.
+If you don't have python installed, please visit [Python.org](https://python.org) and
+install the latest version of python.
 Then you can install log21 using pip module:
@@ -85,6 +92,7 @@ pip install .
 ```
 Or let the pip get it using git:
 ```bash
 pip install git+https://github.com/MPCodeWriter21/log21
 ```
@@ -92,23 +100,20 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
-### 2.10.0
+### 2.10.1
-+ Added some exception classes to raise in the "argumentified" functions to show
-  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
-  `RequiredArgument`, `TooFewArguments`
++ Updated the Argparse module to be usable with python 3.12.3.
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
-Usage Examples:
+Usage Examples
 ---------------
 See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
 About
 -----
 Author: CodeWriter21 (Mehrad Pooryoussof)
 GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
@@ -132,5 +137,5 @@ Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a
 References
 ----------
-+ ANSI Color Codes (
-  Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
++ ANSI Color Codes (Wikipedia):
+[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

{log21-2.10.0 → log21-2.10.2}/README.md RENAMED Viewed

@@ -7,30 +7,37 @@ log21
 ![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
 [![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
-A simple logging package that helps you log colorized messages in Windows console and other operating systems.
+A simple logging package that helps you log colorized messages in Windows console and
+other operating systems.
 Features
 --------
-+ Colors : The main reason for this package was to log text in the Windows console with the support of ANSI colors.
-+ Argument parsing : log21's argument parser can be used like python's argparse but it also colorizes the output.
-+ Logging : A similar logger to logging. Logger but with colorized output and other options such as levelname
-  modifications. It can also decolorize the output if you want to log into a file.
-+ Pretty printing : Have you ever wanted to colorize the output of the pprint module? log21's pretty printer can do
-  that.
-+ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will print it in a tree-like
-  structure. It's also colorized XD.
-+ ProgressBar : log21's progress bar can be used to show progress of a process in a beautiful way.
-+ LoggingWindow : Helps you to log messages and debug your code in a window other than the console.
++ Colors : The main reason for this package was to log text in the Windows console with
+  the support of ANSI colors.
++ Argument parsing : log21's argument parser can be used like python's argparse but it
+  also colorizes the output.
++ Logging : A similar logger to logging. Logger but with colorized output and other
+  options such as levelname modifications. It can also decolorize the output if you want
+  to log into a file.
++ Pretty printing : Have you ever wanted to colorize the output of the pprint module?
+  log21's pretty printer can do that.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will
+  print it in a tree-like structure. It's also colorized XD.
++ ProgressBar : log21's progress bar can be used to show progress of a process in a
+  beautiful way.
++ LoggingWindow : Helps you to log messages and debug your code in a window other than
+  the console.
 + CrashReporter : log21's crash reporter can be used to report crashes in different
   ways. You can use it to log crashes to console or files or use it to receive crash
   reports of your program through email. And you can also define your own crash
   reporter functions and use them instead!
 + Argumentify : You can use the argumentify feature to decrease the number of lines you
   need to write to parse command-line arguments. It's colored by the way!
-+ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues) or submit a pull request.
++ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues)
+  or submit a pull request.
-![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
+![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
 ![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
 Installation
@@ -38,8 +45,8 @@ Installation
 Well, this is a python package so the first thing you need is python.
-If you don't have python installed, please visit [Python.org](https://python.org) and install the latest version of
-python.
+If you don't have python installed, please visit [Python.org](https://python.org) and
+install the latest version of python.
 Then you can install log21 using pip module:
@@ -54,6 +61,7 @@ pip install .
 ```
 Or let the pip get it using git:
 ```bash
 pip install git+https://github.com/MPCodeWriter21/log21
 ```
@@ -61,23 +69,20 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
-### 2.10.0
+### 2.10.1
-+ Added some exception classes to raise in the "argumentified" functions to show
-  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
-  `RequiredArgument`, `TooFewArguments`
++ Updated the Argparse module to be usable with python 3.12.3.
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
-Usage Examples:
+Usage Examples
 ---------------
 See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
 About
 -----
 Author: CodeWriter21 (Mehrad Pooryoussof)
 GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
@@ -101,5 +106,5 @@ Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a
 References
 ----------
-+ ANSI Color Codes (
-  Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
++ ANSI Color Codes (Wikipedia):
+[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

{log21-2.10.0 → log21-2.10.2}/pyproject.toml RENAMED Viewed

@@ -26,7 +26,7 @@ dependencies = [
     "webcolors",
     "docstring-parser"
 ]
-version = "2.10.0"
+version = "2.10.2"
 [tool.setuptools.packages.find]
 where = ["src"]

{log21-2.10.0 → log21-2.10.2}/src/log21/Argparse.py RENAMED Viewed

@@ -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.10.0 → log21-2.10.2}/src/log21/__init__.py RENAMED Viewed

@@ -24,7 +24,7 @@ from .LoggingWindow import LoggingWindow, LoggingWindowHandler
 from .StreamHandler import StreamHandler, ColorizingStreamHandler
 __author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
-__version__ = '2.10.0'
+__version__ = '2.10.2'
 __github__ = 'Https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',

{log21-2.10.0 → log21-2.10.2/src/log21.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: log21
-Version: 2.10.0
+Version: 2.10.2
 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
@@ -38,30 +38,37 @@ log21
 ![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
 [![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
-A simple logging package that helps you log colorized messages in Windows console and other operating systems.
+A simple logging package that helps you log colorized messages in Windows console and
+other operating systems.
 Features
 --------
-+ Colors : The main reason for this package was to log text in the Windows console with the support of ANSI colors.
-+ Argument parsing : log21's argument parser can be used like python's argparse but it also colorizes the output.
-+ Logging : A similar logger to logging. Logger but with colorized output and other options such as levelname
-  modifications. It can also decolorize the output if you want to log into a file.
-+ Pretty printing : Have you ever wanted to colorize the output of the pprint module? log21's pretty printer can do
-  that.
-+ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will print it in a tree-like
-  structure. It's also colorized XD.
-+ ProgressBar : log21's progress bar can be used to show progress of a process in a beautiful way.
-+ LoggingWindow : Helps you to log messages and debug your code in a window other than the console.
++ Colors : The main reason for this package was to log text in the Windows console with
+  the support of ANSI colors.
++ Argument parsing : log21's argument parser can be used like python's argparse but it
+  also colorizes the output.
++ Logging : A similar logger to logging. Logger but with colorized output and other
+  options such as levelname modifications. It can also decolorize the output if you want
+  to log into a file.
++ Pretty printing : Have you ever wanted to colorize the output of the pprint module?
+  log21's pretty printer can do that.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will
+  print it in a tree-like structure. It's also colorized XD.
++ ProgressBar : log21's progress bar can be used to show progress of a process in a
+  beautiful way.
++ LoggingWindow : Helps you to log messages and debug your code in a window other than
+  the console.
 + CrashReporter : log21's crash reporter can be used to report crashes in different
   ways. You can use it to log crashes to console or files or use it to receive crash
   reports of your program through email. And you can also define your own crash
   reporter functions and use them instead!
 + Argumentify : You can use the argumentify feature to decrease the number of lines you
   need to write to parse command-line arguments. It's colored by the way!
-+ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues) or submit a pull request.
++ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues)
+  or submit a pull request.
-![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
+![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
 ![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
 Installation
@@ -69,8 +76,8 @@ Installation
 Well, this is a python package so the first thing you need is python.
-If you don't have python installed, please visit [Python.org](https://python.org) and install the latest version of
-python.
+If you don't have python installed, please visit [Python.org](https://python.org) and
+install the latest version of python.
 Then you can install log21 using pip module:
@@ -85,6 +92,7 @@ pip install .
 ```
 Or let the pip get it using git:
 ```bash
 pip install git+https://github.com/MPCodeWriter21/log21
 ```
@@ -92,23 +100,20 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changes
 -------
-### 2.10.0
+### 2.10.1
-+ Added some exception classes to raise in the "argumentified" functions to show
-  *parser error* to the user: `ArgumentError`, `IncompatibleArguments`,
-  `RequiredArgument`, `TooFewArguments`
++ Updated the Argparse module to be usable with python 3.12.3.
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
-Usage Examples:
+Usage Examples
 ---------------
 See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
 About
 -----
 Author: CodeWriter21 (Mehrad Pooryoussof)
 GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
@@ -132,5 +137,5 @@ Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a
 References
 ----------
-+ ANSI Color Codes (
-  Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
++ ANSI Color Codes (Wikipedia):
+[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)