Skip to content

Commit 6e1d27e

Browse files
committed
chore(tests[legacy_server]): pydocstyle manual fixes
1 parent d2e4990 commit 6e1d27e

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

tests/legacy_api/test_server.py

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313

1414
def test_has_session(server: Server, session: Session) -> None:
15+
"""Server.has_session() returns True if session exists."""
1516
session_name = session.get("session_name")
1617
assert session_name is not None
1718
assert server.has_session(session_name)
@@ -44,6 +45,7 @@ def test_config(server: Server) -> None:
4445

4546

4647
def test_256_colors(server: Server) -> None:
48+
"""Assert Server respects ``colors=256``."""
4749
myserver = Server(colors=256)
4850
assert myserver.colors == 256
4951

@@ -54,6 +56,7 @@ def test_256_colors(server: Server) -> None:
5456

5557

5658
def test_88_colors(server: Server) -> None:
59+
"""Assert Server respects ``colors=88``."""
5760
myserver = Server(colors=88)
5861
assert myserver.colors == 88
5962

@@ -110,9 +113,7 @@ def test_new_session_no_name(server: Server) -> None:
110113

111114

112115
def test_new_session_shell(server: Server) -> None:
113-
"""Server.new_session creates and returns valid session running with
114-
specified command.
115-
"""
116+
"""Verify ``Server.new_session`` creates valid session running w/ command."""
116117
cmd = "sleep 1m"
117118
mysession = server.new_session("test_new_session", window_command=cmd)
118119
window = mysession.list_windows()[0]
@@ -130,31 +131,37 @@ def test_new_session_shell(server: Server) -> None:
130131

131132

132133
def test_no_server_sessions() -> None:
134+
"""Verify ``Server.sessions`` returns empty list without tmux server."""
133135
server = Server(socket_name="test_attached_session_no_server")
134136
assert server.sessions == []
135137

136138

137139
def test_no_server_attached_sessions() -> None:
140+
"""Verify ``Server.attached_sessions`` returns empty list without tmux server."""
138141
server = Server(socket_name="test_no_server_attached_sessions")
139142
assert server.attached_sessions == []
140143

141144

142145
def test_no_server_is_alive() -> None:
146+
"""Verify is_alive() returns False without tmux server."""
143147
dead_server = Server(socket_name="test_no_server_is_alive")
144148
assert not dead_server.is_alive()
145149

146150

147151
def test_with_server_is_alive(server: Server) -> None:
152+
"""Verify is_alive() returns True when tmux server is alive."""
148153
server.new_session()
149154
assert server.is_alive()
150155

151156

152-
def test_no_server_raise_if_dead() -> None:
157+
def test_raise_if_dead_no_server_raises() -> None:
158+
"""Verify new_session() raises if tmux server is dead."""
153159
dead_server = Server(socket_name="test_attached_session_no_server")
154160
with pytest.raises(subprocess.SubprocessError):
155161
dead_server.raise_if_dead()
156162

157163

158-
def test_with_server_raise_if_dead(server: Server) -> None:
164+
def test_raise_if_dead_does_not_raise_if_alive(server: Server) -> None:
165+
"""Verify new_session() does not raise if tmux server is alive."""
159166
server.new_session()
160167
server.raise_if_dead()

0 commit comments

Comments
 (0)