/usr/lib/python3/dist-packages/libtmux/server.py is in python3-libtmux 0.7.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 | # -*- coding: utf-8 -*-
"""Pythonization of the :term:`tmux(1)` server.
libtmux.server
~~~~~~~~~~~~~~
"""
from __future__ import absolute_import, unicode_literals, with_statement
import logging
import os
from . import exc, formats
from .common import EnvironmentMixin, TmuxRelationalObject, tmux_cmd, \
session_check_name, has_gte_version
from .session import Session
logger = logging.getLogger(__name__)
class Server(TmuxRelationalObject, EnvironmentMixin):
"""The :term:`tmux(1)` server.
- :attr:`Server._sessions` [:class:`Session`, ...]
- :attr:`Session._windows` [:class:`Window`, ...]
- :attr:`Window._panes` [:class:`Pane`, ...]
- :class:`Pane`
When instantiated stores information on live, running tmux server.
"""
#: ``[-L socket-name]``
socket_name = None
#: ``[-S socket-path]``
socket_path = None
#: ``[-f file]``
config_file = None
#: ``-2`` or ``-8``
colors = None
#: unique child ID used by :class:`~libtmux.common.TmuxRelationalObject`
child_id_attribute = 'session_id'
#: namespace used :class:`~libtmux.common.TmuxMappingObject`
formatter_prefix = 'server_'
def __init__(
self,
socket_name=None,
socket_path=None,
config_file=None,
colors=None,
**kwargs
):
EnvironmentMixin.__init__(self, '-g')
self._windows = []
self._panes = []
if socket_name:
self.socket_name = socket_name
if socket_path:
self.socket_path = socket_path
if config_file:
self.config_file = config_file
if colors:
self.colors = colors
def cmd(self, *args, **kwargs):
"""Execute tmux command and return output.
:rtype: :class:`common.tmux_cmd`
.. versionchanged:: 0.8
Renamed from ``.tmux`` to ``.cmd``.
"""
args = list(args)
if self.socket_name:
args.insert(0, '-L{0}'.format(self.socket_name))
if self.socket_path:
args.insert(0, '-S{0}'.format(self.socket_path))
if self.config_file:
args.insert(0, '-f{0}'.format(self.config_file))
if self.colors:
if self.colors == 256:
args.insert(0, '-2')
elif self.colors == 88:
args.insert(0, '-8')
else:
raise ValueError('Server.colors must equal 88 or 256')
return tmux_cmd(*args, **kwargs)
def _list_sessions(self):
"""Return list of sessions in :py:obj:`dict` form.
Retrieved from ``$ tmux(1) list-sessions`` stdout.
The :py:obj:`list` is derived from ``stdout`` in
:class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
:rtype: :py:obj:`list` of :py:obj:`dict`
"""
sformats = formats.SESSION_FORMATS
tmux_formats = ['#{%s}' % f for f in sformats]
tmux_args = (
'-F%s' % '\t'.join(tmux_formats), # output
)
proc = self.cmd(
'list-sessions',
*tmux_args
)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
sformats = formats.SESSION_FORMATS
tmux_formats = ['#{%s}' % format for format in sformats]
sessions = proc.stdout
# combine format keys with values returned from ``tmux list-sessions``
sessions = [dict(zip(
sformats, session.split('\t'))) for session in sessions]
# clear up empty dict
sessions = [
dict((k, v) for k, v in session.items() if v)
for session in sessions
]
return sessions
@property
def _sessions(self):
"""Property / alias to return :meth:`~._list_sessions`."""
return self._list_sessions()
def list_sessions(self):
"""Return list of :class:`Session` from the ``tmux(1)`` session.
:rtype: :py:obj:`list` of :class:`Session`
"""
return [
Session(server=self, **s) for s in self._sessions
]
@property
def sessions(self):
"""Property / alias to return :meth:`~.list_sessions`."""
return self.list_sessions()
#: Alias :attr:`sessions` for :class:`~libtmux.common.TmuxRelationalObject`
children = sessions
def _list_windows(self):
"""Return list of windows in :py:obj:`dict` form.
Retrieved from ``$ tmux(1) list-windows`` stdout.
The :py:obj:`list` is derived from ``stdout`` in
:class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
:rtype: list
"""
wformats = ['session_name', 'session_id'] + formats.WINDOW_FORMATS
tmux_formats = ['#{%s}' % format for format in wformats]
proc = self.cmd(
'list-windows', # ``tmux list-windows``
'-a',
'-F%s' % '\t'.join(tmux_formats), # output
)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
windows = proc.stdout
wformats = ['session_name', 'session_id'] + formats.WINDOW_FORMATS
# combine format keys with values returned from ``tmux list-windows``
windows = [dict(zip(
wformats, window.split('\t'))) for window in windows]
# clear up empty dict
windows = [
dict((k, v) for k, v in window.items() if v) for window in windows
]
# tmux < 1.8 doesn't have window_id, use window_name
for w in windows:
if 'window_id' not in w:
w['window_id'] = w['window_name']
if self._windows:
self._windows[:] = []
self._windows.extend(windows)
return self._windows
def _update_windows(self):
"""Update internal window data and return ``self`` for chainability.
:rtype: :class:`Server`
"""
self._list_windows()
return self
def _list_panes(self):
"""Return list of panes in :py:obj:`dict` form.
Retrieved from ``$ tmux(1) list-panes`` stdout.
The :py:obj:`list` is derived from ``stdout`` in
:class:`util.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
:rtype: list
"""
pformats = [
'session_name', 'session_id',
'window_index', 'window_id',
'window_name'
] + formats.PANE_FORMATS
tmux_formats = ['#{%s}\t' % f for f in pformats]
proc = self.cmd(
'list-panes',
'-a',
'-F%s' % ''.join(tmux_formats), # output
)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
panes = proc.stdout
pformats = [
'session_name', 'session_id',
'window_index', 'window_id', 'window_name'
] + formats.PANE_FORMATS
# combine format keys with values returned from ``tmux list-panes``
panes = [dict(zip(
pformats, window.split('\t'))) for window in panes]
# clear up empty dict
panes = [
dict(
(k, v) for k, v in window.items()
if v or
k == 'pane_current_path'
) # preserve pane_current_path, in case it entered a new process
# where we may not get a cwd from.
for window in panes
]
if self._panes:
self._panes[:] = []
self._panes.extend(panes)
return self._panes
def _update_panes(self):
"""Update internal pane data and return ``self`` for chainability.
:rtype: :class:`Server`
"""
self._list_panes()
return self
@property
def attached_sessions(self):
"""Return active :class:`Session` objects.
This will not work where multiple tmux sessions are attached.
:rtype: :py:obj:`list` of :class:`Session`
"""
sessions = self._sessions
attached_sessions = list()
for session in sessions:
if 'session_attached' in session:
# for now session_active is a unicode
if session.attached == '1':
logger.debug('session %s attached', session.name)
attached_sessions.append(session)
else:
continue
return [
Session(server=self, **s) for s in attached_sessions
] or None
def has_session(self, target_session, exact=True):
"""Return True if session exists. ``$ tmux has-session``.
:param target_session: session name
:type target_session: str
:param exact: match the session name exactly.
tmux uses fnmatch by default. Internally prepends ``=`` to the
session in ``$ tmux has-session``. tmux 2.1 and up only.
:type exact: bool
:raises: :exc:`exc.BadSessionName`
:rtype: bool
"""
session_check_name(target_session)
if exact and has_gte_version('2.1'):
target_session = '={}'.format(target_session)
proc = self.cmd('has-session', '-t%s' % target_session)
if not proc.stdout:
return True
if any(
x in proc.stdout for x in
['failed to connect to server', 'error connecting to']
):
return False
elif 'no server running' in proc.stdout: # tmux 2.0
return False
elif 'can\'t find session' in proc.stdout: # tmux 2.1
return False
elif 'bad session name' in proc.stdout: # tmux >= 1.9
return False
elif 'session not found' in proc.stdout:
return False
else:
return True
def kill_server(self):
"""``$ tmux kill-server``."""
self.cmd('kill-server')
def kill_session(self, target_session=None):
"""Kill the tmux session with ``$ tmux kill-session``, return ``self``.
:param: target_session: str. note this accepts ``fnmatch(3)``. 'asdf'
will kill 'asdfasd'.
:raises: :exc:`exc.BadSessionName`
:rtype: :class:`Server`
"""
session_check_name(target_session)
proc = self.cmd('kill-session', '-t%s' % target_session)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
return self
def switch_client(self, target_session):
"""``$ tmux switch-client``.
:param: target_session: str. name of the session. fnmatch(3) works.
:raises: :exc:`exc.BadSessionName`
"""
session_check_name(target_session)
proc = self.cmd('switch-client', '-t%s' % target_session)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
def attach_session(self, target_session=None):
"""``$ tmux attach-session`` aka alias: ``$ tmux attach``.
:param: target_session: str. name of the session. fnmatch(3) works.
:raises: :exc:`exc.BadSessionName`
"""
session_check_name(target_session)
tmux_args = tuple()
if target_session:
tmux_args += ('-t%s' % target_session,)
proc = self.cmd('attach-session', *tmux_args)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
def new_session(self,
session_name=None,
kill_session=False,
attach=False,
start_directory=None,
*args,
**kwargs):
"""Return :class:`Session` from ``$ tmux new-session``.
Uses ``-P`` flag to print session info, ``-F`` for return formatting
returns new Session object.
``$ tmux new-session -d`` will create the session in the background
``$ tmux new-session -Ad`` will move to the session name if it already
exists. todo: make an option to handle this.
:param session_name: session name::
$ tmux new-session -s <session_name>
:type session_name: str
:param attach: create session in the foreground. ``attach=False`` is
equivalent to::
$ tmux new-session -d
:type attach: bool
:param kill_session: Kill current session if ``$ tmux has-session``
Useful for testing workspaces.
:type kill_session: bool
:param start_directory: specifies the working directory in which the
new session is created.
:type start_directory: str
:raises: :exc:`exc.BadSessionName`
:rtype: :class:`Session`
"""
session_check_name(session_name)
if self.has_session(session_name):
if kill_session:
self.cmd('kill-session', '-t%s' % session_name)
logger.info('session %s exists. killed it.' % session_name)
else:
raise exc.TmuxSessionExists(
'Session named %s exists' % session_name
)
logger.debug('creating session %s' % session_name)
sformats = formats.SESSION_FORMATS
tmux_formats = ['#{%s}' % f for f in sformats]
env = os.environ.get('TMUX')
if env:
del os.environ['TMUX']
tmux_args = (
'-s%s' % session_name,
'-P', '-F%s' % '\t'.join(tmux_formats), # output
)
if not attach:
tmux_args += ('-d',)
if start_directory:
tmux_args += ('-c', start_directory)
# tmux 2.6 gives unattached sessions a tiny default area
# no need send in -x/-y if they're in a client already, though
if has_gte_version('2.6') and 'TMUX' not in os.environ:
tmux_args += ('-x', 800, '-y', 600)
proc = self.cmd(
'new-session',
*tmux_args
)
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
session = proc.stdout[0]
if env:
os.environ['TMUX'] = env
# combine format keys with values returned from ``tmux list-windows``
session = dict(zip(sformats, session.split('\t')))
# clear up empty dict
session = dict((k, v) for k, v in session.items() if v)
session = Session(server=self, **session)
return session
|