add opEdit to easily change parameter

op_edit.py

@@ -0,0 +1,220 @@
+#!/usr/bin/env python3
+from common.op_params import opParams
+import time
+import ast
+
+
+class opEdit:  # use by running `python /data/openpilot/op_edit.py`
+  def __init__(self):
+    self.op_params = opParams()
+    self.params = None
+    self.sleep_time = 1.0
+    self.live_tuning = False
+    self.welcome()
+
+  def welcome(self):
+    print('Welcome to the opParams command line editor!')
+    while True:
+      print('Would you like to enter opEdit\'s live-tuning mode?')
+      choice = input('[Y/n]: ').lower().strip()
+      if choice in ['y', 'ye', 'yes']:
+        self.live_tuning = True
+        self.run_loop()
+        break
+      elif choice in ['n', 'no', '']:
+        self.run_loop()
+        break
+      elif choice in ['e', 'exit']:
+        break
+
+  def run_loop(self):
+    if not self.live_tuning:
+      print('Here are your parameters:\n')
+    else:
+      print('Here are your live parameters:\n')
+    while True:
+      self.params = self.op_params.get(force_update=True)
+      if self.live_tuning:  # only display live tunable params
+        self.params = {k: v for k, v in self.params.items() if self.op_params.get_key_info(k).live}
+
+      values_list = [self.params[i] if len(str(self.params[i])) < 20 else '{} ... {}'.format(str(self.params[i])[:30], str(self.params[i])[-15:]) for i in self.params]
+      live = ['(live!)' if self.op_params.get_key_info(i).live else '' for i in self.params]
+
+      to_print = ['{}. {}: {}  {}'.format(idx + 1, i, values_list[idx], live[idx]) for idx, i in enumerate(self.params)]
+      to_print.append('\n{}. Add new parameter!'.format(len(self.params) + 1))
+      to_print.append('{}. Delete parameter!'.format(len(self.params) + 2))
+
+      print('\n'.join(to_print))
+      print('\nChoose a parameter to explore (by integer index): ')
+
+      choice = input('>> ').strip()
+      parsed, choice = self.parse_choice(choice)
+      if parsed == 'continue':
+        continue
+      elif parsed == 'add':
+        self.add_parameter()
+      elif parsed == 'change':
+        self.change_parameter(choice)
+      elif parsed == 'delete':
+        self.delete_parameter()
+      elif parsed == 'error':
+        return
+
+  def parse_choice(self, choice):
+    if choice.isdigit():
+      choice = int(choice)
+      choice -= 1
+    elif choice == '':
+      print('Exiting opEdit!')
+      return 'error', choice
+    else:
+      self.message('Not an integer!')
+      return 'retry', choice
+    if choice not in range(0, len(self.params) + 2):  # three for add/delete parameter
+      self.message('Not in range!')
+      return 'continue', choice
+
+    if choice == len(self.params):  # add new parameter
+      return 'add', choice
+
+    if choice == len(self.params) + 1:  # delete parameter
+      return 'delete', choice
+
+    return 'change', choice
+
+  def change_parameter(self, choice):
+    while True:
+      chosen_key = list(self.params)[choice]
+      key_info = self.op_params.get_key_info(chosen_key)
+
+      old_value = self.params[chosen_key]
+      print('Chosen parameter: {}'.format(chosen_key))
+
+      to_print = []
+      if key_info.has_description:
+        to_print.append('>>  Description: {}'.format(self.op_params.default_params[chosen_key]['description'].replace('\n', '\n  > ')))
+      if key_info.has_allowed_types:
+        allowed_types = self.op_params.default_params[chosen_key]['allowed_types']
+        to_print.append('>>  Allowed types: {}'.format(', '.join([str(i).split("'")[1] for i in allowed_types])))
+      if key_info.live:
+        to_print.append('>>  This parameter supports live tuning! Updates should take affect within 5 seconds.\n')
+
+      if to_print:
+        print('\n{}\n'.format('\n'.join(to_print)))
+
+      print('Current value: {} (type: {})'.format(old_value, str(type(old_value)).split("'")[1]))
+      if key_info.live or self.live_tuning:  # similar to opTune
+        while True:
+          print('Enter your new value:')
+          new_value = input('>> ').strip()
+          if new_value == '':
+            self.message('Exiting this parameter...')
+            return
+
+          new_value = self.parse_input(new_value)
+          if key_info.has_allowed_types and type(new_value) not in allowed_types:
+            self.message('The type of data you entered ({}) is not allowed with this parameter!'.format(str(type(new_value)).split("'")[1]))
+            continue
+
+          self.op_params.put(chosen_key, new_value)
+          print('Saved {} with value: {}! (type: {})\n'.format(chosen_key, new_value, str(type(new_value)).split("'")[1]))
+      else:
+        print('Enter your new value:')
+        new_value = input('>> ').strip()
+        if new_value == '':
+          self.message('Exiting this parameter...')
+          return
+
+        new_value = self.parse_input(new_value)
+        if key_info.has_allowed_types and type(new_value) not in allowed_types:
+          self.message('The type of data you entered ({}) is not allowed with this parameter!'.format(str(type(new_value)).split("'")[1]))
+          continue
+
+        print('\nOld value: {} (type: {})'.format(old_value, str(type(old_value)).split("'")[1]))
+        print('New value: {} (type: {})'.format(new_value, str(type(new_value)).split("'")[1]))
+        print('Do you want to save this?')
+        choice = input('[Y/n]: ').lower().strip()
+        if choice == 'y':
+          self.op_params.put(chosen_key, new_value)
+          self.message('Saved!')
+        else:
+          self.message('Not saved!')
+        return
+
+  def parse_input(self, dat):
+    dat = dat.strip()
+    try:
+      dat = ast.literal_eval(dat)
+    except:
+      if dat.lower() == 'none':
+        dat = None
+      elif dat.lower() == 'false':
+        dat = False
+      elif dat.lower() == 'true':  # else, assume string
+        dat = True
+    return dat
+
+  def delete_parameter(self):
+    while True:
+      print('Enter the name of the parameter to delete:')
+      key = input('>> ').lower()
+      key = self.parse_input(key)
+
+      if key == '':
+        return
+      if not isinstance(key, str):
+        self.message('Input must be a string!')
+        continue
+      if key not in self.params:
+        self.message("Parameter doesn't exist!")
+        continue
+
+      value = self.params.get(key)
+      print('Parameter name: {}'.format(key))
+      print('Parameter value: {} (type: {})'.format(value, str(type(value)).split("'")[1]))
+      print('Do you want to delete this?')
+
+      choice = input('[Y/n]: ').lower().strip()
+      if choice == 'y':
+        self.op_params.delete(key)
+        self.message('Deleted!')
+      else:
+        self.message('Not saved!')
+      return
+
+  def add_parameter(self):
+    while True:
+      print('Type the name of your new parameter:')
+      key = input('>> ').strip()
+      if key == '':
+        return
+
+      key = self.parse_input(key)
+
+      if not isinstance(key, str):
+        self.message('Input must be a string!')
+        continue
+
+      print("Enter the data you'd like to save with this parameter:")
+      value = input('>> ').strip()
+      value = self.parse_input(value)
+
+      print('Parameter name: {}'.format(key))
+      print('Parameter value: {} (type: {})'.format(value, str(type(value)).split("'")[1]))
+      print('Do you want to save this?')
+
+      choice = input('[Y/n]: ').lower().strip()
+      if choice == 'y':
+        self.op_params.put(key, value)
+        self.message('Saved!')
+      else:
+        self.message('Not saved!')
+      return
+
+  def message(self, msg):
+    print('--------\n{}\n--------'.format(msg), flush=True)
+    time.sleep(self.sleep_time)
+    print()
+
+
+opEdit()