log21 3.0.2__tar.gz → 3.2.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: log21
-Version: 3.0.2
+Version: 3.2.0
 Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
 Author: CodeWriter21(Mehrad Pooryoussof)
@@ -94,55 +94,24 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.0.2
+### v3.2.0
 
-Change `argumentify` to use the whole function description as the argument-parser
-description instead of the one-line short description.
+Add `file_mode` and `file_encoding` parameters to `get_logger` for finer control over
+the way a simple logger handles files.
 
-+ Example:
+For even more control you can still define Logger, Handlers, and Formatters manually.
 
-```python
-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)
-```
-
-The way old versions would look:
-
-```help
-usage: test.py [-h] [--verbose]
+#### Example
 
-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...
+```python
+import log21
 
-options:
-  -h, --help
-                        show this help message and exit
-  --verbose, -v
-                        This flag will make the logs more verbose!
+logger = log21.get_logger(
+    "My File Logger", show_level=False, show_time=True, file="myapp.log", file_mode="a",
+    file_encoding="utf-8"
+)
 
+logger.info("Hello World!")
 ```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)

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

@@ -69,55 +69,24 @@ pip install git+https://github.com/MPCodeWriter21/log21
 Changelog
 ---------
 
-### v3.0.2
+### v3.2.0
 
-Change `argumentify` to use the whole function description as the argument-parser
-description instead of the one-line short description.
+Add `file_mode` and `file_encoding` parameters to `get_logger` for finer control over
+the way a simple logger handles files.
 
-+ Example:
+For even more control you can still define Logger, Handlers, and Formatters manually.
 
-```python
-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)
-```
-
-The way old versions would look:
-
-```help
-usage: test.py [-h] [--verbose]
+#### Example
 
-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...
+```python
+import log21
 
-options:
-  -h, --help
-                        show this help message and exit
-  --verbose, -v
-                        This flag will make the logs more verbose!
+logger = log21.get_logger(
+    "My File Logger", show_level=False, show_time=True, file="myapp.log", file_mode="a",
+    file_encoding="utf-8"
+)
 
+logger.info("Hello World!")
 ```
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)

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

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

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

@@ -31,7 +31,7 @@ from .stream_handler import StreamHandler, ColorizingStreamHandler
 # yapf: enable
 
 __author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
-__version__ = '3.0.2'
+__version__ = '3.2.0'
 __github__ = 'https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',
@@ -60,7 +60,8 @@ def _prepare_formatter(
     colorize_time_and_level: bool = True,
     level_names: _Optional[_Mapping[int, str]] = None,
     level_colors: _Optional[_Mapping[int, tuple[str, ...]]] = None,
-    formatter_class: _Type[_logging.Formatter] = ColorizingFormatter
+    formatter_class: _Type[_logging.Formatter] = ColorizingFormatter,
+    prefix_carriage_return: bool = True,
 ) -> _logging.Formatter:
     # Prepares a formatting if the fmt was None
     if not fmt:
