log21 3.0.1__tar.gz → 3.0.2__tar.gz

{log21-3.0.1 → log21-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: log21
-Version: 3.0.1
+Version: 3.0.2
 Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
 Author: CodeWriter21(Mehrad Pooryoussof)
@@ -94,85 +94,56 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.0.1
+### v3.0.2
 
-Fix the issue with `argumentify` which would result in falsy default values to be
-replaced with None.
+Change `argumentify` to use the whole function description as the argument-parser
+description instead of the one-line short description.
 
 + Example:
 
 ```python
-def main(offset: int = 0) -> None:
-    ...
+def main(verbose: bool = False) -> None:
+    """This is a very useful tool and I will describe it thoroughly. It is so good that
+    we have a second line in the first part of the description.
+
+    And now we can talk more about the tool...
+
+    :param verbose: This flag will make the logs more verbose!
+    """
 
 argumentify(main)
 ```
 
-if no value is provided for `--offset`, the default will be `None` instead of `0` which
-is unexpected and can lead to issues.
-
-#### Breaking Changes
-
-+ **Internal module renaming and normalization**
-  + All internal modules were renamed to lowercase and, in some cases, split or
-    reorganized.
-  + Imports such as `log21.Colors`, `log21.Logger`, `log21.ProgressBar`, etc. are no
-    longer valid.
-  + Users importing from internal modules must update their imports to the new module
-    names.
-  + Public imports from `log21` remain supported.
-
-+ **Argumentify exception renames**
-  + Several exceptions were renamed to follow a consistent `*Error` naming convention:
-    + `TooFewArguments` → `TooFewArgumentsError`
-    + `RequiredArgument` → `RequiredArgumentError`
-    + `IncompatibleArguments` → `IncompatibleArgumentsError`
-  + Code that explicitly raises or catches these exceptions must be updated.
-
-#### Changes
-
-+ **Crash reporter behavior improvement**
-  + Prevented the default file crash reporter from creating `.crash_report` files when it
-    is not actually used.
-  + Implemented using an internal `FakeModule` helper.
-
-+ **Argparse compatibility update**
-  + Bundled and used the Python 3.13 `argparse` implementation to ensure consistent
-    behavior across supported Python versions.
-
-+ **Progress bar module rename**
-  + Renamed the internal progress bar module to `progress_bar` for consistency with the
-    new naming scheme.
-  + This will not break the usages of `log21.progress_bar(...)` since the call
-    functionality was added to the module using the `FakeModule` helper.
-
-+ **Examples added and updated**
-  + Added new example code files.
-  + Updated existing examples to match the v3 API and conventions.
-
-#### Fixes
-
-+ Resolved various linting and static-analysis issues across the codebase.
-+ Addressed minor compatibility issues uncovered by running linters and pre-commit hooks.
-+ Resolved errors occurring in environments with newer versions of argparse.
-
-#### Internal and Maintenance Changes
-
-+ Migrated the build system configuration to `uv`.
-+ Updated Python version classifiers and set the supported Python version to 3.9+.
-+ Added `vermin` to the pre-commit configuration.
-+ Updated `.gitignore`, license metadata, and tool configurations.
-+ Silenced and resolved a large number of linter warnings.
-+ General internal refactoring with no intended user-visible behavioral changes.
-
-#### Notes
-
-+ There are **no intentional behavioral changes** in logging output, argument parsing
-  logic, or UI components.
-+ Most projects will require **minimal or no changes** unless they depend on internal
-  modules or renamed exceptions.
-+ See [MIGRATION-V2-V3.md](https://github.com/MPCodeWriter21/log21/blob/master/MIGRATION-V2-V3.md)
-for detailed upgrade instructions.
+The way old versions would look:
+
+```help
+usage: test.py [-h] [--verbose]
+
+This is a very useful tool and I will describe it thoroughly. It is so good that
+
+options:
+  -h, --help
+                        show this help message and exit
+  --verbose, -v
+                        This flag will make the logs more verbose!
+
+```
+
+Now at v3.0.2:
+
+```help
+usage: test.py [-h] [--verbose]
+
+This is a very useful tool and I will describe it thoroughly. It is so good that we have a
+second line in the first part of the description. And now we can talk more about the tool...
+
+options:
+  -h, --help
+                        show this help message and exit
+  --verbose, -v
+                        This flag will make the logs more verbose!
+
+```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 

{log21-3.0.1 → log21-3.0.2}/README.md

@@ -69,85 +69,56 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.0.1
+### v3.0.2
 
-Fix the issue with `argumentify` which would result in falsy default values to be
-replaced with None.
+Change `argumentify` to use the whole function description as the argument-parser
+description instead of the one-line short description.
 
 + Example:
 
 ```python
-def main(offset: int = 0) -> None:
-    ...
+def main(verbose: bool = False) -> None:
+    """This is a very useful tool and I will describe it thoroughly. It is so good that
+    we have a second line in the first part of the description.
+
+    And now we can talk more about the tool...
+
+    :param verbose: This flag will make the logs more verbose!
+    """
 
 argumentify(main)
 ```
 
-if no value is provided for `--offset`, the default will be `None` instead of `0` which
-is unexpected and can lead to issues.
-
-#### Breaking Changes
-
-+ **Internal module renaming and normalization**
-  + All internal modules were renamed to lowercase and, in some cases, split or
-    reorganized.
-  + Imports such as `log21.Colors`, `log21.Logger`, `log21.ProgressBar`, etc. are no
-    longer valid.
-  + Users importing from internal modules must update their imports to the new module
-    names.
-  + Public imports from `log21` remain supported.
-
-+ **Argumentify exception renames**
-  + Several exceptions were renamed to follow a consistent `*Error` naming convention:
-    + `TooFewArguments` → `TooFewArgumentsError`
-    + `RequiredArgument` → `RequiredArgumentError`
-    + `IncompatibleArguments` → `IncompatibleArgumentsError`
-  + Code that explicitly raises or catches these exceptions must be updated.
-
-#### Changes
-
-+ **Crash reporter behavior improvement**
-  + Prevented the default file crash reporter from creating `.crash_report` files when it
-    is not actually used.
-  + Implemented using an internal `FakeModule` helper.
-
-+ **Argparse compatibility update**
-  + Bundled and used the Python 3.13 `argparse` implementation to ensure consistent
-    behavior across supported Python versions.
-
-+ **Progress bar module rename**
-  + Renamed the internal progress bar module to `progress_bar` for consistency with the
-    new naming scheme.
-  + This will not break the usages of `log21.progress_bar(...)` since the call
-    functionality was added to the module using the `FakeModule` helper.
-
-+ **Examples added and updated**
-  + Added new example code files.
-  + Updated existing examples to match the v3 API and conventions.
-
-#### Fixes
-
-+ Resolved various linting and static-analysis issues across the codebase.
-+ Addressed minor compatibility issues uncovered by running linters and pre-commit hooks.
-+ Resolved errors occurring in environments with newer versions of argparse.
-
-#### Internal and Maintenance Changes
-
-+ Migrated the build system configuration to `uv`.
-+ Updated Python version classifiers and set the supported Python version to 3.9+.
-+ Added `vermin` to the pre-commit configuration.
-+ Updated `.gitignore`, license metadata, and tool configurations.
-+ Silenced and resolved a large number of linter warnings.
-+ General internal refactoring with no intended user-visible behavioral changes.
-
-#### Notes
-
-+ There are **no intentional behavioral changes** in logging output, argument parsing
-  logic, or UI components.
-+ Most projects will require **minimal or no changes** unless they depend on internal
-  modules or renamed exceptions.
-+ See [MIGRATION-V2-V3.md](https://github.com/MPCodeWriter21/log21/blob/master/MIGRATION-V2-V3.md)
-for detailed upgrade instructions.
+The way old versions would look:
+
+```help
+usage: test.py [-h] [--verbose]
+
+This is a very useful tool and I will describe it thoroughly. It is so good that
+
+options:
+  -h, --help
+                        show this help message and exit
+  --verbose, -v
+                        This flag will make the logs more verbose!
+
+```
+
+Now at v3.0.2:
+
+```help
+usage: test.py [-h] [--verbose]
+
+This is a very useful tool and I will describe it thoroughly. It is so good that we have a
+second line in the first part of the description. And now we can talk more about the tool...
+
+options:
+  -h, --help
+                        show this help message and exit
+  --verbose, -v
+                        This flag will make the logs more verbose!
+
+```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 

{log21-3.0.1 → log21-3.0.2}/pyproject.toml

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

{log21-3.0.1 → log21-3.0.2}/src/log21/__init__.py

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

{log21-3.0.1 → log21-3.0.2}/src/log21/argumentify.py

@@ -384,9 +384,7 @@ def _argumentify_one(func: Callable) -> None:
             )
 
     # Create the parser
-    parser = _argparse.ColorizingArgumentParser(
-        description=info.docstring.short_description
-    )
+    parser = _argparse.ColorizingArgumentParser(description=info.docstring.description)
     # Add the arguments
     _add_arguments(parser, info)
     cli_args = parser.parse_args()
@@ -432,7 +430,7 @@ def _argumentify(functions: _Dict[str, Callable]) -> None:
     parser = _argparse.ColorizingArgumentParser()
     subparsers = parser.add_subparsers(required=True)
     for name, (_, info) in functions_info.items():
-        subparser = subparsers.add_parser(name, help=info.docstring.short_description)
+        subparser = subparsers.add_parser(name, help=info.docstring.description)
         _add_arguments(subparser, info)
         subparser.set_defaults(func=info.function)
     cli_args = parser.parse_args()