param.py

"""! Module for parsing param files. """
 
 
class Composite:
 
   
   def __init__(self, file=None, label=None):
      self.label = label
      self._children = {}
 
      if file != None:
         if isinstance(file, str):
            with open(file) as f:
               firstLine = f.readline()
               fl = firstLine.split()
               if fl[0][-1] != '{':
                  raise Exception('This is not a valid parameter file.')
               else:
                  self.label = fl[0][:-1]
                  self.read(f)
         else:
            self.read(file)
 
   
   def read(self, file):
      line = file.readline()
      l = line.split()
      while line != '':
         if l[0][-1] == '{':
            # Composite (nested)
            if len(l) == 1:
               label = l[0][:-1]
               p = Composite(file, label)
               #p = Composite(file, l[0][:-1])
            else:
               raise Exception('Invalid syntax for a Composite element')
         elif l[0][-1] == '[':
            # Array item
            if len(l) == 1:
               # Multi-line Array
               label = l[0][:-1]
               p = Array(label, file, None)
               #p = Array(l[0][:-1], file, None)
            else:
               # Single line Array
               val = []
               if l[-1] == ']':
                  for i in range(1, len(l)-1):
                     val.append(getValue(l[i]))
                  p = Array(l[0][:-1], None, val)
               else:
                  for i in range(1,len(l)):
                     val.append(getValue(l[i]))
                  p = Array(l[0][:-1], file, val)
         elif l[0][-1] == '(':
            # Matrix item
            if len(l) == 1:
               label = l[0][:-1]
               p = Matrix(label, file)
               #p = Matrix(l[0][:-1], file)
            else:
               raise Exception('Invalid syntax for Matrix parameter')
         elif l[0] == '}':
            # End of this Composite (closing bracket)
            break
         else:
            # Parameter item
            if len(l) == 1:
               raise Exception('Invalid parameter file line')
            elif len(l) == 2:
               # Parameter with a single value
               label = l[0]
               p = Parameter(label, l[1])
               #p = Parameter(l[0], l[1])
            else:
               # Parameter with multiple values on a single line
               label = l[0]
               val = []
               for i in range(1, len(l)):
                  val.append(getValue(l[i]))
               p = Parameter(label, val)
               #p = Parameter(l[0], val)
         self.addChild(p)
         line = file.readline()
         l = line.split()
      # end while loop
 
   
   def addChild(self, child):
      label = child.label
      if (label == 'label') or (label == '_children'):
         raise Exception('Illegal parameter file label')
      if label in self._children:
         current = self._children[label]
         if not isinstance(current, list):
            self._children[label] = [current]
         self._children[label].append(child)
      else:
         self._children[label] = child
 
   
   def getChildren(self):
      return self._children
 
   
   def __str__(self):
      return self.getString()
 
   
   def __getattr__(self, attr):
      if attr == '_children' :
         # This is needed to prevent infinite recursion before
         # self._children has been given an initial value of {}.
         return {}
      if attr in self._children:
         if isinstance(self._children[attr], list):
            return self._children[attr]
         else:
            return self._children[attr].returnData()
      else:
         raise AttributeError     
 
   
   def __setattr__(self, label, val):
      if label in self._children:
         self._children[label].setValue(val)
      else:
         super(Composite, self).__setattr__(label, val)
 
   
   def getString(self, depth=''):
      s = depth + self.label + '{' + '\n'
      for item in self._children.values():
         if isinstance(item, list):
            for i in range(len(item)):
               s += item[i].getString(depth+'  ')
         else:
            s += item.getString(depth+'  ')
      s += depth + '}\n'
      return s
 
   
   def write(self, filename):
      with open(filename, 'w') as f:
         f.write(self.getString())
 
   
   def returnData(self):
      return self
 
 
class Parameter:
 
   
   def __init__(self, label, val):
      self.label = label
      if isinstance(val, list):
         self.val = val
      else:
         self.val = getValue(val)
 
   
   def setValue(self, val):
      if isinstance(val, list):
         if val[0] is list:
            raise Exception('Not valid input for Parameter.')
         self.val = []
         for i in range(len(val)):
            self.val.append(getValue(str(val[i])))
      else:
         self.val = getValue(str(val))
 
   
   def __str__(self):
      return self.getString()
 
   
   def getString(self, depth=''):
      s = ''
      if isinstance(self.val, list):
         s += depth + f'{self.label:40}'
         s += f'{self.val[0]:>6}'
         for i in range(1, len(self.val)):
            s += f'{self.val[i]:>7}'
         s += '\n'
      else:
         s += depth + f'{self.label:20}'
         if isinstance(self.val, float):
            v = f'{self.val:.12e}'
            s += f'{v:>20}\n'
         else:
            s += f'{self.val:>20}\n'
      return s
 
   
   def returnData(self):
      return self.val
 
 
