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

powertrain_build/interface/generate_hi_interface.py

@@ -1,87 +1,87 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-# -*- coding: utf-8 -*-
-"""Python module used for calculating interfaces for CSP HI"""
-import argparse
-import sys
-from pathlib import Path
-from typing import List, Optional
-
-from powertrain_build.interface import generation_utils
-from powertrain_build.interface.device_proxy import DPAL
-from powertrain_build.lib.helper_functions import recursive_default_dict, to_normal_dict
-
-OP_READ = 'read'
-OP_WRITE = 'write'
-
-PARSER_HELP = "Generate HI YAML interface file."
-
-
-def generate_hi_interface(args, hi_interface):
-    """Generate HI YAML interface file.
-
-    Args:
-        args (Namespace): Arguments from command line.
-        hi_interface (dict): HI interface dict based on HIApplication and generation_utils.get_interface.
-    Returns:
-        result (dict): Aggregated signal information as a dict.
-    """
-
-    io_translation = {
-        'consumer': OP_READ,
-        'producer': OP_WRITE
-    }
-    result = recursive_default_dict()
-    for raster_data in hi_interface.values():
-        for direction, signals in raster_data.items():
-            hi_direction = io_translation[direction]
-            for signal in signals:
-                domain = signal['domain']
-                group = signal['group']
-                name = signal['variable']
-                property_name = signal['property']
-                if group is None:
-                    port_name = signal['port_name'] or property_name
-                    result[hi_direction]['signals'][domain][port_name]['data'][property_name] = name
-                else:
-                    port_name = signal['port_name'] or group
-                    result[hi_direction]['signal_groups'][domain][port_name][group]['data'][property_name] = name
-    generation_utils.write_to_file(to_normal_dict(result), args.output, is_yaml=True)
-
-
-def generate_hi_interface_cli(args: argparse.Namespace):
-    """CLI entrypoint for generating HI YAML interface file.
-
-    Args:
-        args (Namespace): Arguments from command line.
-    """
-    app = generation_utils.process_app(args.config)
-    hi_app = DPAL(app)
-    interface = generation_utils.get_interface(app, hi_app)
-    generate_hi_interface(args, interface)
-
-
-def configure_parser(parser: argparse.ArgumentParser):
-    """Configure parser for generating HI YAML interface file."""
-    generation_utils.add_base_args(parser)
-    parser.add_argument(
-        "output",
-        help="Output file with interface specifications.",
-        type=Path
-    )
-    parser.set_defaults(func=generate_hi_interface_cli)
-
-
-def main(argv: Optional[List[str]] = None):
-    """ Main function for stand alone execution.
-    Mostly useful for testing and generation of dummy hal specifications.
-    """
-    parser = argparse.ArgumentParser(description=PARSER_HELP)
-    configure_parser(parser)
-    args = parser.parse_args(argv)
-    args.func(args)
-
-
-if __name__ == "__main__":
-    main(sys.argv[1:])
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+# -*- coding: utf-8 -*-
+"""Python module used for calculating interfaces for CSP HI"""
+import argparse
+import sys
+from pathlib import Path
+from typing import List, Optional
+
+from powertrain_build.interface import generation_utils
+from powertrain_build.interface.device_proxy import DPAL
+from powertrain_build.lib.helper_functions import recursive_default_dict, to_normal_dict
+
+OP_READ = 'read'
+OP_WRITE = 'write'
+
+PARSER_HELP = "Generate HI YAML interface file."
+
+
+def generate_hi_interface(args, hi_interface):
+    """Generate HI YAML interface file.
+
+    Args:
+        args (Namespace): Arguments from command line.
+        hi_interface (dict): HI interface dict based on HIApplication and generation_utils.get_interface.
+    Returns:
+        result (dict): Aggregated signal information as a dict.
+    """
+
+    io_translation = {
+        'consumer': OP_READ,
+        'producer': OP_WRITE
+    }
+    result = recursive_default_dict()
+    for raster_data in hi_interface.values():
+        for direction, signals in raster_data.items():
+            hi_direction = io_translation[direction]
+            for signal in signals:
+                domain = signal['domain']
+                group = signal['group']
+                name = signal['variable']
+                property_name = signal['property']
+                if group is None:
+                    port_name = signal['port_name'] or property_name
+                    result[hi_direction]['signals'][domain][port_name]['data'][property_name] = name
+                else:
+                    port_name = signal['port_name'] or group
+                    result[hi_direction]['signal_groups'][domain][port_name][group]['data'][property_name] = name
+    generation_utils.write_to_file(to_normal_dict(result), args.output, is_yaml=True)
+
+
+def generate_hi_interface_cli(args: argparse.Namespace):
+    """CLI entrypoint for generating HI YAML interface file.
+
+    Args:
+        args (Namespace): Arguments from command line.
+    """
+    app = generation_utils.process_app(args.config)
+    hi_app = DPAL(app)
+    interface = generation_utils.get_interface(app, hi_app)
+    generate_hi_interface(args, interface)
+
+
+def configure_parser(parser: argparse.ArgumentParser):
+    """Configure parser for generating HI YAML interface file."""
+    generation_utils.add_base_args(parser)
+    parser.add_argument(
+        "output",
+        help="Output file with interface specifications.",
+        type=Path
+    )
+    parser.set_defaults(func=generate_hi_interface_cli)
+
+
+def main(argv: Optional[List[str]] = None):
+    """ Main function for stand alone execution.
+    Mostly useful for testing and generation of dummy hal specifications.
+    """
+    parser = argparse.ArgumentParser(description=PARSER_HELP)
+    configure_parser(parser)
+    args = parser.parse_args(argv)
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

