Database: introduce a short name property

this is not too useful IMO, but the spec says `index.xml` (contained by `.pdx` files) should contain a non-empty `SHORT-NAME` tag... Signed-off-by: Andreas Lauser <[email protected]> Signed-off-by: Michael Hahn <[email protected]>
mercedes-benz · Sep 9, 2024 · 2c5396a · 2c5396a
1 parent c048d0d
commit 2c5396a
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 3 deletions.
diff --git a/examples/somersault.pdx b/examples/somersault.pdx
diff --git a/examples/somersault_modified.pdx b/examples/somersault_modified.pdx
diff --git a/examples/somersaultecu.py b/examples/somersaultecu.py
@@ -2403,6 +2403,7 @@ class SomersaultSID(IntEnum):
 
 # create a database object
 database = Database()
+database.short_name = "somersault_database"
 database._diag_layer_containers = NamedItemList([somersault_dlc])
 database._comparam_subsets = NamedItemList(comparam_subsets)
 database._comparam_specs = NamedItemList(comparam_specs)

diff --git a/odxtools/database.py b/odxtools/database.py
@@ -17,7 +17,7 @@
 from .diaglayers.ecuvariant import EcuVariant
 from .diaglayers.functionalgroup import FunctionalGroup
 from .diaglayers.protocol import Protocol
-from .exceptions import odxraise
+from .exceptions import odxraise, odxrequire
 from .nameditemlist import NamedItemList
 from .odxlink import OdxLinkDatabase, OdxLinkId
 
@@ -36,6 +36,7 @@ def __init__(self) -> None:
         self._diag_layer_containers = NamedItemList[DiagLayerContainer]()
         self._comparam_subsets = NamedItemList[ComparamSubset]()
         self._comparam_specs = NamedItemList[ComparamSpec]()
+        self._short_name = "odx_database"
 
     def add_pdx_file(self, pdx_file: Union[str, "PathLike[Any]", IO[bytes], ZipFile]) -> None:
         """Add PDX file to database.
@@ -54,7 +55,11 @@ def add_pdx_file(self, pdx_file: Union[str, "PathLike[Any]", IO[bytes], ZipFile]
             if p.suffix.lower().startswith(".odx"):
                 root = ElementTree.parse(pdx_zip.open(zip_member)).getroot()
                 self._process_xml_tree(root)
-            elif p.name.lower() != "index.xml":
+            elif p.name.lower() == "index.xml":
+                root = ElementTree.parse(pdx_zip.open(zip_member)).getroot()
+                db_short_name = odxrequire(root.findtext("SHORT-NAME"))
+                self.short_name = db_short_name
+            else:
                 self.add_auxiliary_file(zip_member, pdx_zip.open(zip_member))
 
     def add_odx_file(self, odx_file_name: Union[str, "PathLike[Any]"]) -> None:
@@ -158,6 +163,14 @@ def odxlinks(self) -> OdxLinkDatabase:
         """A map from odx_id to object"""
         return self._odxlinks
 
+    @property
+    def short_name(self) -> str:
+        return self._short_name
+
+    @short_name.setter
+    def short_name(self, value: str) -> None:
+        self._short_name = value
+
     @property
     def ecu_shared_datas(self) -> NamedItemList[EcuSharedData]:
         """All ECU shared data layers defined by this database

diff --git a/odxtools/templates/index.xml.jinja2 b/odxtools/templates/index.xml.jinja2
@@ -4,7 +4,7 @@
 -#}
 <?xml version="1.0" encoding="UTF-8"?>
 <CATALOG xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" F-DTD-VERSION="ODX-2.2.0" xsi:noNamespaceSchemaLocation="odx-cc.xsd">
-  <SHORT-NAME>{{ecu_name}}</SHORT-NAME>
+  <SHORT-NAME>{{database.short_name}}</SHORT-NAME>
   <ABLOCKS>
 {%- for file_name, creation_date, mime_type in file_index %}
     <ABLOCK UPD="UNCHANGED">