Merge pull request #145 from ikirudennis/new-window-command

Add new-window command functionality

Author: tony

tmuxp/session.py

@@ -124,7 +124,8 @@ def new_window(self,
                    window_name=None,
                    start_directory=None,
                    attach=True,
-                   window_index=''):
+                   window_index='',
+                   window_shell=None):
         """Return :class:`Window` from ``$ tmux new-window``.
 
         .. note::
@@ -144,6 +145,16 @@ def new_window(self,
         :type start_directory: string
         :param attach: make new window the current window after creating it,
                        default True.
+        :param window_index: create the new window at the given index position.
+            Default is empty string which will create the window in the next
+            available position.
+        :type window_index: string
+        :param window_shell: execute a command on starting the window.  The
+            window will close when the command exits.
+            NOTE: When this command exits the window will close.  This feature
+            is useful for long-running processes where the closing of the
+            window upon completion is desired.
+        :type window_command: string
         :param type: bool
         :rtype: :class:`Window`
 
@@ -177,6 +188,9 @@ def new_window(self,
             '-t%s:%s' % (self.get('session_id'), window_index),
         )
 
+        if window_shell:
+            window_args += (window_shell,)
+
         proc = self.cmd('new-window', *window_args)
 
         if proc.stderr:

tmuxp/testsuite/workspacebuilder.py

@@ -311,6 +311,39 @@ def test_window_options(self):
             window_count += 1
             w.select_layout(wconf['layout'])
 
+    def test_window_shell(self):
+        yaml_config = """
+        session_name: test window options
+        start_directory: '~'
+        windows:
+        - layout: main-horizontal
+          options:
+            main-pane-height: 5
+          panes:
+          - pane
+          - pane
+          - pane
+          window_name: editor
+          window_shell: top
+        """
+        s = self.session
+        sconfig = kaptan.Kaptan(handler='yaml')
+        sconfig = sconfig.import_config(yaml_config).get()
+        sconfig = config.expand(sconfig)
+
+        builder = WorkspaceBuilder(sconf=sconfig)
+
+        for w, wconf in builder.iter_create_windows(s):
+            if 'window_shell' in wconf:
+                self.assertEqual(wconf['window_shell'], text_type('top'))
+            for i in range(10):
+                self.session.server._update_windows()
+                if w['window_name'] != 'top':
+                    break
+                time.sleep(.2)
+
+            self.assertNotEqual(w.get('window_name'), text_type('top'))
+
 
 class EnvironmentVariables(TmuxTestCase):
 
@@ -337,7 +370,7 @@ def test_environment_variables(self):
 
         self.assertEqual('BAR', self.session.show_environment('FOO'))
         self.assertEqual('/tmp', self.session.show_environment('PATH'))
-        
+
 class WindowAutomaticRename(TmuxTestCase):
 
     yaml_config = """

tmuxp/window.py

@@ -62,7 +62,13 @@ def by(val, *args):
                     return False
                 return True
 
-        return list(filter(by, self.server._windows))[0]
+        ret = list(filter(by, self.server._windows))
+        # If a window_shell option was configured which results in
+        # a short-lived process, the window id is @0.  Use that instead of
+        # self._window_id
+        if len(ret) == 0 and self.server._windows[0]['window_id'] == '@0':
+            ret = self.server._windows
+        return ret[0]
 
     def cmd(self, cmd, *args, **kwargs):
         """Return :meth:`Server.cmd` defaulting ``target_window`` as target.

tmuxp/workspacebuilder.py

@@ -199,11 +199,17 @@ def iter_create_windows(self, s):
             else:
                 sd = None
 
+            if 'window_shell' in wconf:
+                ws = wconf['window_shell']
+            else:
+                ws = 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', ''),
+                window_shell=ws,
             )
 
             if i == int(1) and w1:  # if first window, use window 1