odxtools 10.1.1__py3-none-any.whl → 10.2.1__py3-none-any.whl

odxtools/templates/macros/printSpecialData.xml.jinja2

@@ -25,7 +25,7 @@
 {%- macro printSpecialDataGroup(sdg) %}
 <SDG {{-make_xml_attrib("SI", sdg.semantic_info)}}>
  {%- if sdg.sdg_caption_ref %}
- <SDG-CAPTION-REF ID-REF="{{sdg.sdg_caption_ref.ref_id}}" />
+ <SDG-CAPTION-REF {{make_ref_attribs(sdg.sdg_caption_ref)}} />
  {%- elif sdg.sdg_caption %}
  {{- printSdgCaption(sdg.sdg_caption) | indent(1, first=True) }}
  {%- endif %}
@@ -49,4 +49,4 @@
  {%- endfor %}
 </SDGS>
 {%- endif %}
-{%- endmacro %}
+{#- #}{%- endmacro %}

odxtools/templates/macros/printStateTransitionRef.xml.jinja2

@@ -4,7 +4,7 @@
 -#}
 
 {%- macro printStateTransitionRef(st_ref) -%}
-<STATE-TRANSITION-REF ID-REF="{{st_ref.ref_id}}">
+<STATE-TRANSITION-REF {{make_ref_attribs(st_ref)}}>
   {%- if st_ref.value is not none %}
   <VALUE>{{ st_ref.value }}</VALUE>
   {%- endif %}

odxtools/templates/macros/printStaticField.xml.jinja2

@@ -8,7 +8,7 @@
 {%- macro printStaticField(sf) -%}
 <STATIC-FIELD {{-peid.printElementIdAttribs(sf)}}>
  {{ peid.printElementIdSubtags(sf)|indent(1) }}
- <BASIC-STRUCTURE-REF ID-REF="{{sf.structure_ref.ref_id}}" />
+ <BASIC-STRUCTURE-REF {{make_ref_attribs(sf.structure_ref)}} />
  <FIXED-NUMBER-OF-ITEMS>{{sf.fixed_number_of_items}}</FIXED-NUMBER-OF-ITEMS>
  <ITEM-BYTE-SIZE>{{sf.item_byte_size}}</ITEM-BYTE-SIZE>
 </STATIC-FIELD>

odxtools/templates/macros/printSubComponent.xml.jinja2

@@ -40,7 +40,7 @@
 {%- macro printTableRowConnector(conn) %}
 <TABLE-ROW-CONNECTOR>
   {{ peid.printElementIdSubtags(conn)|indent(2) }}
-  <TABLE-REF ID-REF="{{ conn.table_ref.ref_id }}" />
+  <TABLE-REF {{make_ref_attribs(conn.table_ref)}} />
   <TABLE-ROW-SNREF {{- make_xml_attrib("SHORT-NAME", conn.table_row_snref ) }} />
 </TABLE-ROW-CONNECTOR>
 {%- endmacro %}
@@ -48,7 +48,7 @@
 {%- macro printEnvDataConnector(conn) %}
 <ENV-DATA-CONNECTOR>
   {{ peid.printElementIdSubtags(conn)|indent(2) }}
-  <ENV-DATA-DESC-REF ID-REF="{{ conn.env_data_desc_ref.ref_id }}" />
+  <ENV-DATA-DESC-REF {{make_ref_attribs(conn.env_data_desc_ref)}} />
   <ENV-DATA-SNREF {{- make_xml_attrib("SHORT-NAME", conn.env_data_snref ) }} />
 </ENV-DATA-CONNECTOR>
 {%- endmacro %}
@@ -56,7 +56,7 @@
 {%- macro printDtcConnector(conn) %}
 <DTC-CONNECTOR>
   {{ peid.printElementIdSubtags(conn)|indent(2) }}
-  <DTC-DOP-REF ID-REF="{{ conn.dtc_dop_ref.ref_id }}" />
+  <DTC-DOP-REF {{make_ref_attribs(conn.dtc_dop_ref)}} />
   <DOP-SNREF {{- make_xml_attrib("SHORT-NAME", conn.dtc_snref ) }} />
 </DTC-CONNECTOR>
 {%- endmacro %}

odxtools/templates/macros/printTable.xml.jinja2

@@ -16,7 +16,7 @@
        {{-make_xml_attrib("SEMANTIC", table.semantic)}}>
  {{ peid.printElementIdSubtags(table)|indent(1) }}
 {%- if table.key_dop_ref %}
- <KEY-DOP-REF ID-REF="{{ table.key_dop_ref.ref_id }}" />
+ <KEY-DOP-REF {{make_ref_attribs(table.key_dop_ref)}} />
 {%- endif %}
  {%- for table_row in table.table_rows_raw %}
  {%- if hasattr(table_row, "key") %}
@@ -25,13 +25,13 @@
   {{-peid.printElementIdSubtags(table_row)}}
   <KEY>{{table_row.key|e}}</KEY>
   {%- if table_row.dop_ref is not none %}
-  <DATA-OBJECT-PROP-REF ID-REF="{{ table_row.dop_ref.ref_id }}" />
+  <DATA-OBJECT-PROP-REF {{make_ref_attribs(table_row.dop_ref)}} />
   {%- endif %}
   {%- if table_row.dop_snref is not none %}
   <DATA-OBJECT-PROP-SNREF SHORT-NAME="{{ table_row.dop_snref }}" />
   {%- endif %}
   {%- if table_row.structure_ref is not none %}
-  <STRUCTURE-REF ID-REF="{{ table_row.structure_ref.ref_id }}" />
+  <STRUCTURE-REF {{make_ref_attribs(table_row.structure_ref)}} />
   {%- endif %}
   {%- if table_row.structure_snref is not none %}
   <STRUCTURE-SNREF SHORT-NAME="{{ table_row.structure_snref }}" />
@@ -43,7 +43,7 @@
   {%- if table_row.functional_class_refs %}
   <FUNCT-CLASS-REFS>
     {%- for fc_ref in table_row.functional_class_refs %}
-    <FUNCT-CLASS-REF ID-REF="{{ fc_ref.ref_id }}" />
+    <FUNCT-CLASS-REF {{make_ref_attribs(fc_ref)}} />
     {%- endfor %}
   </FUNCT-CLASS-REFS>
   {%- endif %}
@@ -66,7 +66,7 @@
   {%- endif %}
  </TABLE-ROW>
  {%- else %}
- <TABLE-ROW-REF ID-REF="{{ table_row.ref_id }}" />
+ <TABLE-ROW-REF {{make_ref_attribs(table_row)}} />
  {%- endif %}
 {%- endfor %}
  {%- if table_diag_comm_connectors %}
@@ -75,7 +75,7 @@
   <TABLE-DIAG-COMM-CONNECTOR>
    <SEMANTIC>{{tdcc.semantic}}</SEMANTIC>
    {%- if tdcc.diag_comm_ref %}
-   <DIAG-COMM-REF ID-REF="{{ tdcc.diag_comm_ref.ref_id }}" />
+   <DIAG-COMM-REF {{make_ref_attribs(tdcc.diag_comm_ref)}} />
    {%- elif tdcc.diag_comm_snref %}
    <DIAG-COMM-SNREF SHORT-NAME="{{ tdcc.diag_comm_snref }}" />
    {%- endif %}

odxtools/templates/macros/printUnitSpec.xml.jinja2

@@ -49,7 +49,7 @@
  <OFFSET-SI-TO-UNIT>{{ unit.offset_si_to_unit }}</OFFSET-SI-TO-UNIT>
  {%- endif %}
  {%- if unit.physical_dimension_ref %}
- <PHYSICAL-DIMENSION-REF ID-REF="{{ unit.physical_dimension_ref.ref_id }}" />
+ <PHYSICAL-DIMENSION-REF {{make_ref_attribs(unit.physical_dimension_ref)}} />
  {%- endif %}
 </UNIT>
 {%- endmacro -%}
@@ -61,7 +61,7 @@
  {%- if group.unit_refs %}
  <UNIT-REFS>
  {%- for ref in group.unit_refs %}
-  <UNIT-REF ID-REF="{{ ref.ref_id }}" />
+  <UNIT-REF {{make_ref_attribs(ref)}} />
  {%- endfor %}
  </UNIT-REFS>
  {%- endif %}

odxtools/text.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass
 from xml.etree import ElementTree
 
 from .odxdoccontext import OdxDocContext
+from .utils import strip_indent
 
 
 @dataclass(kw_only=True)
@@ -16,12 +17,7 @@ class Text:
         for e in et_element:
             raw_string += ElementTree.tostring(e, encoding="unicode")
 
-        # remove white spaces at the beginning and at the end of all
-        # extracted lines
-        stripped_lines = [x.strip() for x in raw_string.split("\n")]
-
-        text = "\n".join(stripped_lines).strip()
-
+        text = strip_indent(raw_string)
         text_identifier = et_element.get("TI")
 
         return Text(text=text, text_identifier=text_identifier)

odxtools/utils.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: MIT
 import dataclasses
 import re
-from typing import TYPE_CHECKING, Any, Optional
+from typing import TYPE_CHECKING, Any, Optional, overload
 from xml.etree import ElementTree
 
 from .exceptions import odxraise
@@ -12,6 +12,27 @@ if TYPE_CHECKING:
     from .snrefcontext import SnRefContext
 
 
+@overload
+def strip_indent(text: str) -> str:
+    ...
+
+
+@overload
+def strip_indent(text: None) -> None:
+    ...
+
+
+def strip_indent(text: str | None) -> str | None:
+    """Remove the leading and trailing space characters of all lines of a string.
+
+    Note that non-space whitespace characters (tabulators, etc) are unaffected
+    """
+    if text is None:
+        return None
+
+    return "\n".join([x.strip(" \r") for x in text.split("\n")])
+
+
 def read_hex_binary(et_element: ElementTree.Element | None) -> int | None:
     """Convert the contents of an xsd:hexBinary to an integer
     """

odxtools/validityfor.py

@@ -0,0 +1,30 @@
+# SPDX-License-Identifier: MIT
+from dataclasses import dataclass
+from typing import cast
+from xml.etree import ElementTree
+
+from .exceptions import odxraise, odxrequire
+from .odxdoccontext import OdxDocContext
+from .sessionsubelemtype import SessionSubElemType
+
+
+@dataclass(kw_only=True)
+class ValidityFor:
+    value: str
+    value_type: SessionSubElemType
+
+    @staticmethod
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "ValidityFor":
+        value = et_element.text or ""
+
+        value_type_str = odxrequire(et_element.get("TYPE"))
+        try:
+            value_type = SessionSubElemType(value_type_str)
+        except ValueError:
+            value_type = cast(SessionSubElemType, None)
+            odxraise(f"Encountered unknown SESSION-SUB-ELEM-TYPE type '{value_type_str}'")
+
+        return ValidityFor(
+            value=value,
+            value_type=value_type,
+        )

odxtools/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '10.1.1'
-__version_tuple__ = version_tuple = (10, 1, 1)
+__version__ = version = '10.2.1'
+__version_tuple__ = version_tuple = (10, 2, 1)

odxtools/writepdxfile.py

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: MIT
 import datetime
+import html
 import inspect
 import mimetypes
 import os
@@ -12,10 +13,9 @@ import jinja2
 import odxtools
 
 from .database import Database
+from .odxlink import DocType, OdxDocFragment, OdxLinkRef
 from .odxtypes import bool_to_odxstr
 
-odxdatabase: Database | None = None
-
 
 def jinja2_odxraise_helper(msg: str) -> None:
     raise Exception(msg)
@@ -25,7 +25,7 @@ def make_xml_attrib(attrib_name: str, attrib_val: Any | None) -> str:
     if attrib_val is None:
         return ""
 
-    return f' {attrib_name}="{attrib_val}"'
+    return f' {attrib_name}="{html.escape(attrib_val)}"'
 
 
 def make_bool_xml_attrib(attrib_name: str, attrib_val: bool | None) -> str:
@@ -35,6 +35,39 @@ def make_bool_xml_attrib(attrib_name: str, attrib_val: bool | None) -> str:
     return make_xml_attrib(attrib_name, bool_to_odxstr(attrib_val))
 
 
+def set_category_docfrag(jinja_vars: dict[str, Any], category_short_name: str,
+                         category_type: str) -> str:
+    jinja_vars["cur_docfrags"] = [OdxDocFragment(category_short_name, DocType(category_type))]
+
+    return ""
+
+
+def set_layer_docfrag(jinja_vars: dict[str, Any], layer_short_name: str | None) -> str:
+    cur_docfrags = jinja_vars["cur_docfrags"]
+
+    if layer_short_name is None:
+        cur_docfrags = cur_docfrags[:1]
+        return ""
+
+    if len(cur_docfrags) == 1:
+        cur_docfrags.append(OdxDocFragment(layer_short_name, DocType.LAYER))
+    else:
+        cur_docfrags[1] = OdxDocFragment(layer_short_name, DocType.LAYER)
+
+    return ""
+
+
+def make_ref_attribs(jinja_vars: dict[str, Any], ref: OdxLinkRef) -> str:
+    cur_docfrags = jinja_vars["cur_docfrags"]
+
+    for ref_frag in ref.ref_docs:
+        if ref_frag in cur_docfrags:
+            return f"ID-REF=\"{ref.ref_id}\""
+
+    docfrag = ref.ref_docs[-1]
+    return f"ID-REF=\"{ref.ref_id}\" DOCREF=\"{docfrag.doc_name}\" DOCTYPE=\"{docfrag.doc_type.value}\""
+
+
 __module_filename = inspect.getsourcefile(odxtools)
 assert isinstance(__module_filename, str)
 __templates_dir = os.path.sep.join([os.path.dirname(__module_filename), "templates"])
@@ -48,10 +81,6 @@ def write_pdx_file(
     """
     Write an internalized database to a PDX file.
     """
-    global odxdatabase
-
-    odxdatabase = database
-
     file_index = []
     with zipfile.ZipFile(output_file_name, mode="w", compression=zipfile.ZIP_DEFLATED) as zf:
 
@@ -128,9 +157,14 @@ def write_pdx_file(
         jinja_env.globals["make_xml_attrib"] = make_xml_attrib
         jinja_env.globals["make_bool_xml_attrib"] = make_bool_xml_attrib
 
-        vars: dict[str, Any] = {}
-        vars["odxtools_version"] = odxtools.__version__
-        vars["database"] = database
+        jinja_vars: dict[str, Any] = {}
+        jinja_vars["odxtools_version"] = odxtools.__version__
+        jinja_vars["database"] = database
+
+        jinja_env.globals["set_category_docfrag"] = lambda cname, ctype: set_category_docfrag(
+            jinja_vars, cname, ctype)
+        jinja_env.globals["set_layer_docfrag"] = lambda lname: set_layer_docfrag(jinja_vars, lname)
+        jinja_env.globals["make_ref_attribs"] = lambda ref: make_ref_attribs(jinja_vars, ref)
 
         # write the communication parameter subsets
         comparam_subset_tpl = jinja_env.get_template("comparam-subset.odx-cs.xml.jinja2")
@@ -139,13 +173,13 @@ def write_pdx_file(
             zf_file_cdate = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S")
             zf_mime_type = "application/x-asam.odx.odx-cs"
 
-            vars["comparam_subset"] = comparam_subset
+            jinja_vars["comparam_subset"] = comparam_subset
 
             file_index.append((zf_file_name, zf_file_cdate, zf_mime_type))
 
-            zf.writestr(zf_file_name, comparam_subset_tpl.render(**vars))
+            zf.writestr(zf_file_name, comparam_subset_tpl.render(**jinja_vars))
 
-            del vars["comparam_subset"]
+            del jinja_vars["comparam_subset"]
 
         # write the communication parameter specs
         comparam_spec_tpl = jinja_env.get_template("comparam-spec.odx-c.xml.jinja2")
@@ -154,18 +188,18 @@ def write_pdx_file(
             zf_file_cdate = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S")
             zf_mime_type = "application/x-asam.odx.odx-c"
 
-            vars["comparam_spec"] = comparam_spec
+            jinja_vars["comparam_spec"] = comparam_spec
 
             file_index.append((zf_file_name, zf_file_cdate, zf_mime_type))
 
-            zf.writestr(zf_file_name, comparam_spec_tpl.render(**vars))
+            zf.writestr(zf_file_name, comparam_spec_tpl.render(**jinja_vars))
 
-            del vars["comparam_spec"]
+            del jinja_vars["comparam_spec"]
 
         # write the actual diagnostic data.
         dlc_tpl = jinja_env.get_template("diag_layer_container.odx-d.xml.jinja2")
         for dlc in database.diag_layer_containers:
-            vars["dlc"] = dlc
+            jinja_vars["dlc"] = dlc
 
             file_name = f"{dlc.short_name}.odx-d"
             file_cdate = datetime.datetime.now()
@@ -173,13 +207,28 @@ def write_pdx_file(
             mime_type = "application/x-asam.odx.odx-d"
 
             file_index.append((file_name, creation_date, mime_type))
-            zf.writestr(file_name, dlc_tpl.render(**vars))
-            del vars["dlc"]
+            zf.writestr(file_name, dlc_tpl.render(**jinja_vars))
+            del jinja_vars["dlc"]
+
+        # write the flash description objects
+        flash_tpl = jinja_env.get_template("flash.odx-f.xml.jinja2")
+        for flash in database.flashs:
+            zf_file_name = f"{flash.short_name}.odx-f"
+            zf_file_cdate = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S")
+            zf_mime_type = "application/x-asam.odx.odx-f"
+
+            jinja_vars["flash"] = flash
+
+            file_index.append((zf_file_name, zf_file_cdate, zf_mime_type))
+
+            zf.writestr(zf_file_name, flash_tpl.render(**jinja_vars))
+
+            del jinja_vars["flash"]
 
         # write the index.xml file
-        vars["file_index"] = file_index
+        jinja_vars["file_index"] = file_index
         index_tpl = jinja_env.get_template("index.xml.jinja2")
-        text = index_tpl.render(**vars)
+        text = index_tpl.render(**jinja_vars)
         zf.writestr("index.xml", text)
 
     return True

{odxtools-10.1.1.dist-info → odxtools-10.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odxtools
-Version: 10.1.1
+Version: 10.2.1
 Summary: Utilities to work with the ODX standard for automotive diagnostics
 Author-email: Katrin Bauer <katrin.bauer@mbition.io>, Andreas Lauser <andreas.lauser@mbition.io>, Ayoub Kaanich <kayoub5@live.com>
 Maintainer-email: Andreas Lauser <andreas.lauser@mbition.io>, Ayoub Kaanich <kayoub5@live.com>