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

holado_core/common/actors/actions.py

@@ -0,0 +1,97 @@
+#################################################
+# 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 logging
+import abc
+
+logger = logging.getLogger(__name__)
+
+
+
+class BaseAction(object):
+    """ Base class for actions.
+    An action class defines how to process an action, and then it can be processed with different argument values.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name, func_execute):
+        self.__name = name
+        self.__func_execute = func_execute
+        
+    @property
+    def name(self):
+        return self.__name
+    
+    @property
+    def function_execute(self):
+        return self.__func_execute
+    
+    @function_execute.setter
+    def function_execute(self, func):
+        self.__func_execute = func
+    
+    def execute(self, *args, **kwargs):
+        """ Execute action
+        @return Result or None
+        """
+        raise NotImplementedError
+        
+    
+class Action(BaseAction):
+    """ Action without input.
+    """
+    def __init__(self, name, func_execute):
+        super().__init__(name, func_execute)
+        
+    def execute(self, *args, **kwargs):
+        """ Execute action
+        @return Result or None
+        """
+        return self.function_execute(*args, **kwargs)
+    
+    
+class FindAction(BaseAction):
+    """ Action launching Finder.find method with given find type.
+    """
+    def __init__(self, name, find_builder, func_execute=None, finder=None, find_type=None):
+        super().__init__(f"find '{finder.element_description}'" if name is None and finder is not None else name, func_execute)
+        self.__find_builder = find_builder
+        
+        if finder is not None:
+            def f(*args, **kwargs):
+                return finder.find(find_type, *args, **kwargs)
+            self.function_execute = f
+        
+    def execute(self, container=None, candidates=None, find_context=None, find_parameters=None):
+        container, candidates, find_context, find_parameters = self.__find_builder.update_find_inputs(container, candidates, find_context, find_parameters)
+        return self.function_execute(container, candidates, find_context, find_parameters)
+    
+class FindAllAction(BaseAction):
+    """ Action launching Finder.find_all method with given find type.
+    """
+    def __init__(self, name, find_builder, func_execute=None, finder=None, find_type=None):
+        super().__init__(f"find all '{finder.element_description}'" if name is None and finder is not None else name, func_execute)
+        self.__find_builder = find_builder
+        
+        if finder is not None:
+            def f(*args, **kwargs):
+                return finder.find_all(find_type, *args, **kwargs)
+            self.function_execute = f
+        
+    def execute(self, container=None, candidates=None, find_context=None, find_parameters=None):
+        container, candidates, find_context, find_parameters = self.__find_builder.update_find_inputs(container, candidates, find_context, find_parameters)
+        return self.function_execute(container, candidates, find_context, find_parameters)
+    
+    
+    
+    
+    

holado_core/common/actors/actor.py

@@ -0,0 +1,226 @@
+#################################################
+# 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 logging
+import abc
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.actors.actions import Action
+from holado_core.common.handlers.redo import Redo
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+
+class Actor(object):
+    """ Base class for actor.
+    An actor defines which actions are possible and how to process them.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, module_name):
+        self.__module_name = module_name
+        self.__actor_by_module_name = {}
+        
+    def initialize(self):
+        """
+        Initialize actor
+        """
+        pass
+    
+    @property
+    def module_name(self):
+        return self.__module_name
+    
+    def _get_actor_for_module(self, name):
+        """
+        @param name Module name
+        @return Module actor
+        """
+        if name not in self.__actor_by_module_name:
+            self.__actor_by_module_name[name] = self._initialize_module(name)
+        return self.__actor_by_module_name[name]
+    
+    def _initialize_module(self, name):
+        """
+        Initialize a new instance of given module name
+        @param name Module name
+        @return New module instance
+        """
+        raise TechnicalException(f"Unmanaged module '{name}'")
+    
+    def _call_action_from_module(self, finder_info, method_name, *args, **kwargs):
+        if finder_info is not None and finder_info.module_name is not None:
+            module = self._get_actor_for_module(finder_info.module_name)
+            if hasattr(module, method_name):
+                method = getattr(module, method_name)
+            else:
+                raise TechnicalException(f"Method '{method_name}' is missing in module '{finder_info.module_name}'")
+            return method(*args, **kwargs)
+        else:
+            raise TechnicalException("No such action")
+
+    def act_then(self, action_1, action_2):
+        """
+        @param action_1 First action
+        @param action_2 Second action
+        @return Action that process first action then second action
+        """
+        def func(*args, **kwargs):
+            result_action_1 = action_1.execute(*args, **kwargs)
+            return action_2.execute(result_action_1)
+        return Action(f"{action_1.name} then {action_2.name}", func)
+    
+    def _act_with_redo(self, action):
+        """
+        Manage redo for given action
+        @param action Action
+        @return New action managing redo
+        """
+        raise TechnicalException(f"Unmanaged action type '{Typing.get_object_class_fullname(action)}'")
+    
+    def _get_redo(self, action, *args, **kwargs):
+        """
+        Redo an action
+        @param action Action
+        """
+        class ActionRedo(Redo):
+            def __init__(self):
+                super().__init__(f"redo {action.name}")
+                
+            def _process(self):
+                return action.execute(*args, **kwargs)
+            
+            def _get_waited_description(self):
+                return action.name
+            
+        return ActionRedo()
+    
+    def redo_until(self, action, action_args, action_kwargs, value, timeout_seconds):
+        """
+        Redo until action result for given arguments is given value
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param value Value
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_until(value)
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} until '{value}'", func)
+    
+    def redo_until_none(self, action, action_args, action_kwargs, timeout_seconds):
+        """
+        Redo until action result for given arguments is None
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_until_none()
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} until None", func)
+    
+    def redo_until_not_none(self, action, action_args, action_kwargs, timeout_seconds):
+        """
+        Redo until action result for given arguments is not None
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_until_not_none()
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} until not None", func)
+    
+    def redo_while(self, action, action_args, action_kwargs, value, timeout_seconds):
+        """
+        Redo while action result for given arguments is given value
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param value Value
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_while(value)
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} while '{value}'", func)
+    
+    def redo_while_none(self, action, action_args, action_kwargs, timeout_seconds):
+        """
+        Redo while action result for given arguments is None
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_while_none()
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} while None", func)
+    
+    def redo_while_not_none(self, action, action_args, action_kwargs, timeout_seconds):
+        """
+        Redo while action result for given arguments is not None
+        @param action Action
+        @param action_args Action args
+        @param action_kwargs Action kwargs
+        @param timeout_seconds Timeout in seconds (if None, default timeout is used)
+        @return New action processing redo
+        """
+        def func():
+            redo = self._get_redo(action, *action_args, **action_kwargs)
+            redo.redo_while_not_none()
+            if timeout_seconds is not None:
+                redo.with_timeout(timeout_seconds)
+            redo.execute()
+            return None
+            
+        return Action(f"redo {action.name} while not None", func)
+    
+    
+    
+    

holado_core/common/actors/element_actor.py

@@ -0,0 +1,32 @@
+#################################################
+# 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 logging
+import abc
+from holado_core.common.actors.find_actor import FindActor
+
+logger = logging.getLogger(__name__)
+
+
+
+class ElementActor(FindActor):
+    """ Base class for element actor.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, module_name):
+        super().__init__(module_name)
+    
+    
+    
+    
+    

holado_core/common/actors/find_actor.py

@@ -0,0 +1,106 @@
+#################################################
+# 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 logging
+import abc
+from holado_core.common.finders.tools.find_builder import FindBuilder
+from holado_core.common.actors.actions import FindAllAction, FindAction, Action
+from holado_core.common.actors.actor import Actor
+
+logger = logging.getLogger(__name__)
+
+
+
+class FindActor(Actor):
+    """ Base class for find actor.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, module_name):
+        super().__init__(module_name)
+        self.__find_builder = None
+        
+    def initialize(self):
+        """
+        Initialize actor
+        """
+        self.__find_builder = self.default_find_builder
+    
+    @property
+    def default_find_builder(self):
+        """
+        @return New default find builder for this inspector
+        """
+        return FindBuilder()
+    
+    @property
+    def find_builder(self):
+        """
+        @return Find builder defined for this inspector
+        """
+        return self.__find_builder
+    
+    def act_find(self, finder, find_type, redo=True):
+        """
+        @param finder Finder
+        @param find_type Find type
+        @return Action that find element with finder
+        """
+        res = FindAction(None, self.find_builder, finder=finder, find_type=find_type)
+        return self._act_with_redo(res) if redo else res
+    
+    def act_find_all(self, finder, find_type, redo=True):
+        """
+        @param finder Finder
+        @param find_type Find type
+        @return Action that find all elements with finder
+        """
+        res = FindAllAction(None, self.find_builder, finder=finder, find_type=find_type)
+        return self._act_with_redo(res) if redo else res
+    
+    def act_number_of_occurrences(self, finder=None, find_type=None):
+        """
+        @return Number of occurrences
+        """
+        if finder is None:
+            def func(elements):
+                return len(elements)
+            return Action("number of occurences", func)
+        else:
+            return self.act_then(
+                self.act_find_all(finder, find_type),
+                self.act_number_of_occurrences() )
+    
+    def _act_with_redo(self, action):
+        """
+        Manage redo for given action
+        @param action Action
+        @return New action managing redo
+        """
+        if isinstance(action, FindAction) or isinstance(action, FindAllAction):
+            def func(container, candidates, find_context, find_parameters):
+                if find_parameters.redo:
+                    new_parameters = find_parameters.with_redo(False)
+                    redo = self._get_redo(action, container, candidates, find_context, new_parameters)
+                    redo.ignore_all(find_parameters.redo_ignored_exceptions)
+                    return redo.execute()
+                else:
+                    return action.execute(container, candidates, find_context, find_parameters)
+                
+            return type(action)(f"{action.name} with redo", self.find_builder, func)
+        else:
+            return super()._act_with_redo(action)
+    
+    
+    
+    
+    

holado_core/common/actors/tree_actor.py

@@ -0,0 +1,32 @@
+#################################################
+# 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 logging
+import abc
+from holado_core.common.actors.element_actor import ElementActor
+
+logger = logging.getLogger(__name__)
+
+
+
+class TreeActor(ElementActor):
+    """ Base class for elements tree actor.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, module_name):
+        super().__init__(module_name)
+    
+    
+    
+    
+    

holado_core/common/actors/verify_actions.py

@@ -0,0 +1,69 @@
+#################################################
+# 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 logging
+import abc
+from holado_core.common.actors.actions import ActionOnInput
+from holado_core.common.tools.tools import Tools
+from holado_core.common.exceptions.verify_exception import VerifyException
+
+logger = logging.getLogger(__name__)
+
+
+
+class VerifyInput(ActionOnInput):
+    """ Generic verify of input.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name, raise_exception):
+        super().__init__(name)
+        self.__raise_exception = raise_exception
+        
+    @property
+    def name(self):
+        return self.__name
+    
+    def execute(self, input_):
+        res = None
+        try:
+            res = self._verify(input_)
+        except Exception as exc:
+            if self.__raise_exception:
+                raise exc
+            else:
+                res = False
+                if Tools.do_log(logger, logging.DEBUG):
+                    logger.debug(f"Verify [{self.name}] has failed: {Tools.represent_exception(exc)}")
+                
+        if not res and self.__raise_exception:
+            self._raise_verify_exception()
+        return res
+
+    def _verify(self, input_):
+        """
+        @param input_ Input
+        @return Result of verify
+        """
+        raise NotImplementedError
+
+    def _raise_verify_exception(self):
+        """
+        Raise verify exception
+        """
+        raise VerifyException(f"Verify [{self.name}] has failed")
+    
+    
+    
+    
+    
+    

holado_core/common/block/base.py

@@ -0,0 +1,122 @@
+
+#################################################
+# 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 abc
+from datetime import datetime
+import logging
+from holado_core.common.tools.tools import Tools
+
+logger = logging.getLogger(__name__)
+
+
+class BaseBlock(object):
+    '''
+    Base class for blocks
+    '''
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name, ID=None):
+        super().__init__()
+        self.__id = ID if ID is not None else name
+        self.__name = name
+        
+        self.__start_dt = None
+        self.__end_dt = None
+
+    @property
+    def ID(self):
+        return self.__id
+    
+    @ID.setter
+    def ID(self, id_):
+        self.__id = id_
+
+    @property
+    def name(self):
+        return self.__name
+
+    @property
+    def start_datetime(self):
+        return self.__start_dt
+
+    @property
+    def end_datetime(self):
+        return self.__end_dt
+
+    @property
+    def duration(self):
+        if self.__start_dt is not None and self.__end_dt is not None:
+            return self.__end_dt - self.__start_dt
+        else:
+            return None
+    
+    @abc.abstractmethod
+    def process(self):
+        raise NotImplementedError
+
+    def _process_start(self):
+        self.__start_dt = datetime.now()
+
+    def _process_end(self):
+        self.__end_dt = datetime.now()
+    
+
+
+class BaseScope(BaseBlock):
+    '''
+    Base class for scope blocks
+    '''
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name, ID=None):
+        super().__init__(name, ID=ID)
+        self.__content = []
+    
+    def process(self, *args, **kwargs):
+        """
+        Process the scope.
+        Returns last scope step result
+        """
+        res = None
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Processing scope [{self.name}]: begin")
+        
+        self._process_start()
+        try:
+            res = self._process_blocks(*args, **kwargs)
+        finally:
+            self._process_end()
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug(f"Processing scope [{self.name}]: end")
+
+        return res
+    
+    def _process_blocks(self, *args, **kwargs):
+        """
+        Process inner blocks of the scope.
+        Returns last scope step result
+        """
+        res = None
+        for block in self.__content:
+            res = block.process(*args, **kwargs)
+        return res
+    
+    def add_block(self, block):
+        self.__content.append(block)
+        
+    def add_method_call(self, func, *args, **kwargs):
+        from holado_core.common.block.block_method import BlockMethod
+        self.add_block( BlockMethod(func, *args, **kwargs) )
+        
+