|
6 | 6 | import random |
7 | 7 | import typing as t |
8 | 8 |
|
| 9 | +from libtmux.test.constants import ( |
| 10 | + TEST_SESSION_PREFIX, |
| 11 | +) |
| 12 | + |
| 13 | +logger = logging.getLogger(__name__) |
| 14 | + |
| 15 | +if t.TYPE_CHECKING: |
| 16 | + import sys |
| 17 | + |
| 18 | + from libtmux.server import Server |
| 19 | + from libtmux.session import Session |
| 20 | + |
| 21 | + if sys.version_info >= (3, 11): |
| 22 | + pass |
| 23 | + |
| 24 | + |
9 | 25 | logger = logging.getLogger(__name__) |
10 | 26 |
|
11 | 27 | if t.TYPE_CHECKING: |
@@ -44,3 +60,75 @@ def __next__(self) -> str: |
44 | 60 |
|
45 | 61 |
|
46 | 62 | namer = RandomStrSequence() |
| 63 | + |
| 64 | + |
| 65 | +def get_test_session_name(server: Server, prefix: str = TEST_SESSION_PREFIX) -> str: |
| 66 | + """ |
| 67 | + Faker to create a session name that doesn't exist. |
| 68 | +
|
| 69 | + Parameters |
| 70 | + ---------- |
| 71 | + server : :class:`libtmux.Server` |
| 72 | + libtmux server |
| 73 | + prefix : str |
| 74 | + prefix for sessions (e.g. ``libtmux_``). Defaults to |
| 75 | + ``TEST_SESSION_PREFIX``. |
| 76 | +
|
| 77 | + Returns |
| 78 | + ------- |
| 79 | + str |
| 80 | + Random session name guaranteed to not collide with current ones. |
| 81 | +
|
| 82 | + Examples |
| 83 | + -------- |
| 84 | + >>> get_test_session_name(server=server) |
| 85 | + 'libtmux_...' |
| 86 | +
|
| 87 | + Never the same twice: |
| 88 | + >>> get_test_session_name(server=server) != get_test_session_name(server=server) |
| 89 | + True |
| 90 | + """ |
| 91 | + while True: |
| 92 | + session_name = prefix + next(namer) |
| 93 | + if not server.has_session(session_name): |
| 94 | + break |
| 95 | + return session_name |
| 96 | + |
| 97 | + |
| 98 | +def get_test_window_name( |
| 99 | + session: Session, |
| 100 | + prefix: str | None = TEST_SESSION_PREFIX, |
| 101 | +) -> str: |
| 102 | + """ |
| 103 | + Faker to create a window name that doesn't exist. |
| 104 | +
|
| 105 | + Parameters |
| 106 | + ---------- |
| 107 | + session : :class:`libtmux.Session` |
| 108 | + libtmux session |
| 109 | + prefix : str |
| 110 | + prefix for windows (e.g. ``libtmux_``). Defaults to |
| 111 | + ``TEST_SESSION_PREFIX``. |
| 112 | +
|
| 113 | + ATM we reuse the test session prefix here. |
| 114 | +
|
| 115 | + Returns |
| 116 | + ------- |
| 117 | + str |
| 118 | + Random window name guaranteed to not collide with current ones. |
| 119 | +
|
| 120 | + Examples |
| 121 | + -------- |
| 122 | + >>> get_test_window_name(session=session) |
| 123 | + 'libtmux_...' |
| 124 | +
|
| 125 | + Never the same twice: |
| 126 | + >>> get_test_window_name(session=session) != get_test_window_name(session=session) |
| 127 | + True |
| 128 | + """ |
| 129 | + assert prefix is not None |
| 130 | + while True: |
| 131 | + window_name = prefix + next(namer) |
| 132 | + if len(session.windows.filter(window_name=window_name)) == 0: |
| 133 | + break |
| 134 | + return window_name |
0 commit comments