Refactor InOrder to facade/impl and hide internal API

Author: kaste

mockito/inorder.py

@@ -93,6 +93,36 @@ class InOrder:
 
     """
 
+    def __init__(self, *objects: object) -> None:
+        self._core = InOrderImpl(*objects)
+
+    def verify(
+        self,
+        obj: object,
+        times=None,
+        atleast=None,
+        atmost=None,
+        between=None,
+    ):
+        return self._core.verify(
+            obj,
+            times=times,
+            atleast=atleast,
+            atmost=atmost,
+            between=between,
+        )
+
+    def __enter__(self):
+        self._core.__enter__()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self._core.__exit__(exc_type, exc_val, exc_tb)
+
+
+class InOrderImpl:
+    """Internal implementation behind the public `InOrder` facade."""
+
 
     def __init__(self, *objects: object):
         objects_: list[object] = []
@@ -221,11 +251,12 @@ def _guess_object_labels_from_callsite(self, count: int) -> list[str | None]:
             return [None]
 
         frame = inspect.currentframe()
-        caller_frame = (
-            frame.f_back.f_back
-            if frame and frame.f_back and frame.f_back.f_back
-            else None
-        )
+        # Start at the direct caller and then walk out of our own module.
+        # This is important because public `InOrder` delegates to `InOrderImpl`,
+        # so the first stack frames are internal wrappers.
+        caller_frame = frame.f_back if frame else None
+        while caller_frame and caller_frame.f_code.co_filename == __file__:
+            caller_frame = caller_frame.f_back
 
         if caller_frame is None:
             return [None] * count
@@ -292,7 +323,7 @@ def _is_inorder_constructor_call(self, node: ast.Call) -> bool:
 
 
 class InOrderVerifiableInvocation(VerifiableInvocation):
-    def __init__(self, mock, method_name, verification, inorder: InOrder):
+    def __init__(self, mock, method_name, verification, inorder: InOrderImpl):
         super().__init__(mock, method_name, verification)
         self._inorder = inorder
 

tests/in_order_test.py

@@ -62,6 +62,13 @@ def test_legacy_inorder_verify_is_deprecated():
     )
 
 
+def test_in_order_public_surface_is_verify_only():
+    in_order = InOrder(mock())
+
+    public = [name for name in dir(in_order) if not name.startswith('_')]
+    assert public == ["verify"]
+
+
 def test_observing_the_same_mock_twice_should_raise():
     a = mock()
     with pytest.raises(ValueError) as e:
@@ -393,12 +400,11 @@ def test_allow_double_entrance():
     in_order.verify(cat, times=1).meow()
 
 
-def test_close_should_detach_and_stop_late_registration_capture():
+def test_exited_in_order_should_stop_late_registration_capture():
     bob = Dog()
 
-    in_order = InOrder(bob)
-    in_order.close()
-    in_order.close()
+    with InOrder(bob) as in_order:
+        pass
 
     expect(bob).say(...)
     bob.say("Wuff!")