holado 0.13.22__py3-none-any.whl

holado_xml/xml/stream_xml_file.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 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.common.handlers.object import DeleteableObject
+import xmltodict
+from holado_system.system.filesystem.file import File
+import re
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+
+
+def __get_path_manager():
+    return SessionContext.instance().path_manager
+
+
+class StreamXMLFile(DeleteableObject):
+    """
+    Manage a stream XML file.
+    
+    A stream XML file is a file with many root elements that are valid XML.
+    It is useful for example to process workflows of data formatted in XML.
+    An example in HolAdo is the test report DetailedScenarioReportBuilder with an XML file, 
+    which adds in a single file a new scenario XML report after each scenario.
+    """
+
+    def __init__(self, path, auto_flush=True, do_open=False, **open_kwargs):
+        super().__init__(f"stream XML file '{path}'")
+
+        self.__file = File(path, auto_flush=auto_flush, do_open=do_open, **open_kwargs)
+        self.__current_line = None
+        self.__current_pos = None
+
+    def __enter__(self):
+        self.__file.__enter__()
+        return self
+    
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.__file.__exit__(exc_type, exc_val, exc_tb)
+    
+    @property
+    def path(self):
+        return self.__file.path
+
+    @property
+    def internal_file(self):
+        return self.__file
+    
+    @property
+    def is_open(self):
+        return self.__file.is_open
+
+    def open(self, **kwargs):
+        self.__file.open(**kwargs)
+
+    def close(self):
+        self.__file.close()
+
+    def read_element_as_dict(self, **parse_kwargs):
+        # Extract lines of next element
+        lines = []
+        root_tag = None
+        regex_tag_start = re.compile(r"<(?!/)([^ >]+)>")
+        regex_tag_end = re.compile(r"</([^ >]+)>")
+        level = 0
+        is_found = False
+        current_element_line = ""
+        while not is_found:
+            # Read next file line if needed
+            if self.__current_line is None:
+                line = self.__file.readline()
+                if not line:
+                    break
+                self.__current_line = line
+                self.__current_pos = 0
+                current_element_line = ""
+            
+            # Find next tag
+            m_start = regex_tag_start.search(self.__current_line, pos=self.__current_pos)
+            m_end = regex_tag_end.search(self.__current_line, pos=self.__current_pos)
+            #print(f"{root_tag=} ; {level=}  #  {m_start=} ; {m_end=}  #  {self.__current_pos=} in {self.__current_line=}")
+            is_start = m_start is not None and (m_end is None or m_start.start() < m_end.start())
+            is_end = m_end is not None and (m_start is None or m_end.start() < m_start.start())
+            if is_start:
+                current_end = m_start.end()
+                if root_tag is None:
+                    root_tag = m_start.group(1)
+                else:
+                    level += 1
+            elif is_end:
+                current_end = m_end.end()
+                if level > 0:
+                    level -= 1
+                elif m_end.group(1) == root_tag:
+                    root_tag = None
+                    is_found = True
+                else:
+                    raise TechnicalException(f"Failed to read next element from stream XML file '{self.path}' at position {self.__file.tell()}: got root end element tag '{m_end.group(1)}' that doesn't match previous root start element tag '{root_tag}'")
+            else:
+                current_end = len(self.__current_line)
+            
+            # Append in current element line the text until tag
+            current_element_line += self.__current_line[self.__current_pos:current_end]
+            self.__current_pos = current_end
+            
+            # Add element line and reset current line
+            if self.__current_pos >= len(self.__current_line) or is_found:
+                lines.append(current_element_line)
+                if self.__current_pos >= len(self.__current_line):
+                    self.__current_line = None
+        
+        # Check error cases
+        if root_tag is not None:
+            raise TechnicalException(f"Failed to read next element from stream XML file '{self.path}': end of file is reached whereas a root end element tag '{root_tag}' is still expected")
+        
+        # Manage when end of file is reached without new element
+        content = ''.join(lines).strip()
+        if len(content) == 0:
+            return None
+        
+        # Parse element as dict
+        # print(f"Parsing:\n--------------------------------\n{content}\n--------------------------------")
+        return xmltodict.parse(content, **parse_kwargs)
+    
+    def read_elements_as_dict_list(self, **parse_kwargs):
+        res = []
+        while True:
+            element = self.read_element_as_dict(**parse_kwargs)
+            if element is not None:
+                res.append(element)
+            else:
+                break
+        return res
+    
+    def write_element_dict(self, data, pretty=True, full_document=False, indent=Tools.indent_string(4, ''), **unparse_kwargs):
+        unparse_kwargs['pretty'] = pretty
+        unparse_kwargs['full_document'] = full_document
+        unparse_kwargs['indent'] = indent
+        
+        content = xmltodict.unparse(data, **unparse_kwargs)
+        self.__file.write(content)
+        if pretty:
+            self.__file.write('\n')
+    
+    def write_elements_dict_list(self, data_list, pretty=True, full_document=False, indent=Tools.indent_string(4, ''), **unparse_kwargs):
+        for data in data_list:
+            self.write_element_dict(data, pretty=pretty, full_document=full_document, indent=indent, **unparse_kwargs)
+
+
+    @classmethod
+    def read_stream_xml_file_content_as_dict_list(cls, path, open_kwargs=None, parse_kwargs=None):
+        open_kwargs = open_kwargs if open_kwargs is not None else {}
+        parse_kwargs = parse_kwargs if parse_kwargs is not None else {}
+        
+        file = StreamXMLFile(path, **open_kwargs)
+        return file.read_elements_as_dict_list(**parse_kwargs)
+
+    @classmethod
+    def write_stream_xml_file_with_dict_list(cls, path, data_list, open_kwargs=None, unparse_kwargs=None):
+        open_kwargs = open_kwargs if open_kwargs is not None else {}
+        unparse_kwargs = unparse_kwargs if unparse_kwargs is not None else {}
+        
+        __get_path_manager().makedirs(path)
+        
+        file = StreamXMLFile(path, **open_kwargs)
+        file.write_elements_dict_list(data_list, **unparse_kwargs)
+        return file
+
+
+
+

