python-json-logger 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

{python_json_logger-3.1.0.dist-info → python_json_logger-3.2.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: python-json-logger
-Version: 3.1.0
+Version: 3.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
-Project-URL: Homepage, https://nhairs.github.io/python-json-logger/latest/
+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
@@ -17,33 +17,35 @@ 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: Topic :: System :: Logging
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: typing-extensions
+Requires-Dist: typing_extensions; python_version < "3.10"
 Provides-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'
-Requires-Dist: orjson ; (implementation_name != "pypy" and python_version < "3.13") and extra == 'dev'
-Requires-Dist: msgspec ; (implementation_name != "pypy" and python_version < "3.13") and extra == 'dev'
-Requires-Dist: backports.zoneinfo ; (python_version < "3.9") and extra == 'dev'
+Requires-Dist: orjson; implementation_name != "pypy" and extra == "dev"
+Requires-Dist: msgspec; (implementation_name != "pypy" and python_version < "3.13") and extra == "dev"
+Requires-Dist: msgspec-python313-pre; (implementation_name != "pypy" and python_version == "3.13") 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"
 
 <!-- [![PyPi](https://img.shields.io/pypi/v/python-json-logger.svg)](https://pypi.python.org/pypi/python-json-logger/)
 [![PyPI - Status](https://img.shields.io/pypi/status/python-json-logger)](https://pypi.python.org/pypi/python-json-logger/)

python_json_logger-3.2.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+pythonjsonlogger/__init__.py,sha256=mvnVMTGrh32otHxVE7-MsxT9kBvmMyS6I3NCQDe55LY,898
+pythonjsonlogger/core.py,sha256=zrf2vBMPVjPv5ornwWs2TOi68FbWDnuhj_DrcUiuBG0,13328
+pythonjsonlogger/defaults.py,sha256=-XgxIj8ioq7CsnBBMsQhTRpU-lKbLrpQLJTCaT3iH38,6577
+pythonjsonlogger/exception.py,sha256=r3DXDk7TThscnMVNPpVRaRSFHTnY-ygea6nn-FgjwsI,804
+pythonjsonlogger/json.py,sha256=TsKD_1-TDjaeMUg6la_aVzIWd7GBxgAntY6zWzVe7lU,4165
+pythonjsonlogger/msgspec.py,sha256=M5kiIX4RLr1PwvWKx21N8sgk05LCFymBAWM4cRR3VNA,2161
+pythonjsonlogger/orjson.py,sha256=HVhIHo7CrTwj9pZuZzUmj1qsW0coNdVmDKSDycDs-pM,2357
+pythonjsonlogger/py.typed,sha256=4RLptUHQuSqzK6CDbigff8uvWQjwPPQMxikWPkV4OtA,80
+pythonjsonlogger/utils.py,sha256=qr04nb61TkVw7cJTXAtLBfyH_NBvyYUlR_mehH76-RM,1126
+python_json_logger-3.2.0.dist-info/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
+python_json_logger-3.2.0.dist-info/METADATA,sha256=5eZGCDrb3mmrvVyiug9EYBtzaD_PDzZmHw_UUy4dlKc,4357
+python_json_logger-3.2.0.dist-info/NOTICE,sha256=uRQnFcGZCwuIBR2AIHVvhKi9w1KkiI_vAyralfxCsk4,209
+python_json_logger-3.2.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+python_json_logger-3.2.0.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
+python_json_logger-3.2.0.dist-info/RECORD,,

{python_json_logger-3.1.0.dist-info → python_json_logger-3.2.0.dist-info}/WHEEL

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

pythonjsonlogger/__init__.py

@@ -9,23 +9,12 @@ import warnings
 
 ## Application
 import pythonjsonlogger.json
+import pythonjsonlogger.utils
 
 ### CONSTANTS
 ### ============================================================================
-try:
-    import orjson
-
-    ORJSON_AVAILABLE = True
-except ImportError:
-    ORJSON_AVAILABLE = False
-
-
-try:
-    import msgspec
-
-    MSGSPEC_AVAILABLE = True
-except ImportError:
-    MSGSPEC_AVAILABLE = False
+ORJSON_AVAILABLE = pythonjsonlogger.utils.package_is_available("orjson")
+MSGSPEC_AVAILABLE = pythonjsonlogger.utils.package_is_available("msgspec")
 
 
 ### DEPRECATED COMPATIBILITY

pythonjsonlogger/core.py

@@ -66,9 +66,9 @@ if sys.version_info >= (3, 12):
     RESERVED_ATTRS.sort()
 
 
-STYLE_STRING_TEMPLATE_REGEX = re.compile(r"\$\{(.+?)\}", re.IGNORECASE)
-STYLE_STRING_FORMAT_REGEX = re.compile(r"\{(.+?)\}", re.IGNORECASE)
-STYLE_PERCENT_REGEX = re.compile(r"%\((.+?)\)", re.IGNORECASE)
+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
 
 ## Type Aliases
 ## -----------------------------------------------------------------------------
@@ -132,6 +132,8 @@ class BaseJsonFormatter(logging.Formatter):
     Must not be used directly.
 
     *New in 3.1*
+
+    *Changed in 3.2*: `defaults` argument is no longer ignored.
     """
 
     _style: Union[logging.PercentStyle, str]  # type: ignore[assignment]
@@ -161,7 +163,8 @@ class BaseJsonFormatter(logging.Formatter):
             style: how to extract log fields from `fmt`
             validate: validate `fmt` against style, if implementing a custom `style` you
                 must set this to `False`.
-            defaults: ignored - kept for compatibility with python 3.10+
+            defaults: a dictionary containing default fields that are added before all other fields and
+                may be overridden. The supplied fields are still subject to `rename_fields`.
             prefix: an optional string prefix added at the beginning of
                 the formatted string
             rename_fields: an optional dict, used to rename field names in the output.
@@ -215,6 +218,7 @@ class BaseJsonFormatter(logging.Formatter):
         self._required_fields = self.parse()
         self._skip_fields = set(self._required_fields)
         self._skip_fields.update(self.reserved_attrs)
+        self.defaults = defaults if defaults is not None else {}
         return
 
     def format(self, record: logging.LogRecord) -> str:
@@ -310,6 +314,9 @@ class BaseJsonFormatter(logging.Formatter):
             message_dict: dictionary that was logged instead of a message. e.g
                 `logger.info({"is_this_message_dict": True})`
         """
+        for field in self.defaults:
+            log_record[self._get_rename(field)] = self.defaults[field]
+
         for field in self._required_fields:
             log_record[self._get_rename(field)] = record.__dict__.get(field)
 

pythonjsonlogger/exception.py

@@ -0,0 +1,27 @@
+### IMPORTS
+### ============================================================================
+## Future
+from __future__ import annotations
+
+## Standard Library
+
+## Installed
+
+## Application
+
+
+### CLASSES
+### ============================================================================
+class PythonJsonLoggerError(Exception):
+    "Generic base clas for all Python JSON Logger exceptions"
+
+
+class MissingPackageError(ImportError, PythonJsonLoggerError):
+    "A required package is missing"
+
+    def __init__(self, name: str, extras_name: str | None = None) -> None:
+        msg = f"The {name!r} package is required but could not be found."
+        if extras_name is not None:
+            msg += f" It can be installed using 'python-json-logger[{extras_name}]'."
+        super().__init__(msg)
+        return

pythonjsonlogger/msgspec.py

@@ -9,11 +9,15 @@ from __future__ import annotations
 from typing import Any
 
 ## Installed
-import msgspec.json
 
 ## Application
 from . import core
 from . import defaults as d
+from .utils import package_is_available
+
+# We import msgspec after checking it is available
+package_is_available("msgspec", throw_error=True)
+import msgspec.json  # pylint: disable=wrong-import-position,wrong-import-order
 
 
 ### FUNCTIONS

pythonjsonlogger/orjson.py

@@ -1,4 +1,4 @@
-"""JSON Formatter using [msgspec](https://github.com/ijl/orjson)"""
+"""JSON Formatter using [orjson](https://github.com/ijl/orjson)"""
 
 ### IMPORTS
 ### ============================================================================
@@ -9,11 +9,15 @@ from __future__ import annotations
 from typing import Any
 
 ## Installed
-import orjson
 
 ## Application
 from . import core
 from . import defaults as d
+from .utils import package_is_available
+
+# We import msgspec after checking it is available
+package_is_available("orjson", throw_error=True)
+import orjson  # pylint: disable=wrong-import-position,wrong-import-order
 
 
 ### FUNCTIONS

pythonjsonlogger/utils.py

@@ -0,0 +1,40 @@
+"""Utilities for Python JSON Logger"""
+
+### IMPORTS
+### ============================================================================
+## Future
+from __future__ import annotations
+
+## Standard Library
+import importlib.util
+
+## Installed
+
+## Application
+from .exception import MissingPackageError
+
+
+### FUNCTIONS
+### ============================================================================
+def package_is_available(
+    name: str, *, throw_error: bool = False, extras_name: str | None = None
+) -> bool:
+    """Determine if the given package is available for import.
+
+    Args:
+        name: Import name of the package to check.
+        throw_error: Throw an error if the package is unavailable.
+        extras_name: Extra dependency name to use in `throw_error`'s message.
+
+    Raises:
+        MissingPackageError: When `throw_error` is `True` and the return value would be `False`
+
+    Returns:
+        If the package is available for import.
+    """
+    available = importlib.util.find_spec(name) is not None
+
+    if not available and throw_error:
+        raise MissingPackageError(name, extras_name)
+
+    return available

python_json_logger-3.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-pythonjsonlogger/__init__.py,sha256=J0u_TRg2RJcZFMapD5ZXUgCdiu57RmjdAy2JLMwD50s,927
-pythonjsonlogger/core.py,sha256=A2SMUx_uYQ4vv1NI5tkk9cQyWXk9mpGOMJIq68SgJcI,12933
-pythonjsonlogger/defaults.py,sha256=-XgxIj8ioq7CsnBBMsQhTRpU-lKbLrpQLJTCaT3iH38,6577
-pythonjsonlogger/json.py,sha256=TsKD_1-TDjaeMUg6la_aVzIWd7GBxgAntY6zWzVe7lU,4165
-pythonjsonlogger/msgspec.py,sha256=02ig_PtD9seLiO4HdaILIPezyVpPzik9L4kl1Cmq3VA,1959
-pythonjsonlogger/orjson.py,sha256=9mlRh3Op8ZumIM5ippamhC9qqne9KmOKE6Y2SSORnHo,2157
-pythonjsonlogger/py.typed,sha256=4RLptUHQuSqzK6CDbigff8uvWQjwPPQMxikWPkV4OtA,80
-python_json_logger-3.1.0.dist-info/LICENSE,sha256=GOqVF546Xg4k62zhbED7--IxM8JQKTOi91-KPhoFW1Q,1329
-python_json_logger-3.1.0.dist-info/METADATA,sha256=2cKiV8ZbtRiscpNXxxRR8Lj8xMBFAnzLE35HIcPBH60,4223
-python_json_logger-3.1.0.dist-info/NOTICE,sha256=uRQnFcGZCwuIBR2AIHVvhKi9w1KkiI_vAyralfxCsk4,209
-python_json_logger-3.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-python_json_logger-3.1.0.dist-info/top_level.txt,sha256=9G-OsTkbwPgM8t-bXKPmWDBRZv9cbzLIiEDE5EnGk2I,17
-python_json_logger-3.1.0.dist-info/RECORD,,