log21 3.3.0__tar.gz → 3.3.2__tar.gz

{log21-3.3.0 → log21-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: log21
-Version: 3.3.0
+Version: 3.3.2
 Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
 Author: CodeWriter21(Mehrad Pooryoussof)
@@ -94,55 +94,65 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.3.0
+### v3.3.2
 
-Add `log21.helper_types` module.
+Handle percent signs in arguments' help text.
 
-This module contains a collection of useful types meant for using with argument parser
-to parse CLI arguments to more usable formats.
+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.
 
-+ `FileSize`: Can take `str` and `int` values. Will convert human inputs such as "121 KB",
-  "21MiB", or "4.56 GB" to bytes. Can also be used to represent bytes value in more
-  human-readable formats.
+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.
 
-For even more control you can still define Logger, Handlers, and Formatters manually.
-
-#### Example
+#### Example (works before and after v3.3.2)
 
 ```python
-from pathlib import Path
-
 import log21
-from log21.helper_types import FileSize
 
 
-def main(path: Path, min_size: FileSize, max_size: FileSize, /):
-    log21.info(
-        "Files that are smaller than %s or bigger than %s will be ignored.",
-        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%.
 
-    for file in path.iterdir():
-        if not file.is_file():
-            continue
-        if min_size <= (size := file.stat().st_size) <= max_size:
-            log21.print(
-                "`%s` is %s.",
-                args=(file, FileSize(size).humanize(binary=False, fmt="%.4f")),
-            )
+    :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)
 ```
 
-Example usage and output:
+#### 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}.")
 
-```shell
-$ uv run test.py . "1.23MiB" "0.5 GB"
-[21:21:21] [INFO] Files that are smaller than 1.23 MiB or bigger than 476.84 MiB will be
-ignored.
-`myfile21.zip` is 35.1856 MB.
+
+if __name__ == "__main__":
+    log21.argumentify(show_percentage)
 ```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)

{log21-3.3.0 → log21-3.3.2}/README.md

@@ -69,55 +69,65 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.3.0
+### v3.3.2
 
-Add `log21.helper_types` module.
+Handle percent signs in arguments' help text.
 
-This module contains a collection of useful types meant for using with argument parser
-to parse CLI arguments to more usable formats.
+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.
 
-+ `FileSize`: Can take `str` and `int` values. Will convert human inputs such as "121 KB",
-  "21MiB", or "4.56 GB" to bytes. Can also be used to represent bytes value in more
-  human-readable formats.
+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.
 
-For even more control you can still define Logger, Handlers, and Formatters manually.
-
-#### Example
+#### Example (works before and after v3.3.2)
 
 ```python
-from pathlib import Path
-
 import log21
-from log21.helper_types import FileSize
 
 
-def main(path: Path, min_size: FileSize, max_size: FileSize, /):
-    log21.info(
-        "Files that are smaller than %s or bigger than %s will be ignored.",
-        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%.
 
-    for file in path.iterdir():
-        if not file.is_file():
-            continue
-        if min_size <= (size := file.stat().st_size) <= max_size:
-            log21.print(
-                "`%s` is %s.",
-                args=(file, FileSize(size).humanize(binary=False, fmt="%.4f")),
-            )
+    :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)
 ```
 
-Example usage and output:
+#### 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}.")
 
-```shell
-$ uv run test.py . "1.23MiB" "0.5 GB"
-[21:21:21] [INFO] Files that are smaller than 1.23 MiB or bigger than 476.84 MiB will be
-ignored.
-`myfile21.zip` is 35.1856 MB.
+
+if __name__ == "__main__":
+    log21.argumentify(show_percentage)
 ```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)

{log21-3.3.0 → log21-3.3.2}/pyproject.toml

@@ -23,7 +23,7 @@ dependencies = [
     "webcolors",
     "docstring-parser"
 ]
-version = "3.3.0"
+version = "3.3.2"
 
 [build-system]
 requires = ["uv_build>=0.8.15,<0.9.0"]

{log21-3.3.0 → log21-3.3.2}/src/log21/__init__.py

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

{log21-3.3.0 → log21-3.3.2}/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]))
@@ -784,7 +786,8 @@ class ColorizingArgumentParser(_argparse.ArgumentParser, _ActionsContainer):
             else:
                 exception = ValueError()
                 for type_ in func_type:
-                    name = getattr(type_, '__name__', repr(type_))
+                    if type_ is not type(None):
+                        name = getattr(type_, '__name__', repr(type_))
                     try:
                         result = type_(arg_string)
                         break

{log21-3.3.0 → log21-3.3.2}/src/log21/argumentify.py

@@ -451,7 +451,7 @@ def _argumentify(functions: _Dict[str, Callable]) -> None:
     args = []
     kwargs = {}
     info = None
-    for name, (function, info) in functions_info.items():  # noqa: B007
+    for _name, (function, info) in functions_info.items():  # noqa: B007
         if function == cli_args.func:
             break
     else:
@@ -475,7 +475,7 @@ def _argumentify(functions: _Dict[str, Callable]) -> None:
 
 def argumentify(
     entry_point: _Union[Callable, _List[Callable], _Dict[str, Callable]]
-) -> _Callable:
+) -> _Union[Callable, _List[Callable], _Dict[str, Callable]]:
     """This function argumentifies one or more functions as the entry point of the
     script.
 
@@ -493,7 +493,7 @@ def argumentify(
     12 if __name__ == '__main__':
     13     argumentify(main)
 
-    $ python argumentified.py Ahmad Ahmadi --age 20
+    $ python argumentified.py Ahmad Mohammadi --age 20
     Ahmad Ahmadi is 20 years old.
     $ python argumentified.py Mehrad Pooryoussof
     Mehrad Pooryoussof is not yet born.