Removing uuid feature

Note: Keeping UUID as bit in binary output
Signed-off-by: Erik Jaegervall <[email protected]>

CHANGELOG.md

@@ -7,7 +7,7 @@ It includes changes that are included in released version, but also changes plan
 *This document only contain changes introduced in VSS-Tools 3.0 or later!*
 
 
-## Planned changes for VSS-Tools 6.0
+## Implemented changes for VSS-Tools 6.0
 
 ### Change in UUID handling.
 
@@ -16,6 +16,8 @@ the legacy uuid functionality.
 
 * The parameters `--uuid`/`--no-uuid` are now removed.
 
+Columns (or similar) for UUID in generated output has also been removed.
+An exception is binary output which still contain a byte for UUID, however always 0.
 
 ## VSS-Tools 5.0
 

docs/ddsidl.md

@@ -48,12 +48,12 @@ Below elements are considered only if the switch `--all-idl-features` is supplie
 ### Input VSS block with "arraysize" attribute
 | VSS    | DDS-IDL         |
 |--------|----------------|
-| <pre>Safety.SpeedLimit:<br>    datatype : float[]<br>    arraysize: 5<br>    type: actuator<br>    unit: m/s<br>    description: Maximum allowed speed of the vehicle</pre>  | <pre>struct SpeedLimit{<br>string uuid;<br>sequence&lt;float&gt; value;<br>}<br></pre>          |
+| <pre>Safety.SpeedLimit:<br>    datatype : float[]<br>    arraysize: 5<br>    type: actuator<br>    unit: m/s<br>    description: Maximum allowed speed of the vehicle</pre>  | <pre>struct SpeedLimit{<br>sequence&lt;float&gt; value;<br>}<br></pre>          |
 ### Input VSS block with "allowed" attribute
 
 | VSS    | DDS-IDL         |
 |--------|----------------|
-| <pre>Direction:<br> datatype:string<br> type: actuator<br> allowed: ['FORWARD','BACKWARD']<br> description: Driving direction of the vehicle</pre>  | <pre>module Direction_M {<br>enum DirectionValues{FORWARD,BACKWARD};<br>};<br>struct Direction<br>{<br>string uuid;<br>DirectionValues value;<br>};</pre>
+| <pre>Direction:<br> datatype:string<br> type: actuator<br> allowed: ['FORWARD','BACKWARD']<br> description: Driving direction of the vehicle</pre>  | <pre>module Direction_M {<br>enum DirectionValues{FORWARD,BACKWARD};<br>};<br>struct Direction<br>{<br>DirectionValues value;<br>};</pre>
 
 To comply with DDS-IDL rules and limitations in IDL compilers VSS string literals that start with a digit will get a `d` as prefix.
 

docs/id.md

@@ -25,7 +25,6 @@ identifiers.
 │                                                               [default: no-strict]                         │
 │    --aborts               -a  [unknown-attribute|name-style]  Abort on selected option. The '--strict'     │
 │                                                               option enables all of them.                  │
-│    --uuid/--no-uuid                                           Whether to add UUIDs. [default: no-uuid]     │
 │    --expand/--no-expand                                       Whether to expand the tree.                  │
 │                                                               [default: expand]                            │
 │    --overlays             -l  FILE                            Overlay files to apply on top of the vspec.  │

docs/vspec.md

@@ -81,16 +81,6 @@ Terminates parsing, when the name of a signal does not follow [VSS Naming Conven
 ### --strict/--no-strict
 Enables `--aborts unknown-attribute` and `--aborts name-style`
 
-### --uuid/--no-uuid
-Request the exporter to output UUIDs. The UUID generated is an RFC 4122 Version 5 UUID created from the qualified name
-of the node and the UUID of the namespace `vehicle_signal_specification`.
-
-Note that not all exporters support that arugment
-
-> [!WARNING]
-> The UUID feature is deprecated and will be removed in VSS-tools 6.0.
-> If you need identifiers consider using [vspec id exporter](id.md)
-
 ### --expand/--no-expand
 
 By default all tools expand instance information so that instance information like "Row1" become a branch just like
@@ -359,7 +349,6 @@ Lets the exporter generate _all_ extended metadata attributes found in the model
 | deprecation   | x-deprecation |
 | aggregate     | x-aggregate   |
 | comment       | x-comment     |
-| uuid          | x-uuid        |
 
 Not that strict JSON schema validators might not accept jsonschemas with such extra, non-standard entries.
 
@@ -382,12 +371,6 @@ If the paramter is set it will pretty-print the JSON output, otherwise you will
 ### --extended-all-attributes
 Lets the exporter generate _all_ extended metadata attributes found in the model. By default the exporter is generating only those given by the `-e`/`--extended-attributes` parameter.
 
-## DDS-IDL exporter notes
-The DDS-IDL exporter never generates uuid, i.e. the `--uuid` option has no effect.
-
-## Graphql exporter notes
-The Graphql exporter never generates uuid, i.e. the `--uuid` option has no effect.
-
 ### --all-idl-features
 Will also generate non-payload const attributes such as unit/datatype. Default is not to generate them/comment them out because at least Cyclone DDS and FastDDS do not support const. For more information check the [DDS-IDL exporter docs](ddsidl.md).
 

src/vss_tools/cli_options.py

@@ -72,8 +72,6 @@ def validate_attribute(value):
     show_choices=True,
 )
 
