fix: Handle percent signs in arguments' help text.

Author: MPCodeWriter21

CHANGELOG.md

@@ -6,6 +6,67 @@ Help this project by [Donation](DONATE.md)
 Changes
 -------
 
+### 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)
+```
+
 ### v3.3.1
 
 Get rid of `invalid NoneType value` error message.

README.md

@@ -69,45 +69,65 @@ pip install git+https://github.com/MPCodeWriter21/log21
 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)

pyproject.toml

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

src/log21/__init__.py

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

src/log21/argparse.py

@@ -171,8 +171,10 @@ def _format_action(self, action) -> str:
         # 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]))