allow parameters to be passed into running methods

Author: rob

syscontrol/control_config.yaml

@@ -22,12 +22,16 @@ process_configuration_stop_time:
   run_backups: '23:50'
   run_cleaners: '23:50'
   run_reports: '23:50'
-process_arguments:
-  run_daily_prices_updates:
-    download_by_zone:
-      Asia: '07:00'
-      EMEA: '18:00'
-      US: '20:00'
+## Examples of passing arguments
+#arguments:
+#  run_daily_prices_updates:
+#    update_historical_prices: # everything in this block is passed as **kwargs to this method
+#      download_by_zone:
+#        Asia: '07:00'
+#        EMEA: '18:00'
+#        US: '20:00'
+#    _methods_on_completion: # and this block is passed to all methods that run on completion only
+#        a: 'test'
 # Examples:
 #process_configuration_previous_process:
 #  run_systems: 'run_daily_prices_updates'

syscontrol/run_process.py

@@ -125,13 +125,25 @@ def _main_loop_over_methods(self):
                 if we_should_pause:
                     continue
 
-                timer_class.check_and_run()
+                kwargs = self._kwargs_for_method_and_process(timer_class.method_name)
+                timer_class.check_and_run(**kwargs)
+
+    def _kwargs_for_method_and_process(self, method_name: str) -> dict:
+        return self.diag_process.get_configured_kwargs_for_process_name_and_method(
+            process_name=self.process_name, method=method_name
+        )
 
     def _finish(self):
-        self.list_of_timer_functions.run_methods_which_run_on_exit_only()
+        kwargs = self._kwargs_for_exit_only_method_and_process()
+        self.list_of_timer_functions.run_methods_which_run_on_exit_only(**kwargs)
         self._finish_control_process()
         self.data.close()
 
+    def _kwargs_for_exit_only_method_and_process(self) -> dict:
+        return self.diag_process.get_configured_kwargs_for_process_name_and_methods_that_run_on_completion(
+            self.process_name
+        )
+
     def _finish_control_process(self):
         result_of_finish = self.data_control.finish_process(self.process_name)
 

syscontrol/timer_functions.py

@@ -110,7 +110,7 @@ def report_status(self) -> reportStatus:
     def log_msg(self, msg: str):
         self.log.msg(msg, type=self.process_name)
 
-    def check_and_run(self, last_run: bool = False):
+    def check_and_run(self, last_run: bool = False, **kwargs):
         """
 
         :return: None
@@ -121,7 +121,7 @@ def check_and_run(self, last_run: bool = False):
             return None
 
         self.setup_about_to_run_method()
-        self.run_function()
+        self.run_function(**kwargs)
         self.finished_running_method()
 
     def check_if_okay_to_run(self, last_run=False) -> bool:
@@ -294,9 +294,9 @@ def store_in_db_run_start_method(self):
         data_process = dataControlProcess(self.data)
         data_process.log_start_run_for_method(self.process_name, self.method_name)
 
-    def run_function(self):
+    def run_function(self, **kwargs):
         # Functions can't take args or kwargs or return anything; pure method
-        self._function()
+        self._function(**kwargs)
 
     def finished_running_method(self):
         self.store_in_db_log_run_end_method()
@@ -323,9 +323,9 @@ def check_all_finished(self) -> bool:
 
         return all_finished
 
-    def run_methods_which_run_on_exit_only(self):
+    def run_methods_which_run_on_exit_only(self, **kwargs):
         for timer_class in self:
-            timer_class.check_and_run(last_run=True)
+            timer_class.check_and_run(last_run=True, **kwargs)
 
     def seconds_until_next_method_runs(self) -> float:
         minutes_remaining = [

sysproduction/data/control_process.py

@@ -19,6 +19,7 @@
 DEFAULT_START_TIME_STRING = "00:01"
 DEFAULT_STOP_TIME_STRING = "23:50"
 NAME_OF_TRADING_PROCESS = "run_stack_handler"
+LABEL_FOR_ARGS_METHOD_ON_COMPLETION = "_methods_on_completion"
 
 
 class dataControlProcess(productionDataLayerGeneric):
@@ -382,6 +383,37 @@ def get_list_of_process_names(self) -> list:
         result = self.db_control_process_data.get_list_of_process_names()
         return result
 
+    def get_configured_kwargs_for_process_name_and_methods_that_run_on_completion(
+        self, process_name: str
+    ) -> dict:
+        return self.get_configured_kwargs_for_process_name_and_method(
+            process_name=process_name, method=LABEL_FOR_ARGS_METHOD_ON_COMPLETION
+        )
+
+    def get_configured_kwargs_for_process_name_and_method(
+        self, process_name: str, method: str
+    ) -> dict:
+        configured_kwargs_for_process_name = (
+            self.get_configured_kwargs_for_process_name(process_name)
+        )
+        configured_kwargs_for_process_name_and_method = (
+            configured_kwargs_for_process_name.get(method, {})
+        )
+
+        return configured_kwargs_for_process_name_and_method
+
+    def get_configured_kwargs_for_process_name(self, process_name: str) -> dict:
+        configured_kwargs = self.configured_kwargs()
+        configured_kwargs_for_process_name = configured_kwargs.get(process_name, {})
+
+        return configured_kwargs_for_process_name
+
+    def configured_kwargs(self) -> dict:
+        kwargs = self.get_key_value_from_control_config("arguments")
+        if kwargs is missing_data:
+            return {}
+        return kwargs
+
     def get_key_value_from_control_config(self, item_name: str):
         config = self.get_control_config()
         item = config.get_element_or_missing_data(item_name)

sysproduction/update_historical_prices.py

@@ -40,7 +40,8 @@ class updateHistoricalPrices(object):
     def __init__(self, data):
         self.data = data
 
-    def update_historical_prices(self):
+    def update_historical_prices(self, **kwargs):
+        print("**kwargs** I am ignoring for now %s" % str(kwargs))
         data = self.data
         update_historical_prices_with_data(data)