Large additions to comments/docstrings. Reorganized location of opt parsing logic

Author: Nathan Lee

pyrunner/cli.py

@@ -31,7 +31,7 @@ def main():
   else:
     try:
       pyrunner = PyRunner()
-      pyrunner.parse_args(sys.argv)
+      pyrunner.parse_args()
       exit_status = pyrunner.execute()
     except ValueError as value_error:
       exit_status = 2
@@ -75,7 +75,7 @@ def main():
 def setup():
   print('\nINITIATING NEW PROJECT SETUP\n')
   app_name = input('Project Name (spaces will be removed): ')
-  app_name = app_name.replace(' ', '_')
+  app_name = app_name.replace(' ', '_').lower()
 
   if not app_name.strip():
     raise ValueError('Please provide project name')
@@ -89,7 +89,7 @@ def setup():
   elif len(app_path) > 1 and app_path[-1] == '/':
     app_path = app_path[:-1]
 
-  app_root = '{}/{}'.format(app_path, app_name.lower())
+  app_root = '{}/{}'.format(app_path, app_name)
 
   if os.path.isdir(app_root) or os.path.exists(app_root):
     raise OSError('{} already exists!'.format(app_root))
@@ -101,8 +101,8 @@ def setup():
       print('Invalid Input')
 
   print('\nSUMMARY:\n')
-  print('Project Name: {}'.format(app_name.lower()))
-  print('Project Path: {}/{}'.format(app_path, app_name.lower()))
+  print('Project Name: {}'.format(app_name))
+  print('Project Path: {}/{}'.format(app_path, app_name))
   print('Execution Mode: {}'.format(app_mode))
 
   input('\nPress ENTER if this is correct or Ctrl + C to Abort...\n')
@@ -144,17 +144,16 @@ def setup():
     app_profile.write('if [ ! -e ${APP_TEMP_DIR} ]; then mkdir ${APP_TEMP_DIR}; fi\n')
     app_profile.write('if [ ! -e ${APP_DATA_DIR} ]; then mkdir ${APP_DATA_DIR}; fi\n')
 
-  print('Creating Blank Process List File: {}/config/{}.lst'.format(app_root, app_name.lower()))
-  with open('{}/config/{}.lst'.format(app_root, app_name.lower()), 'w') as lst_file:
+  print('Creating Blank Process List File: {}/config/{}.lst'.format(app_root, app_name))
+  with open('{}/config/{}.lst'.format(app_root, app_name), 'w') as lst_file:
     if app_mode == 'SHELL': lst_file.write('{}\n\n'.format(constants.HEADER_SHELL))
     if app_mode == 'PYTHON': lst_file.write('{}\n\n'.format(constants.HEADER_PYTHON))
 
-  print('Creating Main Execution Script: {}/main.sh'.format(app_root))
-  with open('{}/{}.sh'.format(app_root, app_name), 'w') as main_file:
-    main_file.write('#!/bin/sh\n\n')
-    main_file.write('pyrunner -c {}/config/app_profile -l {}/config/{}.lst "$@"\n'.format('$(dirname ${0})', '$(dirname ${0})', app_name.lower()))
+  print('Creating Driver Program: {}/{}.py'.format(app_root, app_name))
+  with open('{}/{}.py'.format(app_root, app_name), 'w') as main_file:
+    main_file.write(constants.DRIVER_TEMPLATE)
 
-  os.chmod('{}/main.sh'.format(app_root), 0o744)
+  os.chmod('{}/{}.py'.format(app_root, app_name), 0o744)
 
   print('\nComplete!\n')
 

pyrunner/core/config.py

@@ -104,6 +104,21 @@ def __next__(self):
       return self._iter_keys.popleft()
 
   def __getitem__(self, key):
+    """
+    Emulates dictionry key get action.
+    
+    Emulates the act of getting a key in a dictionary structure. Most importantly,
+    keys in the Config object can receive it's value from one of multiple sources.
+    
+    The currently supported sources are: manually assigned values, environment variable
+    values, and hard-coded default values, with priority matching this order.
+    
+    Args:
+      key (str): The key name for which to return the value for.
+    
+    Raises:
+      KeyError: Given key is not valid for the Config object.
+    """
     detl = self._attr.get(key)
     if not detl:
       raise KeyError('Config object does not store key: {}'.format(key))
@@ -124,6 +139,20 @@ def __getitem__(self, key):
     return None
 
   def __setitem__(self, key, value):
