Fix formatting, linting, typing

src/pythonjsonlogger/__init__.py

@@ -18,6 +18,7 @@
 else:
     try:
         import orjson
+
         ORJSON_AVAILABLE = True
     except ImportError:
         ORJSON_AVAILABLE = False

src/pythonjsonlogger/json.py

@@ -3,6 +3,7 @@
 Module contains the `JsonFormatter` and a custom `JsonEncoder` which supports a greater
 variety of types.
 """
+
 ### IMPORTS
 ### ============================================================================
 ## Future

tests/test_formatters.py

@@ -11,6 +11,7 @@
 import logging
 import sys
 import traceback
+from typing import Any, Generator
 
 ## Installed
 from freezegun import freeze_time
@@ -27,12 +28,13 @@
 
 ### SETUP
 ### ============================================================================
-ALL_FORMATTERS: list[BaseJsonFormatter] = [JsonFormatter]
+ALL_FORMATTERS: list[type[BaseJsonFormatter]] = [JsonFormatter]
 if pythonjsonlogger.ORJSON_AVAILABLE:
     ALL_FORMATTERS.append(OrjsonFormatter)
 
 _LOGGER_COUNT = 0
 
+
 @dataclass
 class LoggingEnvironment:
     logger: logging.Logger
@@ -48,7 +50,7 @@ def load_json(self) -> Any:
 
 
 @pytest.fixture
-def env() -> LoggingEnvironment:
+def env() -> Generator[LoggingEnvironment, None, None]:
     global _LOGGER_COUNT  # pylint: disable=global-statement
     _LOGGER_COUNT += 1
     logger = logging.getLogger(f"pythonjsonlogger.tests.{_LOGGER_COUNT}")
@@ -74,12 +76,13 @@ def get_traceback_from_exception_followed_by_log_call(env_: LoggingEnvironment)
             str_traceback = str_traceback[:-1]
     return str_traceback
 
+
 ### TESTS
 ### ============================================================================
 ## Common Tests
 ## -----------------------------------------------------------------------------
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_default_format(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_default_format(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_())
 
     msg = "testing logging format"
@@ -92,11 +95,13 @@ def test_default_format(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_percentage_format(env: LoggingEnvironment, class_: BaseJsonFormatter):
-    env.set_formatter(class_(
-        # All kind of different styles to check the regex
-        "[%(levelname)8s] %(message)s %(filename)s:%(lineno)d %(asctime)"
-    ))
+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)"
+        )
+    )
 
     msg = "testing logging format"
     env.logger.info(msg)
@@ -108,7 +113,7 @@ def test_percentage_format(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_rename_base_field(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_rename_base_field(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_(rename_fields={"message": "@message"}))
 
     msg = "testing logging format"
@@ -120,7 +125,7 @@ def test_rename_base_field(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_rename_nonexistent_field(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_rename_nonexistent_field(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_(rename_fields={"nonexistent_key": "new_name"}))
 
     stderr_watcher = io.StringIO()
@@ -133,7 +138,7 @@ def test_rename_nonexistent_field(env: LoggingEnvironment, class_: BaseJsonForma
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_add_static_fields(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_add_static_fields(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_(static_fields={"log_stream": "kafka"}))
 
     msg = "testing static fields"
@@ -146,7 +151,7 @@ def test_add_static_fields(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_format_keys(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_format_keys(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     supported_keys = [
         "asctime",
         "created",
@@ -182,15 +187,15 @@ def test_format_keys(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_unknown_format_key(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_unknown_format_key(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_("%(unknown_key)s %(message)s"))
     env.logger.info("testing unknown logging format")
     # make sure no error occurs
     return
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_log_dict(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_log_dict(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_())
 
     msg = {"text": "testing logging", "num": 1, 5: "9", "nested": {"more": "data"}}
@@ -199,18 +204,18 @@ def test_log_dict(env: LoggingEnvironment, class_: BaseJsonFormatter):
 
     assert log_json["text"] == msg["text"]
     assert log_json["num"] == msg["num"]
-    assert log_json["5"] ==  msg[5]
+    assert log_json["5"] == msg[5]
     assert log_json["nested"] == msg["nested"]
     assert log_json["message"] == ""
     return
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_log_extra(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_log_extra(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_())
 
     extra = {"text": "testing logging", "num": 1, 5: "9", "nested": {"more": "data"}}
-    env.logger.info("hello", extra=extra)
+    env.logger.info("hello", extra=extra)  # type: ignore[arg-type]
     log_json = env.load_json()
 
     assert log_json["text"] == extra["text"]
@@ -220,9 +225,10 @@ def test_log_extra(env: LoggingEnvironment, class_: BaseJsonFormatter):
     assert log_json["message"] == "hello"
     return
 
+
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_json_custom_logic_adds_field(env: LoggingEnvironment, class_: BaseJsonFormatter):
-    class CustomJsonFormatter(class_):
+def test_json_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"
@@ -237,7 +243,7 @@ def process_log_record(self, log_record):
 
 
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_exc_info(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_exc_info(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_())
 
     expected_value = get_traceback_from_exception_followed_by_log_call(env)
@@ -246,8 +252,9 @@ def test_exc_info(env: LoggingEnvironment, class_: BaseJsonFormatter):
     assert log_json["exc_info"] == expected_value
     return
 
+
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_exc_info_renamed(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_exc_info_renamed(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     env.set_formatter(class_("%(exc_info)s", rename_fields={"exc_info": "stack_trace"}))
 
     expected_value = get_traceback_from_exception_followed_by_log_call(env)
@@ -257,23 +264,25 @@ def test_exc_info_renamed(env: LoggingEnvironment, class_: BaseJsonFormatter):
     assert "exc_info" not in log_json
     return
 
+
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_custom_object_serialization(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_custom_object_serialization(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     def encode_complex(z):
         if isinstance(z, complex):
             return (z.real, z.imag)
         raise TypeError(f"Object of type {type(z)} is no JSON serializable")
 
-    env.set_formatter(class_(json_default=encode_complex))
+    env.set_formatter(class_(json_default=encode_complex))  # type: ignore[call-arg]
 
     env.logger.info("foo", extra={"special": complex(3, 8)})
     log_json = env.load_json()
 
     assert log_json["special"] == [3.0, 8.0]
     return
 
+
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_rename_reserved_attrs(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_rename_reserved_attrs(env: LoggingEnvironment, class_: type[BaseJsonFormatter]):
     log_format = lambda x: [f"%({i:s})s" for i in x]
     reserved_attrs_map = {
         "exc_info": "error.type",
@@ -290,9 +299,9 @@ def test_rename_reserved_attrs(env: LoggingEnvironment, class_: BaseJsonFormatte
     reserved_attrs = [
         attr for attr in RESERVED_ATTRS if attr not in list(reserved_attrs_map.keys())
     ]
-    env.set_formatter(class_(
-        custom_format, reserved_attrs=reserved_attrs, rename_fields=reserved_attrs_map
-    ))
+    env.set_formatter(
+        class_(custom_format, reserved_attrs=reserved_attrs, rename_fields=reserved_attrs_map)
+    )
 
     env.logger.info("message")
     log_json = env.load_json()
@@ -306,9 +315,12 @@ def test_rename_reserved_attrs(env: LoggingEnvironment, class_: BaseJsonFormatte
         assert old_name not in log_json
     return
 
+
 @freeze_time(datetime.datetime(2017, 7, 14, 2, 40))
 @pytest.mark.parametrize("class_", ALL_FORMATTERS)
-def test_json_default_encoder_with_timestamp(env: LoggingEnvironment, class_: BaseJsonFormatter):
+def test_json_default_encoder_with_timestamp(
+    env: LoggingEnvironment, class_: type[BaseJsonFormatter]
+):
     if pythonjsonlogger.ORJSON_AVAILABLE and class_ is OrjsonFormatter:
         # https://github.com/spulec/freezegun/issues/448#issuecomment-1686070438
         pytest.xfail()
@@ -322,6 +334,7 @@ def test_json_default_encoder_with_timestamp(env: LoggingEnvironment, class_: Ba
     assert log_json["timestamp"] == "2017-07-14T02:40:00+00:00"
     return
 
+
 ## JsonFormatter Specific
 ## -----------------------------------------------------------------------------
 def test_json_default_encoder(env: LoggingEnvironment):
@@ -342,6 +355,7 @@ def test_json_default_encoder(env: LoggingEnvironment):
     assert log_json["otherdatetimeagain"] == "1900-01-01T00:00:00"
     return
 
+
 def test_json_custom_default(env: LoggingEnvironment):
     def custom(o):
         return "very custom"
@@ -356,6 +370,7 @@ def custom(o):
     assert log_json["normal"] == "value"
     return
 
+
 def test_ensure_ascii_true(env: LoggingEnvironment):
     env.set_formatter(JsonFormatter())
     env.logger.info("Привет")
@@ -365,6 +380,7 @@ def test_ensure_ascii_true(env: LoggingEnvironment):
     assert msg, r"\u041f\u0440\u0438\u0432\u0435\u0442"
     return
 
+
 def test_ensure_ascii_false(env: LoggingEnvironment):
     env.set_formatter(JsonFormatter(json_ensure_ascii=False))
     env.logger.info("Привет")