python-json-logger 3.2.1.dev1__tar.gz → 3.3.0__tar.gz

{python_json_logger-3.2.1.dev1/src/python_json_logger.egg-info → python_json_logger-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-json-logger
-Version: 3.2.1.dev1
+Version: 3.3.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>
@@ -27,8 +27,7 @@ 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 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: msgspec; implementation_name != "pypy" and extra == "dev"
 Requires-Dist: validate-pyproject[all]; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
@@ -49,6 +48,7 @@ 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/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/python-json-logger)](https://pypi.python.org/pypi/python-json-logger/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 [![License](https://img.shields.io/github/license/nhairs/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 ![Build Status](https://github.com/nhairs/python-json-logger/actions/workflows/test-suite.yml/badge.svg)

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/README.md

@@ -1,5 +1,6 @@
 [![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/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/python-json-logger)](https://pypi.python.org/pypi/python-json-logger/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 [![License](https://img.shields.io/github/license/nhairs/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 ![Build Status](https://github.com/nhairs/python-json-logger/actions/workflows/test-suite.yml/badge.svg)

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-json-logger"
-version = "3.2.1.dev1"
+version = "3.3.0"
 description = "JSON Log Formatter for the Python Logging Package"
 authors = [
     {name = "Zakaria Zajac", email = "zak@madzak.com"},
@@ -47,8 +47,7 @@ GitHub = "https://github.com/nhairs/python-json-logger"
 dev = [
     ## Optional but required for dev
     "orjson;implementation_name!='pypy'",
-    "msgspec;implementation_name!='pypy' and python_version<'3.13'",
-    "msgspec-python313-pre;implementation_name!='pypy' and python_version=='3.13'",
+    "msgspec;implementation_name!='pypy'",
     ## Lint
     "validate-pyproject[all]",
     "black",

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0/src/python_json_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-json-logger
-Version: 3.2.1.dev1
+Version: 3.3.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>
@@ -27,8 +27,7 @@ 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 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: msgspec; implementation_name != "pypy" and extra == "dev"
 Requires-Dist: validate-pyproject[all]; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
@@ -49,6 +48,7 @@ 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/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/python-json-logger)](https://pypi.python.org/pypi/python-json-logger/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 [![License](https://img.shields.io/github/license/nhairs/python-json-logger.svg)](https://github.com/nhairs/python-json-logger)
 ![Build Status](https://github.com/nhairs/python-json-logger/actions/workflows/test-suite.yml/badge.svg)

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/src/python_json_logger.egg-info/requires.txt

@@ -22,12 +22,7 @@ mike
 
 [dev:implementation_name != "pypy"]
 orjson
-
-[dev:implementation_name != "pypy" and python_version < "3.13"]
 msgspec
 
-[dev:implementation_name != "pypy" and python_version == "3.13"]
-msgspec-python313-pre
-
 [dev:python_version < "3.9"]
 backports.zoneinfo

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/src/pythonjsonlogger/core.py

@@ -134,6 +134,8 @@ class BaseJsonFormatter(logging.Formatter):
     *New in 3.1*
 
     *Changed in 3.2*: `defaults` argument is no longer ignored.
+
+    *Added in UNRELEASED*: `exc_info_as_array` and `stack_info_as_array` options are added.
     """
 
     _style: Union[logging.PercentStyle, str]  # type: ignore[assignment]
@@ -155,6 +157,8 @@ class BaseJsonFormatter(logging.Formatter):
         reserved_attrs: Optional[Sequence[str]] = None,
         timestamp: Union[bool, str] = False,
         defaults: Optional[Dict[str, Any]] = None,
+        exc_info_as_array: bool = False,
+        stack_info_as_array: bool = False,
     ) -> None:
         """
         Args:
@@ -177,6 +181,8 @@ class BaseJsonFormatter(logging.Formatter):
                 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.
+            stack_info_as_array: break the stack_info into a list of lines based on line breaks.
 
         *Changed in 3.1*:
 
@@ -219,6 +225,8 @@ class BaseJsonFormatter(logging.Formatter):
         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 format(self, record: logging.LogRecord) -> str:
@@ -368,3 +376,19 @@ class BaseJsonFormatter(logging.Formatter):
             log_record: incoming data
         """
         return log_record
+
+    def formatException(self, ei) -> Union[str, list[str]]:  # type: ignore
+        """Format and return the specified exception information.
+
+        If exc_info_as_array is set to True, This method returns an array of strings.
+        """
+        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
+        """Format and return the specified stack information.
+
+        If stack_info_as_array is set to True, This method returns an array of strings.
+        """
+        stack_info_str = super().formatStack(stack_info)
+        return stack_info_str.splitlines() if self.stack_info_as_array else stack_info_str

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/tests/test_deprecation.py

@@ -4,6 +4,8 @@
 from __future__ import annotations
 
 ## Standard Library
+import subprocess
+import sys
 
 ## Installed
 import pytest
@@ -26,3 +28,18 @@ def test_jsonlogger_reserved_attrs_deprecated():
         # a DeprecationWarning and we specifically want the one for RESERVED_ATTRS
         pythonjsonlogger.json.RESERVED_ATTRS
     return
+
+
+@pytest.mark.parametrize(
+    "command",
+    [
+        "from pythonjsonlogger import jsonlogger",
+        "import pythonjsonlogger.jsonlogger",
+        "from pythonjsonlogger.jsonlogger import JsonFormatter",
+        "from pythonjsonlogger.jsonlogger import RESERVED_ATTRS",
+    ],
+)
+def test_import(command: str):
+    output = subprocess.check_output([sys.executable, "-c", f"{command};print('OK')"])
+    assert output.strip() == b"OK"
+    return

{python_json_logger-3.2.1.dev1 → python_json_logger-3.3.0}/tests/test_formatters.py

@@ -568,8 +568,14 @@ def test_common_types_encoded(
     if pythonjsonlogger.MSGSPEC_AVAILABLE and class_ is MsgspecFormatter:
         # Dataclass: https://github.com/jcrist/msgspec/issues/681
         # Enum: https://github.com/jcrist/msgspec/issues/680
-        if obj is SomeDataclass or (
-            isinstance(obj, enum.Enum) and obj in {MultiEnum.BYTES, MultiEnum.NONE, MultiEnum.BOOL}
+        # These have been fixed in msgspec 0.19.0, however they also dropped python 3.8 support.
+        # https://github.com/jcrist/msgspec/releases/tag/0.19.0
+        if sys.version_info < (3, 9) and (
+            obj is SomeDataclass
+            or (
+                isinstance(obj, enum.Enum)
+                and obj in {MultiEnum.BYTES, MultiEnum.NONE, MultiEnum.BOOL}
+            )
         ):
             pytest.xfail()
 
@@ -616,6 +622,55 @@ def test_custom_default(env: LoggingEnvironment, class_: type[BaseJsonFormatter]
     return
 
 
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exc_info_as_array(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(exc_info_as_array=True))
+
+    try:
+        raise Exception("Error")
+    except BaseException:
+        env.logger.exception("Error occurs")
+    log_json = env.load_json()
+
+    assert isinstance(log_json["exc_info"], list)
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exc_info_as_array_no_exc_info(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(exc_info_as_array=True))
+
+    env.logger.info("hello")
+    log_json = env.load_json()
+
+    assert "exc_info" not in log_json
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_stack_info_as_array(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(stack_info_as_array=True))
+
+    env.logger.info("hello", stack_info=True)
+    log_json = env.load_json()
+
+    assert isinstance(log_json["stack_info"], list)
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_stack_info_as_array_no_stack_info(
+    env: LoggingEnvironment, class_: type[BaseJsonFormatter]
+):
+    env.set_formatter(class_(stack_info_as_array=True))
+
+    env.logger.info("hello", stack_info=False)
+    log_json = env.load_json()
+
+    assert "stack_info" not in log_json
+    return
+
+
 ## JsonFormatter Specific
 ## -----------------------------------------------------------------------------
 def test_json_ensure_ascii_true(env: LoggingEnvironment):