holado 0.13.22__py3-none-any.whl

holado_core/common/inspectors/tools/inspect_builder.py

@@ -0,0 +1,169 @@
+#################################################
+# 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_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.inspectors.tools.inspect_context import InspectContext
+from holado_core.common.inspectors.tools.inspect_parameters import InspectParameters
+
+
+class InspectBuilder(object):
+    """ Inspect builder, used to create new InspectContext and InspectParameters.
+    
+    It is used to store available modules and finder types with Inspector.default_inspect_builder,
+    and activated modules and finder types with Inspector.inspect_builder (or for GUI, GUIWindow.inspect_builder).
+    By default all available modules are activated  it can be modified by overriding inspect_builder property in a new sub-class.
+    """
+    
+    def __init__(self):
+        self.__inspector = None
+        
+        self.__module_names = []
+        self.__inspect_builder_by_module_name = {}
+        
+        self.__default_context = None
+        self.__default_parameters = None
+    
+    def initialize(self, inspector):
+        """
+        @param inspector Inspector
+        """
+        self.__inspector = inspector
+    
+    @property
+    def inspector(self):
+        return self.__inspector
+        
+    @property
+    def module_names(self):
+        """
+        @return Module names in order of priority
+        """
+        return self.__module_names
+    
+    def add_module(self, module_name, module_inspect_builder = None):
+        """
+        Add given module in list of managed modules, with given inspect builder
+        @param module_name Module name
+        @param module_inspect_builder Inspect builder to use with given module
+        """
+        if module_name in self.__module_names:
+            raise TechnicalException(f"Module '{module_name}' already exists")
+            
+        if module_inspect_builder is None:
+            module_inspector = self.__inspector.get_inspector_for_module(module_name)
+            module_inspect_builder = module_inspector.default_inspect_builder
+            
+        self.__module_names.append(module_name)
+        self.__inspect_builder_by_module_name[module_name] = module_inspect_builder
+    
+    def remove_module(self, module_name):
+        """
+        Remove given module from managed modules
+        @param module_name Module name
+        """
+        if module_name not in self.__module_names:
+            raise TechnicalException(f"Module '{module_name}' doesn't exist")
+        self.__module_names.remove(module_name)
+        self.__inspect_builder_by_module_name.remove(module_name)
+    
+    def remove_all_modules(self):
+        """
+        Remove all modules from managed modules
+        """
+        self.__module_names.clear()
+        self.__inspect_builder_by_module_name.clear()
+    
+    def get_inspect_builder_for_module(self, module_name):
+        """
+        @param module_name Module name
+        @return Inspect builder for given module name
+        """
+        if module_name not in self.__inspect_builder_by_module_name:
+            raise TechnicalException(f"Module '{module_name}' doesn't exist")
+        return self.__inspect_builder_by_module_name[module_name]
+    
+    def get_parameters_for_module(self, module_name, inspect_parameters):
+        """
+        @param module_name Module name
+        @param inspect_parameters Current inspect parameters
+        @return Module inspect parameters updated with current inspect parameter
+        """
+        return self.get_inspect_builder_for_module(module_name).parameters().get_module_parameters(inspect_parameters)
+    
+    @property
+    def default_context(self):
+        """
+        Get or create default context.
+        This method is usually used to build the default context.
+        @return Default inspect context
+        """
+        if self.__default_context is None:
+            self.__default_context = self._initialize_default_context()
+        return self.__default_context
+    
+    def _initialize_default_context(self):
+        return InspectContext.default()
+        
+    def context(self, inspect_context=None):
+        """
+        @param inspect_context Inspect context to update
+        @return Updated inspect context
+        """
+        res = inspect_context
+        if res is None:
+            res = self.default_context
+        return res
+    
+    @property
+    def default_parameters(self):
+        """
+        Get or create default parameters.
+        This method is usually used to build the default parameters.
+        @return Default inspect parameters
+        """
+        if self.__default_parameters is None:
+            self.__default_parameters = self.initialize_default_parameters()
+        return self.__default_parameters
+    
+    def initialize_default_parameters(self):
+        return InspectParameters.default_with_raise()
+        
+    def parameters(self, inspect_parameters=None, raise_exception=None):
+        """
+        @param inspect_parameters Inspect parameters to update
+        @param raise_exception Whether raise exceptions or not
+        @return Find parameters
+        """
+        res = inspect_parameters
+        if res is None:
+            res = self.default_parameters
+            
+        if raise_exception is not None:
+            res = res.with_raise(raise_exception)
+            
+        return res
+    
+    def parameters_with_raise(self):
+        """
+        @return Default inspect parameters with raises
+        """
+        return self.parameters(True)
+    
+    def parameters_without_raise(self):
+        """
+        @return Default inspect parameters without any raise
+        """
+        return self.parameters(False)
+    
+    
+    
+    