class Array:
 
   
   def __init__(self, label, file, val=None):
      self.label = label
      if val == None:
         self.val = []
      else:
         self.val = val
      if file != None:
         self.read(file)
 
   
   def read(self, file):
      line = file.readline()
      l = line.split()
      while l[0] != ']':
         # Process a line
         if len(l) == 1:
            # Single value
            self.val.append(getValue(l[0]))
         else:
            # Multiple space-separated values on one line
            ls = []
            for i in range(len(l)):
               ls.append(getValue(l[i]))
            self.val.append(ls)
         # Read and split the next line
         line = file.readline()
         l = line.split()
 
   
   def __str__(self):
      return self.getString()
 
   
   def getString(self, depth=''):
      s = ''
      s += depth + self.label + '[' + '\n'
      if not isinstance(self.val[0], list):
         # Elements with a single value
         for i in range(len(self.val)):
            if isinstance(self.val[i], float):
               v = f'{self.val[i]:.12e}'
               s += depth + f'{v:>40}\n'
            else:
               s += depth + f'{self.val[i]:>40}\n'
      else:
         # Elements with a list of values
         if isinstance(self.val[0][0], int) & (len(self.val[0]) == 2):
            for i in range(len(self.val)):
               v = f'{self.val[i][1]:.12e}'
               s += depth + f'{self.val[i][0]:>41}{v:>22}\n'
         else:
            for i in range(len(self.val)):
               s += depth + f'{self.val[i][0]:^20}'
               for j in range(1, len(self.val[0])):
                  if j == (len(self.val[0])-1):
                     if self.val[i][j] < 0:
                        v = f'{self.val[i][j]:.11e}'
                     else:
                        v = f'{self.val[i][j]:.12e}'
                     s += f'{v:>22}\n'
                  elif j == 1:
                     s += f'{self.val[i][j]}'
                  else:
                     s += f'{self.val[i][j]:>5}'
      s += depth + ']\n'
      return s
 
   
   def returnData(self):
      return self.val
 
   
   def setValue(self, val):
      if not isinstance(val, list):
         raise Exception('Value of an Array must be a list')
      else:
         v = []
         if isinstance(val[0], list):
            same = True
            for i in range(len(val)):
               if len(val[i]) != 1:
                  same = False
                  break
            if same == True:
               for i in range(len(val)):
                  v.append(getValue(str(val[i][0])))
            else:
               for i in range(len(val)):
                  v.append([])
                  for j in range(len(val[i])):
                     v[i].append(getValue(str(val[i][j])))
         else:
            for i in range(len(val)):
               v.append(getValue(str(val[i])))
         self.val = v
 
 
class Matrix:
 
   
   def __init__(self, label, file):
      self.label = label
      self.val = []
      self.read(file)
 
   
   def read(self, file):
      att = []
      line = file.readline()
      l = line.split()
      while l[0] != ')':
         att.append(l)
         line = file.readline()
         l = line.split()
      rowMax = att[0][0]
      colMax = att[0][1]
      for i in range(1, len(att)):
         if att[i][0] > rowMax:
            rowMax = att[i][0]
         if att[i][1] > colMax:
            colMax = att[i][1]
      size = int(max(rowMax, colMax))+1
      for i in range(0, size):
         self.val.append([])
         for j in range(0, size):
            self.val[i].append(getValue('0'))
      for i in range(0, len(att)):
         self.val[int(att[i][0])][int(att[i][1])] = getValue(att[i][2])
         self.val[int(att[i][1])][int(att[i][0])] = getValue(att[i][2])
 
   
   def __str__(self):
      return self.getString()
 
   
   def getString(self, depth=''):
      s = ''
      s += depth + self.label + '(\n'
      for i in range(len(self.val)):
         for j in range(i+1):
            s += depth + f'{i:>24}{j:>5}   ' + f'{self.val[i][j]:.12e}\n'
      s += depth + ')\n'
      return s
 
   
   def returnData(self):
      return self.val
 
   
   def setValue(self, val):
      if not isinstance(val, list):
         raise TypeError('This is not a valid value for Matrix.')
      else:
         if isinstance(val[0], list): 
            # Input value is a matrix
            if len(val) != len(val[0]):
               raise Exception('Input Matrix should be square')
            for i in range(len(val)):
               for j in range(i):
                  if val[i][j] != val[j][i]:
                     raise Exception('This is not a symmetric Matrix.')
            for i in range(len(val)):
               if val[i][i] != 0:
                  raise Exception('The diagonal of the Matrix should all be zero.')
            self.val = []
            for i in range(len(val)):
               self.val.append([])
               for j in range(len(val[0])):
                  self.val[i].append(getValue(str(val[i][j])))
         else: 
            # Input value is a list in format: [x-index, y-index, value]
            if len(val) != 3:
               raise Exception('Not valid input format for Matrix modification.')
            elif (type(val[0]) != int) or (type(val[1]) != int) or ((type(val[-1]) != int) and (type(val[-1]) != float)):
               raise Exception('Not valid input format for Matrix modification.')
            self.val[val[0]][val[1]] = getValue(str(val[-1]))
            self.val[val[1]][val[0]] = getValue(str(val[-1]))
 
 
 
def getValue(v):
 
   if (v.isdigit() == True) or (v[0] == '-' and v[1:].isdigit() == True):
      val = int(v)
   else:
      try:
         val = float(v)
      except ValueError:
         val = str(v)
 
   return val