File tree 1 file changed +17
-3
lines changed
1 file changed +17
-3
lines changed Original file line number Diff line number Diff line change 1
- """libtmux pytest plugin."""
1
+ """Provide a pytest plugin that supplies libtmux testing fixtures.
2
+
3
+ This plugin integrates with pytest to offer session, window, and environment
4
+ fixtures tailored for tmux-based tests. It ensures stable test environments by
5
+ creating and tearing down temporary sessions and windows for each test as
6
+ needed.
7
+
8
+ Notes
9
+ -----
10
+ The existing doctests embedded within each fixture are preserved to maintain
11
+ clarity and verify core behaviors.
12
+
13
+ """
2
14
3
15
from __future__ import annotations
4
16
@@ -67,7 +79,8 @@ def config_file(user_path: pathlib.Path) -> pathlib.Path:
67
79
68
80
- ``base-index -g 1``
69
81
70
- These guarantee pane and windows targets can be reliably referenced and asserted.
82
+ These guarantee pane and windows targets can be reliably referenced
83
+ and asserted.
71
84
72
85
Note: You will need to set the home directory, see :ref:`set_home`.
73
86
"""
@@ -85,7 +98,8 @@ def config_file(user_path: pathlib.Path) -> pathlib.Path:
85
98
def clear_env (monkeypatch : pytest .MonkeyPatch ) -> None :
86
99
"""Clear out any unnecessary environment variables that could interrupt tests.
87
100
88
- tmux show-environment tests were being interrupted due to a lot of crazy env vars.
101
+ tmux show-environment tests were being interrupted due to a lot of
102
+ crazy env vars.
89
103
"""
90
104
for k in os .environ :
91
105
if not any (
You can’t perform that action at this time.
0 commit comments