holado_xml/xml/xml_file.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.
+#################################################
+
+from holado.common.handlers.object import DeleteableObject
+import xmltodict
+from holado_system.system.filesystem.file import File
+from holado_core.common.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+
+
+def __get_path_manager():
+    return SessionContext.instance().path_manager
+
+
+class XMLFile(DeleteableObject):
+    """
+    Manage a XML file
+    """
+
+    def __init__(self, path, auto_flush=True, do_open=False, **open_kwargs):
+        super().__init__(f"XML file '{path}'")
+
+        self.__file = File(path, auto_flush=auto_flush, do_open=do_open, **open_kwargs)
+
+    def __enter__(self):
+        self.__file.__enter__()
+        return self
+    
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.__file.__exit__(exc_type, exc_val, exc_tb)
+    
+    @property
+    def path(self):
+        return self.__file.path
+
+    @property
+    def internal_file(self):
+        return self.__file
+    
+    @property
+    def is_open(self):
+        return self.__file.is_open
+
+    def open(self, **kwargs):
+        self.__file.open(**kwargs)
+
+    def close(self):
+        self.__file.close()
+
+    def read_as_dict(self, **parse_kwargs):
+        with self.__file as fin:
+            content = fin.read()
+        return xmltodict.parse(content, **parse_kwargs)
+
+    def write_dict(self, data, pretty=True, full_document=False, indent=Tools.indent_string(4, ''), **unparse_kwargs):
+        unparse_kwargs['pretty'] = pretty
+        unparse_kwargs['full_document'] = full_document
+        unparse_kwargs['indent'] = indent
+        
+        content = xmltodict.unparse(data, **unparse_kwargs)
+        with self.__file as fout:
+            fout.write(content)
+
+
+
+    @classmethod
+    def read_xml_file_content_as_dict(cls, path, open_kwargs=None, parse_kwargs=None):
+        open_kwargs = open_kwargs if open_kwargs is not None else {}
+        parse_kwargs = parse_kwargs if parse_kwargs is not None else {}
+        
+        file = XMLFile(path, **open_kwargs)
+        return file.read_as_dict(**parse_kwargs)
+
+    @classmethod
+    def write_xml_file_with_dict(cls, path, data, open_kwargs=None, unparse_kwargs=None):
+        open_kwargs = open_kwargs if open_kwargs is not None else {}
+        unparse_kwargs = unparse_kwargs if unparse_kwargs is not None else {}
+        
+        __get_path_manager().makedirs(path)
+        
+        file = XMLFile(path, **open_kwargs)
+        file.write_from_dict(data, **unparse_kwargs)
+        return file
+
+
+
+

holado_xml/xml/xml_manager.py

@@ -0,0 +1,35 @@
+
+#################################################
+# 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 xml.sax.saxutils import escape, unescape
+
+
+class XMLManager():
+    """
+    Manage XML format
+    """
+    
+    @classmethod
+    def escape(cls, txt, entities=None):
+        escape_kwargs = {'entities':entities} if entities is not None else {}
+        return escape(txt, **escape_kwargs)
+    
+    @classmethod
+    def unescape(cls, txt, entities=None):
+        escape_kwargs = {'entities':entities} if entities is not None else {}
+        return unescape(txt, **escape_kwargs)
+    
+
+
+
+

holado_yaml/__init__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.
+#################################################
+
+
+def dependencies():
+    """
+    Return None or the list of names of modules it depend on
+    """
+    return None
+
+def register():
+    """
+    Register the services of this module
+    """
+    # from holado.common.context.session_context import SessionContext
+    
+    # from holado_xxx.xxx import XXXManager
+    # SessionContext.instance().services.register_service_type("xxx_manager", XXXManager)
+    pass
+

holado_yaml/tests/behave/steps/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .yaml_steps import *

holado_yaml/tests/behave/steps/yaml_steps.py

@@ -0,0 +1,161 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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_test.scenario.step_tools import StepTools
+from holado.common.context.session_context import SessionContext
+from holado_test.behave.behave import *  # @UnusedWildImport
+import logging
+from holado_yaml.yaml.yaml_manager import YAMLManager
+from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+
+logger = logging.getLogger(__name__)
+
+
+if YAMLManager.is_available():
+    
+    def __get_scenario_context():
+        return SessionContext.instance().get_scenario_context()
+    
+    def __get_variable_manager():
+        return __get_scenario_context().get_variable_manager()
+    
+    def __get_path_manager():
+        return SessionContext.instance().path_manager
+    
+    def __get_client(client_type, client):
+        client_type = StepTools.evaluate_scenario_parameter(client_type)
+        client = StepTools.evaluate_variable_name(client)
+        
+        if client is None:
+            return YAMLManager.get_client(client_type)
+        else:
+            return client
+    
+    
+    @Step(r"(?P<var_name>{Variable}) = new YAML client(?: \(client type: (?P<client_type>{Str})\))?")
+    def step_impl(context, var_name, client_type):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        client_type = StepTools.evaluate_scenario_parameter(client_type)
+        
+        res = YAMLManager.get_client(client_type)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    
+    # Manage YAML objects
+    
+    @Step(r"(?P<var_name>{Variable}) = YAML object(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, client_type, client):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        client = __get_client(client_type, client)
+        text = BehaveStepTools.get_step_multiline_text(context)
+        
+        res = client.load_string(text)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"update YAML object (?P<obj>{Variable}) with data (?P<data>{Variable})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, obj, data, client_type, client):  # @DuplicatedSignature
+        obj = StepTools.evaluate_scenario_parameter(obj)
+        data = StepTools.evaluate_scenario_parameter(data)
+        client = __get_client(client_type, client)
+        
+        client.update_data(obj, data)
+    
+    @Step(r"(?P<var_name>{Variable}) = convert YAML object (?P<obj>{Variable}) to string(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, obj, client_type, client):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        obj = StepTools.evaluate_scenario_parameter(obj)
+        client = __get_client(client_type, client)
+        
+        res = client.save_in_string(obj)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    
+    # Manage YAML strings
+    
+    @Step(r"(?P<var_name>{Variable}) = load YAML string (?P<text>{Str})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, text, client_type, client):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        text = StepTools.evaluate_scenario_parameter(text)
+        client = __get_client(client_type, client)
+        
+        res = YAMLManager.load_string(text, client_type=client_type)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = update YAML string (?P<text>{Str}) with data (?P<data>{Variable})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, text, data, client_type, client):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        text = StepTools.evaluate_scenario_parameter(text)
+        data = StepTools.evaluate_scenario_parameter(data)
+        client = __get_client(client_type, client)
+        
+        res = YAMLManager.update_string(text, data, client=client)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    
+    # Manage YAML files
+    
+    @Step(r"(?P<var_name>{Variable}) = load YAML file (?P<path>{Str})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, path, client_type, client):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        path = StepTools.evaluate_scenario_parameter(path)
+        client = __get_client(client_type, client)
+        
+        res = YAMLManager.load_file(path, client=client)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = load multiple documents YAML file (?P<path>{Str})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, var_name, path, client_type, client):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        path = StepTools.evaluate_scenario_parameter(path)
+        client = __get_client(client_type, client)
+        
+        res = YAMLManager.load_multiple_documents_file(path, client=client)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"save (?P<data>{Variable}) in YAML file (?P<path>{Str})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?\))?")
+    def step_impl(context, data, path, client_type, client):  # @DuplicatedSignature
+        data = StepTools.evaluate_scenario_parameter(data)
+        path = StepTools.evaluate_scenario_parameter(path)
+        client = __get_client(client_type, client)
+        
+        YAMLManager.save_in_file(path, data, client=client)
+    
+    @Step(r"update YAML file (?P<path>{Str}) with data (?P<data>{Variable})(?: \((?:client type: (?P<client_type>{Str}))?(?: ; )?(?:client: (?P<client>{Variable}))?(?: ; )?(?:(?P<with_backup_str>with backup))?(?: ; )?(?:backup extension: (?P<backup_extension>{Str}))?\))?")
+    def step_impl(context, path, data, client_type, client, with_backup_str, backup_extension):  # @DuplicatedSignature
+        path = StepTools.evaluate_scenario_parameter(path)
+        data = StepTools.evaluate_scenario_parameter(data)
+        client = __get_client(client_type, client)
+        with_backup = with_backup_str is not None
+        backup_extension = StepTools.evaluate_scenario_parameter(backup_extension)
+        
+        YAMLManager.update_file(path, data, client=client, with_backup=with_backup, backup_extension=backup_extension)
+    
+    @Step(r"restore YAML file (?P<path>{Str})(?: \((?:backup extension: (?P<backup_extension>{Str}))?\))?")
+    def step_impl(context, path, backup_extension):  # @DuplicatedSignature
+        path = StepTools.evaluate_scenario_parameter(path)
+        backup_extension = StepTools.evaluate_scenario_parameter(backup_extension)
+        
+        YAMLManager.restore_file(path, backup_extension=backup_extension)
+
+
+
+

holado_yaml/yaml/enums.py

@@ -0,0 +1,28 @@
+
+#################################################
+# 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.common.handlers.enums import AutoNumber
+
+
+class UpdateType(AutoNumber):
+    """
+    @summary: Update type
+    """
+    
+    AddOrUpdate = ()    # Data are added (for all data types) or updated (for object or dict)
+    Replace = ()        # Leaf elements in data are replaced (for whole list or dict) 
+    Delete = ()         # Leaf elements in data are deleted (value can be anything)
+    
+
+
+

holado_yaml/yaml/pyyaml/pyyaml_client.py

@@ -0,0 +1,72 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_core.common.tools.tools import Tools
+from holado_yaml.yaml.yaml_client import YAMLClient
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+
+logger = logging.getLogger(__name__)
+
+try:
+    import yaml  # @UnresolvedImport
+    with_yaml = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"YAML is not available with pyyaml. Initialization failed on error: {exc}")
+    with_yaml = False
+
+
+
+class PyYAMLClient(YAMLClient):
+    """
+    Client for actions on YAML files.
+    """
+    
+    @classmethod
+    def is_available(cls):
+        return with_yaml
+    
+    def __init__(self, name=None, client_type=None):
+        super().__init__(name)
+        
+        if client_type == "base":
+            self.__loader_type = yaml.BaseLoader
+            self.__dumper_type = yaml.BaseDumper
+        elif client_type == "full":
+            self.__loader_type = yaml.FullLoader
+            self.__dumper_type = yaml.Dumper
+        elif client_type == "safe" or client_type is None:
+            self.__loader_type = yaml.SafeLoader
+            self.__dumper_type = yaml.SafeDumper
+        elif client_type == "unsafe":
+            self.__loader_type = yaml.UnsafeLoader
+            self.__dumper_type = yaml.Dumper
+        else:
+            raise TechnicalException(f"Unmanaged client type '{client_type}'")
+    
+    def load_io_file(self, file_like_object):
+        return yaml.load(file_like_object, self.__loader_type)
+    
+    def load_multiple_documents_io_file(self, file_like_object):
+        return list(yaml.load_all(file_like_object, self.__loader_type))
+        
+    def save_in_io_file(self, file_like_object, data, **kwargs):
+        if 'sort_keys' not in kwargs:
+            kwargs['sort_keys'] = False
+        yaml.dump(data, file_like_object, **kwargs)
+    
+
+
+