powertrain_build/interface/generate_service.py

@@ -1,69 +1,69 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-# -*- coding: utf-8 -*-
-"""Python module used for calculating interfaces for CSP"""
-import argparse
-import sys
-from pathlib import Path
-from typing import List, Optional
-
-from powertrain_build.interface.service import get_service
-from powertrain_build.lib import logger
-from powertrain_build.interface import generation_utils
-
-LOGGER = logger.create_logger("CSP service")
-
-PARSER_HELP = "Generate CSP service models"
-
-
-def configure_parser(parser: argparse.ArgumentParser):
-    """Configure parser for CSP service generation"""
-    generation_utils.add_base_args(parser)
-    parser.add_argument(
-        "--client-name",
-        help="Name of the context object in CSP. Defaults to project name."
-    )
-    parser.add_argument(
-        "output",
-        help="Output directory for service models",
-        type=Path
-    )
-    parser.set_defaults(func=generate_service_cli)
-
-
-def generate_service_cli(args: argparse.Namespace):
-    """CLI function for CSP service generation"""
-    app = generation_utils.process_app(args.config)
-    client_name = generation_utils.get_client_name(args, app)
-    service(args, app, client_name)
-
-
-def main(argv: Optional[List[str]] = None):
-    """ Main function for stand alone execution.
-    Mostly useful for testing and generation of dummy hal specifications
-    """
-    parser = argparse.ArgumentParser(description=PARSER_HELP)
-    configure_parser(parser)
-    args = parser.parse_args(argv)
-    args.func(args)
-
-
-def service(args, app, client_name):
-    """ Generate specifications for pt-scheduler wrappers.
-
-    Args:
-        args (Namespace): Arguments from command line
-        app (Application): Application to generate specifications for
-        client_name (str): Signal client name
-    """
-    model_internal = get_service(app, client_name, 'internal')
-    model_external = get_service(app, client_name, 'external')
-    model_observer = get_service(app, client_name, 'observer')
-    generation_utils.write_to_file(model_internal, Path(args.output, 'model', 'internal.yaml'), is_yaml=True)
-    generation_utils.write_to_file(model_external, Path(args.output, 'model', 'external.yaml'), is_yaml=True)
-    generation_utils.write_to_file(model_observer, Path(args.output, 'model', 'observer.yaml'), is_yaml=True)
-
-
-if __name__ == "__main__":
-    main(sys.argv[1:])
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+# -*- coding: utf-8 -*-
+"""Python module used for calculating interfaces for CSP"""
+import argparse
+import sys
+from pathlib import Path
+from typing import List, Optional
+
+from powertrain_build.interface.service import get_service
+from powertrain_build.lib import logger
+from powertrain_build.interface import generation_utils
+
+LOGGER = logger.create_logger("CSP service")
+
+PARSER_HELP = "Generate CSP service models"
+
+
+def configure_parser(parser: argparse.ArgumentParser):
+    """Configure parser for CSP service generation"""
+    generation_utils.add_base_args(parser)
+    parser.add_argument(
+        "--client-name",
+        help="Name of the context object in CSP. Defaults to project name."
+    )
+    parser.add_argument(
+        "output",
+        help="Output directory for service models",
+        type=Path
+    )
+    parser.set_defaults(func=generate_service_cli)
+
+
+def generate_service_cli(args: argparse.Namespace):
+    """CLI function for CSP service generation"""
+    app = generation_utils.process_app(args.config)
+    client_name = generation_utils.get_client_name(args, app)
+    service(args, app, client_name)
+
+
+def main(argv: Optional[List[str]] = None):
+    """ Main function for stand alone execution.
+    Mostly useful for testing and generation of dummy hal specifications
+    """
+    parser = argparse.ArgumentParser(description=PARSER_HELP)
+    configure_parser(parser)
+    args = parser.parse_args(argv)
+    args.func(args)
+
+
+def service(args, app, client_name):
+    """ Generate specifications for pt-scheduler wrappers.
+
+    Args:
+        args (Namespace): Arguments from command line
+        app (Application): Application to generate specifications for
+        client_name (str): Signal client name
+    """
+    model_internal = get_service(app, client_name, 'internal')
+    model_external = get_service(app, client_name, 'external')
+    model_observer = get_service(app, client_name, 'observer')
+    generation_utils.write_to_file(model_internal, Path(args.output, 'model', 'internal.yaml'), is_yaml=True)
+    generation_utils.write_to_file(model_external, Path(args.output, 'model', 'external.yaml'), is_yaml=True)
+    generation_utils.write_to_file(model_observer, Path(args.output, 'model', 'observer.yaml'), is_yaml=True)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

powertrain_build/interface/generate_wrappers.py

@@ -1,147 +1,147 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-# -*- coding: utf-8 -*-
-"""Python module used for calculating interfaces for CSP"""
-import argparse
-import sys
-from pathlib import Path
-from typing import List, Optional
-
-from powertrain_build.interface.hal import HALA, get_hal_list
-from powertrain_build.interface.device_proxy import DPAL
-from powertrain_build.interface.service import ServiceFramework, get_service_list
-from powertrain_build.lib import logger
-from powertrain_build.interface import generation_utils
-
-LOGGER = logger.create_logger("CSP wrappers")
-
-PARSER_HELP = "Generate specifications for pt-scheduler wrappers"
-
-
-def get_manifest(app, domain, client_name):
-    """Get signal manifest for application
-
-    The model yaml files are parsed for the models included in the application.
-    If there are no signals to interact with,
-    this function returns None to indicate that there should not be a manifest.
-
-    Args:
-        app (Application): Pybuild project
-        domain (str): Domain that the signals should not be part of
-        client_name (str): Client name in the signal database
-    Returns:
-        spec (dict/None): signal manifest, None if no manifest should be written
-    """
-    rasters = app.get_rasters()
-    LOGGER.debug("Rasters: %s", rasters)
-    translation_files = app.get_translation_files()
-
-    dpal = DPAL(app)
-    dpal.domain_filter = [domain]
-    dpal.parse_definition(translation_files)
-    dpal.clear_signal_names()
-    dpal.add_signals(app.insignals, "insignals")
-    dpal.add_signals(app.outsignals, "outsignals")
-    return dpal.to_manifest(client_name)
-
-
-def configure_parser(parser: argparse.ArgumentParser):
-    """Configure parser for generating pt-scheduler wrappers."""
-    generation_utils.add_base_args(parser)
-    parser.add_argument(
-        "--client-name",
-        help="Name of the context object in CSP. Defaults to project name."
-    )
-    parser.add_argument(
-        "--dp-interface",
-        help="Output file with DP interface specifications",
-        type=Path
-    )
-    parser.add_argument(
-        "--dp-manifest-dir",
-        help="Output directory for signal manifests",
-        type=Path
-    )
-    parser.add_argument(
-        "--hal-interface",
-        help="Output file with HAL interface specifications",
-        type=Path,
-    )
-    parser.add_argument(
-        "--service-interface",
-        help="Output file with service interface specifications",
-        type=Path
-    )
-    parser.set_defaults(func=generate_wrappers_cli)
-
-
-def generate_wrappers_cli(args: argparse.Namespace):
-    """Generate specifications for pt-scheduler wrappers.
-
-    Args:
-        args (Namespace): Arguments from command line
-    """
-    app = generation_utils.process_app(args.config)
-    client_name = generation_utils.get_client_name(args, app)
-    wrappers(args, app, client_name)
-
-
-def main(argv: Optional[List[str]] = None):
-    """ Main function for stand alone execution.
-    Mostly useful for testing and generation of dummy hal specifications
-    """
-    parser = argparse.ArgumentParser(description=PARSER_HELP)
-    configure_parser(parser)
-    args = parser.parse_args(argv)
-    args.func(args)
-
-
-def wrappers(args, app, client_name):
-    """ Generate specifications for pt-scheduler wrappers.
-
-    Args:
-        args (Namespace): Arguments from command line
-        app (Application): Application to generate specifications for
-        client_name (str): Signal client name
-    """
-    if args.hal_interface:
-        hala = HALA(app)
-        interface = generation_utils.get_interface(app, hala)
-        interface["relocatable_language"] = "C"
-        generation_utils.write_to_file(interface, args.hal_interface, is_yaml=True)
-        hals = get_hal_list(app)
-        cmake = Path(args.hal_interface.parent, 'hal.cmake')
-        generation_utils.write_to_file(hals, cmake)
-    if args.dp_interface:
-        dp = DPAL(app)
-        interface = generation_utils.get_interface(app, dp)
-        interface["relocatable_language"] = "C"
-        generation_utils.write_to_file(interface, args.dp_interface, is_yaml=True)
-    if args.service_interface:
-        service = ServiceFramework(app)
-        interface = generation_utils.get_interface(app, service)
-        interface["relocatable_language"] = "C"
-        generation_utils.write_to_file(interface, args.service_interface, is_yaml=True)
-        proxies = get_service_list(app)
-        cmake = Path(args.service_interface.parent, 'service-proxies.cmake')
-        generation_utils.write_to_file(proxies, cmake)
-    if args.dp_manifest_dir:
-        if not args.dp_manifest_dir.is_dir():
-            args.dp_manifest_dir.mkdir()
-
-        # Enable changing client name in generation
-        for domain in app.get_domain_names():
-            manifest = get_manifest(app, domain, client_name)
-            if manifest is None:
-                # Manifests without produced or consumed signals are not allowed
-                # Therefore get_manifests returned None to tell us to skip this domain
-                continue
-            domain_file = Path(
-                args.dp_manifest_dir,
-                f"{domain}_{app.name}.yaml")
-            generation_utils.write_to_file(manifest, domain_file, is_yaml=True)
-
-
-if __name__ == "__main__":
-    main(sys.argv[1:])
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+# -*- coding: utf-8 -*-
+"""Python module used for calculating interfaces for CSP"""
+import argparse
+import sys
+from pathlib import Path
+from typing import List, Optional
+
+from powertrain_build.interface.hal import HALA, get_hal_list
+from powertrain_build.interface.device_proxy import DPAL
+from powertrain_build.interface.service import ServiceFramework, get_service_list
+from powertrain_build.lib import logger
+from powertrain_build.interface import generation_utils
+
+LOGGER = logger.create_logger("CSP wrappers")
+
+PARSER_HELP = "Generate specifications for pt-scheduler wrappers"
+
+
+def get_manifest(app, domain, client_name):
+    """Get signal manifest for application
+
+    The model yaml files are parsed for the models included in the application.
+    If there are no signals to interact with,
+    this function returns None to indicate that there should not be a manifest.
+
+    Args:
+        app (Application): Pybuild project
+        domain (str): Domain that the signals should not be part of
+        client_name (str): Client name in the signal database
+    Returns:
+        spec (dict/None): signal manifest, None if no manifest should be written
+    """
+    rasters = app.get_rasters()
+    LOGGER.debug("Rasters: %s", rasters)
+    translation_files = app.get_translation_files()
+
+    dpal = DPAL(app)
+    dpal.domain_filter = [domain]
+    dpal.parse_definition(translation_files)
+    dpal.clear_signal_names()
+    dpal.add_signals(app.insignals, "insignals")
+    dpal.add_signals(app.outsignals, "outsignals")
+    return dpal.to_manifest(client_name)
+
+
+def configure_parser(parser: argparse.ArgumentParser):
+    """Configure parser for generating pt-scheduler wrappers."""
+    generation_utils.add_base_args(parser)
+    parser.add_argument(
+        "--client-name",
+        help="Name of the context object in CSP. Defaults to project name."
+    )
+    parser.add_argument(
+        "--dp-interface",
+        help="Output file with DP interface specifications",
+        type=Path
+    )
+    parser.add_argument(
+        "--dp-manifest-dir",
+        help="Output directory for signal manifests",
+        type=Path
+    )
+    parser.add_argument(
+        "--hal-interface",
+        help="Output file with HAL interface specifications",
+        type=Path,
+    )
+    parser.add_argument(
+        "--service-interface",
+        help="Output file with service interface specifications",
+        type=Path
+    )
+    parser.set_defaults(func=generate_wrappers_cli)
+
+
+def generate_wrappers_cli(args: argparse.Namespace):
+    """Generate specifications for pt-scheduler wrappers.
+
+    Args:
+        args (Namespace): Arguments from command line
+    """
+    app = generation_utils.process_app(args.config)
+    client_name = generation_utils.get_client_name(args, app)
+    wrappers(args, app, client_name)
+
+
+def main(argv: Optional[List[str]] = None):
+    """ Main function for stand alone execution.
+    Mostly useful for testing and generation of dummy hal specifications
+    """
+    parser = argparse.ArgumentParser(description=PARSER_HELP)
+    configure_parser(parser)
+    args = parser.parse_args(argv)
+    args.func(args)
+
+
+def wrappers(args, app, client_name):
+    """ Generate specifications for pt-scheduler wrappers.
+
+    Args:
+        args (Namespace): Arguments from command line
+        app (Application): Application to generate specifications for
+        client_name (str): Signal client name
+    """
+    if args.hal_interface:
+        hala = HALA(app)
+        interface = generation_utils.get_interface(app, hala)
+        interface["relocatable_language"] = "C"
+        generation_utils.write_to_file(interface, args.hal_interface, is_yaml=True)
+        hals = get_hal_list(app)
+        cmake = Path(args.hal_interface.parent, 'hal.cmake')
+        generation_utils.write_to_file(hals, cmake)
+    if args.dp_interface:
+        dp = DPAL(app)
+        interface = generation_utils.get_interface(app, dp)
+        interface["relocatable_language"] = "C"
+        generation_utils.write_to_file(interface, args.dp_interface, is_yaml=True)
+    if args.service_interface:
+        service = ServiceFramework(app)
+        interface = generation_utils.get_interface(app, service)
+        interface["relocatable_language"] = "C"
+        generation_utils.write_to_file(interface, args.service_interface, is_yaml=True)
+        proxies = get_service_list(app)
+        cmake = Path(args.service_interface.parent, 'service-proxies.cmake')
+        generation_utils.write_to_file(proxies, cmake)
+    if args.dp_manifest_dir:
+        if not args.dp_manifest_dir.is_dir():
+            args.dp_manifest_dir.mkdir()
+
+        # Enable changing client name in generation
+        for domain in app.get_domain_names():
+            manifest = get_manifest(app, domain, client_name)
+            if manifest is None:
+                # Manifests without produced or consumed signals are not allowed
+                # Therefore get_manifests returned None to tell us to skip this domain
+                continue
+            domain_file = Path(
+                args.dp_manifest_dir,
+                f"{domain}_{app.name}.yaml")
+            generation_utils.write_to_file(manifest, domain_file, is_yaml=True)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])