python-json-logger 4.1.0__py3-none-any.whl → 4.3.0.dev2__py3-none-any.whl

{python_json_logger-4.1.0.dist-info → python_json_logger-4.3.0.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-json-logger
-Version: 4.1.0
+Version: 4.3.0.dev2
 Summary: JSON Log Formatter for the Python Logging Package
 Author-email: Zakaria Zajac <zak@madzak.com>, Nicholas Hairs <info+python-json-logger@nicholashairs.com>
 Maintainer-email: Nicholas Hairs <info+python-json-logger@nicholashairs.com>
@@ -16,30 +16,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: System :: Logging
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: orjson; implementation_name != "pypy" and extra == "dev"
-Requires-Dist: msgspec; implementation_name != "pypy" and extra == "dev"
-Requires-Dist: validate-pyproject[all]; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: freezegun; extra == "dev"
-Requires-Dist: tzdata; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: mkdocs; extra == "dev"
-Requires-Dist: mkdocs-material>=8.5; extra == "dev"
-Requires-Dist: mkdocs-awesome-pages-plugin; extra == "dev"
-Requires-Dist: mdx_truly_sane_lists; extra == "dev"
-Requires-Dist: mkdocstrings[python]; extra == "dev"
-Requires-Dist: mkdocs-gen-files; extra == "dev"
-Requires-Dist: mkdocs-literate-nav; extra == "dev"
-Requires-Dist: mike; extra == "dev"
 Dynamic: license-file
 
 [![PyPi](https://img.shields.io/pypi/v/python-json-logger.svg)](https://pypi.python.org/pypi/python-json-logger/)

{python_json_logger-4.1.0.dist-info → python_json_logger-4.3.0.dev2.dist-info}/RECORD

@@ -1,7 +1,7 @@
-python_json_logger-4.1.0.dist-info/licenses/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
+python_json_logger-4.3.0.dev2.dist-info/licenses/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
 pythonjsonlogger/__init__.py,sha256=2QcveuId10CyXff_BtJ_6kXIarHT5oq66XHHMFiaE8s,419
-pythonjsonlogger/core.py,sha256=27H5Rd1vZsWfFYbtwqoYEQTN8GSqxeZVrAN-_pIcd8A,15870
-pythonjsonlogger/defaults.py,sha256=muj4QzHgUMJH0UwRvgroHKSRfQgHcF9E-EJXhVzAi98,6461
+pythonjsonlogger/core.py,sha256=T02iURAubnMTk0PO0HUOckS93eMfAFapSZcFPXJqB64,17102
+pythonjsonlogger/defaults.py,sha256=VR_Wl092yRjwS0mREjuNn_W4H4sAjtcZAIYFBMYNHe0,6770
 pythonjsonlogger/exception.py,sha256=r3DXDk7TThscnMVNPpVRaRSFHTnY-ygea6nn-FgjwsI,804
 pythonjsonlogger/json.py,sha256=6aJSqd2BeysAHkQkxb7dPgFpqsFRf4rvWYgaWF2MEC0,4064
 pythonjsonlogger/jsonlogger.py,sha256=sfltkYGwRhRvqcpT-kxlPfcMuOc4ngEa4W4NVTiBpMI,417
@@ -9,7 +9,7 @@ pythonjsonlogger/msgspec.py,sha256=tdFes9rLrdns9I_C5ascK9a265iNc4UccLPzc8JbFDI,2
 pythonjsonlogger/orjson.py,sha256=XWM-jyl6g_40Em8kt188EOspD872xHvYy8aS_CLlssw,2354
 pythonjsonlogger/py.typed,sha256=4RLptUHQuSqzK6CDbigff8uvWQjwPPQMxikWPkV4OtA,80
 pythonjsonlogger/utils.py,sha256=qr04nb61TkVw7cJTXAtLBfyH_NBvyYUlR_mehH76-RM,1126
-python_json_logger-4.1.0.dist-info/METADATA,sha256=3m2R5zYhsgprnQkI5JW0VHQl7B2r3maSYjGeegZLI10,3739
-python_json_logger-4.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_json_logger-4.1.0.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
-python_json_logger-4.1.0.dist-info/RECORD,,
+python_json_logger-4.3.0.dev2.dist-info/METADATA,sha256=q4IajnR8q8pXVltRYOx5V3-7FPkoGkECHgo9XbSb9AI,2922
+python_json_logger-4.3.0.dev2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+python_json_logger-4.3.0.dev2.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
+python_json_logger-4.3.0.dev2.dist-info/RECORD,,

{python_json_logger-4.1.0.dist-info → python_json_logger-4.3.0.dev2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pythonjsonlogger/core.py

@@ -9,6 +9,7 @@ from __future__ import annotations
 from datetime import datetime, timezone
 import logging
 import re
+import string
 import sys
 from typing import TypeAlias, Any
 from collections.abc import Container, Sequence
@@ -61,9 +62,10 @@ if sys.version_info >= (3, 12):
     RESERVED_ATTRS.sort()
 
 
-STYLE_STRING_TEMPLATE_REGEX = re.compile(r"\$\{(.+?)\}", re.IGNORECASE)  # $ style
-STYLE_STRING_FORMAT_REGEX = re.compile(r"\{(.+?)\}", re.IGNORECASE)  # { style
-STYLE_PERCENT_REGEX = re.compile(r"%\((.+?)\)", re.IGNORECASE)  # % style
+STYLE_STRING_TEMPLATE_REGEX = re.compile(
+    r"\$(?:\$|\{(?P<braced>.+?)\}|(?P<named>[_a-z][_a-z0-9]*))", re.IGNORECASE
+)  # $ style
+STYLE_PERCENT_REGEX = re.compile(r"%(?:%|\((?P<named>.+?)\))", re.IGNORECASE)  # % style
 
 ## Type Aliases
 ## -----------------------------------------------------------------------------
@@ -111,10 +113,6 @@ class BaseJsonFormatter(logging.Formatter):
     Must not be used directly.
 
     *New in 3.1*
-
-    *Changed in 3.2*: `defaults` argument is no longer ignored.
-
-    *Added in 3.3*: `exc_info_as_array` and `stack_info_as_array` options are added.
     """
 
     _style: logging.PercentStyle | str  # type: ignore[assignment]
@@ -155,12 +153,14 @@ class BaseJsonFormatter(logging.Formatter):
             rename_fields_keep_missing: When renaming fields, include missing fields in the output.
             static_fields: an optional dict, used to add fields with static values to all logs
             reserved_attrs: an optional list of fields that will be skipped when
-                outputting json log record. Defaults to [all log record attributes][pythonjsonlogger.core.RESERVED_ATTRS].
+                outputting json log record. Pass a list or tuple, not a string.
+                Defaults to [all log record attributes][pythonjsonlogger.core.RESERVED_ATTRS].
             timestamp: an optional string/boolean field to add a timestamp when
                 outputting the json log record. If string is passed, timestamp will be added
                 to log record using string as key. If True boolean is passed, timestamp key
                 will be "timestamp". Defaults to False/off.
-            exc_info_as_array: break the exc_info into a list of lines based on line breaks.
+            exc_info_as_array: break the exc_info into a list of lines based on line breaks,
+                including cached exception text in records received over a transport.
             stack_info_as_array: break the stack_info into a list of lines based on line breaks.
 
         *Changed in 3.1*:
@@ -172,16 +172,19 @@ class BaseJsonFormatter(logging.Formatter):
           missing fields. The original behaviour, missing fields have a value of `None`, is still
           available by setting `rename_fields_keep_missing` to `True`.
 
+        *Changed in 3.2*: `defaults` argument is no longer ignored.
+
+        *Added in 3.3*: `exc_info_as_array` and `stack_info_as_array` options are added.
+
         *Added in 4.0*:
 
-        - `fmt` now supports comma seperated lists (`style=","`). Note that this style is specific
+        - `fmt` now supports comma separated lists (`style=","`). Note that this style is specific
           to `python-json-logger` and thus care should be taken to not to pass this format to other
           logging Formatter implementations.
         - `fmt` now supports sequences of strings (e.g. lists and tuples) of field names.
         """
         ## logging.Formatter compatibility
         ## ---------------------------------------------------------------------
-        # Note: validate added in python 3.8, defaults added in 3.10
         if fmt is None or isinstance(fmt, str):
             if style in logging._STYLES:
                 _style = logging._STYLES[style][0](fmt)  # type: ignore[operator]
@@ -212,8 +215,9 @@ class BaseJsonFormatter(logging.Formatter):
         ## ---------------------------------------------------------------------
         self.prefix = prefix
 
-        # We recreate the dict in rename_fields and static_fields to support internal/external
-        # references which require getting the item to do the conversion.
+        # Recreate these dicts so DictConfigurator `ext://` / `cfg://` prefixes
+        # are converted (ConvertingDict only converts on `__getitem__`) and so
+        # later mutation of the caller's dict cannot change formatter state.
         # For more details see: https://github.com/nhairs/python-json-logger/pull/45
         self.rename_fields = (
             {key: rename_fields[key] for key in rename_fields} if rename_fields is not None else {}
@@ -221,29 +225,43 @@ class BaseJsonFormatter(logging.Formatter):
         self.static_fields = (
             {key: static_fields[key] for key in static_fields} if static_fields is not None else {}
         )
+        self.defaults = {key: defaults[key] for key in defaults} if defaults is not None else {}
 
         self.rename_fields_keep_missing = rename_fields_keep_missing
-        self.reserved_attrs = set(reserved_attrs if reserved_attrs is not None else RESERVED_ATTRS)
+        if reserved_attrs is None:
+            reserved_attrs = RESERVED_ATTRS
+        elif isinstance(reserved_attrs, str):
+            raise TypeError("reserved_attrs must be a sequence of field names, not a string")
+        self.reserved_attrs = set(reserved_attrs)
         self.timestamp = timestamp
 
         self._skip_fields = set(self._required_fields)
         self._skip_fields.update(self.reserved_attrs)
-        self.defaults = defaults if defaults is not None else {}
         self.exc_info_as_array = exc_info_as_array
         self.stack_info_as_array = stack_info_as_array
         return
 
+    def usesTime(self) -> bool:
+        """Return whether the parsed format fields include `asctime`."""
+        return "asctime" in self._required_fields
+
     def format(self, record: logging.LogRecord) -> str:
         """Formats a log record and serializes to json
 
+        When `record.msg` is a `dict`, adding `exc_info` and `stack_info` does not
+        modify the caller's dict.
+
         Args:
             record: the record to format
+
+        *Changed in 4.2.0*: a `dict` `record.msg` is copied instead of modified
+        in place.
         """
         message_dict: dict[str, Any] = {}
         # TODO: logging.LogRecord.msg and logging.LogRecord.message in typeshed
         #        are always type of str. We shouldn't need to override that.
         if isinstance(record.msg, dict):
-            message_dict = record.msg
+            message_dict = record.msg.copy()
             record.message = ""
         else:
             record.message = record.getMessage()
@@ -257,7 +275,9 @@ class BaseJsonFormatter(logging.Formatter):
         if record.exc_info and not message_dict.get("exc_info"):
             message_dict["exc_info"] = self.formatException(record.exc_info)
         if not message_dict.get("exc_info") and record.exc_text:
-            message_dict["exc_info"] = record.exc_text
+            message_dict["exc_info"] = (
+                record.exc_text.splitlines() if self.exc_info_as_array else record.exc_text
+            )
 
         # Display formatted record of stack frames
         # default format is a string returned from :func:`traceback.print_stack`
@@ -296,20 +316,30 @@ class BaseJsonFormatter(logging.Formatter):
             raise ValueError(f"Style {self._style!r} is not supported")
 
         if isinstance(self._style, logging.StringTemplateStyle):
-            formatter_style_pattern = STYLE_STRING_TEMPLATE_REGEX
-
-        elif isinstance(self._style, logging.StrFormatStyle):
-            formatter_style_pattern = STYLE_STRING_FORMAT_REGEX
-
-        elif isinstance(self._style, logging.PercentStyle):
+            # String templates support both ${name} and $name, and $$ is an escaped literal
+            return [
+                match.group("braced") or match.group("named")
+                for match in STYLE_STRING_TEMPLATE_REGEX.finditer(self._fmt)
+                if match.group("braced") or match.group("named")
+            ]
+
+        if isinstance(self._style, logging.StrFormatStyle):
+            return [
+                field_name
+                for _, field_name, _, _ in string.Formatter().parse(self._fmt)
+                if field_name
+            ]
+
+        if isinstance(self._style, logging.PercentStyle):
             # PercentStyle is parent class of StringTemplateStyle and StrFormatStyle
             # so it must be checked last.
-            formatter_style_pattern = STYLE_PERCENT_REGEX
-
-        else:
-            raise ValueError(f"Style {self._style!r} is not supported")
+            return [
+                match.group("named")
+                for match in STYLE_PERCENT_REGEX.finditer(self._fmt)
+                if match.group("named")
+            ]
 
-        return formatter_style_pattern.findall(self._fmt)
+        raise ValueError(f"Style {self._style!r} is not supported")
 
     def serialize_log_record(self, log_data: LogData) -> str:
         """Returns the final representation of the data to be logged

pythonjsonlogger/defaults.py

@@ -152,10 +152,18 @@ def use_exception_default(obj: Any) -> TypeGuard[BaseException]:
 def exception_default(obj: BaseException) -> str:
     """Default function for exception instances
 
+    Includes the exception's own notes, if present. Exception groups retain
+    their summary without recursively formatting their children.
+
     Args:
         obj: object to handle
+
+    *Changed in 4.3*: Includes exception notes if available.
     """
-    return f"{obj.__class__.__name__}: {obj}"
+    result = f"{obj.__class__.__name__}: {obj}"
+    if hasattr(obj, "__notes__"):
+        return "\n".join([result, *obj.__notes__])
+    return result
 
 
 def use_traceback_default(obj: Any) -> TypeGuard[TracebackType]: