Drop pretend dependency (hynek#766)

Author: hynek

pyproject.toml

@@ -42,7 +42,6 @@ Twitter = "https://twitter.com/hynek"
 [dependency-groups]
 tests = [
     "time-machine>=2.14.1",
-    "pretend",
     "pytest-asyncio>=0.17",
     "pytest>=6.0",
     "simplejson",

tests/helpers.py

@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: MIT OR Apache-2.0
+# This file is dual licensed under the terms of the Apache License, Version
+# 2.0, and the MIT License.  See the LICENSE file in the root of this
+# repository for complete details.
+
+"""
+Shared test utilities.
+"""
+
+from unittest.mock import Mock, seal
+
+from structlog._log_levels import NAME_TO_LEVEL
+
+
+stdlib_log_methods = [m for m in NAME_TO_LEVEL if m != "notset"]
+
+
+class CustomError(Exception):
+    """
+    Custom exception for testing purposes.
+    """
+
+
+def stub(**kwargs):
+    """
+    Create a restrictive mock that prevents new attributes after creation.
+    Similar to pretend.stub().
+    """
+    m = Mock(**kwargs)
+    seal(m)
+
+    return m
+
+
+def raiser(exception):
+    """
+    Create a mock that raises the given exception when called.
+    """
+    return Mock(side_effect=exception)
+
+
+def call_recorder(func):
+    """
+    Create a mock that records calls while executing func.
+    """
+    return Mock(side_effect=func)

tests/processors/test_renderers.py

@@ -24,7 +24,7 @@
 )
 from structlog.threadlocal import wrap_dict
 
-from ..utils import CustomError
+from ..helpers import CustomError
 
 
 try:

tests/test_base.py

@@ -5,15 +5,14 @@
 
 import pytest
 
-from pretend import raiser, stub
-
 from structlog import get_context
 from structlog._base import BoundLoggerBase
 from structlog._config import _CONFIG
 from structlog.exceptions import DropEvent
 from structlog.processors import KeyValueRenderer
 from structlog.testing import ReturnLogger
-from tests.utils import CustomError
+
+from .helpers import CustomError, raiser, stub
 
 
 def build_bl(logger=None, processors=None, context=None):

tests/test_config.py

@@ -7,9 +7,9 @@
 import pickle
 import warnings
 
-import pytest
+from unittest.mock import call
 
-from pretend import call, call_recorder, stub
+import pytest
 
 import structlog
 
@@ -28,6 +28,8 @@
 )
 from structlog.typing import BindableLogger
 
+from .helpers import call_recorder, stub
+
 
 @pytest.fixture(name="proxy")
 def _proxy():
@@ -463,4 +465,4 @@ def test_get_logger_passes_positional_arguments_to_logger_factory(self):
 
         get_logger("test").bind(x=42)
 
-        assert [call("test")] == factory.calls
+        assert [call("test")] == factory.call_args_list

tests/test_frames.py

@@ -7,14 +7,14 @@
 
 import pytest
 
-from pretend import stub
-
 from structlog._frames import (
     _find_first_app_frame_and_name,
     _format_exception,
     _format_stack,
 )
 
+from .helpers import stub
+
 
 class TestFindFirstAppFrameAndName:
     def test_ignores_structlog_by_default(self):

tests/test_output.py

@@ -20,7 +20,7 @@
 )
 from structlog._output import WRITE_LOCKS, stderr, stdout
 
-from .utils import stdlib_log_methods
+from .helpers import stdlib_log_methods
 
 
 class TestLoggers:

tests/test_stdlib.py

@@ -18,8 +18,6 @@
 import pytest
 import pytest_asyncio
 
-from pretend import call_recorder, stub
-
 from structlog import (
     PrintLogger,
     ReturnLogger,
@@ -53,6 +51,7 @@
 from structlog.typing import BindableLogger, EventDict
 
 from .additional_frame import additional_frame
+from .helpers import call_recorder, stub
 
 
 def build_bl(logger=None, processors=None, context=None):
@@ -1100,7 +1099,7 @@ def test_pass_foreign_args_true_sets_positional_args_key(self):
         positional_args = {"foo": "bar"}
         logging.getLogger().info("okay %(foo)s", positional_args)
 
-        event_dict = test_processor.calls[0].args[2]
+        event_dict = test_processor.call_args_list[0].args[2]
 
         assert "positional_args" in event_dict
         assert positional_args == event_dict["positional_args"]
@@ -1181,7 +1180,7 @@ def test_foreign_pre_chain_gets_exc_info(self):
         except Exception:
             logging.getLogger().exception("okay")
 
-        event_dict = test_processor.calls[0].args[2]
+        event_dict = test_processor.call_args_list[0].args[2]
 
         assert "exc_info" in event_dict
         assert isinstance(event_dict["exc_info"], tuple)
@@ -1209,7 +1208,7 @@ def add_excinfo(logger, log_method, event_dict):
         except Exception:
             logging.getLogger().error("okay")
 
-        event_dict = test_processor.calls[0].args[2]
+        event_dict = test_processor.call_args_list[0].args[2]
 
         assert MyError is event_dict["exc_info"][0]
 
@@ -1232,9 +1231,9 @@ def test_other_handlers_get_original_record(self):
 
         logger.info("meh")
 
-        assert 1 == len(handler2.handle.calls)
+        assert 1 == len(handler2.handle.call_args_list)
 
-        handler2_record = handler2.handle.calls[0].args[0]
+        handler2_record = handler2.handle.call_args_list[0].args[0]
 
         assert "meh" == handler2_record.msg
 

tests/test_threadlocal.py

@@ -28,7 +28,8 @@
     unbind_threadlocal,
     wrap_dict,
 )
-from tests.utils import CustomError
+
+from .helpers import CustomError
 
 
 try:

tests/test_twisted.py

@@ -7,12 +7,12 @@
 
 import pytest
 
-from pretend import call_recorder
-
 from structlog import ReturnLogger
 from structlog._config import _CONFIG
 from structlog.processors import KeyValueRenderer
 
+from .helpers import call_recorder
+
 
 try:
     from twisted.python.failure import Failure
@@ -327,7 +327,7 @@ def test_callsWrappedObserver(self):
         o = call_recorder(lambda *a, **kw: None)
         JSONLogObserverWrapper(o)({"message": ("hello",)})
 
-        assert 1 == len(o.calls)
+        assert 1 == len(o.call_args_list)
 
     def test_jsonifiesPlainLogEntries(self):
         """
@@ -336,7 +336,7 @@ def test_jsonifiesPlainLogEntries(self):
         """
         o = call_recorder(lambda *a, **kw: None)
         JSONLogObserverWrapper(o)({"message": ("hello",), "system": "-"})
-        msg = json.loads(o.calls[0].args[0]["message"][0])
+        msg = json.loads(o.call_args_list[0].args[0]["message"][0])
 
         assert msg == {"event": "hello", "system": "-"}