holado 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

holado_helper/initialize_holado.py

@@ -0,0 +1,72 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+#################################################
+# GOAL: Tools when using a clone of HolAdo project.
+#
+# This file contains methods usefull to initialize environments using a clone of HolAdo project.
+#
+# USAGE: 
+#   - Copy this file in projects using HolAdo.
+#   - Define environment variable HOLADO_PATH with path to cloned HolAdo project.
+#     If HOLADO_PATH is defined, sources of cloned HolAdo project are used, else installed holado package is used.
+#################################################
+
+
+
+import os
+import sys
+
+
+def insert_sys_path(path, index=0):
+    """Insert a path in sys.path if it doesn't already exists.
+    """
+    if path not in sys.path:
+        sys.path.insert(index, path)
+
+def insert_sys_paths(list_paths, index=0):
+    """Insert a list of path in sys.path if it doesn't already exists.
+    """
+    if list_paths:
+        for path in list_paths:
+            insert_sys_path(path, index=index)
+
+def insert_holado_source_paths(with_test_behave=True):
+    """Insert in sys.path all HolAdo source paths.
+    If environment variable HOLADO_PATH is defined with path to HolAdo project, following paths are inserted in sys.path:
+        - HOLADO_PATH/src: path to holado modules sources
+        - HOLADO_PATH/tests/behave (if with_test_behave==True): path to holado test sources, needed by testing solutions
+    """
+    holado_path = os.getenv('HOLADO_PATH')
+    if holado_path is None:
+        try:
+            import holado  # @UnusedImport
+        except Exception as exc:
+            if "No module named" in str(exc):
+                raise Exception(f"If environment variable HOLADO_PATH is not defined with path to HolAdo project, 'holado' python package must be installed")
+            else:
+                raise exc
+        else:
+            # holado is installed, and all sources are already accessible
+            pass
+    else:
+        print(f"Using HolAdo project installed in '{holado_path}'")
+        # import traceback
+        # print("".join(traceback.format_list(traceback.extract_stack())))
+        # insert_sys_path(holado_path)
+        insert_sys_path(os.path.join(holado_path, "src"))
+        if with_test_behave:
+            insert_sys_path(os.path.join(holado_path, "tests", "behave"))
+    
+

holado_helper/script/action.py

@@ -19,6 +19,7 @@ from holado_core.common.tools.tools import Tools
 from holado_core.common.actors.actions import Action
 from holado_core.common.exceptions.technical_exception import TechnicalException
 from holado_python.standard_library.typing import Typing
+from holado.common.handlers.undefined import not_applicable
 
 logger = logging.getLogger(__name__)
 
@@ -80,22 +81,33 @@ class BehaveActionRunner():
         self.__action = FeaturesBehaveAction(action_info.behave_args, variable_manager)
         self.__action_info = action_info
     
+    def __compute_variable_values(self):
+        res = {}
+        self.__add_variable_values(res, self.__action_info.static_params)
+        self.__add_variable_values(res, self.__action_info.params)
+        return res
+    
+    def __add_variable_values(self, res, params):
+        if params:
+            for key, value in params.items():
+                if key == 'STATUS':
+                    continue
+                if value is not_applicable:
+                    res[key] = 'N/A'
+                else:
+                    res[key] = value
+    
     def run(self):
         logger.info(f"Processing action '{self.__action_info.action}' of index {self.__action_info.index}: {self.__action_info.params}")
         if Tools.do_log(logger, logging.DEBUG):
             logger.debug(f"Running behave with arguments '{self.__action_info.behave_args}' on action of index {self.__action_info.index}: {self.__action_info.params}")
         
-        variable_values = {}
-        if self.__action_info.static_params:
-            for key, value in self.__action_info.static_params.items():
-                variable_values[key] = value
-        if self.__action_info.params:
-            for key, value in self.__action_info.params.items():
-                if key == 'STATUS':
-                    continue
-                variable_values[key] = value
+        variable_values = self.__compute_variable_values()
         
         logger.info(f"Launching behave with arguments: {self.__action_info.behave_args}")
+        if Tools.do_log(logger, logging.DEBUG):
+            if variable_values:
+                logger.debug(f"   and with variables:\n{Tools.represent_object(variable_values, 8)}")
         res = self.__action.execute(variable_values)
         logger.info(f"behave finished with result: {res}")
         

holado_helper/script/initialize_script.py

@@ -16,9 +16,9 @@
 # Usually, it is copied and adapted for specific usage.
 
 import os
-import sys
 import logging
 import argparse
+from holado_helper.initialize_holado import insert_sys_path, insert_sys_paths
 
 
 def _chdir(path):
@@ -26,32 +26,12 @@ def _chdir(path):
     os.chdir(path)
     return res
 
-def __insert_sys_path(path):
-    if path not in sys.path:
-        sys.path.insert(0, path)
-
-def _insert_sys_paths(additional_sys_paths=None):
-    # Insert additional paths
-    if additional_sys_paths is not None:
-        for sp in additional_sys_paths:
-            __insert_sys_path(sp)
-            
-    # Insert Holado paths
-    holado_path = os.getenv('HOLADO_PATH')
-    if holado_path is None:
-        # If HolAdo sources are not cloned on this environment, use path within this installation
-        from holado import get_holado_path
-        holado_path = get_holado_path()
-    __insert_sys_path(os.path.join(holado_path) )
-    __insert_sys_path(os.path.join(holado_path, "src") )
-    __insert_sys_path(os.path.join(holado_path, "tests", "behave") )
-    
-def _initialize_holado(TSessionContext=None, logging_config_file=None, log_level=logging.WARNING, log_in_file=False, with_session_path=False, **kwargs):
+def _initialize_holado(TSessionContext=None, logging_config_file_path=None, log_level=logging.WARNING, log_in_file=False, with_session_path=False, **kwargs):
     import holado
     session_kwargs={'with_session_path':with_session_path or log_in_file}
     if kwargs:
         session_kwargs.update(kwargs)
-    holado.initialize_for_script(TSessionContext=TSessionContext, logging_config_file=logging_config_file,
+    holado.initialize_for_script(TSessionContext=TSessionContext, logging_config_file_path=logging_config_file_path,
                                  log_level=log_level, log_in_file=log_in_file, log_on_console=not log_in_file, 
                                  session_kwargs=session_kwargs)
     
@@ -67,24 +47,24 @@ def initialize(work_dir_path=None, change_work_dir=True,
     
     if additional_sys_paths:
         sys_paths.extend(additional_sys_paths)
-    _insert_sys_paths(sys_paths)
+    insert_sys_paths(sys_paths)
     
-    logging_config_file=None
+    logging_config_file_path=None
     for dir_path in [res, work_dir_path, os.getcwd()]:
         if dir_path is not None:
             file_path = os.path.join(dir_path, "logging.conf")
             if os.path.exists(file_path):
-                logging_config_file = file_path
+                logging_config_file_path = file_path
                 break
     
-    _initialize_holado(TSessionContext, logging_config_file, log_level, log_in_file, with_session_path)
+    _initialize_holado(TSessionContext, logging_config_file_path, log_level, log_in_file, with_session_path)
     
     return res
 
 def change_working_dir(work_dir_path=None):
     if work_dir_path:
         res = _chdir(work_dir_path)
-        __insert_sys_path(work_dir_path)
+        insert_sys_path(work_dir_path)
         return res
     else:
         return None

holado_helper/script/script.py

@@ -76,7 +76,7 @@ class Script(object):
         return parser
     
     def change_working_dir(self, work_dir_path):
-        from initialize_script import change_working_dir as init_cd    # @UnresolvedImport
+        from holado_helper.script.initialize_script import change_working_dir as init_cd    # @UnresolvedImport
         
         # If user working dir is not yet defined, save current working dir as user working dir
         if self.__user_work_dir is None:
@@ -90,7 +90,7 @@ class Script(object):
     
     def initialize(self):
         if self.args is not None and hasattr(self.args, 'log_level') and hasattr(self.args, 'log_in_file'):
-            from initialize_script import change_logging_config # @UnresolvedImport
+            from holado_helper.script.initialize_script import change_logging_config # @UnresolvedImport
             change_logging_config(log_level=self.args.log_level, log_in_file=self.args.log_in_file)
     
     def run(self):

holado_logging/__init__.py

@@ -14,23 +14,20 @@
 
 
 
-def configure(initialize_logging=True, log_level=None):
+def configure(use_holado_logger=True, logging_config_file_path=None, log_level=None, log_on_console=False, log_in_file=True):
     from holado_logging.common.logging.log_config import LogConfig
-    if log_level is None:
-        import logging
-        log_level = logging.INFO
-        
-    LogConfig.configure(initialize_logging=initialize_logging, log_level=log_level)
+    LogConfig.configure(use_holado_logger=use_holado_logger, config_file_path=logging_config_file_path, log_level=log_level, log_on_console=log_on_console, log_in_file=log_in_file)
     
 def dependencies():
     return None
 
-def register():
+def initialize_and_register():
     from holado.common.context.session_context import SessionContext
     from holado_logging.common.logging.log_manager import LogManager
     
     log_manager = LogManager()
-    log_manager.initialize(log_on_console=True)
+    log_manager.configure()
+    log_manager.initialize()
     
     SessionContext.instance().services.register_service_instance("log_manager", log_manager, SessionContext.instance(), 
                                                                  raise_if_service_exist=False, raise_if_object_exist=False)

holado_logging/common/logging/holado_logger.py

@@ -15,7 +15,7 @@ import logging
 
 logger = logging.getLogger(__name__)
 
-#TODO EKL: rename HoladoLogger
+
 class HALogger(logging.Logger):
     default_message_size_limit = None
     
@@ -56,7 +56,7 @@ class HALogger(logging.Logger):
     #     logger.print(f"Change logger {self} level to {level}")
     #     logging.Logger.setLevel(self, level)
     
-class TestRootLogger(HALogger):
+class HARootLogger(HALogger):
     """
     Implementation is a copy of logging.RootLogger
     """

holado_logging/common/logging/log_config.py

@@ -20,36 +20,61 @@ import logging
 class LogConfig(object):
     TLogger = None
     TManager = None
+    config_file_path = None
     default_level = logging.INFO
+    log_on_console=False
+    log_in_file=True
+    __is_configured = False
     
     @classmethod
-    def configure(cls, initialize_logging=True, log_level=None):
+    def configure(cls, use_holado_logger=True, config_file_path=None, log_level=None, log_on_console=False, log_in_file=True):
+        if cls.__is_configured:
+            logging.warning(f"Logging was already configured, it is not possible to configure it twice. This new configuration is skipped.")
+            return
+        
         # HolAdo needs at least to add logging level TRACE and PRINT
         cls.add_logging_level_trace()
         cls.add_logging_level_print()
         
+        cls.config_file_path = config_file_path
+        if config_file_path:
+            import configparser
+            config = configparser.ConfigParser()
+            config.read(config_file_path)
+            log_level = config.get("holado", "level")
+            log_on_console = config.get("holado", "log_on_console")
+            log_in_file = config.get("holado", "log_in_file")
+        
         if log_level:
             if isinstance(log_level, str):
-                cls.default_level = logging._nameToLevel[log_level]
-            else:
-                cls.default_level = log_level
+                log_level = logging._nameToLevel[log_level]
+            cls.default_level = log_level
+        if log_on_console:
+            if isinstance(log_on_console, str):
+                log_on_console = True if log_on_console == "True" else False
+            cls.log_on_console = log_on_console
+        if log_in_file:
+            if isinstance(log_in_file, str):
+                log_in_file = True if log_in_file == "True" else False
+            cls.log_in_file = log_in_file
+        
+        if use_holado_logger:
+            cls.__set_holado_loggers()
         
-        if initialize_logging:
-            from holado_logging.common.logging.holado_logger import HALogger
-            
-            HALogger.default_message_size_limit = 10000
-            cls.TLogger = HALogger
-            cls.TManager = logging.Manager
-            
-            # Configure logging
-            cls.configure_logging()
+        cls.__is_configured = True
     
     @classmethod
-    def configure_logging(cls):
-        #TODO EKL: make loggers configuration optional
-        # Configure loggers
-        from holado_logging.common.logging.holado_logger import TestRootLogger
-        logging.root = TestRootLogger(cls.default_level)
+    def __set_holado_loggers(cls):
+        from holado_logging.common.logging.holado_logger import HALogger
+        
+        # Configure loggers to use
+        HALogger.default_message_size_limit = 10000
+        cls.TLogger = HALogger
+        cls.TManager = logging.Manager
+        
+        # Set loggers in logging
+        from holado_logging.common.logging.holado_logger import HARootLogger
+        logging.root = HARootLogger(cls.default_level)
         logging.Logger.root = logging.root
         logging.Logger.manager = cls.TManager(cls.TLogger.root)
         

holado_logging/common/logging/log_manager.py

@@ -63,28 +63,28 @@ class LogManager(object):
                 self.format = '%(asctime)s | %(process)-5d-%(thread)-5d | %(levelname)5s | %(module)35s | %(message)s'
                 self.style = '%'
         
-    def initialize(self, log_on_console=True):
+    def configure(self):
+        self.__config_file_path = LogConfig.config_file_path
+        
+        if self.__config_file_path:
+            config = configparser.ConfigParser()
+            config.read(self.__config_file_path)
+            
+            if config.has_section("loggers_levels"):
+                self.__loggers_levels = config.items(section="loggers_levels")
+    
+    def initialize(self):
         """
         Initialize log manager.
         If log_on_console is True, logs are published on console until a new configuration by calling method set_config
         """
-        if log_on_console:
+        handlers = []
+        if LogConfig.log_on_console:
             self.on_console = True
             self.__console_handler = self.__new_console_handler()
-            logging.basicConfig(format=self.format, style=self.style, level=LogConfig.default_level, handlers=[self.__console_handler])
-        else:
-            logging.basicConfig(format=self.format, style=self.style, level=LogConfig.default_level, handlers=[])
-        
-    def set_config_file_path(self, file_path, update_default_level=True):
-        self.__config_file_path = file_path
+            handlers.append(self.__console_handler)
         
-        config = configparser.ConfigParser()
-        config.read(self.__config_file_path)
-        if update_default_level:
-            LogConfig.default_level = config.get("logger_root", "level")
-        
-        if config.has_section("loggers_levels"):
-            self.__loggers_levels = config.items(section="loggers_levels")
+        logging.basicConfig(format=self.format, style=self.style, level=LogConfig.default_level, handlers=handlers)
     
     def has_log_file(self, file_name):
         with self.__files_lock:
@@ -154,8 +154,7 @@ class LogManager(object):
         # Update log destination to files
         with self.__files_lock:
             # Remove old log files
-            # if self.__root_file_name:
-            #     self.remove_root_file_handler(do_reset=True)
+            # Note: root file is not removed if it is configured
             for file_name in list(self.__file_handlers.keys()):
                 if file_name not in self.__file_names:
                     self.remove_file_handler(file_name, do_remove_log_file=False)
@@ -166,7 +165,6 @@ class LogManager(object):
             for file_name in self.__file_names:
                 if file_name not in list(self.__file_handlers.keys()):
                     self.add_file_handler(file_name)
-                
         
         # level
         if logger_.getEffectiveLevel() != LogConfig.default_level:
@@ -176,7 +174,10 @@ class LogManager(object):
         for name, level in self.__loggers_levels:
             if not name.startswith("#"):
                 logging.getLogger(name).setLevel(level)
-                
+        
+        # WARNING: For local debug only
+        # logging.getLogger("holado_logging.common.logging.log_manager").setLevel(logging.DEBUG)
+        
     def set_level(self, log_level, do_set_config=True):
         from holado_core.common.exceptions.technical_exception import TechnicalException
         

holado_multitask/multitasking/multitask_manager.py

@@ -187,7 +187,7 @@ class MultitaskManager(object):
     
     def prepare_thread(self, name, update_parent=True):
         """
-        Create a process context and return a unique name based to given name
+        Create a thread context and return a unique name based to given name
         """
         with self.__thread_lock:
             res = name

holado_multitask/multithreading/thread.py

@@ -21,6 +21,7 @@ from holado_python.standard_library.typing import Typing
 from holado.common.handlers.undefined import undefined_argument, default_context
 from holado_core.common.exceptions.technical_exception import TimeoutTechnicalException
 from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_python.common.tools.datetime import DateTime, FORMAT_DATETIME_ISO
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +36,8 @@ class Thread(threading.Thread):
             default_wait_timeout = Config.timeout_seconds * 1000
             
         self.__name = name
-        self.__unique_name = SessionContext.instance().multitask_manager.prepare_thread(name)
+        # Note: if SessionContext doesn't have an instance (like during session context reset), use name+now as unique name
+        self.__unique_name = SessionContext.instance().multitask_manager.prepare_thread(name) if SessionContext.has_instance() else f"{name}_{DateTime.datetime_2_str(DateTime.now(), FORMAT_DATETIME_ISO)}"
         self.__default_wait_timeout = default_wait_timeout
         self.__delay_before_run_sec = delay_before_run_sec
 
@@ -48,7 +50,8 @@ class Thread(threading.Thread):
         self._is_idle.set()
         
         # Register thread
-        if register_thread:
+        # Note: Do not register thread if session context doesn't have an instance (like during session context reset)
+        if register_thread and SessionContext.has_instance():
             # Registered name has to be unique
             SessionContext.instance().threads_manager.register_thread(self.__unique_name, self, scope=register_scope)
         
@@ -74,13 +77,14 @@ class Thread(threading.Thread):
         
     def _set_ident(self):
         super()._set_ident()
-        if not MultitaskManager.has_thread_native_id():
+        if not MultitaskManager.has_thread_native_id() and SessionContext.has_instance():
             SessionContext.instance().multitask_manager.set_thread_uid(self.__unique_name, MultitaskManager.get_thread_uid(thread=self))
         
     if MultitaskManager.has_thread_native_id():
         def _set_native_id(self):
             super()._set_native_id()
-            SessionContext.instance().multitask_manager.set_thread_uid(self.__unique_name, MultitaskManager.get_thread_uid(thread=self))
+            if SessionContext.has_instance():
+                SessionContext.instance().multitask_manager.set_thread_uid(self.__unique_name, MultitaskManager.get_thread_uid(thread=self))
         
     def join(self, timeout=undefined_argument, raise_if_still_alive=True):
         """

holado_protobuf/ipc/protobuf/protobuf_messages.py

@@ -301,7 +301,7 @@ class ProtobufMessages(object):
                 if ValueTableManager.verify_table_is_name_value_table(fields_table, raise_exception=False):
                     self.__set_object_fields_with_name_value_table(res, fields_table)
                 else:
-                    raise TechnicalException(f"When defining parameter fields_table, it must be a Name/Value table")
+                    raise TechnicalException(f"When defining parameter fields_table, it must be a Name/Value table: [{Typing.get_object_class_fullname(fields_table)}]\n{fields_table.represent(4)}")
             elif fields_dict is not None:
                 self.__set_object_fields_with_dict(res, fields_dict)
             

holado_scripting/common/tools/evaluate_parameters.py

@@ -11,6 +11,7 @@
 #################################################
 
 import copy
+from holado.common.handlers.undefined import undefined_value
 
 
 class EvaluateParameters(object):
@@ -23,7 +24,8 @@ class EvaluateParameters(object):
     
     def __init__(self, do_interpret=True, do_eval_variable=True, do_eval=True, \
                  raise_on_interpret_error=True, raise_on_variable_eval_error=True, raise_on_eval_error=True,
-                 do_interpret_recursively=False, do_eval_variable_recursively=False):
+                 do_interpret_recursively=False, do_eval_variable_recursively=False,
+                 result_type=undefined_value):
         """
         Constructor
         @param  
@@ -36,9 +38,11 @@ class EvaluateParameters(object):
         self.raise_on_interpret_error = raise_on_interpret_error
         self.raise_on_variable_eval_error = raise_on_variable_eval_error
         self.raise_on_eval_error = raise_on_eval_error
+        self.result_type = result_type
+        self.result_is_str = result_type is str
     
     def __str__(self)->str:
-        return f"{{interpret:({self.do_interpret},recursive:{self.do_interpret_recursively},raise:{self.raise_on_interpret_error}) ; eval variable:({self.do_eval_variable},recursive:{self.do_eval_variable_recursively},raise:{self.raise_on_variable_eval_error}) ; eval:({self.do_eval},raise:{self.raise_on_eval_error})}}"
+        return f"{{interpret:({self.do_interpret},recursive:{self.do_interpret_recursively},raise:{self.raise_on_interpret_error}) ; eval variable:({self.do_eval_variable},recursive:{self.do_eval_variable_recursively},raise:{self.raise_on_variable_eval_error}) ; eval:({self.do_eval},raise:{self.raise_on_eval_error}) ; result type:{self.result_type}}}"
     
     def with_interpret(self, do_interpret):
         """
@@ -160,6 +164,20 @@ class EvaluateParameters(object):
         @return Same parameters but without raise
         """
         return self.with_raise(False)
+        
+    def with_result_type(self, result_type=undefined_value):
+        """
+        Note: if result_type types are same, self instance is returned, else a new one is returned
+        @param result_type Evaluation result type
+        @return Same parameters but with result_type
+        """
+        if self.result_type == result_type:
+            return self
+        else:
+            res = copy.deepcopy(self)
+            res.result_type = result_type
+            res.result_is_str = result_type is str
+            return res
     
     @staticmethod
     def default(raise_exception=True):
@@ -178,7 +196,7 @@ class EvaluateParameters(object):
         @return Default evaluate parameters with raises
         """
         if EvaluateParameters.__instance_default is None:
-            EvaluateParameters.__instance_default = EvaluateParameters(True, True, True, True, True, True)
+            EvaluateParameters.__instance_default = EvaluateParameters(True, True, True, True, True, True, undefined_value)
         return EvaluateParameters.__instance_default
     
     @staticmethod
@@ -187,7 +205,7 @@ class EvaluateParameters(object):
         @return Default evaluate parameters without any raise
         """
         if EvaluateParameters.__instance_default_without_raise is None:
-            EvaluateParameters.__instance_default_without_raise = EvaluateParameters(True, True, True, False, False, False)
+            EvaluateParameters.__instance_default_without_raise = EvaluateParameters(True, True, True, False, False, False, undefined_value)
         return EvaluateParameters.__instance_default_without_raise
     
     @staticmethod
@@ -204,7 +222,7 @@ class EvaluateParameters(object):
         @return Default evaluate parameters without any raise
         """
         if EvaluateParameters.__instance_nothing is None:
-            EvaluateParameters.__instance_nothing = EvaluateParameters(False, False, False, False, False, False)
+            EvaluateParameters.__instance_nothing = EvaluateParameters(False, False, False, False, False, False, undefined_value)
         return EvaluateParameters.__instance_nothing