Update reviews

Signed-off-by: Jan Kubovy <jan.kubovy@bmw.de>

Author: jankubovy

pyproject.toml

@@ -8,6 +8,7 @@ dependencies = [
     "anytree>=2.12.1",
     "bump2version>=1.0.1",
     "click>=8.1.7",
+    "dataclasses-json>=0.6.7",
     "deprecation>=2.1.0",
     "graphql-core>=3.2.5",
     "importlib-metadata>=8.5.0",

src/vss_tools/cli_options.py

@@ -158,72 +158,3 @@ def validate_attribute(value):
 )
 
 pretty_print_opt = option("--pretty/--no-pretty", help="Pretty print.", default=False, show_default=True)
-
-vhal_map_opt = option(
-    "--vhal-map",
-    type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=False),
-    required=True,
-    help="""
-        Read a json file with mapping of VSS property names to Android vehicle property ids.
-        The file containing json list of all VSS properties (leaves) mappings by vss_tools generated VHAL IDs.
-    """,
-)
-
-continuous_change_mode_opt = option(
-    "--continuous-change-mode",
-    type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
-    required=False,
-    help="Read a json file list of VSS paths which should be considered as continuous change mode.",
-)
-
-output_dir_opt = option(
-    "--output-dir",
-    type=click.Path(dir_okay=True, readable=True, path_type=Path, exists=True),
-    required=True,
-    help="Output directory, where vhal specific generated files are saved into.",
-)
-
-property_group_opt = option(
-    "--property-group",
-    type=int,
-    required=False,
-    default=1,
-    show_default=True,
-    help="""
-        Group of generated VHAL properties: 1 = SYSTEM, 2 = VENDOR, 3 = BACKPORTED, 4 = VSS.
-        See https://cs.android.com/android/platform/superproject/main/+/main:hardware/interfaces/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehiclePropertyGroup.aidl
-    """,
-)
-
-min_property_id_opt = option(
-    "--min-property-id",
-    type=int,
-    required=False,
-    default=1,
-    show_default=True,
-    help="Stating ID for newly generated properties. This considers only the last 2 bytes of the VHAL property ID.",
-)
-
-extend_new_opt = option(
-    "--extend-new/--no-extend-new",
-    help="""
-        Whether to extend the map with new VSS nodes from the spec not present in the map file or only update
-        existing VHAL properties and ignores all new VSS nodes.
-    """,
-    default=True,
-    show_default=True,
-)
-
-override_vhal_units_opt = option(
-    "--override-vhal-units/--no-override-vhal-units",
-    help="Overrides previously generated VHAL units.",
-    default=False,
-    show_default=True,
-)
-
-override_vhal_datatype_opt = option(
-    "--override-vhal-datatype/--no-override-vhal-datatype",
-    help="Overrides previously generated VHAL datatypes.",
-    default=False,
-    show_default=True,
-)

src/vss_tools/exporters/vhal.py

@@ -18,14 +18,67 @@
 
 @click.command()
 @clo.vspec_opt