-uuid_opt = option("--uuid/--no-uuid", help="Whether to add UUIDs.", show_default=True, default=False)
-
 expand_opt = option(
     "--expand/--no-expand",
     default=True,

src/vss_tools/exporters/apigear.py

@@ -445,7 +445,6 @@ def export_apigear(
 @clo.extended_attributes_opt
 @clo.strict_opt
 @clo.aborts_opt
-@clo.uuid_opt
 @clo.overlays_opt
 @clo.quantities_opt
 @clo.units_opt
@@ -482,7 +481,6 @@ def cli(
     extended_attributes: tuple[str],
     strict: bool,
     aborts: tuple[str],
-    uuid: bool,
     overlays: tuple[Path],
     quantities: tuple[Path],
     units: tuple[Path],
@@ -502,7 +500,6 @@ def cli(
         aborts=aborts,
         strict=strict,
         extended_attributes=extended_attributes,
-        uuid=uuid,
         quantities=quantities,
         units=units,
         types=types,

src/vss_tools/exporters/binary.py

@@ -19,7 +19,7 @@
 # The order of fields (where each field is composed of
 # fieldlength + fielddata) is:
 #
-# name (vsspath), type, uuid, description, datatype, min, max, unit,
+# name (vsspath), type, description, datatype, min, max, unit,
 # allowed, default, validate
 #
 # if a field is not present (e.g. min, max, unit, allowed, default, validate),
@@ -73,16 +73,13 @@ def create_l16v_string(s: str) -> bytes:
     return pack
 
 
-def export_node(node: VSSNode, generate_uuid, f: BinaryIO):
+def export_node(node: VSSNode, f: BinaryIO):
     data = node.get_vss_data().as_dict()
 
     f.write(create_l8v_string(node.name))
     f.write(create_l8v_string(data.get("type", "")))
-    if node.uuid is None:
-        log.debug(("No UUID for node %s", node.name))
-        f.write(struct.pack("B", 0))
-    else:
-        f.write(create_l8v_string(node.uuid))
+    # Keeping UUID field in output for now (always 0)
+    f.write(struct.pack("B", 0))
 
     f.write(create_l16v_string(data.get("description", "")))
     f.write(create_l8v_string(data.get("datatype", "")))
@@ -101,7 +98,7 @@ def export_node(node: VSSNode, generate_uuid, f: BinaryIO):
     f.write(struct.pack("B", len(node.children)))
 
     for child in node.children:
-        export_node(child, generate_uuid, f)
+        export_node(child, f)
 
 
 @click.command()
@@ -111,7 +108,6 @@ def export_node(node: VSSNode, generate_uuid, f: BinaryIO):
 @clo.extended_attributes_opt
 @clo.strict_opt
 @clo.aborts_opt
-@clo.uuid_opt
 @clo.overlays_opt
 @clo.quantities_opt
 @clo.units_opt
@@ -122,7 +118,6 @@ def cli(
     extended_attributes: tuple[str],
     strict: bool,
     aborts: tuple[str],
-    uuid: bool,
     overlays: tuple[Path],
     quantities: tuple[Path],
     units: tuple[Path],
@@ -137,12 +132,11 @@ def cli(
         aborts=aborts,
         strict=strict,
         extended_attributes=extended_attributes,
-        uuid=uuid,
         quantities=quantities,
         units=units,
         overlays=overlays,
     )
     log.info("Generating binary output...")
     with open(str(output), "wb") as f:
-        export_node(tree, uuid, f)
+        export_node(tree, f)
     log.info("Binary output generated in %s", output)

src/vss_tools/exporters/csv.py

@@ -22,7 +22,7 @@
 from vss_tools.utils.misc import getattr_nn
 
 
-def get_header(with_uuid: bool, entry_type: str, with_instance_column: bool) -> list[str]:
+def get_header(entry_type: str, with_instance_column: bool) -> list[str]:
     row = [
         entry_type,
         "Type",
@@ -36,14 +36,12 @@ def get_header(with_uuid: bool, entry_type: str, with_instance_column: bool) ->
         "Allowed",
         "Default",
     ]
-    if with_uuid:
-        row.append("Id")
     if with_instance_column:
         row.append("Instances")
     return row
 
 
-def add_rows(rows: list[list[Any]], root: VSSNode, with_uuid: bool, with_instance_column: bool) -> None:
+def add_rows(rows: list[list[Any]], root: VSSNode, with_instance_column: bool) -> None:
     node: VSSNode
     for node in PreOrderIter(root):
         data = node.get_vss_data()
@@ -60,8 +58,6 @@ def add_rows(rows: list[list[Any]], root: VSSNode, with_uuid: bool, with_instanc
             getattr_nn(data, "allowed", ""),
             getattr_nn(data, "default", ""),
         ]
-        if with_uuid:
-            row.append(getattr_nn(node, "uuid", ""))
         if with_instance_column:
             row.append(getattr_nn(data, "instances", ""))
         rows.append(row)
@@ -80,7 +76,6 @@ def write_csv(rows: list[list[Any]], output: Path):
 @clo.extended_attributes_opt
 @clo.strict_opt
 @clo.aborts_opt
-@clo.uuid_opt
 @clo.expand_opt
 @clo.overlays_opt
 @clo.quantities_opt
@@ -94,7 +89,6 @@ def cli(
     extended_attributes: tuple[str],
     strict: bool,
     aborts: tuple[str],
-    uuid: bool,
     expand: bool,
     overlays: tuple[Path],
     quantities: tuple[Path],
@@ -111,7 +105,6 @@ def cli(
         aborts=aborts,
         strict=strict,
         extended_attributes=extended_attributes,
-        uuid=uuid,
         quantities=quantities,
         units=units,
         types=types,
@@ -124,13 +117,13 @@ def cli(
     with_instance_column = not expand
 
     entry_type = "Node" if generic_entry else "Signal"
-    rows = [get_header(uuid, entry_type, with_instance_column)]
-    add_rows(rows, tree, uuid, with_instance_column)
+    rows = [get_header(entry_type, with_instance_column)]
+    add_rows(rows, tree, with_instance_column)
     if generic_entry and datatype_tree:
-        add_rows(rows, datatype_tree, uuid, with_instance_column)
+        add_rows(rows, datatype_tree, with_instance_column)
     write_csv(rows, output)
 
     if not generic_entry and datatype_tree:
-        rows = [get_header(uuid, "Node", with_instance_column)]
-        add_rows(rows, datatype_tree, uuid, with_instance_column)
+        rows = [get_header("Node", with_instance_column)]
+        add_rows(rows, datatype_tree, with_instance_column)
         write_csv(rows, types_output)

src/vss_tools/exporters/ddsidl.py

@@ -187,7 +187,7 @@ def get_allowed_enum_literal(name: str):
 }
 
 
-def export_node(node: VSSNode, generate_uuid: bool, generate_all_idl_features: bool) -> None:
+def export_node(node: VSSNode, generate_all_idl_features: bool) -> None:
     """
     This method is used to traverse VSS node and to create corresponding DDS IDL buffer string
     """
@@ -199,7 +199,7 @@ def export_node(node: VSSNode, generate_uuid: bool, generate_all_idl_features: b
         idl_file_buffer.append("module " + getAllowedName(node.name))
         idl_file_buffer.append("{")
         for child in node.children:
-            export_node(child, generate_uuid, generate_all_idl_features)
+            export_node(child, generate_all_idl_features)
         idl_file_buffer.append("};")
         idl_file_buffer.append("")
     else:
@@ -233,8 +233,6 @@ def export_node(node: VSSNode, generate_uuid: bool, generate_all_idl_features: b
 
         idl_file_buffer.append("struct " + getAllowedName(node.name))
         idl_file_buffer.append("{")
-        if generate_uuid:
-            idl_file_buffer.append("string uuid;")
         # fetching value of datatype and obtaining the equivalent DDS type
         try:
             if datatype:
@@ -372,11 +370,11 @@ def export_data_type_node(self, node: VSSNode):
         self.str_buf += suffix
 
 
-def export_idl(file, root, generate_uuids=True, generate_all_idl_features=False):
+def export_idl(file, root, generate_all_idl_features=False):
     """This method is used to traverse through the root VSS node to build
     -> DDS IDL equivalent string buffer and to serialize it acccordingly into a file
     """
-    export_node(root, generate_uuids, generate_all_idl_features)
+    export_node(root, generate_all_idl_features)
     file.write("\n".join(idl_file_buffer))
     log.info("IDL file generated at location : " + file.name)
 
@@ -388,7 +386,6 @@ def export_idl(file, root, generate_uuids=True, generate_all_idl_features=False)
 @clo.extended_attributes_opt
 @clo.strict_opt
 @clo.aborts_opt
-@clo.uuid_opt
 @clo.overlays_opt
 @clo.quantities_opt
 @clo.units_opt
@@ -405,7 +402,6 @@ def cli(
     extended_attributes: tuple[str],
     strict: bool,
     aborts: tuple[str],
-    uuid: bool,
     overlays: tuple[Path],
     quantities: tuple[Path],
     units: tuple[Path],
@@ -421,7 +417,6 @@ def cli(
         aborts=aborts,
         strict=strict,
         extended_attributes=extended_attributes,
-        uuid=uuid,
         quantities=quantities,
         units=units,
         types=types,
@@ -438,6 +433,5 @@ def cli(
         export_idl(
             idl_out,
             tree,
-            uuid,
             all_idl_features,
         )

src/vss_tools/exporters/franca.py

@@ -48,7 +48,7 @@ def print_franca_header(file, version="unknown"):
 
 
 # Write the data lines
-def print_franca_content(file: TextIOWrapper, root: VSSNode, with_uuid: bool) -> None:
+def print_franca_content(file: TextIOWrapper, root: VSSNode) -> None:
     output = ""
     node: VSSNode
     for node in PreOrderIter(root):
@@ -64,8 +64,6 @@ def print_franca_content(file: TextIOWrapper, root: VSSNode, with_uuid: bool) ->
             datatype = getattr(data, "datatype", None)
             if datatype:
                 output += f',\n\tdatatype: "{datatype}"'
-            if with_uuid:
-                output += f',\n\tuuid: "{node.uuid}"'
             unit = getattr(data, "unit", None)
             if unit:
                 output += f',\n\tunit: "{unit}"'
@@ -89,7 +87,6 @@ def print_franca_content(file: TextIOWrapper, root: VSSNode, with_uuid: bool) ->
 @clo.extended_attributes_opt
 @clo.strict_opt
 @clo.aborts_opt
-@clo.uuid_opt
 @clo.overlays_opt
 @clo.quantities_opt
 @clo.units_opt
@@ -101,7 +98,6 @@ def cli(
     extended_attributes: tuple[str],
     strict: bool,
     aborts: tuple[str],
-    uuid: bool,
     overlays: tuple[Path],
     quantities: tuple[Path],
     units: tuple[Path],
@@ -117,12 +113,11 @@ def cli(
         aborts=aborts,
         strict=strict,
         extended_attributes=extended_attributes,
-        uuid=uuid,
         quantities=quantities,
         units=units,
         overlays=overlays,
     )
     with open(output, "w") as f:
         print_franca_header(f, franca_vss_version)
-        print_franca_content(f, tree, uuid)
+        print_franca_content(f, tree)
         f.write("\n]")