Skip to content

Commit ced0438

Browse files
committed
feat(Server.kill): Add Server.kill(), deprecate kill_server()
1 parent 1b8c02a commit ced0438

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

src/libtmux/server.py

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,24 @@ def has_session(self, target_session: str, exact: bool = True) -> bool:
270270

271271
return False
272272

273-
def kill_server(self) -> None:
274-
"""Kill tmux server."""
273+
def kill(self) -> None:
274+
"""Kill tmux server.
275+
276+
>>> svr = Server(socket_name="testing")
277+
>>> svr
278+
Server(socket_name=testing)
279+
280+
>>> svr.new_session()
281+
Session(...)
282+
283+
>>> svr.is_alive()
284+
True
285+
286+
>>> svr.kill()
287+
288+
>>> svr.is_alive()
289+
False
290+
"""
275291
self.cmd("kill-server")
276292

277293
def kill_session(self, target_session: t.Union[str, int]) -> "Server":
@@ -585,6 +601,23 @@ def __repr__(self) -> str:
585601
#
586602
# Legacy: Redundant stuff we want to remove
587603
#
604+
def kill_server(self) -> None:
605+
"""Kill tmux server.
606+
607+
Notes
608+
-----
609+
.. deprecated:: 0.30
610+
611+
Deprecated in favor of :meth:`.kill()`.
612+
613+
"""
614+
warnings.warn(
615+
"Server.kill_server() is deprecated in favor of Server.kill()",
616+
category=DeprecationWarning,
617+
stacklevel=2,
618+
)
619+
self.cmd("kill-server")
620+
588621
def _list_panes(self) -> t.List[PaneDict]:
589622
"""Return list of panes in :py:obj:`dict` form.
590623

0 commit comments

Comments
 (0)