refactor!(test[random]) Move helpers to test.random

Author: tony

src/libtmux/pytest_plugin.py

@@ -13,8 +13,9 @@
 
 from libtmux import exc
 from libtmux.server import Server
-from libtmux.test import get_test_session_name, namer
+from libtmux.test import get_test_session_name
 from libtmux.test.constants import TEST_SESSION_PREFIX
+from libtmux.test.random import namer
 
 if t.TYPE_CHECKING:
     import pathlib

src/libtmux/test/__init__.py

@@ -17,6 +17,8 @@
     TEST_SESSION_PREFIX,
 )
 
+from .random import namer
+
 logger = logging.getLogger(__name__)
 
 if t.TYPE_CHECKING:
@@ -34,35 +36,6 @@
         from typing_extensions import Self
 
 
-class RandomStrSequence:
-    """Factory to generate random string."""
-
-    def __init__(
-        self,
-        characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_",
-    ) -> None:
-        """Create a random letter / number generator. 8 chars in length.
-
-        >>> rng = RandomStrSequence()
-        >>> next(rng)
-        '...'
-        >>> len(next(rng))
-        8
-        >>> type(next(rng))
-        <class 'str'>
-        """
-        self.characters: str = characters
-
-    def __iter__(self) -> RandomStrSequence:
-        """Return self."""
-        return self
-
-    def __next__(self) -> str:
-        """Return next random string."""
-        return "".join(random.sample(self.characters, k=8))
-
-
-namer = RandomStrSequence()
 current_dir = pathlib.Path(__file__)
 example_dir = current_dir.parent / "examples"
 fixtures_dir = current_dir / "fixtures"

src/libtmux/test/random.py

@@ -0,0 +1,46 @@
+"""Random helpers for libtmux and downstream libtmux libraries."""
+
+from __future__ import annotations
+
+import logging
+import random
+import typing as t
+
+logger = logging.getLogger(__name__)
+
+if t.TYPE_CHECKING:
+    import sys
+
+    if sys.version_info >= (3, 11):
+        pass
+
+
+class RandomStrSequence:
+    """Factory to generate random string."""
+
+    def __init__(
+        self,
+        characters: str = "abcdefghijklmnopqrstuvwxyz0123456789_",
+    ) -> None:
+        """Create a random letter / number generator. 8 chars in length.
+
+        >>> rng = RandomStrSequence()
+        >>> next(rng)
+        '...'
+        >>> len(next(rng))
+        8
+        >>> type(next(rng))
+        <class 'str'>
+        """
+        self.characters: str = characters
+
+    def __iter__(self) -> RandomStrSequence:
+        """Return self."""
+        return self
+
+    def __next__(self) -> str:
+        """Return next random string."""
+        return "".join(random.sample(self.characters, k=8))
+
+
+namer = RandomStrSequence()

tests/legacy_api/test_session.py

@@ -12,8 +12,8 @@
 from libtmux.common import has_gte_version, has_lt_version
 from libtmux.pane import Pane
 from libtmux.session import Session
-from libtmux.test import namer
 from libtmux.test.constants import TEST_SESSION_PREFIX
+from libtmux.test.random import namer
 from libtmux.window import Window
 
 if t.TYPE_CHECKING:

tests/legacy_api/test_tmuxobject.py

@@ -7,8 +7,8 @@
 
 from libtmux.pane import Pane
 from libtmux.session import Session
-from libtmux.test import namer
 from libtmux.test.constants import TEST_SESSION_PREFIX
+from libtmux.test.random import namer
 from libtmux.window import Window
 
 if t.TYPE_CHECKING:

tests/test_session.py

@@ -13,8 +13,8 @@
 from libtmux.constants import WindowDirection
 from libtmux.pane import Pane
 from libtmux.session import Session
-from libtmux.test import namer
 from libtmux.test.constants import TEST_SESSION_PREFIX
+from libtmux.test.random import namer
 from libtmux.window import Window
 
 if t.TYPE_CHECKING:

tests/test_tmuxobject.py

@@ -7,8 +7,8 @@
 
 from libtmux.pane import Pane
 from libtmux.session import Session
-from libtmux.test import namer
 from libtmux.test.constants import TEST_SESSION_PREFIX
+from libtmux.test.random import namer
 from libtmux.window import Window
 
 if t.TYPE_CHECKING: