odxtools 6.4.3__py3-none-any.whl → 6.5.0__py3-none-any.whl

odxtools/cli/decode.py

@@ -84,7 +84,7 @@ def add_subparser(subparsers: "argparse._SubParsersAction") -> None:
             "  For more information use:",
             "    odxtools decode -h",
         ]),
-        help="Find & print service by hex-data. Can also decode the hex-data to into their named parameters.",
+        help="Find & print service by hex-data. Can also decode the hex-data to its named parameters.",
         formatter_class=argparse.RawTextHelpFormatter,
     )
     _parser_utils.add_pdx_argument(parser)

odxtools/cli/find.py

@@ -26,7 +26,8 @@ def print_summary(odxdb: Database,
                   service_names: List[str],
                   ecu_variants: Optional[List[str]] = None,
                   allow_unknown_bit_lengths: bool = False,
-                  print_params: bool = False) -> None:
+                  print_params: bool = False,
+                  plumbing_output: bool = False) -> None:
     ecu_names = ecu_variants if ecu_variants else [ecu.short_name for ecu in odxdb.ecus]
     service_db: Dict[str, DiagService] = {}
     service_ecus: Dict[str, List[str]] = {}
@@ -60,7 +61,7 @@ def print_summary(odxdb: Database,
                 print_pre_condition_states=True,
                 print_state_transitions=True,
                 print_audiences=True,
-            )
+                plumbing_output=plumbing_output)
         elif isinstance(service, SingleEcuJob):
             print(f"SingleEcuJob: {service.odx_id}")
         else:
@@ -79,7 +80,7 @@ def add_subparser(subparsers: "argparse._SubParsersAction") -> None:
             "  For more information use:",
             "    odxtools find -h",
         ]),
-        help="Find & print services by hex-data, or name. Can also decode the request.",
+        help="Find & display services by their name",
         formatter_class=argparse.RawTextHelpFormatter,
     )
     _parser_utils.add_pdx_argument(parser)
@@ -120,6 +121,14 @@ def add_subparser(subparsers: "argparse._SubParsersAction") -> None:
         help="Relax output formatting rules (allow unknown bitlengths for ascii representation)",
     )
 
+    parser.add_argument(
+        "-po",
+        "--plumbing-output",
+        action="store_true",
+        required=False,
+        help="Print full objects instead of selected and formatted attributes",
+    )
+
 
 def run(args: argparse.Namespace) -> None:
     odxdb = _parser_utils.load_file(args)
@@ -131,4 +140,4 @@ def run(args: argparse.Namespace) -> None:
         service_names=args.service_names,
         print_params=not args.no_details,
         allow_unknown_bit_lengths=args.relaxed_output,
-    )
+        plumbing_output=args.plumbing_output)

odxtools/cli/list.py

@@ -2,40 +2,57 @@
 import argparse
 from typing import Callable, List, Optional
 
+from rich import print
+
 from ..database import Database
 from ..diagcomm import DiagComm
 from ..diaglayer import DiagLayer
 from ..diagservice import DiagService
 from ..singleecujob import SingleEcuJob
 from . import _parser_utils
-from ._print_utils import format_desc, print_diagnostic_service
+from ._print_utils import format_desc, print_diagnostic_service, print_dl_metrics
 
 # name of the tool
 _odxtools_tool_name_ = "list"
 
 
