python-json-logger 4.1.0__tar.gz → 4.2.0__tar.gz

{python_json_logger-4.1.0/src/python_json_logger.egg-info → python_json_logger-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-json-logger
-Version: 4.1.0
+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>
@@ -21,25 +21,6 @@ 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 → python_json_logger-4.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-json-logger"
-version = "4.1.0"
+version = "4.2.0"
 description = "JSON Log Formatter for the Python Logging Package"
 authors = [
     {name = "Zakaria Zajac", email = "zak@madzak.com"},
@@ -39,7 +39,7 @@ classifiers = [
 Homepage = "https://nhairs.github.io/python-json-logger"
 GitHub = "https://github.com/nhairs/python-json-logger"
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
     ## Optional but required for dev
     "orjson;implementation_name!='pypy'",
@@ -48,7 +48,8 @@ dev = [
     "validate-pyproject[all]",
     "black",
     "pylint",
-    "mypy",
+    "mypy<2; implementation_name == 'pypy' and python_version < '3.11'",
+    "mypy; implementation_name != 'pypy' or python_version >= '3.11'",
     ## Test
     "pytest",
     "freezegun",

{python_json_logger-4.1.0 → python_json_logger-4.2.0/src/python_json_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-json-logger
-Version: 4.1.0
+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>
@@ -21,25 +21,6 @@ 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 → python_json_logger-4.2.0}/src/python_json_logger.egg-info/SOURCES.txt

@@ -6,7 +6,6 @@ pyproject.toml
 src/python_json_logger.egg-info/PKG-INFO
 src/python_json_logger.egg-info/SOURCES.txt
 src/python_json_logger.egg-info/dependency_links.txt
-src/python_json_logger.egg-info/requires.txt
 src/python_json_logger.egg-info/top_level.txt
 src/pythonjsonlogger/__init__.py
 src/pythonjsonlogger/core.py

{python_json_logger-4.1.0 → python_json_logger-4.2.0}/src/pythonjsonlogger/core.py

@@ -61,7 +61,9 @@ 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
 
@@ -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]
@@ -172,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]
@@ -236,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] = {}
         # 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()
@@ -296,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

{python_json_logger-4.1.0 → python_json_logger-4.2.0}/tests/test_formatters.py

@@ -167,6 +167,22 @@ def test_percentage_format(env: LoggingEnvironment, class_: type[BaseJsonFormatt
     return
 
 
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_string_template_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    # Note: string templates support both $name and ${name}, and $$ is an escaped literal $
+    env.set_formatter(
+        class_("$$literal $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_comma_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     # Note: we have double comma `,,` to test handling "empty" names
@@ -393,6 +409,23 @@ def test_log_dict_defaults(env: LoggingEnvironment, class_: type[BaseJsonFormatt
     return
 
 
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_log_dict_not_modified(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_())
+
+    msg = {"text": "testing logging", "nested": {"more": "data"}}
+    try:
+        raise ValueError("test")
+    except ValueError:
+        env.logger.exception(msg, stack_info=True)
+    log_json = env.load_json()
+
+    assert log_json["exc_info"]
+    assert log_json["stack_info"]
+    assert msg == {"text": "testing logging", "nested": {"more": "data"}}
+    return
+
+
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
 def test_log_extra(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_())
@@ -681,6 +714,148 @@ def test_exc_info_as_array_no_exc_info(env: LoggingEnvironment, class_: type[Bas
     return
 
 
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception notes require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_notes(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_())
+
+    try:
+        err = ValueError("my error")
+        err.add_note("this is a note")
+        raise err
+    except ValueError:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert "ValueError: my error" in log_json["exc_info"]
+    assert "this is a note" in log_json["exc_info"]
+    return
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception notes require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_notes_as_array(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(exc_info_as_array=True))
+
+    try:
+        err = ValueError("my error")
+        err.add_note("this is a note")
+        raise err
+    except ValueError:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert isinstance(log_json["exc_info"], list)
+    full_traceback = "\n".join(log_json["exc_info"])
+    assert "ValueError: my error" in full_traceback
+    assert "this is a note" in full_traceback
+    return
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception groups require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_groups(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_())
+
+    try:
+        raise ExceptionGroup("my group", [ValueError("err 1"), TypeError("err 2")])
+    except ExceptionGroup:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert "ExceptionGroup: my group" in log_json["exc_info"]
+    assert "ValueError: err 1" in log_json["exc_info"]
+    assert "TypeError: err 2" in log_json["exc_info"]
+    return
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception groups require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_groups_as_array(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_(exc_info_as_array=True))
+
+    try:
+        raise ExceptionGroup("my group", [ValueError("err 1"), TypeError("err 2")])
+    except ExceptionGroup:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert isinstance(log_json["exc_info"], list)
+    full_traceback = "\n".join(log_json["exc_info"])
+    assert "ExceptionGroup: my group" in full_traceback
+    assert "ValueError: err 1" in full_traceback
+    assert "TypeError: err 2" in full_traceback
+    return
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception groups and notes require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_groups_with_notes(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
+    env.set_formatter(class_())
+
+    try:
+        err1 = ValueError("err 1")
+        err1.add_note("note 1")
+        err2 = TypeError("err 2")
+        err2.add_note("note 2")
+        eg = ExceptionGroup("my group", [err1, err2])
+        eg.add_note("group note")
+        raise eg
+    except ExceptionGroup:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert "ExceptionGroup: my group" in log_json["exc_info"]
+    assert "group note" in log_json["exc_info"]
+    assert "ValueError: err 1" in log_json["exc_info"]
+    assert "note 1" in log_json["exc_info"]
+    assert "TypeError: err 2" in log_json["exc_info"]
+    assert "note 2" in log_json["exc_info"]
+    return
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 11), reason="Exception groups and notes require Python 3.11 or higher"
+)
+@pytest.mark.parametrize("class_", ALL_FORMATTERS)
+def test_exception_groups_with_notes_as_array(
+    env: LoggingEnvironment, class_: type[BaseJsonFormatter]
+):
+    env.set_formatter(class_(exc_info_as_array=True))
+
+    try:
+        err1 = ValueError("err 1")
+        err1.add_note("note 1")
+        err2 = TypeError("err 2")
+        err2.add_note("note 2")
+        eg = ExceptionGroup("my group", [err1, err2])
+        eg.add_note("group note")
+        raise eg
+    except ExceptionGroup:
+        env.logger.exception("oops")
+
+    log_json = env.load_json()
+    assert isinstance(log_json["exc_info"], list)
+    full_traceback = "\n".join(log_json["exc_info"])
+    assert "ExceptionGroup: my group" in full_traceback
+    assert "group note" in full_traceback
+    assert "ValueError: err 1" in full_traceback
+    assert "note 1" in full_traceback
+    assert "TypeError: err 2" in full_traceback
+    assert "note 2" in full_traceback
+    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))

python_json_logger-4.1.0/src/python_json_logger.egg-info/requires.txt

@@ -1,22 +0,0 @@
-
-[dev]
-validate-pyproject[all]
-black
-pylint
-mypy
-pytest
-freezegun
-tzdata
-build
-mkdocs
-mkdocs-material>=8.5
-mkdocs-awesome-pages-plugin
-mdx_truly_sane_lists
-mkdocstrings[python]
-mkdocs-gen-files
-mkdocs-literate-nav
-mike
-
-[dev:implementation_name != "pypy"]
-orjson
-msgspec