holado 0.13.22__py3-none-any.whl

holado_python/common/tools/comparators/bytes_comparator.py

@@ -0,0 +1,48 @@
+
+#################################################
+# 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.tools.comparators.comparator import Comparator
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+class BytesComparator(Comparator):
+    
+    def __init__(self, encoding_1=None, encoding_2=None):
+        super().__init__("bytes")
+        
+        self.__encoding_1 = encoding_1
+        self.__encoding_2 = encoding_2
+    
+    def _convert_input1(self, obj, name):
+        return self.__convert_input(obj, name, self.__encoding_1)
+    
+    def _convert_input2(self, obj, name):
+        return self.__convert_input(obj, name, self.__encoding_2)
+    
+    def __convert_input(self, obj, name, encoding):
+        if isinstance(obj, str):
+            if encoding is not None:
+                res = obj.encode(encoding=encoding)
+            else:
+                res = obj.encode()
+        else:
+            res = obj
+            
+        if not isinstance(res, bytes):
+            raise FunctionalException(f"{name.capitalize()} value is not a bytes: [{res}] (type: {Typing.get_object_class_fullname(res)})")
+        return res
+

holado_python/common/tools/comparators/datetime_comparator.py

@@ -0,0 +1,74 @@
+
+#################################################
+# 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.tools.comparators.comparator import Comparator
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from datetime import datetime, timezone
+from holado_python.common.tools.datetime import DateTime
+from holado_core.common.handlers.features.resource_by_type import FeatureObjectAndClassResourceByType
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+
+class DatetimeComparator(Comparator, FeatureObjectAndClassResourceByType):
+    
+    def __init__(self):
+        Comparator.__init__(self, "datetime")
+        FeatureObjectAndClassResourceByType.__init__(self)
+    
+    # Define resource description
+    
+    @classmethod
+    def _get_class_resource_description(cls, plural=False):
+        if plural:
+            return 'class datetime converters'
+        else:
+            return 'class datetime converter'
+    
+    def _get_resource_description(self, plural=False):
+        if plural:
+            return 'datetime converters'
+        else:
+            return 'datetime converter'
+    
+    
+    # Define how to convert imputs before compare
+    
+    def _convert_input(self, obj, name):
+        convert_func = self.get_resource_for_type(obj=obj, raise_if_not_found=False)
+        if convert_func:
+            res = convert_func(obj)
+        else:
+            res = obj
+        
+        if not isinstance(res, datetime):
+            raise FunctionalException(f"{name.capitalize()} value is not a datetime: [{res}] (type: {Typing.get_object_class_fullname(res)})")
+        if res.tzinfo is None:
+            res = res.replace(tzinfo=timezone.utc)
+        return res
+
+
+# Register default datetime converters
+
+DatetimeComparator.register_resource_for_type_in_class('str', None, 
+                                                       lambda o: isinstance(o, str) and DateTime.is_str_datetime(o), 
+                                                       DateTime.str_2_datetime)
+
+DatetimeComparator.register_resource_for_type_in_class('int or float', None, 
+                                                       lambda o: isinstance(o, int) or isinstance(o, float), 
+                                                       DateTime.timestamp_to_datetime)
+
+

holado_python/common/tools/comparators/float_comparator.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
+from holado_core.common.tools.comparators.comparator import Comparator,\
+    CompareOperator
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.converters.converter import Converter
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+class FloatComparator(Comparator):
+    
+    def __init__(self, diff_precision=None, relative_precision=1e-15):
+        """
+        Define the comparing method and its associated precision.
+        If difference precision is defined, difference comparison is applied, else relative comparison is applied.
+        By default, a relative comparison is used with a precision of 1e-15
+        
+        Notes: 
+        1. Usually, python implement float type with 52 digits for significant digits, which is a precision of 2**-52=2.220446049250313e-16. 
+           The default relative precision is 1e-15, a little bit over this limit precision, in order to manage small computational errors.
+           In many cases, this precision is too small ; if you don't know which precision to use, a relative precision of 1e-9 is quite usual.
+        2. For the same reason, the appropriate difference precision is dependent on the values compared and the number of comparable significant digits.
+           If you are not sure, prefer the relative comparison. 
+        :param diff_precision: If defined, a difference comparison is done with this precision
+        :param relative_precision: If defined, a relative comparison is done with this precision
+        """
+        super().__init__("float")
+        
+        self.__diff_precision = diff_precision
+        self.__relative_precision = relative_precision
+
+        if self.__diff_precision is not None:
+            self.__relative_precision = None        
+        if self.__diff_precision is None and self.__relative_precision is None:
+            raise TechnicalException("A precision must be defined") 
+    
+    def _convert_input(self, obj, name):
+        if Converter.is_float(obj):
+            res = float(obj)
+        else:
+            res = obj
+            
+        if not isinstance(res, float):
+            raise FunctionalException(f"{name.capitalize()} value is not a float: [{res}] (type: {Typing.get_object_class_fullname(res)})")
+        return res
+    
+    def _compare_result(self, obj_1, operator: CompareOperator, obj_2):
+        if operator == CompareOperator.Different:
+            return not self.__almost_equals(obj_1, obj_2)
+        elif operator == CompareOperator.Equal:
+            return self.__almost_equals(obj_1, obj_2)
+        elif operator == CompareOperator.Inferior:
+            return (obj_1 < obj_2)
+        elif operator == CompareOperator.InferiorOrEqual:
+            return (obj_1 < obj_2) or self.__almost_equals(obj_1, obj_2)
+        elif operator == CompareOperator.Superior:
+            return (obj_1 > obj_2)
+        elif operator == CompareOperator.SuperiorOrEqual:
+            return (obj_1 > obj_2) or self.__almost_equals(obj_1, obj_2)
+        else:
+            raise TechnicalException(f"Unmanaged compare operator {operator}")
+    
+    def __almost_equals(self, val_1, val_2):
+        if self.__relative_precision is not None:
+            return self.__almost_equals_relative(val_1, val_2)
+        else:
+            return self.__almost_equals_diff(val_1, val_2)
+    
+    def __almost_equals_diff(self, val_1, val_2):
+        diff = abs(val_1 - val_2)
+        return (diff < self.__diff_precision)
+    
+    def __almost_equals_relative(self, val_1, val_2):
+        diff = abs(val_1 - val_2)
+        vmax = max(abs(val_1), abs(val_2))
+        if vmax > 0:
+            return (diff < vmax * self.__relative_precision)
+        else:
+            return True
+    
+    
+    

holado_python/common/tools/comparators/integer_comparator.py

@@ -0,0 +1,37 @@
+
+#################################################
+# 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.tools.comparators.comparator import Comparator
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.tools.converters.converter import Converter
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+class IntegerComparator(Comparator):
+    
+    def __init__(self):
+        super().__init__("integer")
+        
+    def _convert_input(self, obj, name):
+        if Converter.is_integer(obj):
+            res = int(obj)
+        else:
+            res = obj
+            
+        if not isinstance(res, int):
+            raise FunctionalException(f"{name.capitalize()} value is not an integer: [{res}] (type: {Typing.get_object_class_fullname(res)})")
+        return res
+    

holado_python/common/tools/comparators/string_comparator.py

@@ -0,0 +1,99 @@
+
+#################################################
+# 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.tools.comparators.comparator import Comparator,\
+    CompareOperator
+from holado_core.common.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+from holado_core.common.exceptions.verify_exception import VerifyException
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+class StringComparator(Comparator):
+
+    def __init__(self, text_interpreter=None, text_verifier=None):
+        super().__init__("string")
+        self.__text_interpreter = text_interpreter
+        self.__text_verifier = text_verifier
+        
+    def __get_text_interpreter(self):
+        if self.__text_interpreter is not None:
+            return self.__text_interpreter
+        elif SessionContext.instance().has_scenario_context():
+            return SessionContext.instance().get_scenario_context().get_text_interpreter()
+        else:
+            return SessionContext.instance().text_interpreter
+    
+    def __get_text_verifier(self):
+        if self.__text_verifier is not None:
+            return self.__text_verifier
+        elif SessionContext.instance().has_scenario_context():
+            return SessionContext.instance().get_scenario_context().get_text_verifier()
+        else:
+            return SessionContext.instance().text_verifier
+    
+    def _compare_by_operator(self, obj_1, operator: CompareOperator, obj_2, is_obtained_vs_expected = True, raise_exception = True, redirect_to_equals=True):
+        if operator == CompareOperator.Equal:
+            return self.__verify_by_text_interpreter(obj_1, obj_2, is_obtained_vs_expected, raise_exception)
+        else:
+            i_obj_1 = self.__get_text_interpreter().interpret(obj_1)
+            i_obj_2 = self.__get_text_interpreter().interpret(obj_2)
+            super()._compare_by_operator(i_obj_1, operator, i_obj_2, is_obtained_vs_expected, raise_exception, redirect_to_equals=redirect_to_equals)
+    
+    def _convert_input(self, obj, name):
+        if isinstance(obj, str):
+            res = obj
+        else:
+            res = str(obj)
+        return res
+    
+    def __verify_by_text_interpreter(self, str_1, str_2, is_obtained_vs_expected = True, raise_exception = True):
+        """
+        Compare by equality.
+        Switch is_obtained_vs_expected:
+            - True: value 1 is considered obtained ; value 2 is considered expected ; only expected value is interpreted
+            - False: value 1 is considered expected ; value 2 is considered obtained ; only expected value is interpreted
+            - None: value 1 is compared to value 2 ; both values are interpreted
+        """
+        if not isinstance(str_1, str):
+            if raise_exception:
+                raise VerifyException(f"{self._get_name_1(is_obtained_vs_expected).capitalize()} value is not a string: [{str_1}] (type: {Typing.get_object_class_fullname(str_1)})")
+            else:
+                if Tools.do_log(logger, logging.DEBUG):
+                    logger.debug(f"Compare result is false since {self._get_name_1(is_obtained_vs_expected)} value is not a string: [{str_1}] (type: {Typing.get_object_class_fullname(str_1)})")
+                return False
+        if not isinstance(str_2, str):
+            if raise_exception:
+                raise VerifyException(f"{self._get_name_2(is_obtained_vs_expected).capitalize()} value is not a string: [{str_2}] (type: {Typing.get_object_class_fullname(str_2)})")
+            else:
+                if Tools.do_log(logger, logging.DEBUG):
+                    logger.debug(f"Compare result is false since {self._get_name_2(is_obtained_vs_expected)} value is not a string: [{str_2}] (type: {Typing.get_object_class_fullname(str_2)})")
+                return False
+        
+        if is_obtained_vs_expected is None:
+            # Interpret obtained as TextInterpreter.verify won't do it on obtained parameter
+            str_1 = self.__get_text_interpreter().interpret(str_1)
+        
+        if is_obtained_vs_expected == True or is_obtained_vs_expected is None:
+            res = self.__get_text_verifier().verify(str_1, str_2, raise_exception=raise_exception)
+        else:
+            res = self.__get_text_verifier().verify(str_2, str_1, raise_exception=raise_exception)
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug("[{}] str_1 equals str_2 => {}\n    str_1 = [{}]\n    str_2 = [{}]".format(Typing.get_object_class(self).__name__, res, str_1, str_2))
+        return res
+    
+    

holado_python/common/tools/comparators/type_comparator.py

@@ -0,0 +1,31 @@
+
+#################################################
+# 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.tools.comparators.comparator import Comparator
+
+logger = logging.getLogger(__name__)
+
+
+class TypeComparator(Comparator):
+    
+    def __init__(self):
+        super().__init__("type")
+        
+    def _convert_input(self, obj, name):
+        if isinstance(obj, type):
+            res = obj
+        else:
+            res = type(obj)
+        return res
+