-def print_summary(
-    odxdb: Database,
-    print_global_negative_responses: bool = False,
-    print_services: bool = False,
-    print_dops: bool = False,
-    print_params: bool = False,
-    print_comparams: bool = False,
-    print_pre_condition_states: bool = False,
-    print_state_transitions: bool = False,
-    print_audiences: bool = False,
-    allow_unknown_bit_lengths: bool = False,
-    variants: Optional[str] = None,
-    service_filter: Callable[[DiagComm], bool] = lambda x: True,
-) -> None:
-
-    diag_layer_names = variants if variants else [dl.short_name for dl in odxdb.diag_layers]
-
-    for dl_sn in diag_layer_names:
-        dl = odxdb.diag_layers[dl_sn]
-        if not dl:
-            print(f"The variant '{dl_sn}' could not be found!")
-            continue
+def print_summary(odxdb: Database,
+                  print_global_negative_responses: bool = False,
+                  print_services: bool = False,
+                  print_dops: bool = False,
+                  print_params: bool = False,
+                  print_comparams: bool = False,
+                  print_pre_condition_states: bool = False,
+                  print_state_transitions: bool = False,
+                  print_audiences: bool = False,
+                  allow_unknown_bit_lengths: bool = False,
+                  variants: Optional[List[str]] = None,
+                  service_filter: Callable[[DiagComm], bool] = lambda x: True,
+                  plumbing_output: bool = False) -> None:
+
+    diag_layer_names = [dl.short_name for dl in odxdb.diag_layers]
+    diag_layers: List[DiagLayer] = []
+
+    if variants is None:
+        variants = diag_layer_names
+
+    for name in variants:
+        if name in diag_layer_names:
+            diag_layers.append([x for x in odxdb.diag_layers if x.short_name == name][0])
+
+        else:
+            print(f"The variant '{name}' could not be found!")
+            return
+
+    if diag_layers:
+        print("\n")
+        print(f"Overview of diagnostic layers: ")
+        print_dl_metrics(diag_layers)
+
+    for dl in diag_layers:
+        print("\n")
+        print(f"[green]Diagnostic layer:[/green] '[bold white]{dl.short_name}[/bold white]'")
+        print(f" [blue]Variant Type[/blue]: {dl.variant_type.value}")
 
         assert isinstance(dl, DiagLayer)
         all_services: List[DiagComm] = sorted(dl.services, key=lambda x: x.short_name)
@@ -43,31 +60,35 @@ def print_summary(
         data_object_properties = dl.diag_data_dictionary_spec.data_object_props
         comparams = dl.comparams
 
-        print(f"{dl.variant_type} '{dl.short_name}'")
-        print(
-            f" num services: {len(all_services)}, num DOPs: {len(data_object_properties)}, num communication parameters: {len(comparams)}."
-        )
-
         for proto in dl.protocols:
             if (can_rx_id := dl.get_can_receive_id(proto.short_name)) is not None:
-                print(f"  CAN receive ID for protocol '{proto.short_name}': 0x{can_rx_id:x}")
+                print(
+                    f"  [blue]CAN receive ID[/blue] for protocol '{proto.short_name}': 0x{can_rx_id:x}"
+                )
 
             if (can_tx_id := dl.get_can_send_id(proto.short_name)) is not None:
-                print(f"  CAN send ID for protocol '{proto.short_name}': 0x{can_tx_id:x}")
+                print(
+                    f"  [blue]CAN send ID[/blue] for protocol '{proto.short_name}': 0x{can_tx_id:x}"
+                )
 
         if dl.description:
             desc = format_desc(dl.description, ident=2)
-            print(f" Description: " + desc)
+            print(f" [blue]Description[/blue]: " + desc)
 
         if print_global_negative_responses and dl.global_negative_responses:
-            print(f"The global negative responses of '{dl.short_name}' are: ")
+            print("\n")
+            print(f"The [blue]global negative responses[/blue] of '{dl.short_name}' are: ")
             for gnr in dl.global_negative_responses:
-                print(f" {gnr}")
+                if plumbing_output:
+                    print(f" {gnr}")
+                else:
+                    print(f" {gnr.short_name}")
 
         if print_services and len(all_services) > 0:
             services = [s for s in all_services if service_filter(s)]
             if len(services) > 0:
-                print(f"The services of '{dl.short_name}' are: ")
+                print("\n")
+                print(f"The [blue]services[/blue] of '{dl.short_name}' are: ")
                 for service in services:
                     if isinstance(service, DiagService):
                         print_diagnostic_service(
@@ -77,21 +98,26 @@ def print_summary(
                             print_state_transitions=print_state_transitions,
                             print_audiences=print_audiences,
                             allow_unknown_bit_lengths=allow_unknown_bit_lengths,
-                        )
+                            plumbing_output=plumbing_output)
                     elif isinstance(service, SingleEcuJob):
-                        print(f" Single ECU job: {service.odx_id}")
+                        print(f" [blue]Single ECU job[/blue]: {service.odx_id}")
                     else:
                         print(f" Unidentifiable service: {service}")
 
         if print_dops and len(data_object_properties) > 0:
-            print(f"The DOPs of the {dl.variant_type} '{dl.short_name}' are: ")
+            print("\n")
+            print(f"The [blue]DOPs[/blue] of the {dl.variant_type.value} '{dl.short_name}' are: ")
             for dop in sorted(
                     data_object_properties, key=lambda x: (type(x).__name__, x.short_name)):
-                print("  " + str(dop).replace("\n", "\n  "))
+                if plumbing_output:
+                    print("  " + str(dop).replace("\n", "\n  "))
+                else:
+                    print("  " + str(dop.short_name).replace("\n", "\n  "))
 
         if print_comparams and len(comparams) > 0:
+            print("\n")
             print(
-                f"The communication parameters of the {dl.variant_type.value} '{dl.short_name}' are: "
+                f"The [blue]communication parameters[/blue] of the {dl.variant_type.value} '{dl.short_name}' are: "
             )
             for com_param in comparams:
                 print(f"  {com_param.short_name}: {com_param.value}")
@@ -178,6 +204,14 @@ def add_subparser(subparsers: "argparse._SubParsersAction") -> None:
         help="Print a list of all diagnostic services and DOPs specified in the pdx",
     )
 
