{{ message }}
Repository navigation
Expand file tree
/
Copy pathworkspacebuilder.py
More file actions
343 lines (246 loc) · 10.4 KB
/
Copy pathworkspacebuilder.py
File metadata and controls
343 lines (246 loc) · 10.4 KB
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
# -*- coding: utf8 -*-
"""Create a tmux workspace from a configuration :py:obj:`dict`.
tmuxp.workspacebuilder
~~~~~~~~~~~~~~~~~~~~~~
"""
from __future__ import absolute_import, division, print_function, \
with_statement, unicode_literals
import logging
from . import exc, Window, Pane, Session, Server
from .util import run_before_script
logger = logging.getLogger(__name__)
class WorkspaceBuilder(object):
"""Load workspace from session :py:obj:`dict`.
Build tmux workspace from a configuration. Creates and names windows, sets
options, splits windows into panes.
The normal phase of loading is:
1. :term:`kaptan` imports json/yaml/ini. ``.get()`` returns python
:class:`dict`::
import kaptan
sconf = kaptan.Kaptan(handler='yaml')
sconf = sconfig.import_config(self.yaml_config).get()
or from config file with extension::
import kaptan
sconf = kaptan.Kaptan()
sconf = sconfig.import_config('path/to/config.yaml').get()
kaptan automatically detects the handler from filenames.
2. :meth:`config.expand` sconf inline shorthand::
from tmuxp import config
sconf = config.expand(sconf)
3. :meth:`config.trickle` passes down default values from session
-> window -> pane if applicable::
sconf = config.trickle(sconf)
4. (You are here) We will create a :class:`Session` (a real
``tmux(1)`` session) and iterate through the list of windows, and
their panes, returning full :class:`Window` and :class:`Pane`
objects each step of the way::
workspace = WorkspaceBuilder(sconf=sconf)
It handles the magic of cases where the user may want to start
a session inside tmux (when `$TMUX` is in the env variables).
"""
def __init__(self, sconf, server=None):
"""Initialize workspace loading.
:todo: initialize :class:`Session` from here, in ``self.session``.
:param sconf: session config, includes a :py:obj:`list` of ``windows``.
:type sconf: :py:obj:`dict`
:param server:
:type server: :class:`Server`
"""
if not sconf:
raise exc.EmptyConfigException('session configuration is empty.')
# config.validate_schema(sconf)
if isinstance(server, Server):
self.server = server
else:
self.server = None
self.sconf = sconf
def build(self, session=None):
"""Build tmux workspace in session.
Optionally accepts ``session`` to build with only session object.
Without ``session``, it will use :class:`Server` at ``self.server``
passed in on initialization to create a new Session object.
:param session: - session to build workspace in
:type session: :class:`Session`
"""
if not session:
if not self.server:
raise exc.TmuxpException(
'WorkspaceBuilder.build requires server to be passed ' +
'on initialization, or pass in session object to here.'
)
if self.server.has_session(self.sconf['session_name']):
self.session = self.server.findWhere(
{
'session_name': self.sconf['session_name']
}
)
raise exc.TmuxSessionExists(
'Session name %s is already running.' %
self.sconf['session_name']
)
else:
session = self.server.new_session(
session_name=self.sconf['session_name']
)
assert(self.sconf['session_name'] == session.get('session_name'))
assert(len(self.sconf['session_name']) > 0)
self.session = session
self.server = session.server
self.server._list_sessions()
assert self.server.has_session(session.get('session_name'))
assert session.get('session_id')
assert(isinstance(session, Session))
focus = None
if 'before_script' in self.sconf:
try:
run_before_script(self.sconf['before_script'])
except Exception as e:
self.session.kill_session()
raise(e)
if 'environment' in self.sconf:
for option, value in self.sconf['environment'].items():
self.session.set_environment(option, value)
for w, wconf in self.iter_create_windows(session):
assert(isinstance(w, Window))
focus_pane = None
for p, pconf in self.iter_create_panes(w, wconf):
assert(isinstance(p, Pane))
p = p
if 'layout' in wconf:
w.select_layout(wconf['layout'])
if 'focus' in pconf and pconf['focus']:
focus_pane = p
if 'focus' in wconf and wconf['focus']:
focus = w
if focus_pane:
focus_pane.select_pane()
if focus:
focus.select_window()
def iter_create_windows(self, s):
"""Return :class:`Window` iterating through session config dict.
Generator yielding :class:`Window` by iterating through
``sconf['windows']``.
Applies ``window_options`` to window.
:param session: :class:`Session` from the config
:rtype: tuple(:class:`Window`, ``wconf``)
"""
for i, wconf in enumerate(self.sconf['windows'], start=1):
if 'window_name' not in wconf:
window_name = None
else:
window_name = wconf['window_name']
w1 = None
if i == int(1): # if first window, use window 1
w1 = s.attached_window()
w1.move_window(99)
pass
if 'start_directory' in wconf:
sd = wconf['start_directory']
else:
sd = None
w = s.new_window(
window_name=window_name,
start_directory=sd,
attach=False, # do not move to the new window
window_index=wconf.get('window_index', ''),
)
if i == int(1) and w1: # if first window, use window 1
w1.kill_window()
assert(isinstance(w, Window))
s.server._update_windows()
if 'options' in wconf and isinstance(wconf['options'], dict):
for key, val in wconf['options'].items():
w.set_window_option(key, val)
if 'focus' in wconf and wconf['focus']:
w.select_window()
s.server._update_windows()
yield w, wconf
def iter_create_panes(self, w, wconf):
"""Return :class:`Pane` iterating through window config dict.
Run ``shell_command`` with ``$ tmux send-keys``.
:param w: window to create panes for
:type w: :class:`Window`
:param wconf: config section for window
:type wconf: :py:obj:`dict`
:rtype: tuple(:class:`Pane`, ``pconf``)
"""
assert(isinstance(w, Window))
pane_base_index = int(w.show_window_option('pane-base-index', g=True))
for pindex, pconf in enumerate(wconf['panes'], start=pane_base_index):
if pindex == int(pane_base_index):
p = w.attached_pane()
else:
def get_pane_start_directory():
if 'start_directory' in pconf:
return pconf['start_directory']
elif 'start_directory' in wconf:
return wconf['start_directory']
else:
return None
p = w.split_window(
attach=True,
start_directory=get_pane_start_directory(),
)
assert(isinstance(p, Pane))
assert(int(p.get('pane_index')) == int(pindex))
if 'layout' in wconf:
w.select_layout(wconf['layout'])
for cmd in pconf['shell_command']:
p.send_keys(cmd)
if 'focus' in pconf and pconf['focus']:
w.select_pane(p['pane_id'])
w.server._update_panes()
yield p, pconf
def freeze(session):
"""Freeze live tmux session and Return session config :py:obj:`dict`.
:param session: session object
:type session: :class:`Session`
:rtype: dict
"""
sconf = {}
sconf['session_name'] = session['session_name']
sconf['windows'] = []
for w in session.windows:
wconf = {}
wconf['options'] = w.show_window_options()
wconf['window_name'] = w.get('window_name')
wconf['layout'] = w.get('window_layout')
wconf['panes'] = []
if w.get('window_active', '0') == '1':
wconf['focus'] = 'true'
# If all panes have same path, set 'start_directory' instead
# of using 'cd' shell commands.
pane_has_same_path = lambda p: (
w.panes[0].get('pane_current_path') ==
p.get('pane_current_path')
)
if (all(pane_has_same_path(p) for p in w.panes)):
wconf['start_directory'] = w.panes[0].get('pane_current_path')
for p in w.panes:
pconf = {}
pconf['shell_command'] = []
if 'start_directory' not in wconf:
pconf['shell_command'].append(
'cd ' + p.get('pane_current_path')
)
if p.get('pane_active', '0') == '1':
pconf['focus']='true'
current_cmd = p.get('pane_current_command')
def filter_interpretters_and_shells():
return (
current_cmd.startswith('-') or
any(
current_cmd.endswith(cmd)
for cmd in ['python', 'ruby', 'node']
)
)
if (filter_interpretters_and_shells()):
current_cmd = None
if current_cmd:
pconf['shell_command'].append(current_cmd)
else:
if not len(pconf['shell_command']):
pconf = 'pane'
wconf['panes'].append(pconf)
sconf['windows'].append(wconf)
return sconf
You can’t perform that action at this time.