log21 3.3.0__tar.gz → 3.3.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: log21
-Version: 3.3.0
+Version: 3.3.1
 Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
 Author: CodeWriter21(Mehrad Pooryoussof)
@@ -94,55 +94,45 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.3.0
+### v3.3.1
 
-Add `log21.helper_types` module.
+Get rid of `invalid NoneType value` error message.
 
-This module contains a collection of useful types meant for using with argument parser
-to parse CLI arguments to more usable formats.
-
-+ `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.
-
-For even more control you can still define Logger, Handlers, and Formatters manually.
+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
-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),
-    )
-
-    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")),
-            )
-
+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)
 ```
 
-Example usage and output:
+Before v3.3.1:
 
 ```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.
+$ 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)

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

@@ -69,55 +69,45 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.3.0
+### v3.3.1
 
-Add `log21.helper_types` module.
+Get rid of `invalid NoneType value` error message.
 
-This module contains a collection of useful types meant for using with argument parser
-to parse CLI arguments to more usable formats.
-
-+ `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.
-
-For even more control you can still define Logger, Handlers, and Formatters manually.
+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
-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),
-    )
-
-    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")),
-            )
-
+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)
 ```
 
-Example usage and output:
+Before v3.3.1:
 
 ```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.
+$ 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)

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

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

{log21-3.3.0 → log21-3.3.1}/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.1'
 __github__ = 'https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',

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

@@ -784,7 +784,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.1}/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.