+    parser.add_argument(
+        "-po",
+        "--plumbing-output",
+        action="store_true",
+        required=False,
+        help="Print full objects instead of selected and formatted attributes",
+    )
+
 
 def run(args: argparse.Namespace) -> None:
     odxdb = _parser_utils.load_file(args)
@@ -201,4 +235,4 @@ def run(args: argparse.Namespace) -> None:
         print_state_transitions=args.all,
         print_audiences=args.all,
         allow_unknown_bit_lengths=args.all,
-    )
+        plumbing_output=args.plumbing_output)

odxtools/cli/main.py

@@ -9,7 +9,7 @@ from .dummy_sub_parser import DummyTool
 # import the tool modules which can be loaded. if a tool
 # can't be loaded, add a dummy one
 tool_modules: List[Any] = []
-for tool_name in ["list", "browse", "snoop", "find", "decode"]:
+for tool_name in ["list", "browse", "snoop", "find", "decode", "compare"]:
     try:
         tool_modules.append(importlib.import_module(f".{tool_name}", package="odxtools.cli"))
     except Exception as e:

odxtools/database.py

@@ -4,6 +4,7 @@ from pathlib import Path
 from typing import List, Optional
 from xml.etree import ElementTree
 from zipfile import ZipFile
+
 from packaging.version import Version
 
 from .comparamspec import ComparamSpec

odxtools/diagcodedtype.py

@@ -142,6 +142,8 @@ class DiagCodedType(abc.ABC):
         """Convert the internal_value to bytes."""
         # Check that bytes and strings actually fit into the bit length
         if base_data_type == DataType.A_BYTEFIELD:
+            if isinstance(internal_value, bytearray):
+                internal_value = bytes(internal_value)
             if not isinstance(internal_value, bytes):
                 odxraise()
             if 8 * len(internal_value) > bit_length:

odxtools/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '6.4.3'
-__version_tuple__ = version_tuple = (6, 4, 3)
+__version__ = version = '6.5.0'
+__version_tuple__ = version_tuple = (6, 5, 0)