added parameters :)

Author: fmauch

etc/example_session.yaml

@@ -3,13 +3,17 @@ common:
   before_commands:
     - fzirob change_environment # before commands can be specified global and per window
   default_window: README # This window will be visible when first attaching to the session
+parameters:
+  show_layouts: false
+  replacement_param: world\!
 windows:
   - name: roscore
     splits:
       - commands:
         - roscore
     delay: 1 # Use this to wait before starting the next window
   - name: tiled
+    if: show_layouts
     layout: tiled
     splits:
       - commands:
@@ -24,13 +28,15 @@ windows:
       - commands:
         - echo "4"
   - name: left-right
+    if: show_layouts
     layout: even-vertical
     splits:
       - commands:
         - echo "left"
       - commands:
         - echo "right"
   - name: top-bottom
+    if: show_layouts
     layout: even-horizontal
     splits:
       - commands:
@@ -42,8 +48,9 @@ windows:
       - clear && tput bold && tput setaf 6 && roscat catmux readme_tmux.txt
       - tput sgr0
   - name: no_split
+    unless: show_layouts
     # If just one split is desired, just skip it
     commands:
-      - echo "hello"
+      - echo "hello ${replacement_param}"
 
 

script/create_session

@@ -49,6 +49,10 @@ def parse_arguments(debug=False):
                         help="This config will be used for the tmux session")
     parser.add_argument('-d', '--detach', action='store_true',
                         help="Start session in detached mode")
+    parser.add_argument('--overwrite',
+                        help="Overwrite a parameter from the session config. Parameters can be "
+                             "specified using a comma-separated list such as '--overwrite "
+                             "param_a=1,param_b=2'.")
 
     args = parser.parse_args()
     if debug:
@@ -60,7 +64,7 @@ def main():
     """Creates a new tmux session if it does not yet exist"""
     args = parse_arguments()
 
-    session_config = CatmuxSession()
+    session_config = CatmuxSession(args.overwrite)
     session_config.init_from_filepath(args.session_config)
 
     try:

src/catmux/session.py

@@ -21,8 +21,9 @@
 """Contains everything around the config file"""
 from __future__ import print_function
 
-
+import re
 import yaml
+
 from window import Window
 import tmux_wrapper as tmux
 
@@ -31,10 +32,12 @@ class Session(object):
 
     """Parser for a config yaml file"""
 
-    def __init__(self):
+    def __init__(self, runtime_params=None):
         """TODO: to be defined1. """
 
         self._common = dict()
+        self._parameters = dict()
+        self._runtime_params = self._parse_overwrites(runtime_params)
         self._windows = list()
         self.__yaml_data = None
 
@@ -54,9 +57,10 @@ def init_from_yaml(self, yaml_data):
 
         self.__yaml_data = yaml_data
         self._parse_common()
+        self._parse_parameters()
         self._parse_windows()
 
-    def run(self):
+    def run(self, debug=False):
         """Runs the loaded session"""
         if len(self._windows) == 0:
             print('No windows to run found')
@@ -65,6 +69,8 @@ def run(self):
         first = True
         for window in self._windows:
             window.create(first)
+            if debug:
+                window.debug()
             first = False
 
         if 'default_window' in self._common:
@@ -79,13 +85,84 @@ def _parse_common(self):
         if 'common' in self.__yaml_data:
             self._common = self.__yaml_data['common']
 
+    def _parse_overwrites(self, data_string):
+        """Separates a comma-separated list of foo=val1,bar=val2 into a dictionary."""
+        if data_string is None:
+            return None
+
+        overwrites = dict()
+        param_list = data_string.split(',')
+        for param in param_list:
+            key, value = param.split('=')
+            overwrites[key] = value
+
+        return overwrites
+
+    def _parse_parameters(self):
+        if self.__yaml_data is None:
+            print('parse_parameters was called without yaml data loaded.')
+            raise RuntimeError
+        if 'parameters' in self.__yaml_data:
+            self._parameters = self.__yaml_data['parameters']
+
+        print('Parameters found in session config:')
+        print(' - ' + '\n - '.join('{} = {}'.format(key, value)
+                                   for key, value in self._parameters.items()))
+        if self._runtime_params:
+            print('Parameters found during runtime (overwrites):')
+            print(' - ' + '\n - '.join('{} = {}'.format(key, value)
+                                       for key, value in self._runtime_params.items()))
+            # Overwrite parameters given from command line
+            self._parameters.update(self._runtime_params)
+
+
+        self._replace_parameters(self.__yaml_data)
+
+    def _replace_parameters(self, data):
+        if isinstance(data, dict):
+            for key, value in data.items():
+                data[key] = self._replace_parameters(value)
+        elif isinstance(data, list):
+            for index, item in enumerate(data):
+                data[index] = self._replace_parameters(item)
+        elif isinstance(data, str):
+            for key, value in self._parameters.items():
+                if isinstance(value, str):
+                    # print('replacing {} in {}'.format(key, data))
+                    data = re.sub(r"\${%s}"%(key), value, data)
+        return data
+
+
     def _parse_windows(self):
         if self.__yaml_data is None:
             print('parse_windows was called without yaml data loaded.')
             raise RuntimeError
 
         if 'windows' in self.__yaml_data:
             for window in self.__yaml_data['windows']:
+                if 'if' in window:
+                    print('Detected of condition for window ' + window['name'])
+                    if window['if'] not in self._parameters:
+                        print('Skipping window ' + window['name'] + ' because parameter ' +
+                              window['if'] + ' was not found.')
+                        continue
+                    elif not self._parameters[window['if']]:
+                        print('Skipping window ' + window['name'] + ' because parameter ' +
+                              window['if'] + ' is switched off globally')
+                        continue
+                    else:
+                        print('condition fulfilled: {} == {}'
+                              .format(window['if'], self._parameters[window['if']]))
+                if 'unless' in window:
+                    print('Detected unless condition for window ' + window['name'])
+                    if self._parameters[window['unless']]:
+                        print('Skipping window ' + window['name'] + ' because parameter ' +
+                              window['unless'] + ' is switched on globally')
+                        continue
+                    else:
+                        print('condition fulfilled: {} == {}'
+                              .format(window['unless'], self._parameters[window['unless']]))
+
                 kwargs = dict()
                 if 'before_commands' in self._common:
                     kwargs['before_commands'] = self._common['before_commands']

src/catmux/tmux_wrapper.py

@@ -36,7 +36,7 @@ def tmux_call(command_list):
     """Executes a tmux command """
     tmux_cmd = ['tmux'] + command_list
 
-    print(' '.join(tmux_cmd))
+    # print(' '.join(tmux_cmd))
     _safe_call(tmux_cmd)
 
 def _safe_call(cmd_list):

src/catmux/window.py

@@ -48,8 +48,6 @@ def __init__(self, **kwargs):
             for key, value in kwargs.iteritems():
                 setattr(self, key, value)
 
-        self.debug()
-
 
     def debug(self):
         """Prints all information about this window"""