Skip to content

Commit 164490d

Browse files
committed
chore(tests[server]): pydocstyle manual fixes
1 parent f5528e8 commit 164490d

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

tests/test_server.py

+13-8
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.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.windows[0]
@@ -131,9 +132,7 @@ def test_new_session_shell(server: Server) -> None:
131132

132133
@pytest.mark.skipif(has_version("3.2"), reason="Wrong width returned with 3.2")
133134
def test_new_session_width_height(server: Server) -> None:
134-
"""Server.new_session creates and returns valid session running with
135-
specified width /height.
136-
"""
135+
"""Verify ``Server.new_session`` creates valid session running w/ dimensions."""
137136
cmd = "/usr/bin/env PS1='$ ' sh"
138137
mysession = server.new_session(
139138
"test_new_session_width_height",
@@ -148,31 +147,37 @@ def test_new_session_width_height(server: Server) -> None:
148147

149148

150149
def test_no_server_sessions() -> None:
150+
"""Verify ``Server.sessions`` returns empty list without tmux server."""
151151
server = Server(socket_name="test_attached_session_no_server")
152152
assert server.sessions == []
153153

154154

155155
def test_no_server_attached_sessions() -> None:
156+
"""Verify ``Server.attached_sessions`` returns empty list without tmux server."""
156157
server = Server(socket_name="test_no_server_attached_sessions")
157158
assert server.attached_sessions == []
158159

159160

160161
def test_no_server_is_alive() -> None:
162+
"""Verify is_alive() returns False without tmux server."""
161163
dead_server = Server(socket_name="test_no_server_is_alive")
162164
assert not dead_server.is_alive()
163165

164166

165167
def test_with_server_is_alive(server: Server) -> None:
168+
"""Verify is_alive() returns True when tmux server is alive."""
166169
server.new_session()
167170
assert server.is_alive()
168171

169172

170-
def test_no_server_raise_if_dead() -> None:
173+
def test_raise_if_dead_no_server_raises() -> None:
174+
"""Verify new_session() raises if tmux server is dead."""
171175
dead_server = Server(socket_name="test_attached_session_no_server")
172176
with pytest.raises(subprocess.CalledProcessError):
173177
dead_server.raise_if_dead()
174178

175179

176-
def test_with_server_raise_if_dead(server: Server) -> None:
180+
def test_raise_if_dead_does_not_raise_if_alive(server: Server) -> None:
181+
"""Verify new_session() does not raise if tmux server is alive."""
177182
server.new_session()
178183
server.raise_if_dead()

0 commit comments

Comments
 (0)