@@ -70,7 +71,8 @@ def _prepare_formatter(
             fmt = '[%(levelname)s] ' + fmt
         if show_time:
             fmt = '[%(asctime)s] ' + fmt
-        fmt = '\r' + fmt
+        if prefix_carriage_return:
+            fmt = '\r' + fmt
 
     if level_colors and not issubclass(formatter_class, ColorizingFormatter):
         warning(
@@ -116,7 +118,10 @@ def get_logger(
     override: bool = False,
     level_names: _Optional[_Mapping[int, str]] = None,
     level_colors: _Optional[_Mapping[int, tuple[str, ...]]] = None,
-    file: _Optional[_Union[_os.PathLike, str]] = None
+    # TODO: Rename file to file_path in one future update
+    file: _Optional[_Union[_os.PathLike, str]] = None,
+    file_mode: _Optional[str] = None,
+    file_encoding: _Optional[str] = None,
 ) -> Logger:
     """Returns a logging.Logger with colorizing support.
 
@@ -182,7 +187,9 @@ def get_logger(
     :param level_names: Mapping[int, str] = None: You can specify custom level names.
     :param level_colors: Mapping[int, Tuple[str, ...]] = None: You can specify custom
         level colors.
-    :param file: Union[os.PathLike, str] = None: The file to log to
+    :param file: Union[os.PathLike, str] = None: The file path to log to
+    :param file_mode: str = None: The mode to open file at (Defaults to 'a')
+    :param file_encoding: str = None: The file encoding
     :return: log21.Logger
     """
     if not isinstance(name, str):
@@ -209,7 +216,9 @@ def get_logger(
         _manager.addLogger(name, logger)
 
         if file:
-            file_handler = FileHandler(file)
+            file_handler = DecolorizingFileHandler(
+                file, mode=file_mode or 'a', encoding=file_encoding
+            )
             file_formatter = _prepare_formatter(
                 fmt,
                 style,
@@ -218,7 +227,8 @@ def get_logger(
                 show_time,
                 False,
                 level_names,
-                formatter_class=DecolorizingFormatter
+                formatter_class=DecolorizingFormatter,
+                prefix_carriage_return=False,
             )
             file_handler.setFormatter(file_formatter)
             logger.addHandler(file_handler)

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

@@ -344,6 +344,28 @@ def _add_arguments(
     """
     if reserved_flags is None:
         reserved_flags = RESERVED_FLAGS.copy()
+
+    keyword_only_exists = False
+    for argument in info.arguments.values():
+        # Reserve the name of POSITIONAL_ONLY and VAR_POSITIONAL arguments as flags
+        # since their flag name and their dest need to be the same
+        if argument.kind in [_inspect._ParameterKind.POSITIONAL_ONLY,
+                             _inspect._ParameterKind.VAR_POSITIONAL]:
+            reserved_flags.add(argument.name)
+        # If there is at least one KEYWORD_ONLY argument, the parameters of kind
+        # POSITIONAL_OR_KEYWORD will be marked as required
+        if argument.kind == _inspect._ParameterKind.KEYWORD_ONLY:
+            keyword_only_exists = True
+        # Check if the function has a VAR_KEYWORD argument
+        # Raises a ArgumentTypeError if it does
+        # TODO: See if we can find a use-case and a way of supporting these arguments
+        if argument.kind == _inspect._ParameterKind.VAR_KEYWORD:
+            raise ArgumentTypeError(
+                f"The function has a `**{argument.name}` argument, "
+                "which is not supported.",
+                unsupported_arg=argument.name
+            )
+
     # Add the arguments
     for argument in info.arguments.values():
         config: _Dict[str, _Any] = {
@@ -351,19 +373,21 @@ def _add_arguments(
             'dest': argument.name,
             'help': argument.help
         }
+        flags = generate_flag(argument, reserved_flags=reserved_flags)
         if argument.annotation is bool:
             config['action'] = 'store_true'
         elif argument.annotation:
             config['type'] = argument.annotation
         if argument.kind == _inspect._ParameterKind.POSITIONAL_ONLY:
-            config['required'] = True
+            flags = [config.pop('dest')]
         if argument.kind == _inspect._ParameterKind.VAR_POSITIONAL:
             config['nargs'] = '*'
+            flags = [config.pop('dest')]
+        if argument.kind == _inspect._ParameterKind.POSITIONAL_OR_KEYWORD and keyword_only_exists:
+            config['required'] = True
         if argument.default is not None:
             config['default'] = argument.default
-        parser.add_argument(
-            *generate_flag(argument, reserved_flags=reserved_flags), **config
-        )
+        parser.add_argument(*flags, **config)
 
 
 def _argumentify_one(func: Callable) -> None:
@@ -373,16 +397,6 @@ def _argumentify_one(func: Callable) -> None:
     """
     info = FunctionInfo(func)
 
-    # Check if the function has a VAR_KEYWORD argument
-    # Raises a ArgumentTypeError if it does
-    for argument in info.arguments.values():
-        if argument.kind == _inspect._ParameterKind.VAR_KEYWORD:
-            raise ArgumentTypeError(
-                f"The function has a `**{argument.name}` argument, "
-                "which is not supported.",
-                unsupported_arg=argument.name
-            )
-
     # Create the parser
     parser = _argparse.ColorizingArgumentParser(description=info.docstring.description)
     # Add the arguments