+    """
+    Emulates dictionry key set action.
+    
+    Emulates the act of setting a key in a dictionary structure. Additionally,
+    key names and variable values/types are validated upon set. If invalid key
+    name or invalid value type, an exception will be thrown.
+    
+    Args:
+      key (str): The key name for which to assign the incoming value to.
+      value (mixed): The value to assign key with.
+    
+    Raises:
+      KeyError: Given key is not valid for the Config object.
+    """
     if key not in self._attr:
       raise KeyError('Config object does not store key: {}'.format(key))
     else:
@@ -140,26 +169,70 @@ def __setitem__(self, key, value):
         self._attr[key]['value'] = self._attr[key]['type'](value)
 
   def __delitem__(self, key):
+    """
+    Emulates dictionry key delete action.
+    
+    Emulates the act of deleting a key in a dictionary structure.
+    
+    Args:
+      key (str): The key name for which to delete the current.
+    
+    Raises:
+      KeyError: Given key is not valid for the Config object.
+    """
     if key not in self._attr:
       raise KeyError('Config object does not store key: {}'.format(key))
     else:
       self._attr[key]['value'] = None
 
   def __contains__(self, key):
+    """
+    Determines if key is stored in the Config object.
+    
+    Args:
+      key (str): The key name for which to check for existence.
+    
+    Returns:
+      Boolean True/False indicating if key exists in Config.
+    """
     return key in self._attr
 
   def items(self, only_preserve=True):
+    """
+    Converts the Config object into a simple dictionary containing only simple key:value pairs.
+    
+    Converts the internal representation of Config object and returns a simple dictionary
+    containing each key and it's highest priority value currently assigned. Optionally allows
+    for selection of only key:value pairs marked for preservation, rather than returning
+    all pairs. By default, only returns preserved pairs.
+    
+    Preserved pairs aare those designated for persisting into longer term storage in case
+    of job failure.
+    
+    Args:
+      only_preserve (bool, optional): Indicates if only keys marked for preservation
+        should be returned. Default: True
+    
+    Returns:
+      Dictionary containing keys assigned with their highest priority value in Config object.
+    """
     return { k:v['value'] for k,v in self._attr.items() if v['preserve'] }
 
   @property
   def ctllog_file(self):
+    """
+    Path/filename of job's .ctllog file.
+    """
     if not self['temp_dir'] or not self['app_name']:
       return None
     else:
       return '{}/{}.ctllog'.format(self['temp_dir'], self['app_name'])
 
   @property
   def ctx_file(self):
+    """
+    Path/filename of job's .ctx file.
+    """
     if not self['temp_dir'] or not self['app_name']:
       return None
     else:
@@ -173,6 +246,9 @@ def source_config_file(self, config_file):
     prior to executing app/job instance. Only variables beginning with
     'APP_' will be preserved/exported, while other vars will be lost.
     
+    Args:
+      config_file (str): The path to the application profile/config to source.
+    
     Raises:
       FileNotFoundError: Could not find specified file or is not a file.
     """
@@ -192,6 +268,9 @@ def source_config_file(self, config_file):
     proc.communicate()
 
   def print_attributes(self):
+    """
+    Prints out the Contig object's key:value pairs, using the highest
+    priority source as value.
+    """
     for k in self._attr:
-      print('{} : {}'.format(k, self._attr[k]))
-    return
+      print('{} : {}'.format(k, self._attr[k]))

pyrunner/core/constants.py

@@ -34,4 +34,31 @@
 HEADER_SHELL  = '#{}\n#ID|PARENT_IDS|MAX_ATTEMPTS|RETRY_WAIT_TIME|PROCESS_NAME|SHELL_COMMAND|LOGFILE'.format(MODE_SHELL)
 HEADER_PYTHON = '#{}\n#ID|PARENT_IDS|MAX_ATTEMPTS|RETRY_WAIT_TIME|PROCESS_NAME|MODULE_NAME|WORKER_NAME|ARGUMENTS|LOGFILE'.format(MODE_PYTHON)
 
-ROOT_NODE_NAME = 'PyRunnerRootNode'
+ROOT_NODE_NAME = 'PyRunnerRootNode'
+
+DRIVER_TEMPLATE = """
+#!/usr/bin/env python3
+
+import sys
+from pyrunner import PyRunner
+from pathlib import Path
+
+def main():
+  pr = PyRunner()
+  
+  # Assign default config and .lst file
+  pr.source_config_file(Path('{}/app_profile'.format(pr.config['config_dir'])))
+  pr.load_from_file(Path('{}/{}.lst'.format(pr.config['config_dir'], pr.config['app_name'])))
+  
+  # Parse command line args
+  pr.parse_args()
+  
+  # Initiate job
+  exit_status = pr.execute()
+  
+  # Ensure job exit status is passed to the caller
+  sys.exit(exit_status)
+
+if __name__ == '__main__':
+  main()
+"""