refactor!(test[retry]) Move from test to test.retry

Author: tony

src/libtmux/test/__init__.py

@@ -39,52 +39,3 @@
 current_dir = pathlib.Path(__file__)
 example_dir = current_dir.parent / "examples"
 fixtures_dir = current_dir / "fixtures"
-
-
-def retry_until(
-    fun: Callable[[], bool],
-    seconds: float = RETRY_TIMEOUT_SECONDS,
-    *,
-    interval: float = RETRY_INTERVAL_SECONDS,
-    raises: bool | None = True,
-) -> bool:
-    """
-    Retry a function until a condition meets or the specified time passes.
-
-    Parameters
-    ----------
-    fun : callable
-        A function that will be called repeatedly until it returns ``True``  or
-        the specified time passes.
-    seconds : float
-        Seconds to retry. Defaults to ``8``, which is configurable via
-        ``RETRY_TIMEOUT_SECONDS`` environment variables.
-    interval : float
-        Time in seconds to wait between calls. Defaults to ``0.05`` and is
-        configurable via ``RETRY_INTERVAL_SECONDS`` environment variable.
-    raises : bool
-        Whether or not to raise an exception on timeout. Defaults to ``True``.
-
-    Examples
-    --------
-    >>> def fn():
-    ...     p = session.active_window.active_pane
-    ...     return p.pane_current_path is not None
-
-    >>> retry_until(fn)
-    True
-
-    In pytest:
-
-    >>> assert retry_until(fn, raises=False)
-    """
-    ini = time.time()
-
-    while not fun():
-        end = time.time()
-        if end - ini >= seconds:
-            if raises:
-                raise WaitTimeout
-            return False
-        time.sleep(interval)
-    return True

src/libtmux/test/retry.py

@@ -0,0 +1,71 @@
+"""Retry helpers for libtmux and downstream libtmux libraries."""
+
+from __future__ import annotations
+
+import logging
+import time
+import typing as t
+
+from libtmux.exc import WaitTimeout
+from libtmux.test.constants import (
+    RETRY_INTERVAL_SECONDS,
+    RETRY_TIMEOUT_SECONDS,
+)
+
+logger = logging.getLogger(__name__)
+
+if t.TYPE_CHECKING:
+    import sys
+    from collections.abc import Callable
+
+    if sys.version_info >= (3, 11):
+        pass
+
+
+def retry_until(
+    fun: Callable[[], bool],
+    seconds: float = RETRY_TIMEOUT_SECONDS,
+    *,
+    interval: float = RETRY_INTERVAL_SECONDS,
+    raises: bool | None = True,
+) -> bool:
+    """
+    Retry a function until a condition meets or the specified time passes.
+
+    Parameters
+    ----------
+    fun : callable
+        A function that will be called repeatedly until it returns ``True``  or
+        the specified time passes.
+    seconds : float
+        Seconds to retry. Defaults to ``8``, which is configurable via
+        ``RETRY_TIMEOUT_SECONDS`` environment variables.
+    interval : float
+        Time in seconds to wait between calls. Defaults to ``0.05`` and is
+        configurable via ``RETRY_INTERVAL_SECONDS`` environment variable.
+    raises : bool
+        Whether or not to raise an exception on timeout. Defaults to ``True``.
+
+    Examples
+    --------
+    >>> def fn():
+    ...     p = session.active_window.active_pane
+    ...     return p.pane_current_path is not None
+
+    >>> retry_until(fn)
+    True
+
+    In pytest:
+
+    >>> assert retry_until(fn, raises=False)
+    """
+    ini = time.time()
+
+    while not fun():
+        end = time.time()
+        if end - ini >= seconds:
+            if raises:
+                raise WaitTimeout
+            return False
+        time.sleep(interval)
+    return True

tests/test_pane.py

@@ -10,7 +10,7 @@
 
 from libtmux.common import has_gte_version, has_lt_version, has_lte_version
 from libtmux.constants import PaneDirection, ResizeAdjustmentDirection
-from libtmux.test import retry_until
+from libtmux.test.retry import retry_until
 
 if t.TYPE_CHECKING:
     from libtmux.session import Session

tests/test_test.py

@@ -7,7 +7,7 @@
 import pytest
 
 from libtmux.exc import WaitTimeout
-from libtmux.test import retry_until
+from libtmux.test.retry import retry_until
 
 
 def test_retry_three_times() -> None: