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

holado_helper/script/job.py

@@ -0,0 +1,75 @@
+
+#################################################
+# 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 typing import NamedTuple, List, get_type_hints
+from holado_helper.script.action import BehaveActionInfo
+from holado_json.ipc.json_converter import JsonConverter
+from holado_json.ipc.json_types import JsonTypes
+from holado_json.ipc.json_types import _from_json_to_NamedTuple as orig_from_json_to_NamedTuple
+from holado_json.ipc.json_types import _from_json_to_object as orig_from_json_to_object
+from holado_python.standard_library.typing import Typing
+import inspect
+
+logger = logging.getLogger(__name__)
+
+class Job(NamedTuple):
+    actions:List[BehaveActionInfo]
+    in_parallel:bool
+    
+    
+class JobJsonConverter(JsonConverter):
+    def __init__(self, script_inst):
+        super().__init__()
+        self.__script_inst = script_inst
+        self.__job_counter = 0
+        self.__action_info_counter = 0
+        
+        self.__override_registered_types()
+        
+    def __override_registered_types(self):
+        self.register_resource_for_type('NamedTuple', lambda c: Typing.is_NamedTuple(class_=c), lambda o: Typing.is_NamedTuple(obj=o), 
+                           (None, None, self._from_json_to_NamedTuple))
+
+        self.register_resource_for_type_in_class('object', lambda c: inspect.isclass(c) and issubclass(c, object), lambda o: isinstance(o, object) and hasattr(o, '__dict__'), 
+                                (None, lambda x: x.__dict__, self._from_json_to_object))
+    
+    def _from_json_to_object(self, obj_json, class_, _parents=None, converter=None):
+        if inspect.isclass(class_) and issubclass(class_, BehaveActionInfo):
+            self.__action_info_counter += 1
+            action = obj_json['action']
+            
+            params = self.from_json_to(obj_json['params'], dict, _parents=JsonTypes._new_parents(_parents, class_, name='params'))
+            action_params = self.__script_inst.build_processing_action_params(action, action_args=obj_json, action_params=params, job_id=self.__job_counter)
+            
+            static_params = self.__script_inst.action_registry.get_action_static_parameters_values(action)
+            
+            tags = self.__script_inst.build_action_tags(action, action_args=obj_json)
+            behave_args = self.__script_inst._build_behave_args(tags)
+            
+            index = _parents[-1]['index'] if _parents is not None and 'index' in _parents[-1] else None
+            return self.__script_inst.new_action_info(action, behave_args=behave_args, params=action_params, static_params=static_params, index=index)
+        else:
+            return orig_from_json_to_object(obj_json, class_, _parents=_parents, converter=converter)
+    
+    def _from_json_to_NamedTuple(self, obj_json, class_, _parents=None, converter=None):
+        if inspect.isclass(class_) and issubclass(class_, Job):
+            self.__job_counter += 1
+            actions = self.from_json_to(obj_json['actions'], get_type_hints(Job)['actions'], _parents=JsonTypes._new_parents(_parents, class_, name='actions'))
+            is_parallel = obj_json.get('is_parallel', False)
+            return Job(actions, is_parallel)
+        else:
+            return orig_from_json_to_NamedTuple(obj_json, class_, _parents=_parents, converter=converter)
+
+
+

holado_helper/script/json_action_script.py

@@ -0,0 +1,104 @@
+# -*- 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.
+#################################################
+
+# This file is a helper to build scripts using HolAdo solution, with CSV files as input.
+# Usually, it is copied and adapted for specific usage.
+
+
+import logging
+import json
+from holado_helper.script.behave_action_script import BehaveActionScript, BehaveActionScriptFile
+from holado_helper.script.job import Job
+
+logger = logging.getLogger(__name__)
+
+
+class JsonMultipleActionScriptFile(BehaveActionScriptFile):
+    def __init__(self):
+        super().__init__(file_ext='.json')
+
+    def read_jobs(self, file_path, action_script):
+        converter = self.get_job_json_converter(action_script)
+        
+        with open(file_path, "r") as fin:
+            file_json = json.load(fin)
+        
+        res = []
+        for job_json in file_json:
+            job = converter.from_json_to(job_json, Job)
+            res.append(job)
+        
+        return res
+    
+    def write_jobs(self, file_path, jobs, action_script):
+        raise NotImplementedError()
+    
+    def get_job_json_converter(self, action_script):
+        from holado_helper.script.job import JobJsonConverter
+        return JobJsonConverter(action_script)
+
+
+class JsonMultipleActionScript(BehaveActionScript):
+    def __init__(self, work_dir_path=None, actor=None, action_registry=None, script_file=None):
+        if script_file is None:
+            script_file = JsonMultipleActionScriptFile()
+        super().__init__(work_dir_path=work_dir_path, with_action_parameter=False, actor=actor, action_registry=action_registry, script_file=script_file)
+    
+    def get_description(self, script_command, short_description):
+        return """{short_description}
+        
+        Usage:
+            1. Generate a template file with parameter '--output-template' as in example 1.
+                It is possible to specify the name of the output file with parameter '-o'.
+            2. Copy and modify the template file with desired actions. 
+            3. Process actions described in file with parameter '-i'.
+            4. See result in output file, if parameter '-o' is specified.
+        
+        In template files, a default value is set for each possible field. 
+        For fields with enum values, the default value is a combination of each possible enum value separated by a '|', but only one value is possible.
+        
+        
+        In input and output files, the field 'STATUS' describes the status of execution of each action:
+            - 'TODO' (or ''): the action is to process (in output file, it means that execution was stopped on an error with a previous action)
+            - 'SUCCESS': the action was in success
+            - 'ERROR': the action was in error
+            - others: the action is not processed, you can specify your own status to skip this action
+        In template files, this column is automatically initialized with status 'TODO'.
+        Any output file can be used as input file, the lines that are in status 'ERROR' or 'TODO' will be processed again.
+        
+        Example 1: Output template
+                
+                {script_command} --output-template -o actions.json
+                
+        Example 2: Process actions with given input file
+                
+                {script_command} -i actions.json
+                
+        """.format(short_description=short_description, script_command=script_command)
+    
+    def build_template_jobs(self):
+        actions = []
+        for action in self.action_registry.get_action_names():
+            params_default_values = self.action_registry.get_action_parameters_default_values(action)
+            params = {pdv[0]:pdv[1] for pdv in params_default_values}
+            # Note: for templates, add static parameters is not needed
+            act_info = self.new_action_info(action, params=params)
+            actions.append(act_info)
+        
+        job = Job(actions=actions, in_parallel=False)
+        
+        return [job]
+
+
+

holado_helper/script/script.py

@@ -0,0 +1,110 @@
+# -*- 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.
+#################################################
+
+# This file is a helper to build scripts using HolAdo solution, with CSV files as input.
+# Usually, it is copied and adapted for specific usage.
+
+
+import logging
+import os
+from holado_helper.script.initialize_script import get_logging_argument_parser
+from holado_core.common.tools.tools import Tools
+
+logger = logging.getLogger(__name__)
+
+class Script(object):
+    
+    def __init__(self, with_args=True):
+        self.__with_args = with_args
+        
+        self.__args = None
+        self.__cwd = None
+        self.__user_work_dir=None
+    
+    @property
+    def args(self):
+        return self.__args
+    
+    @property
+    def cwd(self):
+        """ Current working directory
+        A script can change its working directory by calling 'change_working_dir' method.
+        """
+        if self.__cwd is not None:
+            return self.__cwd
+        else:
+            return os.getcwd()
+    
+    @property
+    def user_working_dir(self):
+        """ User working directory
+        Although the user working directory is persisted.
+        """
+        if self.__user_work_dir is not None:
+            return self.__user_work_dir
+        else:
+            return os.getcwd()
+    
+    @user_working_dir.setter
+    def user_working_dir(self, wd):
+        self.__user_work_dir = wd
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Changed user working dir to '{self.__user_work_dir}'")
+    
+    def parse_args(self):
+        arg_parser = self.new_argument_parser()
+        self.__args = arg_parser.parse_args()
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Parsed args: {self.__args}")
+    
+    def new_argument_parser(self):
+        raise NotImplementedError
+    
+    def _new_argument_parser(self, description=None, additional_arguments=None, add_help=True):
+        parser = get_logging_argument_parser(description=description, additional_arguments=additional_arguments, add_help=add_help)
+        return parser
+    
+    def change_working_dir(self, work_dir_path):
+        from initialize_script import change_working_dir as init_cd    # @UnresolvedImport
+        
+        # If user working dir is not yet defined, save current working dir as user working dir
+        if self.__user_work_dir is None:
+            self.user_working_dir = os.getcwd()
+        
+        # Change working dir
+        new_cwd = init_cd(work_dir_path)
+        self.__cwd = new_cwd
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Changed script working dir to '{self.__cwd}'")
+    
+    def initialize(self):
+        if self.args is not None and hasattr(self.args, 'log_level') and hasattr(self.args, 'log_in_file'):
+            from initialize_script import change_logging_config # @UnresolvedImport
+            change_logging_config(log_level=self.args.log_level, log_in_file=self.args.log_in_file)
+    
+    def run(self):
+        self.parse_args()
+        self.initialize()
+        self.run_script()
+        
+    def run_script(self):
+        raise NotImplementedError
+    
+    def _build_path(self, filename, cwd):
+        if os.path.isabs(filename):
+            return filename
+        else:
+            return os.path.join(cwd, filename)
+
+

holado_json/__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.
+#################################################
+
+
+

holado_json/ipc/json.py

@@ -0,0 +1,125 @@
+
+#################################################
+# 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.tables.table_with_header import TableWithHeader
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_python.standard_library.typing import Typing
+from holado_core.common.exceptions.functional_exception import FunctionalException
+
+logger = logging.getLogger(__name__)
+
+
+def create_name_value_table_from_json(json_value, recursive=False, uncollapse_list=False):
+    from holado_json.ipc.json_converter import JsonConverter
+    
+    res = TableWithHeader()
+    res.header.add_cells_from_contents(["Name", "Value"])
+    
+    converter = JsonConverter()
+    json_value = converter.to_json(json_value)
+    
+    name_values = __convert_json_value_2_name_values(json_value, recursive=recursive, uncollapse_list=uncollapse_list)
+    for name, value in name_values:
+        res.add_row(cells_content=(name, value))
+    
+    return res
+    
+def create_table_with_header_from_json(json_value, recursive=False, uncollapse_list=False):
+    from holado_json.ipc.json_converter import JsonConverter
+    
+    res = TableWithHeader()
+    
+    converter = JsonConverter()
+    json_value = converter.to_json(json_value)
+    
+    if isinstance(json_value, list):
+        json_list = json_value
+    else:
+        json_list = [json_value]
+    
+    for json_val in json_list:
+        json_val = converter.to_json(json_val)
+        
+        name_values = __convert_json_value_2_name_values(json_val, recursive=recursive, uncollapse_list=uncollapse_list)
+        
+        # Add new columns if needed
+        for name, value in name_values:
+            if not res.has_column(name, raise_exception=False):
+                res.add_column(name=name, cells_content = [None]*res.nb_rows)
+        
+        # Fill table
+        values_by_name = {name: value for name, value in name_values}
+        res.add_row(contents_by_colname = values_by_name)
+        
+    # Order columns
+    if res.nb_columns > 0:
+        res.order_columns(names = sorted(res.get_column_names()))
+        
+    return res
+    
+def __convert_json_value_2_name_values(json_value, recursive=False, uncollapse_list=False):
+    res = []
+    __fill_name_values_with_json_value(res, None, json_value, recursive=recursive, uncollapse_list=uncollapse_list)
+    return res
+    
+def __fill_name_values_with_json_value(res, name_prefix, json_value, recursive=False, uncollapse_list=False):
+    if isinstance(json_value, dict):
+        __fill_name_values_with_json_dict(res, name_prefix, json_value, recursive=recursive, uncollapse_list=uncollapse_list)
+    elif isinstance(json_value, list):
+        __fill_name_values_with_json_list(res, name_prefix, json_value, recursive=recursive, uncollapse_list=uncollapse_list)
+    else:
+        res.append((name_prefix, json_value))
+    
+def __fill_name_values_with_json_dict(res, name_prefix, json_value, recursive=False, uncollapse_list=False):
+    if not isinstance(json_value, dict):
+        raise TechnicalException(f"json value is expected to be a dict (obtained: {Typing.get_object_class_fullname(json_value)}")
+    
+    sorted_dict = dict(sorted(json_value.items()))
+    for name, value in sorted_dict.items():
+        new_prefix = f"{name_prefix}.{name}" if name_prefix is not None and len(name_prefix) > 0 else name
+        if recursive:
+            __fill_name_values_with_json_value(res, new_prefix, value, recursive=recursive, uncollapse_list=uncollapse_list)
+        else:
+            res.append((new_prefix, value))
+    
+def __fill_name_values_with_json_list(res, name_prefix, json_value, recursive=False, uncollapse_list=False):
+    if not isinstance(json_value, list):
+        raise TechnicalException(f"json value is expected to be a list (obtained: {Typing.get_object_class_fullname(json_value)}")
+    
+    if not uncollapse_list:
+        res.append((name_prefix, json_value))
+        return
+        
+    if len(json_value) == 0:
+        res.append((name_prefix+"[]", None))
+        return
+        
+    for index, value in enumerate(json_value):
+        new_prefix = f"{name_prefix}[{index}]" if name_prefix is not None else f"[{index}]"
+        __fill_name_values_with_json_value(res, new_prefix, value, recursive=recursive, uncollapse_list=uncollapse_list)
+
+
+def set_object_attributes_with_json_dict(obj, json_value):
+    if not isinstance(json_value, dict):
+        raise TechnicalException(f"json value is expected to be a dict (obtained: {Typing.get_object_class_fullname(json_value)}")
+    
+    for attr_name, attr_value_json in json_value.items():
+        if hasattr(obj, attr_name):
+            if isinstance(attr_value_json, dict) and not isinstance(getattr(obj, attr_name), dict):
+                set_object_attributes_with_json_dict(getattr(obj, attr_name), attr_value_json)
+            else:
+                setattr(obj, attr_name, attr_value_json)
+        else:
+            raise FunctionalException(f"Object doesn't have attribute '{attr_name}' (object type: {Typing.get_object_class_fullname(obj)})")
+

holado_json/ipc/json_converter.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
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_json.ipc.json_types import JsonTypes
+from holado_core.common.handlers.features.resource_by_type import FeatureObjectAndClassResourceByType
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+class JsonConverter(FeatureObjectAndClassResourceByType):
+    
+    def __init__(self):
+        super().__init__()
+        self.import_registered_resources_in_class(class_=JsonTypes)
+    
+    @classmethod
+    def _get_class_resource_description(cls, plural=False):
+        if plural:
+            return 'class json types'
+        else:
+            return 'class json type'
+    
+    def _get_resource_description(self, plural=False):
+        if plural:
+            return 'json types'
+        else:
+            return 'json type'
+    
+    def to_json(self, obj):
+        resource = self.get_resource_for_type(obj=obj)
+        if resource[1] is not None:
+            return resource[1](obj)
+        else:
+            raise TechnicalException(f"Resource 'to_json' is not defined for object of type {Typing.get_object_class_fullname(obj)}")
+    
+    def from_json_to(self, obj_json, class_, _parents=None):
+        if logger.isEnabledFor(logging.TRACE):  # @UndefinedVariable
+            logger.trace(f"[{Typing.get_object_class_fullname(self)}] from_json_to({obj_json}, {Typing.get_class_fullname(class_)})")
+        # Find resource associated to class_, else find the resource associated to json object
+        resource = None
+        if class_ is not None:
+            resource = self.get_resource_for_type(class_=class_, raise_if_not_found=False)
+        if resource is None:
+            resource = self.get_resource_for_type(obj=obj_json)
+        
+        # If defined, use complex json conversion method, else use simple method
+        if resource[2] is not None:
+            return resource[2](obj_json, class_, _parents=_parents, converter=self)
+        elif resource[0] is not None:
+            return resource[0](obj_json)
+        else:
+            raise TechnicalException(f"Resource 'from_json_to' is not defined for type {class_}")
+        
+    
+    
+    
+