added naming to monitors, handlers and conductors so runners can identify them, in prep for in-workflow modification of patterns and recipes'

core/base_conductor.py

@@ -8,11 +8,17 @@ Author(s): David Marchant
 
 from typing import Any, Tuple, Dict
 
-from meow_base.core.correctness.vars import get_drt_imp_msg
-from meow_base.core.correctness.validation import check_implementation
+from meow_base.core.correctness.vars import VALID_CONDUCTOR_NAME_CHARS, \
+    get_drt_imp_msg
+from meow_base.core.correctness.validation import check_implementation, \
+    valid_string
+from meow_base.functionality.naming import generate_conductor_id
 
 
 class BaseConductor:
+    # An identifier for a conductor within the runner. Can be manually set in 
+    # the constructor, or autogenerated if no name provided.
+    name:str
     # Directory where queued jobs are initially written to. Note that this 
     # will be overridden by a MeowRunner, if a handler instance is passed to 
     # it, and so does not need to be initialised within the handler itself.
@@ -21,11 +27,15 @@ class BaseConductor:
     # will be overridden by a MeowRunner, if a handler instance is passed to 
     # it, and so does not need to be initialised within the handler itself.
     job_output_dir:str
-    def __init__(self)->None:
+    def __init__(self, name:str="")->None:
         """BaseConductor Constructor. This will check that any class inheriting
         from it implements its validation functions."""
         check_implementation(type(self).execute, BaseConductor)
         check_implementation(type(self).valid_execute_criteria, BaseConductor)
+        if not name:
+            name = generate_conductor_id()
+        self._is_valid_name(name)
+        self.name = name    
 
     def __new__(cls, *args, **kwargs):
         """A check that this base class is not instantiated itself, only 
@@ -35,6 +45,12 @@ class BaseConductor:
             raise TypeError(msg)
         return object.__new__(cls)
 
+    def _is_valid_name(self, name:str)->None:
+        """Validation check for 'name' variable from main constructor. Is 
+        automatically called during initialisation. This does not need to be 
+        overridden by child classes."""
+        valid_string(name, VALID_CONDUCTOR_NAME_CHARS)
+
     def valid_execute_criteria(self, job:Dict[str,Any])->Tuple[bool,str]:
         """Function to determine given an job defintion, if this conductor can 
         process it or not. Must be implemented by any child process."""