-
Notifications
You must be signed in to change notification settings - Fork 104
/
common.py
443 lines (329 loc) · 13.4 KB
/
common.py
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
# -*- coding: utf-8 -*-
"""Helper methods and mixins.
libtmux.common
~~~~~~~~~~~~~~
"""
import collections
import logging
import os
import re
import subprocess
from distutils.version import StrictVersion
from . import exc
from ._compat import console_to_str
logger = logging.getLogger(__name__)
class EnvironmentMixin(object):
"""Mixin class for managing session and server level environment
variables in tmux.
"""
_add_option = None
def __init__(self, add_option=None):
self._add_option = add_option
def set_environment(self, name, value):
"""Set environment ``$ tmux set-environment <name> <value>``.
:param name: the environment variable name. such as 'PATH'.
:type option: string
:param value: environment value.
:type value: string
"""
args = ['set-environment']
if self._add_option:
args += [self._add_option]
args += [name, value]
proc = self.cmd(*args)
if proc.stderr:
if isinstance(proc.stderr, list) and len(proc.stderr) == int(1):
proc.stderr = proc.stderr[0]
raise ValueError('tmux set-environment stderr: %s' % proc.stderr)
def unset_environment(self, name):
"""Unset environment variable ``$ tmux set-environment -u <name>``.
:param name: the environment variable name. such as 'PATH'.
:type option: string
"""
args = ['set-environment']
if self._add_option:
args += [self._add_option]
args += ['-u', name]
proc = self.cmd(*args)
if proc.stderr:
if isinstance(proc.stderr, list) and len(proc.stderr) == int(1):
proc.stderr = proc.stderr[0]
raise ValueError('tmux set-environment stderr: %s' % proc.stderr)
def remove_environment(self, name):
"""Remove environment variable ``$ tmux set-environment -r <name>``.
:param name: the environment variable name. such as 'PATH'.
:type option: string
"""
args = ['set-environment']
if self._add_option:
args += [self._add_option]
args += ['-r', name]
proc = self.cmd(*args)
if proc.stderr:
if isinstance(proc.stderr, list) and len(proc.stderr) == int(1):
proc.stderr = proc.stderr[0]
raise ValueError('tmux set-environment stderr: %s' % proc.stderr)
def show_environment(self, name=None):
"""Show environment ``$tmux show-environment -t [session] <name>``.
Return dict of environment variables for the session or the value of a
specific variable if the name is specified.
:param name: the environment variable name. such as 'PATH'.
:type option: string
"""
tmux_args = ['show-environment']
if self._add_option:
tmux_args += [self._add_option]
if name:
tmux_args += [name]
vars = self.cmd(*tmux_args).stdout
vars = [tuple(item.split('=', 1)) for item in vars]
vars_dict = {}
for t in vars:
if len(t) == 2:
vars_dict[t[0]] = t[1]
elif len(t) == 1:
vars_dict[t[0]] = True
else:
raise ValueError('unexpected variable %s', t)
if name:
return vars_dict.get(name)
return vars_dict
class tmux_cmd(object):
""":term:`tmux(1)` command via :py:mod:`subprocess`.
Usage::
proc = tmux_cmd('new-session', '-s%' % 'my session')
if proc.stderr:
raise exc.LibTmuxException(
'Command: %s returned error: %s' % (proc.cmd, proc.stderr)
)
print('tmux command returned %s' % proc.stdout)
Equivalent to:
.. code-block:: bash
$ tmux new-session -s my session
:versionchanged: 0.8
Renamed from ``tmux`` to ``tmux_cmd``.
"""
def __init__(self, *args, **kwargs):
cmd = [which('tmux')]
cmd += args # add the command arguments to cmd
cmd = [str(c) for c in cmd]
self.cmd = cmd
try:
self.process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
self.process.wait()
stdout = self.process.stdout.read()
self.process.stdout.close()
stderr = self.process.stderr.read()
self.process.stderr.close()
except Exception as e:
logger.error(
'Exception for %s: \n%s' % (
subprocess.list2cmdline(cmd),
e
)
)
self.stdout = console_to_str(stdout)
self.stdout = self.stdout.split('\n')
self.stdout = list(filter(None, self.stdout)) # filter empty values
self.stderr = console_to_str(stderr)
self.stderr = self.stderr.split('\n')
self.stderr = list(filter(None, self.stderr)) # filter empty values
if 'has-session' in cmd and len(self.stderr):
if not self.stdout:
self.stdout = self.stderr[0]
logging.debug('self.stdout for %s: \n%s' %
(' '.join(cmd), self.stdout))
class TmuxMappingObject(collections.MutableMapping):
"""Base: :py:class:`collections.MutableMapping`.
Convenience container. Base class for :class:`Pane`, :class:`Window`,
:class:`Session` and :class:`Server`.
Instance attributes for useful information :term:`tmux(1)` uses for
Session, Window, Pane, stored :attr:`self._info`. For example, a
:class:`Window` will have a ``window_id`` and ``window_name``.
================ ================================== ==============
Object formatter_prefix value
================ ================================== ==============
:class:`Server` n/a n/a
:class:`Session` :attr:`Session.formatter_prefix` session\_
:class:`Window` :attr:`Window.formatter_prefix` window\_
:class:`Pane` :attr:`Pane.formatter_prefix` pane\_
================ ================================== ==============
"""
def __getitem__(self, key):
return self._info[key]
def __setitem__(self, key, value):
self._info[key] = value
self.dirty = True
def __delitem__(self, key):
del self._info[key]
self.dirty = True
def keys(self):
"""Return list of keys."""
return self._info.keys()
def __iter__(self):
return self._info.__iter__()
def __len__(self):
return len(self._info.keys())
def __getattr__(self, key):
try:
return self._info[self.formatter_prefix + key]
except:
raise AttributeError('%s has no property %s' %
(self.__class__, key))
class TmuxRelationalObject(object):
"""Base Class for managing tmux object child entities. .. # NOQA
Manages collection of child objects (a :class:`Server` has a collection of
:class:`Session` objects, a :class:`Session` has collection of
:class:`Window`)
Children of :class:`TmuxRelationalObject` are going to have a
``self.children``, ``self.child_id_attribute``.
================ ========================= =================================
Object .children method
================ ========================= =================================
:class:`Server` :attr:`Server._sessions` :meth:`Server.list_sessions`
:class:`Session` :attr:`Sessions._windows` :meth:`Session.list_windows`
:class:`Window` :attr:`Windows._panes` :meth:`Window.list_panes`
:class:`Pane` n/a n/a
================ ========================= =================================
================ ================================== ==============
Object child_id_attribute value
================ ================================== ==============
:class:`Server` :attr:`Server.child_id_attribute` session_id
:class:`Session` :attr:`Session.child_id_attribute` window_id
:class:`Window` :attr:`Window.child_id_attribute` pane_id
:class:`Pane` n/a n/a
================ ================================== ==============
"""
def find_where(self, attrs):
"""Return object on first match.
:versionchanged: 0.4
Renamed from ``.findWhere`` to ``.find_where``.
"""
try:
return self.where(attrs)[0]
except IndexError:
return None
def where(self, attrs, first=False):
"""Return objects matching child objects properties.
:param attrs: tmux properties to match
:type attrs: dict
:rtype: list
"""
# from https://github.com/serkanyersen/underscore.py
def by(val, *args):
for key, value in attrs.items():
try:
if attrs[key] != val[key]:
return False
except KeyError:
return False
return True
if first:
return list(filter(by, self.children))[0]
else:
return list(filter(by, self.children))
def get_by_id(self, id):
"""Return object based on ``child_id_attribute``.
Based on `.get()`_ from `backbone.js`_.
.. _backbone.js: http://backbonejs.org/
.. _.get(): http://backbonejs.org/#Collection-get
:param id:
:type id: string
:rtype: object
"""
for child in self.children:
if child[self.child_id_attribute] == id:
return child
else:
continue
return None
def which(exe=None,
default_paths=[
'/bin', '/sbin', '/usr/bin', '/usr/sbin', '/usr/local/bin']
):
"""Return path of bin. Python clone of /usr/bin/which.
from salt.util - https://www.github.com/saltstack/salt - license apache
:param exe: Application to search PATHs for.
:type exe: string
:param default_path: Application to search PATHs for.
:type default_path: list
:rtype: string
"""
def _is_executable_file_or_link(exe):
# check for os.X_OK doesn't suffice because directory may executable
return (os.access(exe, os.X_OK) and
(os.path.isfile(exe) or os.path.islink(exe)))
if _is_executable_file_or_link(exe):
# executable in cwd or fullpath
return exe
# Enhance POSIX path for the reliability at some environments, when
# $PATH is changing. This also keeps order, where 'first came, first
# win' for cases to find optional alternatives
search_path = os.environ.get('PATH') and \
os.environ['PATH'].split(os.pathsep) or list()
for default_path in default_paths:
if default_path not in search_path:
search_path.append(default_path)
os.environ['PATH'] = os.pathsep.join(search_path)
for path in search_path:
full_path = os.path.join(path, exe)
if _is_executable_file_or_link(full_path):
return full_path
logger.info(
'\'{0}\' could not be found in the following search path: '
'\'{1}\''.format(exe, search_path))
return None
def is_version(version):
"""Return True if tmux version installed.
:param version: version, '1.8'
:param type: string
:rtype: bool
"""
proc = tmux_cmd('-V')
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
installed_version = proc.stdout[0].split('tmux ')[1]
return StrictVersion(installed_version) == StrictVersion(version)
def has_required_tmux_version(version=None):
"""Return if tmux meets version requirement. Version >1.8 or above.
:versionchanged: 0.1.7
Versions will now remove trailing letters per `Issue 55`_.
.. _Issue 55: https://github.com/tony/tmuxp/issues/55.
"""
if not version:
proc = tmux_cmd('-V')
if proc.stderr:
if proc.stderr[0] == 'tmux: unknown option -- V':
raise exc.LibTmuxException(
'libtmux supports tmux 1.8 and greater. This system'
' is running tmux 1.3 or earlier.')
raise exc.LibTmuxException(proc.stderr)
version = proc.stdout[0].split('tmux ')[1]
version = re.sub(r'[a-z]', '', version)
if StrictVersion(version) <= StrictVersion("1.7"):
raise exc.LibTmuxException(
'libtmux only supports tmux 1.8 and greater. This system'
' has %s installed. Upgrade your tmux to use libtmux.' % version
)
return version
def session_check_name(session_name):
"""Raises exception session name invalid, modeled after tmux function.
tmux(1) session names may not be empty, or include periods or colons.
These delimiters are reserved for noting session, window and pane.
:param session_name: name of session
:type session_name: string
:returns: void
:raises: :exc:`exc.BadSessionName`
"""
if not session_name or len(session_name) == 0:
raise exc.BadSessionName("tmux session names may not be empty.")
elif '.' in session_name:
raise exc.BadSessionName(
"tmux session name \"%s\" may not contain periods.", session_name)
elif ':' in session_name:
raise exc.BadSessionName(
"tmux session name \"%s\" may not contain colons.", session_name)