-@clo.vhal_map_opt
-@clo.continuous_change_mode_opt
-@clo.output_dir_opt
-@clo.extend_new_opt
-@clo.property_group_opt
-@clo.min_property_id_opt
-@clo.override_vhal_units_opt
-@clo.override_vhal_datatype_opt
+@click.option(
+    "--vhal-map",
+    type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=False),
+    required=True,
+    help="""
+        Read a json file with mapping of VSS property names to Android vehicle property ids.
+        The file containing json list of all VSS properties (leaves) mappings by vss_tools generated VHAL IDs.
+    """,
+)
+@click.option(
+    "--continuous-change-mode",
+    type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
+    required=False,
+    help="Read a json file list of VSS paths which should be considered as continuous change mode.",
+)
+@click.option(
+    "--output-dir",
+    type=click.Path(dir_okay=True, readable=True, path_type=Path, exists=True),
+    required=True,
+    help="Output directory, where vhal specific generated files are saved into.",
+)
+@click.option(
+    "--property-group",
+    type=int,
+    required=False,
+    default=1,
+    show_default=True,
+    help="""
+        Group of generated VHAL properties: 1 = SYSTEM, 2 = VENDOR, 3 = BACKPORTED, 4 = VSS.
+        See https://cs.android.com/android/platform/superproject/main/+/main:hardware/interfaces/automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/VehiclePropertyGroup.aidl
+    """,
+)
+@click.option(
+    "--min-property-id",
+    type=int,
+    required=False,
+    default=1,
+    show_default=True,
+    help="Stating ID for newly generated properties. This considers only the last 2 bytes of the VHAL property ID.",
+)
+@click.option(
+    "--extend-new/--no-extend-new",
+    help="""
+        Whether to extend the map with new VSS nodes from the spec not present in the map file or only update
+        existing VHAL properties and ignores all new VSS nodes.
+    """,
+    default=True,
+    show_default=True,
+)
+@click.option(
+    "--override-vhal-units/--no-override-vhal-units",
+    help="Overrides previously generated VHAL units.",
+    default=False,
+    show_default=True,
+)
+@click.option(
+    "--override-vhal-datatype/--no-override-vhal-datatype",
+    help="Overrides previously generated VHAL datatypes.",
+    default=False,
+    show_default=True,
+)
 def cli(
     vspec: Path,
     vhal_map: Path,

src/vss_tools/utils/vhal/property_constants.py

@@ -26,13 +26,12 @@ class VhalAreaType(Enum):
     VEHICLE_AREA_TYPE_VENDOR = 7  # VehicleAreaType.VENDOR java
     VEHICLE_AREA_TYPE_VENDOR_AIDL = int(0x08000000)  # VehicleArea.VENDOR aidl
 
-    def __str__(self):
-        if self.name == VhalAreaType.VEHICLE_AREA_TYPE_VENDOR_AIDL.name:
-            return "VehicleArea.VENDOR"
-        elif self.name == VhalAreaType.VEHICLE_AREA_TYPE_GLOBAL_AIDL.name:
-            return "VehicleArea.GLOBAL"
-        else:
-            return f"VehicleAreaType.{self.name}"
+    def __str__(self) -> str:
+        d = {
+            self.VEHICLE_AREA_TYPE_GLOBAL: "VehicleArea.GLOBAL",
+            self.VEHICLE_AREA_TYPE_VENDOR: "VehicleArea.VENDOR",
+        }
+        return d.get(self, f"VehicleAreaType.{self.name}")
 
 
 class VhalPropertyGroup(Enum):
@@ -61,16 +60,13 @@ def get(group: int):
             sys.exit(1)
 
     def __str__(self):
-        if self.name == VhalPropertyGroup.VEHICLE_PROPERTY_GROUP_SYSTEM.name:
-            return "VehiclePropertyGroup.SYSTEM"
-        if self.name == VhalPropertyGroup.VEHICLE_PROPERTY_GROUP_VENDOR.name:
-            return "VehiclePropertyGroup.VENDOR"
-        if self.name == VhalPropertyGroup.VEHICLE_PROPERTY_GROUP_BACKPORTED.name:
-            return "VehiclePropertyGroup.BACKPORTED"
-        if self.name == VhalPropertyGroup.VEHICLE_PROPERTY_GROUP_VSS.name:
-            return "VehiclePropertyGroup.VSS"
-        else:
-            return "VehiclePropertyGroup.SYSTEM"
+        d = {
+            self.VEHICLE_PROPERTY_GROUP_SYSTEM: "VehiclePropertyGroup.SYSTEM",
+            self.VEHICLE_PROPERTY_GROUP_VENDOR: "VehiclePropertyGroup.VENDOR",
+            self.VEHICLE_PROPERTY_GROUP_BACKPORTED: "VehiclePropertyGroup.BACKPORTED",
+            self.VEHICLE_PROPERTY_GROUP_VSS: "VehiclePropertyGroup.VSS",
+        }
+        return d.get(self, "VehiclePropertyGroup.SYSTEM")
 
 
 class VSSDatatypesToVhal:
@@ -135,8 +131,7 @@ def get_property_type_repr(cls, datatype_id: int) -> str:
         """
         datatype_name = VSSDatatypesToVhal.VHAL_TO_VSS_TYPE_MAP.get(datatype_id)
         if not datatype_name:
-            logging.error(f"Invalid property type id {datatype_id}, must be one of IDs listed in VSSDataTypeToVhal")
-            sys.exit()
+            raise Exception(f"Invalid property type id {datatype_id}, must be one of IDs listed in VSSDataTypeToVhal")
 
         return f"VehiclePropertyType.{datatype_name}"
 

src/vss_tools/utils/vhal/vehicle_mapping.py

@@ -7,58 +7,61 @@
 # SPDX-License-Identifier: MPL-2.0
 
 from dataclasses import dataclass
-from typing import List, Optional
+from typing import List, Optional, Union
 
+from dataclasses_json import LetterCase, dataclass_json
 
-@dataclass
+
+@dataclass_json(letter_case=LetterCase.CAMEL)
+@dataclass(frozen=True)
 class VehicleMappingItem:
     """
     Represents a single vehicle mapping item.
     """
 
     name: str
-    propertyId: int
-    areaId: int
+    property_id: int
+    area_id: int
     access: int
-    changeMode: int
+    change_mode: int
     unit: str
     source: str
     formula: Optional[str] = None
     comment: Optional[str] = None
-    configString: Optional[str] = None
+    config_string: Optional[str] = None
 
     datatype: Optional[str] = None
     type: Optional[str] = None
     min: Optional[int] = None
     max: Optional[int] = None
     allowed: Optional[List[str]] = None
-    default: Optional[int] = None
+    default: Optional[Union[Union[int, str], Union[List[int], List[str]]]] = None
     deprecation: Optional[str] = None
 
     @property
-    def vhalGroup(self):
+    def vhal_group(self):
         """
         VHAL group component of the property ID.
         """
-        return (self.propertyId & 0xF0000000) >> 28
+        return (self.property_id & 0xF0000000) >> 28
 
     @property
-    def vhalArea(self):
+    def vhal_area(self):
         """
         VHAL area component of the property ID.
         """
-        return (self.propertyId & 0x0F000000) >> 24
+        return (self.property_id & 0x0F000000) >> 24
 
     @property
-    def vhalType(self):
+    def vhal_type(self):
         """
         VHAL type component of the property ID.
         """
-        return (self.propertyId & 0x00FF0000) >> 16
+        return (self.property_id & 0x00FF0000) >> 16
 
     @property
-    def vhalId(self):
+    def vhal_id(self):
         """
         VHAL unique ID component of the property ID.
         """
-        return self.propertyId & 0x0000FFFF
+        return self.property_id & 0x0000FFFF