powertrain-build 1.13.1__py3-none-any.whl → 1.13.3.dev3__py3-none-any.whl

powertrain_build/interface/generation_utils.py

@@ -1,142 +1,142 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-"""Module with generation utils."""
-
-import argparse
-from ruamel.yaml import YAML
-from pathlib import Path
-from powertrain_build.interface.application import Application, get_internal_domain
-from powertrain_build.interface.base import filter_signals
-from powertrain_build.lib import logger
-
-LOGGER = logger.create_logger("CSP interface generation utils")
-
-
-def add_base_args(parser: argparse.ArgumentParser):
-    """ Base parser that adds config argument.
-
-    Returns:
-        parser (ArgumentParser): Base parser
-    """
-    parser.add_argument("config", help="The project configuration file", type=Path)
-
-
-def get_client_name(args, app):
-    """ Get client name for app.
-
-    Args:
-        app (Application): Parsed project configuration
-    Returns:
-        name (str): Name of the project
-    """
-    return args.client_name if args.client_name else app.name
-
-
-def process_app(config):
-    """ Get an app specification for the current project
-
-    Entrypoint for external scripts.
-
-    Args:
-        config (pathlib.Path): Path to the ProjectCfg.json
-    Returns:
-        app (Application): powertrain-build project
-    """
-    app = Application()
-    app.parse_definition(config)
-    return app
-
-
-def get_interface(app, interface_type):
-    """Get interface(hal/dp/zc/service) to application
-
-    Args:
-        app (Application): Pybuild project
-        interface_type (BaseApplication): A type of interface
-    Returns:
-        spec (obj): obj for hal/dp/zc/service class
-    """
-    spec = {}
-    rasters = app.get_rasters()
-    LOGGER.debug("Rasters: %s", rasters)
-    translation_files = app.get_translation_files()
-    interface_type.parse_definition(translation_files)
-    internal = get_internal_domain(rasters)
-    properties_from_json = [
-        {"destination": "min", "source": "min", "default": "-"},
-        {"destination": "max", "source": "max", "default": "-"},
-        {"destination": "variable_type", "source": "type"},
-        {"destination": "offset", "source": "offset", "default": "-"},
-        {"destination": "factor", "source": "lsb", "default": 1},
-        {"destination": "description", "source": "description"},
-        {"destination": "unit", "source": "unit", "default": "-"},
-    ]
-    # TODO We read all yaml files at once, should we "add_signals" for all rasters at once?
-    # For example, service.check_endpoints will miss endpoint mismatches that reside in different rasters.
-    for raster in rasters:
-        interface_type.name = raster.name
-        interface_type.clear_signal_names()
-        interface_type.add_signals(
-            filter_signals(raster.insignals, internal), "insignals", properties_from_json)
-        interface_type.add_signals(raster.outsignals, "outsignals", properties_from_json)
-        LOGGER.debug("Current communication interface: %s", interface_type)
-        spec[raster.name] = interface_type.to_dict()
-    return spec
-
-
-def get_method_interface(app):
-    """ Get method interface
-    Args:
-        app (Application): Application
-    Returns:
-        spec (dict): Specification for csp methods
-    """
-    spec = {}
-
-    for method in app.get_methods():
-        method_spec = {}
-        method_spec['name'] = method.name
-        method_spec['primitive'] = method.get_primitive(method.name)
-        method_spec['namespace'] = method.namespace
-        if method.description:
-            method_spec['description'] = method.description
-        inports = {}
-        outports = {}
-        for signal in method.signals:
-            signal_spec = {
-                'primitive': method.get_primitive(signal.name),
-                'type': signal.properties['type'],
-                'variable_type': signal.properties['type'],
-                'variable': signal.name,
-                'range': signal.properties['range'],
-                'init': 0,
-                'description': '',
-                'unit': ''
-            }
-            if signal in method.outsignals:
-                outports[signal.name] = signal_spec
-            else:
-                inports[signal.name] = signal_spec
-
-        ports = {'in': inports, 'out': outports}
-        method_spec['ports'] = ports
-        spec[method.name] = method_spec
-    return spec
-
-
-def write_to_file(content, output, is_yaml=False):
-    """ Write to cmake.
-
-    Args:
-        content (str): cmake
-        output (Path): File to write.
-        yaml (bool): Dump yaml
-    """
-    output.parent.mkdir(parents=True, exist_ok=True)
-    with open(output, "w", encoding="utf-8") as file_handler:
-        if is_yaml:
-            yaml = YAML()
-            yaml.dump(content, file_handler)
-        else:
-            file_handler.write(content)
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+"""Module with generation utils."""
+
+import argparse
+from ruamel.yaml import YAML
+from pathlib import Path
+from powertrain_build.interface.application import Application, get_internal_domain
+from powertrain_build.interface.base import filter_signals
+from powertrain_build.lib import logger
+
+LOGGER = logger.create_logger("CSP interface generation utils")
+
+
+def add_base_args(parser: argparse.ArgumentParser):
+    """ Base parser that adds config argument.
+
+    Returns:
+        parser (ArgumentParser): Base parser
+    """
+    parser.add_argument("config", help="The project configuration file", type=Path)
+
+
+def get_client_name(args, app):
+    """ Get client name for app.
+
+    Args:
+        app (Application): Parsed project configuration
+    Returns:
+        name (str): Name of the project
+    """
+    return args.client_name if args.client_name else app.name
+
+
+def process_app(config):
+    """ Get an app specification for the current project
+
+    Entrypoint for external scripts.
+
+    Args:
+        config (pathlib.Path): Path to the ProjectCfg.json
+    Returns:
+        app (Application): powertrain-build project
+    """
+    app = Application()
+    app.parse_definition(config)
+    return app
+
+
+def get_interface(app, interface_type):
+    """Get interface(hal/dp/zc/service) to application
+
+    Args:
+        app (Application): Pybuild project
+        interface_type (BaseApplication): A type of interface
+    Returns:
+        spec (obj): obj for hal/dp/zc/service class
+    """
+    spec = {}
+    rasters = app.get_rasters()
+    LOGGER.debug("Rasters: %s", rasters)
+    translation_files = app.get_translation_files()
+    interface_type.parse_definition(translation_files)
+    internal = get_internal_domain(rasters)
+    properties_from_json = [
+        {"destination": "min", "source": "min", "default": "-"},
+        {"destination": "max", "source": "max", "default": "-"},
+        {"destination": "variable_type", "source": "type"},
+        {"destination": "offset", "source": "offset", "default": "-"},
+        {"destination": "factor", "source": "lsb", "default": 1},
+        {"destination": "description", "source": "description"},
+        {"destination": "unit", "source": "unit", "default": "-"},
+    ]
+    # TODO We read all yaml files at once, should we "add_signals" for all rasters at once?
+    # For example, service.check_endpoints will miss endpoint mismatches that reside in different rasters.
+    for raster in rasters:
+        interface_type.name = raster.name
+        interface_type.clear_signal_names()
+        interface_type.add_signals(
+            filter_signals(raster.insignals, internal), "insignals", properties_from_json)
+        interface_type.add_signals(raster.outsignals, "outsignals", properties_from_json)
+        LOGGER.debug("Current communication interface: %s", interface_type)
+        spec[raster.name] = interface_type.to_dict()
+    return spec
+
+
+def get_method_interface(app):
+    """ Get method interface
+    Args:
+        app (Application): Application
+    Returns:
+        spec (dict): Specification for csp methods
+    """
+    spec = {}
+
+    for method in app.get_methods():
+        method_spec = {}
+        method_spec['name'] = method.name
+        method_spec['primitive'] = method.get_primitive(method.name)
+        method_spec['namespace'] = method.namespace
+        if method.description:
+            method_spec['description'] = method.description
+        inports = {}
+        outports = {}
+        for signal in method.signals:
+            signal_spec = {
+                'primitive': method.get_primitive(signal.name),
+                'type': signal.properties['type'],
+                'variable_type': signal.properties['type'],
+                'variable': signal.name,
+                'range': signal.properties['range'],
+                'init': 0,
+                'description': '',
+                'unit': ''
+            }
+            if signal in method.outsignals:
+                outports[signal.name] = signal_spec
+            else:
+                inports[signal.name] = signal_spec
+
+        ports = {'in': inports, 'out': outports}
+        method_spec['ports'] = ports
+        spec[method.name] = method_spec
+    return spec
+
+
+def write_to_file(content, output, is_yaml=False):
+    """ Write to cmake.
+
+    Args:
+        content (str): cmake
+        output (Path): File to write.
+        yaml (bool): Dump yaml
+    """
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with open(output, "w", encoding="utf-8") as file_handler:
+        if is_yaml:
+            yaml = YAML()
+            yaml.dump(content, file_handler)
+        else:
+            file_handler.write(content)

powertrain_build/interface/hal.py

@@ -1,194 +1,194 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-"""Python module used for abstracting Hardware Abstraction Layer specifications"""
-import re
-from pathlib import Path
-from ruamel.yaml import YAML
-from powertrain_build.interface.csp_api import CspApi
-from powertrain_build.lib import logger
-
-LOGGER = logger.create_logger('base')
-
-
-def get_hal_list(app):
-    """Get translated hal name from yaml file
-
-    Args:
-        app (Application): Pybuild project
-    Returns:
-        cmake (str): a string contains translated hal name
-    """
-    translation_files = app.get_translation_files()
-    hala = HALA(app)
-    hala.parse_definition(translation_files)
-    hal_translations = hala.get_map()
-
-    hals = set()
-    for definitions in hala.translations.values():
-        for definition in definitions:
-            hal_abbreviation = definition[hala.position.api.value]
-            real_hal_name = get_real_hal_name(hal_abbreviation, hal_translations)
-            hals.add((hal_abbreviation, real_hal_name))
-
-    cmake = ""
-    for hal_abbreviation, real_hal_name in hals:
-        lib = re.sub('-', '_', f'hal_{hal_abbreviation}' + '_libhal_' + real_hal_name).upper()
-        include = re.sub('-', '_', f'hal_{hal_abbreviation}' + '_include_dir').upper()
-        cmake += f"LIST(APPEND extra_libraries ${{{lib}}})\n"
-        cmake += f"LIST(APPEND EXTRA_INCLUDE_DIRS ${{{include}}})\n"
-    return cmake
-
-
-def strip_hal_name(hal_name):
-    """Strip hal name
-
-    Args:
-        hal_name (str): hal name
-    Returns:
-        (str): stripped hal name
-    """
-    return hal_name.replace('_hal', '')
-
-
-def verify_name(hal_name, api_map):
-    """Verify hal name
-
-    Args:
-        hal_name (str): hal name
-        api_map (dict): hal translation map
-    """
-    if strip_hal_name(hal_name) not in api_map:
-        raise HalTranslationException(
-            f"{hal_name} does not exist in the hal translation file."
-        )
-
-
-def get_real_hal_name(hal_name, translation_map):
-    """Get real hal name from translation map file.
-
-    Args:
-        hal_name (str): hal abreviation
-
-    Returns:
-        real_hal_name (str): real name of a hal
-    """
-    verify_name(hal_name, translation_map)
-    return translation_map.get(strip_hal_name(hal_name))
-
-
-class UnknownAccessorError(Exception):
-    """Error when setting a producer and there already exists one"""
-    def __init__(self, hal, signal, accessor):
-        """Set error message
-
-        Args:
-            hal (HAL): Hal where the problem is
-            signal (Signal): Signal with the problem
-            accessor (str): Unknown accessor type
-        """
-        super().__init__()
-        self.message = f"Accessor of type {accessor} for {signal.name} in {hal.name} is not handled"
-
-
-class HalTranslationException(Exception):
-    """Class for hal translation exceptions"""
-
-
-class HALA(CspApi):
-    """Hardware abstraction layer abstraction"""
-
-    def __repr__(self):
-        """String representation of HALA"""
-        return (f"<HALA {self.name}"
-                f" app_side insignals: {len(self.signal_names['app']['insignals'])}"
-                f" app_side outsignals: {len(self.signal_names['app']['outsignals'])}>")
-
-    def get_map(self):
-        """Get hal translation map
-
-        Returns:
-            (dict): hal translation map
-        """
-        path = self.get_map_file()
-        if path.is_file():
-            return self._get_hal_translation(path)
-        return {}
-
-    @staticmethod
-    def get_map_file():
-        """Get hal translation map file
-
-        Returns:
-            (Path): hal translation map file
-        """
-        return Path("Projects", "CSP", "hal_list.yaml")
-
-    def get_api_name(self, api_name):
-        real_hal_name = get_real_hal_name(
-            api_name,
-            self.api_map
-        )
-        return real_hal_name
-
-    def verify_api(self, api_name):
-        verify_name(api_name, self.api_map)
-
-    @staticmethod
-    def _get_hal_translation(path):
-        """Get translated hal names
-
-        Args:
-            path (Path): path to the hal translation list.
-        Returns:
-            hal_translation_content (dict): translated hal names
-        """
-        hal_translation_content = None
-        if path and path.is_file():
-            with path.open("r") as file_handler:
-                yaml = YAML(typ="safe", pure=True)
-                hal_translation_content = yaml.load(file_handler)
-
-        if not hal_translation_content:
-            if hal_translation_content is None:
-                raise HalTranslationException(
-                    "No hal translation file given."
-                )
-            if isinstance(hal_translation_content, dict):
-                raise HalTranslationException(
-                    "Hal translation file are empty."
-                )
-            raise HalTranslationException("Bad hal translation format.")
-        return hal_translation_content
-
-    def check_endpoints(self):
-        pass
-
-    def extract_endpoint_definitions(self, raw):
-        """Extract endpoint definitions from raw data
-
-        Args:
-            (dict): endpoint definitions
-        """
-        self.parse_api_definitions(raw.get("hal", {}))
-
-    @staticmethod
-    def extract_definition(definition):
-        """Extract definition from hal
-
-        Args:
-            definition (dict): hal definition
-
-        Returns:
-            (dict): hal definition
-        """
-        if isinstance(definition, list):
-            specifications = {
-                'hals': definition
-            }
-        else:
-            specifications = {
-                'properties': definition.get('properties', []),
-                'methods': definition.get('methods', [])
-            }
-        return specifications
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+"""Python module used for abstracting Hardware Abstraction Layer specifications"""
+import re
+from pathlib import Path
+from ruamel.yaml import YAML
+from powertrain_build.interface.csp_api import CspApi
+from powertrain_build.lib import logger
+
+LOGGER = logger.create_logger('base')
+
+
+def get_hal_list(app):
+    """Get translated hal name from yaml file
+
+    Args:
+        app (Application): Pybuild project
+    Returns:
+        cmake (str): a string contains translated hal name
+    """
+    translation_files = app.get_translation_files()
+    hala = HALA(app)
+    hala.parse_definition(translation_files)
+    hal_translations = hala.get_map()
+
+    hals = set()
+    for definitions in hala.translations.values():
+        for definition in definitions:
+            hal_abbreviation = definition[hala.position.api.value]
+            real_hal_name = get_real_hal_name(hal_abbreviation, hal_translations)
+            hals.add((hal_abbreviation, real_hal_name))
+
+    cmake = ""
+    for hal_abbreviation, real_hal_name in hals:
+        lib = re.sub('-', '_', f'hal_{hal_abbreviation}' + '_libhal_' + real_hal_name).upper()
+        include = re.sub('-', '_', f'hal_{hal_abbreviation}' + '_include_dir').upper()
+        cmake += f"LIST(APPEND extra_libraries ${{{lib}}})\n"
+        cmake += f"LIST(APPEND EXTRA_INCLUDE_DIRS ${{{include}}})\n"
+    return cmake
+
+
+def strip_hal_name(hal_name):
+    """Strip hal name
+
+    Args:
+        hal_name (str): hal name
+    Returns:
+        (str): stripped hal name
+    """
+    return hal_name.replace('_hal', '')
+
+
+def verify_name(hal_name, api_map):
+    """Verify hal name
+
+    Args:
+        hal_name (str): hal name
+        api_map (dict): hal translation map
+    """
+    if strip_hal_name(hal_name) not in api_map:
+        raise HalTranslationException(
+            f"{hal_name} does not exist in the hal translation file."
+        )
+
+
+def get_real_hal_name(hal_name, translation_map):
+    """Get real hal name from translation map file.
+
+    Args:
+        hal_name (str): hal abreviation
+
+    Returns:
+        real_hal_name (str): real name of a hal
+    """
+    verify_name(hal_name, translation_map)
+    return translation_map.get(strip_hal_name(hal_name))
+
+
+class UnknownAccessorError(Exception):
+    """Error when setting a producer and there already exists one"""
+    def __init__(self, hal, signal, accessor):
+        """Set error message
+
+        Args:
+            hal (HAL): Hal where the problem is
+            signal (Signal): Signal with the problem
+            accessor (str): Unknown accessor type
+        """
+        super().__init__()
+        self.message = f"Accessor of type {accessor} for {signal.name} in {hal.name} is not handled"
+
+
+class HalTranslationException(Exception):
+    """Class for hal translation exceptions"""
+
+
+class HALA(CspApi):
+    """Hardware abstraction layer abstraction"""
+
+    def __repr__(self):
+        """String representation of HALA"""
+        return (f"<HALA {self.name}"
+                f" app_side insignals: {len(self.signal_names['app']['insignals'])}"
+                f" app_side outsignals: {len(self.signal_names['app']['outsignals'])}>")
+
+    def get_map(self):
+        """Get hal translation map
+
+        Returns:
+            (dict): hal translation map
+        """
+        path = self.get_map_file()
+        if path.is_file():
+            return self._get_hal_translation(path)
+        return {}
+
+    @staticmethod
+    def get_map_file():
+        """Get hal translation map file
+
+        Returns:
+            (Path): hal translation map file
+        """
+        return Path("Projects", "CSP", "hal_list.yaml")
+
+    def get_api_name(self, api_name):
+        real_hal_name = get_real_hal_name(
+            api_name,
+            self.api_map
+        )
+        return real_hal_name
+
+    def verify_api(self, api_name):
+        verify_name(api_name, self.api_map)
+
+    @staticmethod
+    def _get_hal_translation(path):
+        """Get translated hal names
+
+        Args:
+            path (Path): path to the hal translation list.
+        Returns:
+            hal_translation_content (dict): translated hal names
+        """
+        hal_translation_content = None
+        if path and path.is_file():
+            with path.open("r") as file_handler:
+                yaml = YAML(typ="safe", pure=True)
+                hal_translation_content = yaml.load(file_handler)
+
+        if not hal_translation_content:
+            if hal_translation_content is None:
+                raise HalTranslationException(
+                    "No hal translation file given."
+                )
+            if isinstance(hal_translation_content, dict):
+                raise HalTranslationException(
+                    "Hal translation file are empty."
+                )
+            raise HalTranslationException("Bad hal translation format.")
+        return hal_translation_content
+
+    def check_endpoints(self):
+        pass
+
+    def extract_endpoint_definitions(self, raw):
+        """Extract endpoint definitions from raw data
+
+        Args:
+            (dict): endpoint definitions
+        """
+        self.parse_api_definitions(raw.get("hal", {}))
+
+    @staticmethod
+    def extract_definition(definition):
+        """Extract definition from hal
+
+        Args:
+            definition (dict): hal definition
+
+        Returns:
+            (dict): hal definition
+        """
+        if isinstance(definition, list):
+            specifications = {
+                'hals': definition
+            }
+        else:
+            specifications = {
+                'properties': definition.get('properties', []),
+                'methods': definition.get('methods', [])
+            }
+        return specifications