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."""

core/base_handler.py

@@ -8,11 +8,16 @@ Author(s): David Marchant
 
 from typing import Any, Tuple, Dict
 
-from meow_base.core.correctness.vars import VALID_CHANNELS, get_drt_imp_msg 
-from meow_base.core.correctness.validation import check_implementation
-
+from meow_base.core.correctness.vars import VALID_CHANNELS, \
+    VALID_HANDLER_NAME_CHARS, get_drt_imp_msg
+from meow_base.core.correctness.validation import check_implementation, \
+    valid_string
+from meow_base.functionality.naming import generate_handler_id
 
 class BaseHandler:
+    # An identifier for a handler within the runner. Can be manually set in 
+    # the constructor, or autogenerated if no name provided.
+    name:str
     # A channel for sending messages to the runner. 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 +26,15 @@ class BaseHandler:
     # 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_queue_dir:str
-    def __init__(self)->None:
+    def __init__(self, name:str='')->None:
         """BaseHandler Constructor. This will check that any class inheriting 
         from it implements its validation functions."""
         check_implementation(type(self).handle, BaseHandler)
         check_implementation(type(self).valid_handle_criteria, BaseHandler)
+        if not name:
+            name = generate_handler_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 +44,12 @@ class BaseHandler:
             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_HANDLER_NAME_CHARS)
+
     def valid_handle_criteria(self, event:Dict[str,Any])->Tuple[bool,str]:
         """Function to determine given an event defintion, if this handler can 
         process it or not. Must be implemented by any child process."""

core/base_monitor.py

@@ -12,12 +12,18 @@ from typing import Union, Dict
 from meow_base.core.base_pattern import BasePattern
 from meow_base.core.base_recipe import BaseRecipe
 from meow_base.core.base_rule import BaseRule
-from meow_base.core.correctness.vars import VALID_CHANNELS, get_drt_imp_msg 
-from meow_base.core.correctness.validation import check_implementation
+from meow_base.core.correctness.vars import VALID_CHANNELS, \
+    VALID_MONITOR_NAME_CHARS, get_drt_imp_msg 
+from meow_base.core.correctness.validation import check_implementation, \
+    valid_string
 from meow_base.functionality.meow import create_rules
+from meow_base.functionality.naming import generate_monitor_id
 
 
 class BaseMonitor:
+    # An identifier for a monitor within the runner. Can be manually set in 
+    # the constructor, or autogenerated if no name provided.
+    name:str
     # A collection of patterns
     _patterns: Dict[str, BasePattern]
     # A collection of recipes
@@ -29,7 +35,7 @@ class BaseMonitor:
     # monitor is passed to it.
     to_runner: VALID_CHANNELS
     def __init__(self, patterns:Dict[str,BasePattern], 
-            recipes:Dict[str,BaseRecipe])->None:
+            recipes:Dict[str,BaseRecipe], name:str="")->None:
         """BaseMonitor Constructor. This will check that any class inheriting 
         from it implements its validation functions. It will then call these on
         the input parameters."""
@@ -53,6 +59,10 @@ class BaseMonitor:
         self._patterns = deepcopy(patterns)
         self._recipes = deepcopy(recipes)
         self._rules = create_rules(patterns, recipes)
+        if not name:
+            name = generate_monitor_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 
@@ -62,6 +72,12 @@ class BaseMonitor:
             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_MONITOR_NAME_CHARS)
+
     def _is_valid_patterns(self, patterns:Dict[str,BasePattern])->None:
         """Validation check for 'patterns' variable from main constructor. Must
         be implemented by any child class."""

core/correctness/vars.py

@@ -21,6 +21,9 @@ CHAR_NUMERIC = '0123456789'
 
 VALID_NAME_CHARS = CHAR_UPPERCASE + CHAR_LOWERCASE + CHAR_NUMERIC + "_-"
 
+VALID_CONDUCTOR_NAME_CHARS = VALID_NAME_CHARS
+VALID_HANDLER_NAME_CHARS = VALID_NAME_CHARS
+VALID_MONITOR_NAME_CHARS = VALID_NAME_CHARS
 VALID_RECIPE_NAME_CHARS = VALID_NAME_CHARS
 VALID_PATTERN_NAME_CHARS = VALID_NAME_CHARS
 VALID_RULE_NAME_CHARS = VALID_NAME_CHARS