python-json-logger 4.0.0rc1__py3-none-any.whl → 4.2.0__py3-none-any.whl

{python_json_logger-4.0.0rc1.dist-info → python_json_logger-4.2.0.dist-info}/METADATA

@@ -1,50 +1,26 @@
 Metadata-Version: 2.4
 Name: python-json-logger
-Version: 4.0.0rc1
+Version: 4.2.0
 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>
-License: BSD-2-Clause License
+License-Expression: BSD-2-Clause
 Project-URL: Homepage, https://nhairs.github.io/python-json-logger
 Project-URL: GitHub, https://github.com/nhairs/python-json-logger
 Classifier: Development Status :: 6 - Mature
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 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: Topic :: System :: Logging
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: typing_extensions; python_version < "3.10"
-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: backports.zoneinfo; python_version < "3.9" and 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.2.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+python_json_logger-4.2.0.dist-info/licenses/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
+pythonjsonlogger/__init__.py,sha256=2QcveuId10CyXff_BtJ_6kXIarHT5oq66XHHMFiaE8s,419
+pythonjsonlogger/core.py,sha256=L41AmWK0t5n-QHazXeOlggNX7uzri750i7SFSpeXZ5Q,16268
+pythonjsonlogger/defaults.py,sha256=muj4QzHgUMJH0UwRvgroHKSRfQgHcF9E-EJXhVzAi98,6461
+pythonjsonlogger/exception.py,sha256=r3DXDk7TThscnMVNPpVRaRSFHTnY-ygea6nn-FgjwsI,804
+pythonjsonlogger/json.py,sha256=6aJSqd2BeysAHkQkxb7dPgFpqsFRf4rvWYgaWF2MEC0,4064
+pythonjsonlogger/jsonlogger.py,sha256=sfltkYGwRhRvqcpT-kxlPfcMuOc4ngEa4W4NVTiBpMI,417
+pythonjsonlogger/msgspec.py,sha256=tdFes9rLrdns9I_C5ascK9a265iNc4UccLPzc8JbFDI,2159
+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.2.0.dist-info/METADATA,sha256=kgcfdHSWOBb_eR3Xg4Or8GzyuDw9HbClYz9cTx4y5GU,2866
+python_json_logger-4.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_json_logger-4.2.0.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
+python_json_logger-4.2.0.dist-info/RECORD,,

{python_json_logger-4.0.0rc1.dist-info → python_json_logger-4.2.0.dist-info}/WHEEL

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

pythonjsonlogger/core.py

@@ -10,12 +10,8 @@ from datetime import datetime, timezone
 import logging
 import re
 import sys
-from typing import Optional, Union, List, Dict, Container, Any, Sequence
-
-if sys.version_info >= (3, 10):
-    from typing import TypeAlias
-else:
-    from typing_extensions import TypeAlias
+from typing import TypeAlias, Any
+from collections.abc import Container, Sequence
 
 ## Installed
 
@@ -24,7 +20,7 @@ else:
 
 ### CONSTANTS
 ### ============================================================================
