Merge pull request #8 from Colin-b/develop

Release 0.2.1

Author: Colin-b

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 21.11b1
+    rev: 21.12b0
     hooks:
       - id: black

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2022-01-26
+### Fixed
+- `datetime`, `time` and `date` instances are now represented following [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format instead of raising a `TypeError`.
+- Default to the `str` representation of value instead of raising a `TypeError` for non-standard python types.
+
 ## [0.2.0] - 2021-11-24
 ### Added
 - Added `message_field_name` parameter.
@@ -18,7 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Public release.
 
-[Unreleased]: https://github.com/Colin-b/healthpy/compare/v0.2.0...HEAD
-[0.2.0]: https://github.com/Colin-b/healthpy/compare/v0.1.0...v0.2.0
-[0.1.0]: https://github.com/Colin-b/healthpy/compare/v0.0.1...v0.1.0
-[0.0.1]: https://github.com/Colin-b/healthpy/releases/tag/v0.0.1
+[Unreleased]: https://github.com/Colin-b/logging_json/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/Colin-b/logging_json/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/Colin-b/logging_json/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/Colin-b/logging_json/compare/v0.0.1...v0.1.0
+[0.0.1]: https://github.com/Colin-b/logging_json/releases/tag/v0.0.1

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Colin Bounouar
+Copyright (c) 2022 Colin Bounouar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,7 +5,7 @@
 <a href="https://github.com/Colin-b/logging_json/actions"><img alt="Build status" src="https://github.com/Colin-b/logging_json/workflows/Release/badge.svg"></a>
 <a href="https://github.com/Colin-b/logging_json/actions"><img alt="Coverage" src="https://img.shields.io/badge/coverage-100%25-brightgreen"></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-<a href="https://github.com/Colin-b/logging_json/actions"><img alt="Number of tests" src="https://img.shields.io/badge/tests-17 passed-blue"></a>
+<a href="https://github.com/Colin-b/logging_json/actions"><img alt="Number of tests" src="https://img.shields.io/badge/tests-18 passed-blue"></a>
 <a href="https://pypi.org/project/logging_json/"><img alt="Number of downloads" src="https://img.shields.io/pypi/dm/logging_json"></a>
 </p>
 
@@ -35,7 +35,7 @@ It must be a dictionary where keys are the keys to be appended to the resulting
 
 If an exception is logged, the `exception` key will be appended to the resulting JSON dictionary.
 
-This dictionary will contains 3 keys:
+This dictionary will contain 3 keys:
 * `type`: The name of the exception class (useful when the message is blank).
 * `message`: The str representation of the exception (usually the provided error message).
 * `stack`: The stack trace, formatted as a string.

logging_json/_formatter.py

@@ -1,4 +1,5 @@
 import collections
+import datetime
 import json
 import logging
 from typing import Any, Dict
@@ -48,6 +49,12 @@ def _value(record: logging.LogRecord, field_name_or_value: Any) -> Any:
         return field_name_or_value
 
 
+def default_converter(obj: Any) -> str:
+    if isinstance(obj, datetime.datetime):
+        return obj.isoformat()
+    return str(obj)
+
+
 class JSONFormatter(logging.Formatter):
     def __init__(
         self,
@@ -84,11 +91,10 @@ def format(self, record: logging.LogRecord):
                 "stack": self.formatException(record.exc_info),
             }
 
-        return (
-            super().formatMessage(record)
-            if (len(message) == 1 and self.message_field_name in message)
-            else json.dumps(message)
-        )
+        if len(message) == 1 and self.message_field_name in message:
+            return super().formatMessage(record)
+
+        return json.dumps(message, default=default_converter)
 
     def formatMessage(self, record: logging.LogRecord) -> str:
         # Speed up this step by doing nothing

logging_json/version.py

@@ -3,4 +3,4 @@
 # Major should be incremented in case there is a breaking change. (eg: 2.5.8 -> 3.0.0)
 # Minor should be incremented in case there is an enhancement. (eg: 2.5.8 -> 2.6.0)
 # Patch should be incremented in case there is a bug fix. (eg: 2.5.8 -> 2.5.9)
-__version__ = "0.2.0"
+__version__ = "0.2.1"

tests/test_formatter.py

@@ -1,6 +1,7 @@
 import logging
 import json
 import time
+import datetime
 
 import logging_json
 
@@ -197,21 +198,43 @@ def test_documented_record_attributes(caplog, monkeypatch):
 def test_with_extra_in_fields_and_message(caplog):
     caplog.set_level("INFO")
     logging.info("message 1", extra={"key1": "value 1"})
-    assert (
-        dict_fmt(
-            caplog,
-            fields={
-                "extra": "key1",
-                "key2": "value 2",
-            },
-        )
-        == {
-            "extra": "value 1",
-            "key1": "value 1",
-            "key2": "value 2",
-            "msg": "message 1",
+    assert dict_fmt(caplog, fields={"extra": "key1", "key2": "value 2",},) == {
+        "extra": "value 1",
+        "key1": "value 1",
+        "key2": "value 2",
+        "msg": "message 1",
+    }
+
+
+def test_json_dumps_error(caplog):
+    class CustomWithoutStr:
+        pass
+
+    custom = CustomWithoutStr()
+
+    class CustomWithStr:
+        def __str__(self):
+            return "Custom instance"
+
+    caplog.set_level("INFO")
+    logging.info(
+        {
+            "my_datetime": datetime.datetime(
+                2020, 1, 10, 3, 14, 11, tzinfo=datetime.timezone.utc
+            ),
+            "my_date": datetime.date(2020, 1, 10),
+            "my_time": datetime.time(3, 14, 11, tzinfo=datetime.timezone.utc),
+            "my_custom_obj": custom,
+            "my_custom_obj_with_str": CustomWithStr(),
         }
     )
+    assert dict_fmt(caplog,) == {
+        "my_custom_obj": str(custom),
+        "my_custom_obj_with_str": "Custom instance",
+        "my_date": "2020-01-10",
+        "my_datetime": "2020-01-10T03:14:11+00:00",
+        "my_time": "03:14:11+00:00",
+    }
 
 
 def fmt(caplog, *formatter_args, **formatter_kwargs) -> str: