holado 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

holado_multitask/multiprocessing/periodic_function_process.py

@@ -0,0 +1,135 @@
+
+#################################################
+# 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.
+#################################################
+
+from builtins import super
+import logging
+import time
+from holado_core.common.tools.tools import Tools
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_multitask.multiprocessing.process import InterruptableProcess
+from holado_multitask.multiprocessing.function_process import FunctionProcess
+
+logger = logging.getLogger(__name__)
+
+
+class PeriodicFunctionProcess(InterruptableProcess):
+    '''
+    Execute periodically in a process given function with given arguments.
+    
+    Implementation uses a precise timer, in order to globally satisfy the desired periodicity (with a precision of around a nanosecond, depending to system latency).
+    But implementation is quite simple, function is executed around each timer ticks : it is based on waits after function execution of the time needed to satisfy periodicity.
+    If function execution is greater than periodicity, a warning is logged, and function is run immediately without waiting next timer tick.
+    
+    For fast periodicity, it is recommended to disable logs by setting property 'do_log' to False (and also 'do_log_warning' if needed).
+    '''
+    
+    def __init__(self, period_seconds, target, args=None, kwargs=None, name=None, default_wait_timeout=None, register_process=True, delay_before_run_sec=None, nb_times=None):
+        super().__init__(name if name is not None else f"PeriodicFunctionProcess({repr(target)})", default_wait_timeout=default_wait_timeout, register_process=register_process, delay_before_run_sec=delay_before_run_sec)
+
+        self.__period_seconds = period_seconds
+        if self.__period_seconds < 1e-8:
+            raise TechnicalException(f"Periodicity must be at least 10ns")
+        self.__nb_times = nb_times
+        self.__function_process = FunctionProcess(target, args, kwargs)
+        self.__do_log = True
+        self.__do_log_warning = True
+        
+        if isinstance(self.__period_seconds, int) or self.__period_seconds % 1 < 1e-9 or self.__period_seconds % 1 > 1 - 1e-9:
+            self.__timer = Tools.timer_s
+            self.__timer_period = self.__period_seconds
+            self.__timer_unity = "s"
+            self.__timer_s_value = 1
+        else:
+            self.__timer = Tools.timer_ns
+            self.__timer_period = self.__period_seconds * 1e9
+            self.__timer_unity = "ns"
+            self.__timer_s_value = 1e9
+
+    @property
+    def function_process(self):
+        return self.__function_process
+
+    @property
+    def do_log(self):
+        return self.__do_log
+
+    @do_log.setter
+    def do_log(self, do_log):
+        self.__do_log = do_log
+
+    @property
+    def do_log_warning(self):
+        return self.__do_log_warning
+
+    @do_log_warning.setter
+    def do_log_warning(self, do_log):
+        self.__do_log_warning = do_log
+
+    def run(self):
+        # Start running by superclass run
+        super().run()
+        
+        logger.info(f"[{self.name}] Process managing periodic function.")
+        
+        start = self.__timer()
+        count = 0
+        while not self.is_interrupted:
+            # Process function
+            if self.do_log:
+                logger.info(f"[{self.name}] Processing periodic iteration {count+1}...")
+            beg = self.__timer()
+            try:
+                self.__function_process.run()
+            except Exception as exc:
+                msg = "{} Exception catched while processing function:\n    [{}]".format(self.name, repr(exc))
+                logger.exception(msg)
+            finally:
+                count += 1
+                iter_dur = self.__timer() - beg
+                
+            # Define next iteration timer
+            next_timer = start + count * self.__timer_period
+            wait_duration = next_timer - self.__timer()
+            skip_wait = wait_duration < 0
+            if skip_wait:
+                if self.do_log_warning:
+                    logger.warning(f"[{self.name}] {count}'th iteration finished too late (of {-wait_duration} {self.__timer_unity}) to process next iteration on time (duration: {iter_dur} {self.__timer_unity} ; periodicity: {self.__timer_period} {self.__timer_unity}). Processing immediatelly next iteration")
+                
+                while wait_duration + self.__timer_period < 0:
+                    if self.do_log_warning:
+                        logger.warning(f"[{self.name}] Failed to process {count+1}'th iteration, its activity period is passed")
+                    count += 1
+                    next_timer = start + count * self.__timer_period
+                    wait_duration = next_timer - self.__timer()
+            
+            # Stop if nb_times is reached
+            if self.__nb_times is not None:
+                if count >= self.__nb_times:
+                    break
+            
+            # Wait periodicity
+            if not skip_wait:
+                if self.do_log:
+                    logger.info(f"[{self.name}] Waiting {wait_duration} {self.__timer_unity} to process next periodic function...")
+                while not self.is_interrupted:
+                    if wait_duration > 0.1 * self.__timer_s_value:
+                        time.sleep(0.1)
+                        wait_duration = next_timer - self.__timer()
+                    else:
+                        if wait_duration > 1e-9 * self.__timer_s_value:
+                            time.sleep(wait_duration / self.__timer_s_value)
+                        break
+            
+        logger.info(f"[{self.name}] Process of periodic function has finished.")
+        
+        

holado_multitask/multiprocessing/process.py

@@ -0,0 +1,196 @@
+
+#################################################
+# 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.
+#################################################
+
+from holado.holado_config import Config
+import logging
+import multiprocessing
+import time
+from holado.common.context.session_context import SessionContext
+from holado_multitask.multitasking.multitask_manager import MultitaskManager
+from holado_python.standard_library.typing import Typing
+from holado.common.handlers.undefined import undefined_argument
+from holado_core.common.exceptions.technical_exception import TimeoutTechnicalException
+from holado_core.common.exceptions.functional_exception import FunctionalException
+
+logger = logging.getLogger(__name__)
+
+
+class Process(multiprocessing.context.Process):
+    """ Helper class managing a multiprocessing process.
+    WARNING: Do not use, it is under construction
+    """
+    
+    def __init__(self, name, default_wait_timeout = None, register_process = True, delay_before_run_sec=None):
+        super().__init__()
+        
+        if default_wait_timeout is None:
+            default_wait_timeout = Config.timeout_seconds * 1000
+            
+        self.__name = name
+        self.__unique_name = SessionContext.instance().multitask_manager.prepare_process(name)
+        self.__default_wait_timeout = default_wait_timeout
+        self.__delay_before_run_sec = delay_before_run_sec
+
+        # Put process as daemon
+        self.daemon = True
+        
+        # Manage process status
+        # self._is_lock = threading.Lock()
+        # self._is_idle = threading.Event()
+        # self._is_idle.set()
+        
+        # Register process
+        if register_process:
+            # Registered name has to be unique
+            SessionContext.instance().processes_manager.register_process(self.__unique_name, self)
+        
+    @property
+    def name(self):
+        return self.__name
+    
+    @property
+    def unique_name(self):
+        return self.__unique_name
+    
+    @property
+    def default_wait_timeout(self):
+        return self.__default_wait_timeout
+        
+    @default_wait_timeout.setter
+    def default_wait_timeout(self, timeout):
+        self.__default_wait_timeout = timeout
+        
+    @property
+    def delay_before_run_seconds(self):
+        return self.__delay_before_run_sec
+        
+    def start(self)->None:
+        super().start()
+        SessionContext.instance().multitask_manager.set_process_id(self.__unique_name, MultitaskManager.get_process_id(process=self))
+    
+    def run(self)->None:
+        SessionContext.instance().multitask_manager.set_process_thread_uid(self.__unique_name, MultitaskManager.get_thread_uid())
+        super().run()
+    
+    def join(self, timeout=undefined_argument, raise_if_still_alive=True):
+        """
+        See Process.join documentation for default behavior.
+        
+        This implementation tries to avoid deadlocks by special and default timeout value undefined_argument.
+        With any other timeout value, including None, default behavior is happening.
+        If timeout argument is undefined_argument, it means that it should stop by itself without deadlock.
+        In this case, a timeout value Config.join_timeout_seconds is used.
+        
+        If argument raise_if_still_alive is True (default) and if process is still alive after join, an exception is raised.
+        If timeout is undefined_argument, a TimeoutTechnicalException is raised, else a FunctionalException.
+        """
+        timeout_str = "long and finite" if timeout is undefined_argument else f"{timeout}s" if timeout else "none"
+        logger.debug(f"Joining process '{self.name}' ; timeout={timeout_str} ...")
+        
+        real_timeout = timeout if timeout is not undefined_argument else Config.join_timeout_seconds
+        super().join(real_timeout)
+        
+        logger.debug(f"End of joining process '{self.name}' ; timeout={timeout_str} ; alive:{self.is_alive()}")
+        
+        if self.is_alive():
+            if raise_if_still_alive:
+                if timeout is undefined_argument:
+                    raise TimeoutTechnicalException(f"Process '{self.name}' is still alive after join")
+                else:
+                    raise FunctionalException(f"Process '{self.name}' is still alive after join")
+            else:
+                logger.error(f"Process '{self.name}' is still alive after join")
+    
+    def wait_before_run(self):
+        if self.delay_before_run_seconds is not None:
+            try:
+                time.sleep(self.delay_before_run_seconds)
+            except Exception as exc:
+                logger.exception(f"Exception while waiting delay before run (delay: {self.delay_before_run_seconds} ; type: {Typing.get_object_class_fullname(self.delay_before_run_seconds)})")
+                
+    # def wait_is_idle(self, timeout=None):
+    #     """ Wait event self._is_idle"""
+    #     self._wait(self.__is_idle, "is idle", timeout=timeout)
+    #
+    # def _wait(self, event, event_details, timeout=None):
+    #     """ Wait given threading.Event"""
+    #     is_set = False
+    #     wait_round_counter = 0
+    #     round_wait_seconds = 1
+    #     if timeout is None:
+    #         timeout = self.__default_wait_timeout
+    #
+    #     logger.debug("[{}] Waiting {}...".format(self.name, event_details))
+    #     while not is_set:
+    #         wait_round_counter += 1
+    #         is_set = event.wait(round_wait_seconds)
+    #
+    #         if not is_set:
+    #             if wait_round_counter * round_wait_seconds * 1000 > timeout:
+    #                 raise TimeoutError("[{}] Timeout when waiting {}".format(self.name, event_details))
+    #             elif wait_round_counter % 10 == 0:
+    #                 logger.debug("[{}] Still waiting {} (round {})".format(self.name, event_details, wait_round_counter))
+    #     logger.debug("[{}] Finished waiting {}...".format(self.name, event_details))
+
+class InterruptableProcess(Process):
+    """ Helper class managing a process interruptable.
+    It gives only the interface, sub-classes must implement if it is really interruptable and how.
+    """
+    
+    def __init__(self, name, default_wait_timeout = None, register_process = True, delay_before_run_sec=None):
+        super().__init__(name, default_wait_timeout = default_wait_timeout, register_process = register_process, delay_before_run_sec=delay_before_run_sec)
+
+        # Manage interrupt
+        # self.__interrupt_lock = threading.Lock()
+        # self.__interrupt_event = threading.Event()
+    
+    @property    
+    def is_interruptable(self):
+        # return True
+        raise NotImplementedError
+    
+    @property
+    def is_interrupted(self):
+        return False
+    #     with self.__interrupt_lock:
+    #         return self.__interrupt_event.is_set()
+
+    def interrupt(self):
+        # if not self.is_interrupted:
+        #     logger.debug("Interrupt thread '{}'".format(self.name))
+        #     with self.__interrupt_lock:
+        #         self.__interrupt_event.set()
+        raise NotImplementedError
+    
+    def _raise_if_interrupted(self):
+        if self.is_interrupted:
+            raise InterruptedError
+        
+
+
+class ThreadAsProcess(InterruptableProcess):
+    """
+    WARNING: Do not use, it is under construction
+    """
+    def __init__(self, thread):
+        super().__init__()
+        self.__thread = thread
+        
+    def run(self):
+        # Start running by superclass run
+        super().run()
+        
+        return self.__thread.run()
+    
+    
+

holado_multitask/multiprocessing/processesmanager.py

@@ -0,0 +1,133 @@
+
+#################################################
+# 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.
+#################################################
+
+import threading
+import logging
+from holado_core.common.exceptions.technical_exception import TechnicalException
+import holado_multitask.multiprocessing as hmm
+from holado.common.handlers.undefined import undefined_argument
+
+logger = logging.getLogger(__name__)
+
+
+class ProcessesManager(object):
+    """
+    Helper class to manage running processes.
+    """
+    
+    
+    def __init__(self, multitask_manager):
+        self.__multitask_manager = multitask_manager
+        self.__managed_processes_lock = threading.Lock()
+        self.__managed_processes = {}
+    
+    def register_process(self, name, process):
+        with self.__managed_processes_lock:
+            if name in self.__managed_processes:
+                logger.error(f"A process with name '{name}' is already registered, it will be overwritten: {self.__managed_processes[name]}")
+            else:
+                logger.debug(f"Registered process with name '{name}': {process}")
+            self.__managed_processes[name] = process
+    
+    def unregister_process(self, name):
+        with self.__managed_processes_lock:
+            if name in self.__managed_processes:
+                if self.__managed_processes[name].is_alive():
+                    logger.warn(f"Unregistering process with name '{name}' whereas it is still alive")
+                else:
+                    logger.debug(f"Unregistered process with name '{name}'")
+                del self.__managed_processes[name]
+            else:
+                raise Exception("Not registered process of name '{}'".format(name))
+
+
+    def get_process(self, name):
+        with self.__managed_processes_lock:
+            if name in self.__managed_processes:
+                return self.__managed_processes[name]
+            else:
+                raise Exception("Unregistered process of name '{}'".format(name))
+
+
+    def interrupt_process(self, name, with_join=True, join_timeout=undefined_argument, raise_if_not_interruptable=True):
+        process = self.get_process(name)
+        if process.is_alive():
+            if self.is_interruptable(process=process):
+                try:
+                    process.interrupt()
+                except Exception as exc:
+                    # logger.exception("Failed to interrupt process of name '{}'".format(name))
+                    raise exc
+                
+                if with_join:
+                    process.join(join_timeout)
+            elif raise_if_not_interruptable:
+                raise TechnicalException("Thread '{}' is not interruptable".format(name))
+                
+
+
+    def join_process(self, name, timeout=undefined_argument):
+        process = self.get_process(name)
+        if process.is_alive():
+            process.join(timeout)
+
+
+    def interrupt_all_processes(self, with_join=True, join_timeout=undefined_argument):
+        """Interrupt all processes that are interruptable."""
+        names = self.get_process_names()
+        for name in names:
+            try:
+                if self.is_interruptable(name=name):
+                    self.interrupt_process(name, with_join=False)
+            except Exception:
+                logger.exception("Failed to interrupt process of name '{}'".format(name))
+
+        if with_join:
+            self.join_all_processes(timeout=join_timeout, skip_not_interruptable=True)
+
+
+    def join_all_processes(self, timeout=undefined_argument, skip_not_interruptable=False):
+        names = self.get_process_names()
+        for name in names:
+            if skip_not_interruptable and self.is_interruptable(name=name):
+                continue
+            self.join_process(name, timeout=timeout)
+    
+
+    def unregister_all_processes(self, keep_alive=True):
+        names = self.get_process_names()
+        for name in names:
+            process = self.get_process(name)
+            if not keep_alive or keep_alive and not process.is_alive():
+                self.unregister_process(name)
+    
+
+    def get_process_names(self):
+        with self.__managed_processes_lock:
+            return sorted(list( self.__managed_processes.keys() ))
+    
+
+    def get_alive_process_names(self):
+        with self.__managed_processes_lock:
+            res = sorted(list( self.__managed_processes.keys() ))
+            res = [name for name in res if self.__managed_processes[name].is_alive()]
+            
+
+    def is_interruptable(self, process=None, name=None):
+        if name is not None:
+            process = self.get_process(name)
+        if process is None:
+            raise TechnicalException("At least one argument must be not None")    
+        
+        return isinstance(process, hmm.process.InterruptableProcess) and process.is_interruptable
+