-RESERVED_ATTRS: List[str] = [
+RESERVED_ATTRS: list[str] = [
     "args",
     "asctime",
     "created",
@@ -65,13 +61,15 @@ if sys.version_info >= (3, 12):
     RESERVED_ATTRS.sort()
 
 
-STYLE_STRING_TEMPLATE_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_STRING_FORMAT_REGEX = re.compile(r"\{(.+?)\}", re.IGNORECASE)  # { style
 STYLE_PERCENT_REGEX = re.compile(r"%\((.+?)\)", re.IGNORECASE)  # % style
 
 ## Type Aliases
 ## -----------------------------------------------------------------------------
-LogData: TypeAlias = Dict[str, Any]
+LogData: TypeAlias = dict[str, Any]
 """Type alias
 
 *Changed in 4.0*: renamed from `LogRecord` to `LogData`
@@ -82,10 +80,10 @@ LogData: TypeAlias = Dict[str, Any]
 ### ============================================================================
 def merge_record_extra(
     record: logging.LogRecord,
-    target: Dict,
+    target: dict[Any, Any],
     reserved: Container[str],
-    rename_fields: Optional[Dict[str, str]] = None,
-) -> Dict:
+    rename_fields: dict[str, str] | None = None,
+) -> dict[Any, Any]:
     """
     Merges extra attributes from LogRecord object into target dictionary
 
@@ -115,31 +113,27 @@ 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: Union[logging.PercentStyle, str]  # type: ignore[assignment]
+    _style: logging.PercentStyle | str  # type: ignore[assignment]
 
     ## Parent Methods
     ## -------------------------------------------------------------------------
     # pylint: disable=too-many-arguments,super-init-not-called
     def __init__(
         self,
-        fmt: Optional[Union[str, Sequence[str]]] = None,
-        datefmt: Optional[str] = None,
+        fmt: str | Sequence[str] | None = None,
+        datefmt: str | None = None,
         style: str = "%",
         validate: bool = True,
         *,
         prefix: str = "",
-        rename_fields: Optional[Dict[str, str]] = None,
+        rename_fields: dict[str, str] | None = None,
         rename_fields_keep_missing: bool = False,
-        static_fields: Optional[Dict[str, Any]] = None,
-        reserved_attrs: Optional[Sequence[str]] = None,
-        timestamp: Union[bool, str] = False,
-        defaults: Optional[Dict[str, Any]] = None,
+        static_fields: dict[str, Any] | None = None,
+        reserved_attrs: Sequence[str] | None = None,
+        timestamp: bool | str = False,
+        defaults: dict[str, Any] | None = None,
         exc_info_as_array: bool = False,
         stack_info_as_array: bool = False,
     ) -> None:
@@ -176,16 +170,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]
@@ -240,14 +237,20 @@ class BaseJsonFormatter(logging.Formatter):
     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] = {}
+        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()
@@ -276,7 +279,7 @@ class BaseJsonFormatter(logging.Formatter):
 
     ## JSON Formatter Specific Methods
     ## -------------------------------------------------------------------------
-    def parse(self) -> List[str]:
+    def parse(self) -> list[str]:
         """Parses format string looking for substitutions
 
         This method is responsible for returning a list of fields (as strings)
@@ -300,20 +303,22 @@ 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
+            # 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")
+            ]
 
-        elif isinstance(self._style, logging.StrFormatStyle):
-            formatter_style_pattern = STYLE_STRING_FORMAT_REGEX
+        if isinstance(self._style, logging.StrFormatStyle):
+            return STYLE_STRING_FORMAT_REGEX.findall(self._fmt)
 
-        elif isinstance(self._style, logging.PercentStyle):
+        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 STYLE_PERCENT_REGEX.findall(self._fmt)
 
-        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
@@ -327,9 +332,9 @@ class BaseJsonFormatter(logging.Formatter):
 
     def add_fields(
         self,
-        log_data: Dict[str, Any],
+        log_data: dict[str, Any],
         record: logging.LogRecord,
-        message_dict: Dict[str, Any],
+        message_dict: dict[str, Any],
     ) -> None:
         """Extract fields from a LogRecord for logging
 
@@ -402,7 +407,7 @@ class BaseJsonFormatter(logging.Formatter):
         """
         return log_data
 
-    def formatException(self, ei) -> Union[str, list[str]]:  # type: ignore
+    def formatException(self, ei) -> str | list[str]:  # type: ignore[override]
         """Format and return the specified exception information.
 
         If exc_info_as_array is set to True, This method returns an array of strings.
@@ -410,7 +415,7 @@ class BaseJsonFormatter(logging.Formatter):
         exception_info_str = super().formatException(ei)
         return exception_info_str.splitlines() if self.exc_info_as_array else exception_info_str
 
-    def formatStack(self, stack_info) -> Union[str, list[str]]:  # type: ignore
+    def formatStack(self, stack_info) -> str | list[str]:  # type: ignore[override]
         """Format and return the specified stack information.
 
         If stack_info_as_array is set to True, This method returns an array of strings.

pythonjsonlogger/defaults.py

@@ -16,17 +16,11 @@ import base64
 import dataclasses
 import datetime
 import enum
-import sys
 from types import TracebackType
-from typing import Any
+from typing import Any, TypeGuard
 import traceback
 import uuid
 
-if sys.version_info >= (3, 10):
-    from typing import TypeGuard
-else:
-    from typing_extensions import TypeGuard
-
 ## Installed
 
 ## Application

pythonjsonlogger/json.py

@@ -12,7 +12,8 @@ from __future__ import annotations
 ## Standard Library
 import datetime
 import json
-from typing import Any, Callable, Optional, Union
+from typing import Any
+from collections.abc import Callable
 import warnings
 
 ## Application
@@ -67,10 +68,10 @@ class JsonFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: Optional[Callable] = None,
-        json_encoder: Optional[Callable] = None,
+        json_default: Callable | None = None,
+        json_encoder: Callable | None = None,
         json_serializer: Callable = json.dumps,
-        json_indent: Optional[Union[int, str]] = None,
+        json_indent: int | str | None = None,
         json_ensure_ascii: bool = True,
         **kwargs,
     ) -> None:

pythonjsonlogger/msgspec.py

@@ -6,7 +6,8 @@
 from __future__ import annotations
 
 ## Standard Library
-from typing import Any, Optional, Callable
+from typing import Any
+from collections.abc import Callable
 
 ## Installed
 
@@ -43,7 +44,7 @@ class MsgspecFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: Optional[Callable] = msgspec_default,
+        json_default: Callable | None = msgspec_default,
         **kwargs,
     ) -> None:
         """