holado_core/common/inspectors/tools/inspect_context.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 self 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 self 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 copy
+
+
+class InspectContext(object):
+    """ Base inspect context
+    In usual use cases, the appropriate sub-class should be instantiated.
+    """
+    
+    __instance_default = None
+    
+    def __init__(self, find_type=None, inspect_context=None):
+        if find_type is not None:
+            self.__find_type = find_type
+        elif inspect_context is not None:
+            self.__find_type = inspect_context.find_type
+        else:
+            self.__find_type = None
+    
+    @property
+    def find_type(self):
+        """
+        @return Find type
+        """
+        return self.__find_type
+    
+    def with_find_type(self, find_type):
+        """
+        Note: if wanted find type is the same, self instance is returned, else a new one is returned
+        @param find_type Find type
+        @return Same context but with given find type
+        """
+        if find_type == self.find_type:
+            return self
+        else:
+            res = copy.deepcopy(self)
+            res.find_type = find_type
+            return res
+    
+    @staticmethod
+    def default(find_type=None):
+        """
+        @return Default inspect context
+        """
+        if InspectContext.__instance_default is None:
+            InspectContext.__instance_default = InspectContext()
+        res = InspectContext.__instance_default
+        
+        if find_type is not None:
+            res = res.with_find_type(find_type)
+        
+        return res
+    
+    
+    
+    
+    
+    

holado_core/common/inspectors/tools/inspect_parameters.py

@@ -0,0 +1,181 @@
+#################################################
+# 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 self 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 self 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 copy
+from holado_core.common.finders.else_finder import ElseFinder
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+
+class InspectParameters(object):
+    """ Inspect parameters
+    """
+    
+    __instance_default = None
+    __instance_default_without_raise = None
+    
+    def __init__(self, raise_no_such_finder=True, finder_types=None, result_finder_type=None):
+        """
+        Constructor
+        @param raise_no_such_finder If True, raise NoSuchElementException, else return None, when no element is found.
+        @param finder_types Finder types to use
+        @param result_finder_type Type of finder result when multiple finders are possible
+        """
+        self.raise_no_such_finder = raise_no_such_finder
+        self.finder_types = [] if finder_types is None else finder_types
+        self.result_finder_type = ElseFinder if result_finder_type is None else result_finder_type
+    
+    def get_module_parameters(self, inspect_parameters):
+        """
+        @param inspect_parameters Current inspect parameters
+        @return Module inspect parameters updated with current inspect parameter
+        """
+        return self.with_result_finder_type(inspect_parameters.result_finder_type) \
+            .with_raise(inspect_parameters.raise_no_such_finder)
+    
+    def set_raise(self, raise_exception):
+        """
+        @param raise_exception Whether raise exceptions or not
+        """
+        self.raise_no_such_finder = raise_exception
+    
+    def with_raise(self, raise_exception=True):
+        """
+        Note: if raise booleans are same, self instance is returned, else a new one is returned
+        @param raise_exception Whether raise exceptions or not
+        @return Same parameters but with raise
+        """
+        if self.raise_no_such_finder == raise_exception:
+            return self
+        else:
+            res = copy.deepcopy(self)
+            res.raise_no_such_finder = raise_exception
+            return res
+        
+    def without_raise(self):
+        """
+        Note: if raise booleans are already False, self instance is returned, else a new one is returned
+        @return Same parameters but without raise
+        """
+        return self.with_raise(False)
+    
+    def add_finder_type(self, finder_type):
+        """
+        @param finder_type Finder type to add
+        """
+        if finder_type in self.finder_types:
+            raise TechnicalException(f"Finder type '{finder_type}' already exists")
+        self.finder_types.append(finder_type)
+    
+    def add_finder_types(self, finder_types):
+        """
+        @param finder_types Finder types to add
+        """
+        for finder_type in finder_types:
+            self.add_finder_type(finder_type)
+    
+    def remove_finder_type(self, finder_type):
+        """
+        @param finder_type Finder type to remove
+        """
+        if finder_type not in self.finder_types:
+            raise TechnicalException(f"Finder type '{finder_type}' doesn't exist")
+        self.finder_types.remove(finder_type)
+    
+    def remove_finder_types(self, finder_types):
+        """
+        @param finder_types Finder types to remove
+        """
+        for finder_type in finder_types:
+            self.remove_finder_type(finder_type)
+    
+    def remove_all_finder_types(self):
+        """
+        Remove all finder types
+        """
+        self.finder_types.clear()
+    
+    def with_finder_type(self, finder_type):
+        """
+        Note: if wanted finder type is already set, this instance is returned, else a new one is returned
+        @param finder_type Finder type
+        @return Same parameters but with given finder type
+        """
+        if finder_type in self.finder_types:
+            return self
+        else:
+            res = copy.deepcopy(self)
+            res.finder_types.append(finder_type)
+            return res
+        
+    def with_finder_types(self, finder_types):
+        """
+        Note: if wanted finder types are already set, this instance is returned, else a new one is returned
+        @param finder_types Finder types
+        @return Same parameters but with given finder types
+        """
+        res = self
+        for finder_type in finder_types:
+            res = res.with_find_type(finder_type)
+        return res
+        
+    def set_result_finder_type(self, result_finder_type):
+        """
+        @param result_finder_type Result finder type
+        """
+        self.result_finder_type = result_finder_type
+    
+    def with_result_finder_type(self, result_finder_type):
+        """
+        Note: if given result finder class is already set, this instance is returned, else a new one is returned
+        @param result_finder_type Result finder class
+        @return Same parameters but with given result finder class
+        """
+        if self.result_finder_type == result_finder_type:
+            return self
+        else:
+            res = copy.deepcopy(self)
+            res.result_finder_type = result_finder_type
+            return res
+        
+    @staticmethod
+    def default(raise_exception=True):
+        """
+        @param raise_exception Whether raise exceptions or not
+        @return Default inspect parameters with given raiseability
+        """
+        if raise_exception:
+            return InspectParameters.default_with_raise()
+        else:
+            return InspectParameters.default_without_raise()
+    
+    @staticmethod
+    def default_with_raise():
+        """
+        @return Default find parameters with raises
+        """
+        if InspectParameters.__instance_default is None:
+            InspectParameters.__instance_default = InspectParameters()
+        return InspectParameters.__instance_default
+    
+    @staticmethod
+    def default_without_raise():
+        """
+        @return Default find parameters without any raise
+        """
+        if InspectParameters.__instance_default_without_raise is None:
+            InspectParameters.__instance_default_without_raise = InspectParameters(raise_no_such_finder=False)
+        return InspectParameters.__instance_default_without_raise
+    
+
+    
+    
+    

holado_core/common/inspectors/tree_inspector.py

@@ -0,0 +1,73 @@
+#################################################
+# 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
+from holado_core.common.finders.then_finder import ThenFinder
+from holado_core.common.inspectors.element_inspector import ElementInspector
+from holado_core.common.finders.after_in_tree_finder import AfterInTreeFinder
+import abc
+from holado_core.common.inspectors.tools.inspect_parameters import InspectParameters
+from holado_core.common.inspectors.tools.inspect_context import InspectContext
+
+logger = logging.getLogger(__name__)
+
+
+
+class TreeInspector(ElementInspector):
+    """ Base class for inspector on tree elements.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, module_name):
+        super().__init__(module_name)
+    
+    """
+    Find element with given finder, after element in tree found with given finder
+    @param finder_first Finder for first element
+    @param finder_after_first Finder for element to find after first one
+    @param inspect_context Inspect context
+    @param inspect_parameters Inspect parameters
+    @return Finder
+    """
+    def get_finder_element_after(self, finder_first, finder_after_first, inspect_context:InspectContext=None, inspect_parameters:InspectParameters=None):
+        description = f"{finder_after_first.element_description} after {finder_first.element_description} in tree"
+        res = ThenFinder(description)
+        
+        # Find first element
+        res.set_next_finder(finder_first)
+        
+        # Then find in tree
+        res.set_next_finder( AfterInTreeFinder(finder_after_first, description) )
+        
+        return self._build_result_finder(res, inspect_context, inspect_parameters)
+    
+    def get_finder_parent(self, inspect_context:InspectContext=None, inspect_parameters:InspectParameters=None):
+        """
+        Finder for parent
+        @param inspect_context Inspect context
+        @param inspect_parameters Inspect parameters
+        @return Finder
+        """
+        raise NotImplementedError
+    
+    def get_finder_children(self, inspect_context:InspectContext=None, inspect_parameters:InspectParameters=None):
+        """
+        Finder for children
+        @param inspect_context Inspect context
+        @param inspect_parameters Inspect parameters
+        @return Finder
+        """
+        raise NotImplementedError
+    
+    
+    
+    

holado_core/common/resource/persisted_data_manager.py

@@ -0,0 +1,113 @@
+
+#################################################
+# 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
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.tools import Tools
+import copy
+from holado.common.handlers.undefined import undefined_argument
+
+logger = logging.getLogger(__name__)
+
+
+
+class PersistedDataManager():
+    """
+    Manage data persisted in a dedicated table.
+    """
+    def __init__(self, data_name, table_name, table_sql_create, db_name="default", do_audit=False):
+        self.__data_name = data_name
+        self.__table_name = table_name
+        self.__table_sql_create = table_sql_create
+        self.__db_name = db_name
+        self.__do_audit = do_audit
+        
+        self.__resource_manager = None
+    
+    def initialize(self, resource_manager):
+        self.__resource_manager = resource_manager
+        
+    @property
+    def table_name(self):
+        return self.__table_name
+    
+    def does_persistent_db_exist(self):
+        return self.__resource_manager.has_data_table(self.__table_name, db_name=self.__db_name, is_persistent=True) \
+            and self.__resource_manager.check_data_table_schema(self.__table_name, self.__table_sql_create, db_name=self.__db_name, is_persistent=True)
+    
+    def ensure_persistent_db_exists(self):
+        if self.__resource_manager.has_data_table(self.__table_name, db_name=self.__db_name, is_persistent=True):
+            if self.__resource_manager.check_data_table_schema(self.__table_name, self.__table_sql_create, db_name=self.__db_name, is_persistent=True):
+                # Table already exists with the right schema
+                return
+            else:
+                # Table already exists but with wrong schema => delete table before creating it again
+                self.__resource_manager.delete_data_table(self.__table_name, db_name=self.__db_name, is_persistent=True, raise_if_not_exist=True, do_commit=True)
+        
+        # Create table
+        # Note: method create_data_table raise an exception if it doesn't succeed to create the table
+        self.__resource_manager.create_data_table(self.__table_name, self.__table_sql_create, db_name=self.__db_name, is_persistent=True, raise_if_exist=True, do_commit=True, do_audit=self.__do_audit)
+    
+    def has_persisted_data(self, filter_data=None, filter_compare_data=None):
+        return self.__resource_manager.has_data(self.__table_name, where_data=filter_data, where_compare_data=filter_compare_data, db_name=self.__db_name, is_persistent=True)
+        
+    def get_persisted_datas(self, filter_data=None, filter_compare_data=None, as_generator=False):
+        """
+        Note: Whereas 'data' is already a plural, a 's' is added in method name to be coherent with other method names
+        """
+        return self.__resource_manager.get_data(self.__table_name, where_data=filter_data, where_compare_data=filter_compare_data, db_name=self.__db_name, is_persistent=True, result_as_dict_list=True, as_generator=as_generator)
+
+    def get_persisted_data(self, filter_data=None, filter_compare_data=None):
+        """
+        Note: Whereas 'datum' should be the right word in method name since method returns only one datum, method is named with 'data' in its usual singular meaning for most people.
+        """
+        data = self.get_persisted_datas(filter_data=filter_data, filter_compare_data=filter_compare_data)
+        if len(data) > 1:
+            raise TechnicalException(f"Too many ({len(data)}) {self.__data_name} found for filter {filter_data}.")
+        elif len(data) == 1:
+            return data[0]
+        else:
+            return None
+        
+    def count_persisted_data(self, filter_data=None, filter_compare_data=None):
+        return self.__resource_manager.count_data(self.__table_name, where_data=filter_data, where_compare_data=filter_compare_data, db_name=self.__db_name, is_persistent=True)
+
+    def update_persisted_data(self, data, filter_data=None, filter_compare_data=None):
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Update persisted {self.__data_name} for {filter_data} and {filter_compare_data}: {data}")
+        self.__resource_manager.update_data(self.__table_name, data, where_data=filter_data, where_compare_data=filter_compare_data, db_name=self.__db_name, is_persistent=True)
+
+    def add_persisted_data(self, data, persisted_filter_data=None):
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Add persisted {self.__data_name} for {persisted_filter_data}: {data}")
+        data = copy.copy(data)
+        if persisted_filter_data:
+            data.update(persisted_filter_data)
+        self.__resource_manager.add_data(self.__table_name, data, db_name=self.__db_name, is_persistent=True)
+        
+    def update_or_add_persisted_data(self, persisted_filter_data, data, persisted_data=undefined_argument):
+        if persisted_data is undefined_argument:
+            has_persisted_data = self.has_persisted_data(persisted_filter_data)
+        else:
+            has_persisted_data = persisted_data is not None
+        
+        if has_persisted_data:
+            self.update_persisted_data(data, filter_data=persisted_filter_data)
+        else:
+            self.add_persisted_data(data, persisted_filter_data)
+        
+    def delete_persisted_data(self, filter_data):
+        self.__resource_manager.delete_data(self.__table_name, where_data=filter_data, db_name=self.__db_name, is_persistent=True)
+
+
+