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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-json-logger
-Version: 3.2.1.dev1
+Version: 4.0.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"
@@ -46,9 +45,11 @@ 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/)
 [![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-4.0.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-4.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-json-logger"
-version = "3.2.1.dev1"
+version = "4.0.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-4.0.0/src/python_json_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-json-logger
-Version: 3.2.1.dev1
+Version: 4.0.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"
@@ -46,9 +45,11 @@ 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/)
 [![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-4.0.0}/src/python_json_logger.egg-info/SOURCES.txt

@@ -20,5 +20,6 @@ src/pythonjsonlogger/py.typed
 src/pythonjsonlogger/utils.py
 tests/__init__.py
 tests/test_deprecation.py
+tests/test_dictconfig.py
 tests/test_formatters.py
 tests/test_missing.py

{python_json_logger-3.2.1.dev1 → python_json_logger-4.0.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-4.0.0}/src/pythonjsonlogger/core.py

@@ -7,11 +7,10 @@ from __future__ import annotations
 
 ## Standard Library
 from datetime import datetime, timezone
-import importlib
 import logging
 import re
 import sys
-from typing import Optional, Union, Callable, List, Dict, Container, Any, Sequence
+from typing import Optional, Union, List, Dict, Container, Any, Sequence
 
 if sys.version_info >= (3, 10):
     from typing import TypeAlias
@@ -72,31 +71,15 @@ STYLE_PERCENT_REGEX = re.compile(r"%\((.+?)\)", re.IGNORECASE)  # % style
 
 ## Type Aliases
 ## -----------------------------------------------------------------------------
-OptionalCallableOrStr: TypeAlias = Optional[Union[Callable, str]]
-"""Type alias"""
+LogData: TypeAlias = Dict[str, Any]
+"""Type alias
 
-LogRecord: TypeAlias = Dict[str, Any]
-"""Type alias"""
+*Changed in 4.0*: renamed from `LogRecord` to `LogData`
+"""
 
 
 ### FUNCTIONS
 ### ============================================================================
-def str_to_object(obj: Any) -> Any:
-    """Import strings to an object, leaving non-strings as-is.
-
-    Args:
-        obj: the object or string to process
-
-    *New in 3.1*
-    """
-
-    if not isinstance(obj, str):
-        return obj
-
-    module_name, attribute_name = obj.rsplit(".", 1)
-    return getattr(importlib.import_module(module_name), attribute_name)
-
-
 def merge_record_extra(
     record: logging.LogRecord,
     target: Dict,
@@ -134,6 +117,8 @@ class BaseJsonFormatter(logging.Formatter):
     *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]
@@ -143,7 +128,7 @@ class BaseJsonFormatter(logging.Formatter):
     # pylint: disable=too-many-arguments,super-init-not-called
     def __init__(
         self,
-        fmt: Optional[str] = None,
+        fmt: Optional[Union[str, Sequence[str]]] = None,
         datefmt: Optional[str] = None,
         style: str = "%",
         validate: bool = True,
@@ -155,14 +140,16 @@ 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:
-            fmt: string representing fields to log
+            fmt: String format or `Sequence` of field names of fields to log.
             datefmt: format to use when formatting `asctime` field
-            style: how to extract log fields from `fmt`
+            style: how to extract log fields from `fmt`. Ignored if `fmt` is a `Sequence[str]`.
             validate: validate `fmt` against style, if implementing a custom `style` you
-                must set this to `False`.
+                must set this to `False`. Ignored if `fmt` is a `Sequence[str]`.
             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
@@ -177,6 +164,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*:
 
@@ -186,39 +175,66 @@ class BaseJsonFormatter(logging.Formatter):
         - Renaming fields now preserves the order that fields were added in and avoids adding
           missing fields. The original behaviour, missing fields have a value of `None`, is still
           available by setting `rename_fields_keep_missing` to `True`.
+
+        *Added in 4.0*:
+
+        - `fmt` now supports comma seperated 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 3.8, defaults added in 3.10
-        if style in logging._STYLES:
-            _style = logging._STYLES[style][0](fmt)  # type: ignore[operator]
-            if validate:
-                _style.validate()
-            self._style = _style
-            self._fmt = _style._fmt
-
-        elif not validate:
-            self._style = style
-            self._fmt = fmt
-
-        else:
-            raise ValueError(f"Style must be one of: {','.join(logging._STYLES.keys())}")
+        # 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]
+                if validate:
+                    _style.validate()
+                self._style = _style
+                self._fmt = _style._fmt
+
+            elif style == "," or not validate:
+                self._style = style
+                self._fmt = fmt
+                # TODO: Validate comma format
+
+            else:
+                raise ValueError("Style must be one of: '%{$,'")
+
+            self._required_fields = self.parse()
+
+        # Note: we do this check second as string is still a Sequence[str]
+        elif isinstance(fmt, Sequence):
+            self._style = "__sequence__"
+            self._fmt = str(fmt)
+            self._required_fields = list(fmt)
 
         self.datefmt = datefmt
 
         ## JSON Logging specific
         ## ---------------------------------------------------------------------
         self.prefix = prefix
-        self.rename_fields = rename_fields if rename_fields is not None else {}
+
+        # We recreate the dict in rename_fields and static_fields to support internal/external
+        # references which require getting the item to do the conversion.
+        # 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 {}
+        )
+        self.static_fields = (
+            {key: static_fields[key] for key in static_fields} if static_fields is not None else {}
+        )
+
         self.rename_fields_keep_missing = rename_fields_keep_missing
-        self.static_fields = static_fields if static_fields is not None else {}
         self.reserved_attrs = set(reserved_attrs if reserved_attrs is not None else RESERVED_ATTRS)
         self.timestamp = timestamp
 
-        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 {}
+        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:
@@ -252,11 +268,11 @@ class BaseJsonFormatter(logging.Formatter):
         if record.stack_info and not message_dict.get("stack_info"):
             message_dict["stack_info"] = self.formatStack(record.stack_info)
 
-        log_record: LogRecord = {}
-        self.add_fields(log_record, record, message_dict)
-        log_record = self.process_log_record(log_record)
+        log_data: LogData = {}
+        self.add_fields(log_data, record, message_dict)
+        log_data = self.process_log_record(log_data)
 
-        return self.serialize_log_record(log_record)
+        return self.serialize_log_record(log_data)
 
     ## JSON Formatter Specific Methods
     ## -------------------------------------------------------------------------
@@ -271,6 +287,18 @@ class BaseJsonFormatter(logging.Formatter):
         Returns:
             list of fields to be extracted and serialized
         """
+        if self._fmt is None:
+            return []
+
+        if isinstance(self._style, str):
+            if self._style == "__sequence__":
+                raise RuntimeError("Must not call parse when fmt is a sequence of strings")
+
+            if self._style == ",":
+                return [field.strip() for field in self._fmt.split(",") if field.strip()]
+
+            raise ValueError(f"Style {self._style!r} is not supported")
+
         if isinstance(self._style, logging.StringTemplateStyle):
             formatter_style_pattern = STYLE_STRING_TEMPLATE_REGEX
 
@@ -285,22 +313,21 @@ class BaseJsonFormatter(logging.Formatter):
         else:
             raise ValueError(f"Style {self._style!r} is not supported")
 
-        if self._fmt:
-            return formatter_style_pattern.findall(self._fmt)
-
-        return []
+        return formatter_style_pattern.findall(self._fmt)
 
-    def serialize_log_record(self, log_record: LogRecord) -> str:
-        """Returns the final representation of the log record.
+    def serialize_log_record(self, log_data: LogData) -> str:
+        """Returns the final representation of the data to be logged
 
         Args:
-            log_record: the log record
+            log_data: the data
+
+        *Changed in 4.0*: `log_record` renamed to `log_data`
         """
-        return self.prefix + self.jsonify_log_record(log_record)
+        return self.prefix + self.jsonify_log_record(log_data)
 
     def add_fields(
         self,
-        log_record: Dict[str, Any],
+        log_data: Dict[str, Any],
         record: logging.LogRecord,
         message_dict: Dict[str, Any],
     ) -> None:
@@ -309,38 +336,40 @@ class BaseJsonFormatter(logging.Formatter):
         This method can be overridden to implement custom logic for adding fields.
 
         Args:
-            log_record: data that will be logged
+            log_data: data that will be logged
             record: the record to extract data from
             message_dict: dictionary that was logged instead of a message. e.g
                 `logger.info({"is_this_message_dict": True})`
+
+        *Changed in 4.0*: `log_record` renamed to `log_data`
         """
         for field in self.defaults:
-            log_record[self._get_rename(field)] = self.defaults[field]
+            log_data[self._get_rename(field)] = self.defaults[field]
 
         for field in self._required_fields:
-            log_record[self._get_rename(field)] = record.__dict__.get(field)
+            log_data[self._get_rename(field)] = record.__dict__.get(field)
 
         for data_dict in [self.static_fields, message_dict]:
             for key, value in data_dict.items():
-                log_record[self._get_rename(key)] = value
+                log_data[self._get_rename(key)] = value
 
         merge_record_extra(
             record,
-            log_record,
+            log_data,
             reserved=self._skip_fields,
             rename_fields=self.rename_fields,
         )
 
         if self.timestamp:
             key = self.timestamp if isinstance(self.timestamp, str) else "timestamp"
-            log_record[self._get_rename(key)] = datetime.fromtimestamp(
+            log_data[self._get_rename(key)] = datetime.fromtimestamp(
                 record.created, tz=timezone.utc
             )
 
         if self.rename_fields_keep_missing:
             for field in self.rename_fields.values():
-                if field not in log_record:
-                    log_record[field] = None
+                if field not in log_data:
+                    log_data[field] = None
         return
 
     def _get_rename(self, key: str) -> str:
@@ -348,23 +377,43 @@ class BaseJsonFormatter(logging.Formatter):
 
     # Child Methods
     # ..........................................................................
-    def jsonify_log_record(self, log_record: LogRecord) -> str:
-        """Convert this log record into a JSON string.
+    def jsonify_log_record(self, log_data: LogData) -> str:
+        """Convert the log data into a JSON string.
 
         Child classes MUST override this method.
 
         Args:
-            log_record: the data to serialize
+            log_data: the data to serialize
+
+        *Changed in 4.0*: `log_record` renamed to `log_data`
         """
         raise NotImplementedError()
 
-    def process_log_record(self, log_record: LogRecord) -> LogRecord:
-        """Custom processing of the log record.
+    def process_log_record(self, log_data: LogData) -> LogData:
+        """Custom processing of the data to be logged.
 
         Child classes can override this method to alter the log record before it
         is serialized.
 
         Args:
-            log_record: incoming data
+            log_data: incoming data
+
+        *Changed in 4.0*: `log_record` renamed to `log_data`
+        """
+        return log_data
+
+    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.
         """
-        return log_record
+        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-4.0.0}/src/pythonjsonlogger/json.py

@@ -67,9 +67,9 @@ class JsonFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: core.OptionalCallableOrStr = None,
-        json_encoder: core.OptionalCallableOrStr = None,
-        json_serializer: Union[Callable, str] = json.dumps,
+        json_default: Optional[Callable] = None,
+        json_encoder: Optional[Callable] = None,
+        json_serializer: Callable = json.dumps,
         json_indent: Optional[Union[int, str]] = None,
         json_ensure_ascii: bool = True,
         **kwargs,
@@ -87,19 +87,19 @@ class JsonFormatter(core.BaseJsonFormatter):
         """
         super().__init__(*args, **kwargs)
 
-        self.json_default = core.str_to_object(json_default)
-        self.json_encoder = core.str_to_object(json_encoder)
-        self.json_serializer = core.str_to_object(json_serializer)
+        self.json_default = json_default
+        self.json_encoder = json_encoder
+        self.json_serializer = json_serializer
         self.json_indent = json_indent
         self.json_ensure_ascii = json_ensure_ascii
         if not self.json_encoder and not self.json_default:
             self.json_encoder = JsonEncoder
         return
 
-    def jsonify_log_record(self, log_record: core.LogRecord) -> str:
-        """Returns a json string of the log record."""
+    def jsonify_log_record(self, log_data: core.LogData) -> str:
+        """Returns a json string of the log data."""
         return self.json_serializer(
-            log_record,
+            log_data,
             default=self.json_default,
             cls=self.json_encoder,
             indent=self.json_indent,

{python_json_logger-3.2.1.dev1 → python_json_logger-4.0.0}/src/pythonjsonlogger/msgspec.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 ## Standard Library
-from typing import Any
+from typing import Any, Optional, Callable
 
 ## Installed
 
@@ -43,7 +43,7 @@ class MsgspecFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: core.OptionalCallableOrStr = msgspec_default,
+        json_default: Optional[Callable] = msgspec_default,
         **kwargs,
     ) -> None:
         """
@@ -54,10 +54,10 @@ class MsgspecFormatter(core.BaseJsonFormatter):
         """
         super().__init__(*args, **kwargs)
 
-        self.json_default = core.str_to_object(json_default)
+        self.json_default = json_default
         self._encoder = msgspec.json.Encoder(enc_hook=self.json_default)
         return
 
-    def jsonify_log_record(self, log_record: core.LogRecord) -> str:
-        """Returns a json string of the log record."""
-        return self._encoder.encode(log_record).decode("utf8")
+    def jsonify_log_record(self, log_data: core.LogData) -> str:
+        """Returns a json string of the log data."""
+        return self._encoder.encode(log_data).decode("utf8")

{python_json_logger-3.2.1.dev1 → python_json_logger-4.0.0}/src/pythonjsonlogger/orjson.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 ## Standard Library
-from typing import Any
+from typing import Any, Optional, Callable
 
 ## Installed
 
@@ -45,7 +45,7 @@ class OrjsonFormatter(core.BaseJsonFormatter):
     def __init__(
         self,
         *args,
-        json_default: core.OptionalCallableOrStr = orjson_default,
+        json_default: Optional[Callable] = orjson_default,
         json_indent: bool = False,
         **kwargs,
     ) -> None:
@@ -58,14 +58,14 @@ class OrjsonFormatter(core.BaseJsonFormatter):
         """
         super().__init__(*args, **kwargs)
 
-        self.json_default = core.str_to_object(json_default)
+        self.json_default = json_default
         self.json_indent = json_indent
         return
 
-    def jsonify_log_record(self, log_record: core.LogRecord) -> str:
-        """Returns a json string of the log record."""
+    def jsonify_log_record(self, log_data: core.LogData) -> str:
+        """Returns a json string of the log data."""
         opt = orjson.OPT_NON_STR_KEYS
         if self.json_indent:
             opt |= orjson.OPT_INDENT_2
 
-        return orjson.dumps(log_record, default=self.json_default, option=opt).decode("utf8")
+        return orjson.dumps(log_data, default=self.json_default, option=opt).decode("utf8")

{python_json_logger-3.2.1.dev1 → python_json_logger-4.0.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-4.0.0/tests/test_dictconfig.py

@@ -0,0 +1,96 @@
+### IMPORTS
+### ============================================================================
+## Future
+from __future__ import annotations
+
+## Standard Library
+from dataclasses import dataclass
+import io
+import json
+import logging
+import logging.config
+from typing import Any, Generator
+
+## Installed
+import pytest
+
+### SETUP
+### ============================================================================
+_LOGGER_COUNT = 0
+EXT_VAL = 999
+
+
+class Dummy:
+    pass
+
+
+def my_json_default(obj: Any) -> Any:
+    if isinstance(obj, Dummy):
+        return "DUMMY"
+    return obj
+
+
+LOGGING_CONFIG = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "default": {
+            "()": "pythonjsonlogger.json.JsonFormatter",
+            "json_default": "ext://tests.test_dictconfig.my_json_default",
+            "static_fields": {"ext-val": "ext://tests.test_dictconfig.EXT_VAL"},
+        }
+    },
+    "handlers": {
+        "default": {
+            "level": "DEBUG",
+            "formatter": "default",
+            "class": "logging.StreamHandler",
+            "stream": "ext://sys.stdout",  # Default is stderr
+        },
+    },
+    "loggers": {
+        "": {"handlers": ["default"], "level": "WARNING", "propagate": False},  # root logger
+    },
+}
+
+
+@dataclass
+class LoggingEnvironment:
+    logger: logging.Logger
+    buffer: io.StringIO
+
+    def load_json(self) -> Any:
+        return json.loads(self.buffer.getvalue())
+
+
+@pytest.fixture
+def env() -> Generator[LoggingEnvironment, None, None]:
+    global _LOGGER_COUNT  # pylint: disable=global-statement
+    _LOGGER_COUNT += 1
+    logging.config.dictConfig(LOGGING_CONFIG)
+    default_formatter = logging.root.handlers[0].formatter
+    logger = logging.getLogger(f"pythonjsonlogger.tests.{_LOGGER_COUNT}")
+    logger.setLevel(logging.DEBUG)
+    buffer = io.StringIO()
+    handler = logging.StreamHandler(buffer)
+    handler.setFormatter(default_formatter)
+    logger.addHandler(handler)
+    yield LoggingEnvironment(logger=logger, buffer=buffer)
+    logger.removeHandler(handler)
+    logger.setLevel(logging.NOTSET)
+    buffer.close()
+    return
+
+
+### TESTS
+### ============================================================================
+def test_external_reference_support(env: LoggingEnvironment):
+
+    assert logging.root.handlers[0].formatter.json_default is my_json_default  # type: ignore[union-attr]
+
+    env.logger.info("hello", extra={"dummy": Dummy()})
+    log_json = env.load_json()
+
+    assert log_json["ext-val"] == EXT_VAL
+    assert log_json["dummy"] == "DUMMY"
+    return

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