pythonjsonlogger/orjson.py

@@ -6,7 +6,8 @@
 from __future__ import annotations
 
 ## Standard Library
-from typing import Any, Optional, Callable
+from typing import Any
+from collections.abc import Callable
 
 ## Installed
 
@@ -15,7 +16,7 @@ from . import core
 from . import defaults as d
 from .utils import package_is_available
 
-# We import msgspec after checking it is available
+# We import orjson after checking it is available
 package_is_available("orjson", throw_error=True)
 import orjson  # pylint: disable=wrong-import-position,wrong-import-order
 
@@ -45,7 +46,7 @@ class OrjsonFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: Optional[Callable] = orjson_default,
+        json_default: Callable | None = orjson_default,
         json_indent: bool = False,
         **kwargs,
     ) -> None:

python_json_logger-4.0.0rc1.dist-info/RECORD

@@ -1,16 +0,0 @@
-python_json_logger-4.0.0rc1.dist-info/licenses/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
-python_json_logger-4.0.0rc1.dist-info/licenses/NOTICE,sha256=uRQnFcGZCwuIBR2AIHVvhKi9w1KkiI_vAyralfxCsk4,209
-pythonjsonlogger/__init__.py,sha256=2QcveuId10CyXff_BtJ_6kXIarHT5oq66XHHMFiaE8s,419
-pythonjsonlogger/core.py,sha256=7n2y-jUpLO_D826OYq0eA8u4PAQcKr3vJWeQbsP604E,15988
-pythonjsonlogger/defaults.py,sha256=-XgxIj8ioq7CsnBBMsQhTRpU-lKbLrpQLJTCaT3iH38,6577
-pythonjsonlogger/exception.py,sha256=r3DXDk7TThscnMVNPpVRaRSFHTnY-ygea6nn-FgjwsI,804
-pythonjsonlogger/json.py,sha256=jiVE029rsnuXUUNghNwHaWsuQQ6rSZGRHVx8FKvVV_c,4069
-pythonjsonlogger/jsonlogger.py,sha256=sfltkYGwRhRvqcpT-kxlPfcMuOc4ngEa4W4NVTiBpMI,417
-pythonjsonlogger/msgspec.py,sha256=xZLqPwS8MqjtOwdnMY8tgCq5yMtKaytY5tXEV_YLhLo,2145
-pythonjsonlogger/orjson.py,sha256=Fd8eurRQsMZ6JB9zdClfjogWJ5J15NOTsbjH7p9jzsE,2341
-pythonjsonlogger/py.typed,sha256=4RLptUHQuSqzK6CDbigff8uvWQjwPPQMxikWPkV4OtA,80
-pythonjsonlogger/utils.py,sha256=qr04nb61TkVw7cJTXAtLBfyH_NBvyYUlR_mehH76-RM,1126
-python_json_logger-4.0.0rc1.dist-info/METADATA,sha256=B9XwbhoBT005SoTqtLmq71eJXnRQ0KtLMKvO_NT9L50,3994
-python_json_logger-4.0.0rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_json_logger-4.0.0rc1.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
-python_json_logger-4.0.0rc1.dist-info/RECORD,,

python_json_logger-4.0.0rc1.dist-info/licenses/NOTICE

@@ -1,5 +0,0 @@
-This software includes the following licenced software:
-  - mkdocstrings-python
-    Copyright (c) 2021, Timothée Mazzucotelli
-    Licenced under ISC Licence
-    Source: https://github.com/mkdocstrings/python