log21 3.3.1__tar.gz → 3.3.3__tar.gz

{log21-3.3.1 → log21-3.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: log21
-Version: 3.3.1
+Version: 3.3.3
 Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
 Author: CodeWriter21(Mehrad Pooryoussof)
@@ -18,19 +18,18 @@ Classifier: Operating System :: MacOS :: MacOS X
 Requires-Dist: webcolors
 Requires-Dist: docstring-parser
 Requires-Python: >=3.9
-Project-URL: Donations, https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md
-Project-URL: Homepage, https://github.com/MPCodeWriter21/log21
-Project-URL: Source, https://github.com/MPCodeWriter21/log21
+Project-URL: Donations, https://gitlab.com/CodeWriter21/log21/-/blob/master/DONATE.md
+Project-URL: Homepage, https://gitlab.com/CodeWriter21/log21
+Project-URL: Repository, https://gitlab.com/CodeWriter21/log21
+Project-URL: Source, https://gitlab.com/CodeWriter21/log21
 Description-Content-Type: text/markdown
 
 log21
 =====
 
 ![version](https://img.shields.io/pypi/v/log21)
-![stars](https://img.shields.io/github/stars/MPCodeWriter21/log21)
-![forks](https://img.shields.io/github/forks/MPCodeWriter21/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)
+[![pipeline status](https://gitlab.com/CodeWriter21/log21/badges/master/pipeline.svg)](https://gitlab.com/CodeWriter21/log21/-/commits/master)
+[![repo size](https://img.shields.io/gitlab/repo-size/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21)
 
 A simple logging package that helps you log colorized messages in Windows console and
 other operating systems.
@@ -59,11 +58,11 @@ Features
   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://gitlab.com/CodeWriter21/log21/-/issues)
+  or submit a merge request.
 
-![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
-![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
+[![Issues](https://img.shields.io/gitlab/issues/open/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/issues)
+[![contributors](https://img.shields.io/gitlab/contributors/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/graphs/master)
 
 Installation
 ------------
@@ -79,7 +78,7 @@ Then you can install log21 using pip module:
 python -m pip install log21 -U
 ```
 
-Or you can clone [the repository](https://github.com/MPCodeWriter21/log21) and run:
+Or you can clone [the repository](https://gitlab.com/CodeWriter21/log21) and run:
 
 ```bash
 pip install .
@@ -88,72 +87,92 @@ pip install .
 Or let the pip get it using git:
 
 ```bash
-pip install git+https://github.com/MPCodeWriter21/log21
+pip install git+https://gitlab.com/CodeWriter21/log21.git
 ```
 
 Changelog
 ---------
 
-### v3.3.1
+### v3.3.2
 
-Get rid of `invalid NoneType value` error message.
+Handle percent signs in arguments' help text.
 
-In the previous versions, if you used an optional union type such as `int | float | None`
-which ended with `None`, you'd get an error saying `invalid NoneType value` that didn't
-make any sense to the user. The code has been updated to use the name of the last
-non-None type for the error message in these situations.
+In the older versions, if you had a percent sign in the help text of an argument, it
+would cause an error when you try to show the help. This is because the argparse
+module uses percent signs for string formatting, and it would try to format the help
+text as a string, which would fail if there are any percent signs in it.
 
-#### Example
+The workaround for this issue was to escape the percent signs by doubling them, but it
+was not a good solution. Now, in v3.3.2, log21 handles percent signs in arguments' help
+text properly, so you can use percent signs without any issues.
+
+#### Example (works before and after v3.3.2)
 
 ```python
 import log21
-from log21.helper_types import FileSize
 
 
-def main(min_size: FileSize | None = None, max_size: FileSize | None = None) -> None:
-    log21.info("Min Size: %s, Max Size: %s", args=(min_size, max_size))
+def show_percentage(a: float, b: float, /) -> None:
+    """Takes two numbers and returns the percentage of a in b. E.g. if a is 50 and b is
+    200, the percentage would be 25.00%.
+
+    :param a: The first number. (a %% b)
+    :param b: The second number. (a %% b)
+    :return: The percentage of a in b.
+    """
+    if b == 0:
+        raise log21.ArgumentError("b cannot be zero.")
+    percentage = (a / b) * 100
+    print(f"{a} is {percentage:.2f}% of {b}.")
+
 
 if __name__ == "__main__":
-    log21.argumentify(main)
+    log21.argumentify(show_percentage)
 ```
 
-Before v3.3.1:
+#### Example (Works only after v3.3.2)
+
+```python
+import log21
 
-```shell
-$ python test.py -m Hello
-usage: test.py [-h] [--min-size MIN_SIZE] [--max-size MAX_SIZE]
 
-test.py: error: argument --min-size/-m: invalid NoneType value: 'Hello'
-```
+def show_percentage(a: float, b: float, /) -> None:
+    """Takes two numbers and returns the percentage of a in b. E.g. if a is 50 and b is
+    200, the percentage would be 25.00%.
 
-With v3.3.1 update:
+    :param a: The first number. (a % b)
+    :param b: The second number. (a % b)
+    :return: The percentage of a in b.
+    """
+    if b == 0:
+        raise log21.ArgumentError("b cannot be zero.")
+    percentage = (a / b) * 100
+    print(f"{a} is {percentage:.2f}% of {b}.")
 
-```shell
-$ python test.py -m Hello
-usage: test.py [-h] [--min-size MIN_SIZE] [--max-size MAX_SIZE]
 
-test.py: error: argument --min-size/-m: invalid FileSize value: 'Hello'
+if __name__ == "__main__":
+    log21.argumentify(show_percentage)
 ```
 
-[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
+[Full CHANGELOG](https://gitlab.com/CodeWriter21/log21/-/blob/master/CHANGELOG.md)
 
 Usage Examples
 ---------------
 
-See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
+See [EXAMPLES.md](https://gitlab.com/CodeWriter21/log21/-/blob/master/EXAMPLES.md)
 
 About
 -----
 
 Author: CodeWriter21 (Mehrad Pooryoussof)
 
-GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
+GitLab: [CodeWriter21](https://gitlab.com/CodeWriter21)
 
 Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
 
 ### License
 
-![License](https://img.shields.io/github/license/MPCodeWriter21/log21)
+[![License](https://img.shields.io/gitlab/license/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/blob/master/LICENSE.txt)
 
 [apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
 
@@ -161,10 +180,10 @@ Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
 
 In order to support this project you can donate some crypto of your choice 8D
 
-[Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
+[Donate Addresses](https://gitlab.com/CodeWriter21/log21/-/blob/master/DONATE.md)
 
-Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on
-GitHub :)
+Or if you can't, give [this project](https://gitlab.com/CodeWriter21/log21) a star on
+GitLab :)
 
 References
 ----------

log21-3.3.3/README.md

@@ -0,0 +1,166 @@
+log21
+=====
+
+![version](https://img.shields.io/pypi/v/log21)
+[![pipeline status](https://gitlab.com/CodeWriter21/log21/badges/master/pipeline.svg)](https://gitlab.com/CodeWriter21/log21/-/commits/master)
+[![repo size](https://img.shields.io/gitlab/repo-size/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21)
+
+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.
++ 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://gitlab.com/CodeWriter21/log21/-/issues)
+  or submit a merge request.
+
+[![Issues](https://img.shields.io/gitlab/issues/open/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/issues)
+[![contributors](https://img.shields.io/gitlab/contributors/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/graphs/master)
+
+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.
+
+Then you can install log21 using pip module:
+
+```bash
+python -m pip install log21 -U
+```
+
+Or you can clone [the repository](https://gitlab.com/CodeWriter21/log21) and run:
+
+```bash
+pip install .
+```
+
+Or let the pip get it using git:
+
+```bash
+pip install git+https://gitlab.com/CodeWriter21/log21.git
+```
+
+Changelog
+---------
+
+### v3.3.2
+
+Handle percent signs in arguments' help text.
+
+In the older versions, if you had a percent sign in the help text of an argument, it
+would cause an error when you try to show the help. This is because the argparse
+module uses percent signs for string formatting, and it would try to format the help
+text as a string, which would fail if there are any percent signs in it.
+
+The workaround for this issue was to escape the percent signs by doubling them, but it
+was not a good solution. Now, in v3.3.2, log21 handles percent signs in arguments' help
+text properly, so you can use percent signs without any issues.
+
+#### Example (works before and after v3.3.2)
+
+```python
+import log21
+
+
+def show_percentage(a: float, b: float, /) -> None:
+    """Takes two numbers and returns the percentage of a in b. E.g. if a is 50 and b is
+    200, the percentage would be 25.00%.
+
+    :param a: The first number. (a %% b)
+    :param b: The second number. (a %% b)
+    :return: The percentage of a in b.
+    """
+    if b == 0:
+        raise log21.ArgumentError("b cannot be zero.")
+    percentage = (a / b) * 100
+    print(f"{a} is {percentage:.2f}% of {b}.")
+
+
+if __name__ == "__main__":
+    log21.argumentify(show_percentage)
+```
+
+#### Example (Works only after v3.3.2)
+
+```python
+import log21
+
+
+def show_percentage(a: float, b: float, /) -> None:
+    """Takes two numbers and returns the percentage of a in b. E.g. if a is 50 and b is
+    200, the percentage would be 25.00%.
+
+    :param a: The first number. (a % b)
+    :param b: The second number. (a % b)
+    :return: The percentage of a in b.
+    """
+    if b == 0:
+        raise log21.ArgumentError("b cannot be zero.")
+    percentage = (a / b) * 100
+    print(f"{a} is {percentage:.2f}% of {b}.")
+
+
+if __name__ == "__main__":
+    log21.argumentify(show_percentage)
+```
+
+[Full CHANGELOG](https://gitlab.com/CodeWriter21/log21/-/blob/master/CHANGELOG.md)
+
+Usage Examples
+---------------
+
+See [EXAMPLES.md](https://gitlab.com/CodeWriter21/log21/-/blob/master/EXAMPLES.md)
+
+About
+-----
+
+Author: CodeWriter21 (Mehrad Pooryoussof)
+
+GitLab: [CodeWriter21](https://gitlab.com/CodeWriter21)
+
+Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
+
+### License
+
+[![License](https://img.shields.io/gitlab/license/CodeWriter21/log21)](https://gitlab.com/CodeWriter21/log21/-/blob/master/LICENSE.txt)
+
+[apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+### Donate
+
+In order to support this project you can donate some crypto of your choice 8D
+
+[Donate Addresses](https://gitlab.com/CodeWriter21/log21/-/blob/master/DONATE.md)
+
+Or if you can't, give [this project](https://gitlab.com/CodeWriter21/log21) a star on
+GitLab :)
+
+References
+----------
+
++ ANSI Color Codes (Wikipedia):
+[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

{log21-3.3.1 → log21-3.3.3}/pyproject.toml

@@ -23,16 +23,17 @@ dependencies = [
     "webcolors",
     "docstring-parser"
 ]
-version = "3.3.1"
+version = "3.3.3"
 
 [build-system]
 requires = ["uv_build>=0.8.15,<0.9.0"]
 build-backend = "uv_build"
 
 [project.urls]
-Homepage = "https://github.com/MPCodeWriter21/log21"
-Donations = "https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md"
-Source = "https://github.com/MPCodeWriter21/log21"
+Homepage = "https://gitlab.com/CodeWriter21/log21"
+Repository = "https://gitlab.com/CodeWriter21/log21"
+Donations = "https://gitlab.com/CodeWriter21/log21/-/blob/master/DONATE.md"
+Source = "https://gitlab.com/CodeWriter21/log21"
 
 [tool.yapf]
 column_limit = 88

{log21-3.3.1 → log21-3.3.3}/src/log21/__init__.py

@@ -33,7 +33,7 @@ from .stream_handler import StreamHandler, ColorizingStreamHandler
 # yapf: enable
 
 __author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
-__version__ = '3.3.1'
+__version__ = '3.3.3'
 __github__ = 'https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',

{log21-3.3.1 → log21-3.3.3}/src/log21/argparse.py

@@ -171,8 +171,10 @@ class ColorizingHelpFormatter(_argparse.HelpFormatter):
         # collect the pieces of the action help
         parts = [action_header]
 
+        percent_pattern = _re.compile(r'([%]{2}|[%])')
         # if there was help for the action, add lines of help text
         if action.help:
+            action.help = percent_pattern.sub("%%", action.help)
             help_text = _gc(self.colors['help']) + self._expand_help(action)
             help_lines = self._split_lines(help_text, help_width)
             parts.append('%*s%s\n' % (indent_first, '', help_lines[0]))
@@ -573,9 +575,23 @@ class _ActionsContainer(_argparse._ActionsContainer):  # novm
                 and not isinstance(func_type, (_types.UnionType, tuple))):
             raise ValueError(f'{func_type} is not callable; level={level}')
 
-        # Handle `UnionType` as a type (e.g. `int|str`)
+        # Handle `UnionType` as a type (e.g. `int|str` and `int|None`)
         if hasattr(_types, 'UnionType') and isinstance(func_type, _types.UnionType):
-            func_type = func_type.__args__  # type: ignore
+            # `X | None` is the PEP 604 spelling of `Optional[X]` and must
+            # behave identically: mark the action as not required and unwrap
+            # to `X`. `types.UnionType` exposes `__args__` just like
+            # `typing.Optional`, e.g. `(str | None).__args__ == (str, NoneType)`.
+            args = func_type.__args__  # type: ignore
+            if (hasattr(_types, 'NoneType') and len(args) == 2
+                    and args[1] is _types.NoneType):
+                action.required = False
+                func_type = args[0]
+            elif (hasattr(_types, 'NoneType') and len(args) == 2
+                    and args[0] is _types.NoneType):
+                action.required = False
+                func_type = args[1]
+            else:
+                func_type = args
 
         # Handle `Literal` as a type (e.g. `Literal[1, 2, 3]`)
         elif (hasattr(_typing, '_LiteralGenericAlias')

log21-3.3.1/README.md

@@ -1,148 +0,0 @@
-log21
-=====
-
-![version](https://img.shields.io/pypi/v/log21)
-![stars](https://img.shields.io/github/stars/MPCodeWriter21/log21)
-![forks](https://img.shields.io/github/forks/MPCodeWriter21/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.
-
-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.
-+ 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.
-
-![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
-![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
-
-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.
-
-Then you can install log21 using pip module:
-
-```bash
-python -m pip install log21 -U
-```
-
-Or you can clone [the repository](https://github.com/MPCodeWriter21/log21) and run:
-
-```bash
-pip install .
-```
-
-Or let the pip get it using git:
-
-```bash
-pip install git+https://github.com/MPCodeWriter21/log21
-```
-
-Changelog
----------
-
-### v3.3.1
-
-Get rid of `invalid NoneType value` error message.
-
-In the previous versions, if you used an optional union type such as `int | float | None`
-which ended with `None`, you'd get an error saying `invalid NoneType value` that didn't
-make any sense to the user. The code has been updated to use the name of the last
-non-None type for the error message in these situations.
-
-#### Example
-
-```python
-import log21
-from log21.helper_types import FileSize
-
-
-def main(min_size: FileSize | None = None, max_size: FileSize | None = None) -> None:
-    log21.info("Min Size: %s, Max Size: %s", args=(min_size, max_size))
-
-if __name__ == "__main__":
-    log21.argumentify(main)
-```
-
-Before v3.3.1:
-
-```shell
-$ python test.py -m Hello
-usage: test.py [-h] [--min-size MIN_SIZE] [--max-size MAX_SIZE]
-
-test.py: error: argument --min-size/-m: invalid NoneType value: 'Hello'
-```
-
-With v3.3.1 update:
-
-```shell
-$ python test.py -m Hello
-usage: test.py [-h] [--min-size MIN_SIZE] [--max-size MAX_SIZE]
-
-test.py: error: argument --min-size/-m: invalid FileSize value: 'Hello'
-```
-
-[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
-
-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)
-
-Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
-
-### License
-
-![License](https://img.shields.io/github/license/MPCodeWriter21/log21)
-
-[apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
-
-### Donate
-
-In order to support this project you can donate some crypto of your choice 8D
-
-[Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
-
-Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on
-GitHub :)
-
-References
-----------
-
-+ ANSI Color Codes (Wikipedia):
-[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)