@@ -158,12 +158,48 @@ def test_default_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
 def test_percentage_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
-    env.set_formatter(
-        class_(
-            # All kind of different styles to check the regex
-            "[%(levelname)8s] %(message)s %(filename)s:%(lineno)d %(asctime)"
-        )
-    )
+    # Note: We use different %s styles in the format to check the regex correctly collects them
+    env.set_formatter(class_("[%(levelname)8s] %(message)s %(filename)s:%(lineno)d %(asctime)"))
+
+    msg = "testing logging format"
+    env.logger.info(msg)
+    log_json = env.load_json()
+
+    assert log_json["message"] == msg
+    assert log_json.keys() == {"levelname", "message", "filename", "lineno", "asctime"}
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_comma_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    # Note: we have double comma `,,` to test handling "empty" names
+    env.set_formatter(class_("levelname,,message,filename,lineno,asctime,", style=","))
+
+    msg = "testing logging format"
+    env.logger.info(msg)
+    log_json = env.load_json()
+
+    assert log_json["message"] == msg
+    assert log_json.keys() == {"levelname", "message", "filename", "lineno", "asctime"}
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_sequence_list_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(["levelname", "message", "filename", "lineno", "asctime"]))
+
+    msg = "testing logging format"
+    env.logger.info(msg)
+    log_json = env.load_json()
+
+    assert log_json["message"] == msg
+    assert log_json.keys() == {"levelname", "message", "filename", "lineno", "asctime"}
+    return
+
+
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_sequence_tuple_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(("levelname", "message", "filename", "lineno", "asctime")))
 
     msg = "testing logging format"
     env.logger.info(msg)
@@ -380,9 +416,9 @@ def test_log_extra(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
 def test_custom_logic_adds_field(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     class CustomJsonFormatter(class_):  # type: ignore[valid-type,misc]
 
-        def process_log_record(self, log_record):
-            log_record["custom"] = "value"
-            return super().process_log_record(log_record)
+        def process_log_record(self, log_data):
+            log_data["custom"] = "value"
+            return super().process_log_record(log_data)
 
     env.set_formatter(CustomJsonFormatter())
     env.logger.info("message")
@@ -568,8 +604,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 +658,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):