objdictgen 3.4__tar.gz → 3.5__tar.gz

{objdictgen-3.4/src/objdictgen.egg-info → objdictgen-3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: objdictgen
-Version: 3.4
+Version: 3.5
 Summary: CanFestival Object Dictionary tool
 Home-page: https://github.com/Laerdal/python-objdictgen
 Author: Svein Seldal
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: jsonschema
 Requires-Dist: colorama
-Requires-Dist: deepdiff
+Requires-Dist: deepdiff<8.0.0
 Provides-Extra: ui
 Requires-Dist: wxPython; extra == "ui"
 Provides-Extra: dist
@@ -39,6 +39,7 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: freezegun; extra == "dev"
 
 # Objdictgen (`odg`)
 
@@ -70,8 +71,8 @@ To install into a virtual environment `venv`. Check out this repo and go to
 the top in a command-prompt (here assuming Windows and git bash):
 
     $ py -3 -mvenv venv
-    $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .[ui]    # [ui] will install GUI tools
+    $ venv/Scripts/python -mpip install --upgrade pip setuptools   # Optional
+    $ venv/Scripts/pip install objdictgen[ui]    # [ui] will install GUI tools
 
 After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
 from anywhere to run it.

{objdictgen-3.4 → objdictgen-3.5}/README.md

@@ -28,8 +28,8 @@ To install into a virtual environment `venv`. Check out this repo and go to
 the top in a command-prompt (here assuming Windows and git bash):
 
     $ py -3 -mvenv venv
-    $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .[ui]    # [ui] will install GUI tools
+    $ venv/Scripts/python -mpip install --upgrade pip setuptools   # Optional
+    $ venv/Scripts/pip install objdictgen[ui]    # [ui] will install GUI tools
 
 After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
 from anywhere to run it.

{objdictgen-3.4 → objdictgen-3.5}/setup.cfg

@@ -31,7 +31,7 @@ python_requires = >=3.10, <4
 install_requires = 
 	jsonschema
 	colorama
-	deepdiff
+	deepdiff<8.0.0
 
 [options.packages.find]
 where = src
@@ -58,6 +58,7 @@ dev =
 	coverage
 	pytest-cov
 	pytest-mock
+	freezegun
 
 [options.entry_points]
 console_scripts = 

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen/__init__.py

@@ -23,7 +23,7 @@ from pathlib import Path
 from objdictgen.node import Node
 from objdictgen.nodemanager import NodeManager
 
-__version__ = "3.4"
+__version__ = "3.5"
 
 # Shortcuts
 LoadFile = Node.LoadFile

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen/__main__.py

@@ -128,7 +128,7 @@ def list_od(
     """Generator for producing the output for odg list"""
 
     # Get the indexes to print and determine the order
-    keys = od.GetAllIndices(sort=not opts.no_sort)
+    keys = od.GetAllIndices(sort=opts.sort)
     if opts.index:
         indexp = [jsonod.str_to_int(i) for i in opts.index]
         keys = [k for k in keys if k in indexp]
@@ -259,7 +259,7 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
     subp.add_argument('-i', '--index', action="append", help="Specify parameter index to show")
     subp.add_argument('--all', action="store_true",
                         help="Show all subindexes, including subindex 0")
-    subp.add_argument('--no-sort', action="store_true", help="Do not sort output")
+    subp.add_argument('--sort', action="store_true", help="Sort output")
     subp.add_argument('--compact', action="store_true", help="Compact listing")
     subp.add_argument('--raw', action="store_true", help="Show raw parameter values")
     subp.add_argument('--short', action="store_true", help="Do not list sub-index")

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen/jsonod.py

@@ -240,6 +240,14 @@ def remove_underscore(d: T) -> T:
             remove_underscore(v)
             for v in d
         ]
+    if isinstance(d, str):
+        # Remove comments from any @@ fields
+        return re.sub(  # type: ignore[return-value]
+            r'@@"?(.*?)"?(\s*//.*?)?@@',
+            lambda m: m[1].replace('\\"', '"'),
+            d,
+            flags=re.MULTILINE,
+        )
     return d
 
 
@@ -353,7 +361,7 @@ def generate_jsonc(node: "Node", compact=False, sort=False, internal=False, vali
     """ Export a JSONC string representation of the node """
 
     # Get the dict representation
-    jd, objtypes_s2i = node_todict(
+    jd = node_todict(
         node, sort=sort, internal=internal, validate=validate,
         rich=not compact,
     )
@@ -365,39 +373,22 @@ def generate_jsonc(node: "Node", compact=False, sort=False, internal=False, vali
     # Generate the json string
     text = json.dumps(jd, separators=(',', ': '), indent=2)
 
-    # Convert the special __ fields to jasonc comments
-    out = re.sub(
+    # Convert the special __ fields to jsonc comments
+    text = re.sub(
         r'^(\s*)"__(\w+)": "(.*)",?$',
         r'\1// "\2": "\3"',
         text,
         flags=re.MULTILINE,
     )
 
-    # Annotate symbolic fields with comments of the value
-    def _index_repl(m: re.Match[str]) -> str:
-        p = m.group(1)
-        n = v = m.group(2)
-        if p == 'index':
-            n = str_to_int(v)
-        if p == 'type':
-            n = objtypes_s2i.get(v, v)
-        if n != v:
-            return m.group(0) + f'  // {n}'
-        return m.group(0)
-    out = re.sub(  # As object entries
-        r'"(index|type)": "([a-zA-Z0-9_]+)",?$',
-        _index_repl,
-        out,
-        flags=re.MULTILINE,
-    )
-    out = re.sub(  # As comments
-        r'// (index|type): "([a-zA-Z0-9_]+)"',
-        _index_repl,
-        out,
+    # Convert the special @@ fields to jsonc comments
+    text = re.sub(
+        r'"@@(.*?)(\s*//.*?)?@@"(.*)$',
+        lambda m: m[1].replace('\\"', '"') + m[3] + m[2],
+        text,
         flags=re.MULTILINE,
     )
-
-    return out
+    return text
 
 
 def generate_node(contents: str|TODJson) -> "Node":
@@ -440,7 +431,7 @@ def generate_node(contents: str|TODJson) -> "Node":
     return node_fromdict(jd, objtypes_s2i)
 
 
-def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=True) -> tuple[TODJson, dict[str, int]]:
+def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=True) -> TODJson:
     """
         Convert a node to dict representation for serialization.
 
@@ -500,7 +491,8 @@ def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=Tr
         finally:
             # Add in a fancyer index (do it here after index is finished being used)
             if rich:
-                obj["index"] = f"0x{index:04X}"
+                index = obj["index"]
+                obj["index"] = f'@@"0x{index:04X}"  // {index}@@'
 
             dictionary.append(obj)
 
@@ -510,7 +502,7 @@ def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=Tr
         '$version': JSON_INTERNAL_VERSION if internal else JSON_VERSION,
         '$description': JSON_DESCRIPTION,
         '$tool': str(objdictgen.ODG_PROGRAM) + ' ' + str(objdictgen.__version__),
-        '$date': datetime.isoformat(datetime.now()),
+        '$date': datetime.now().astimezone().isoformat(),
         'name': node.Name,
         'description': node.Description,
         'type': node.Type,
@@ -532,9 +524,9 @@ def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=Tr
 
     # Cross check verification to see if we later can import the generated dict
     if validate and not internal:
-        validate_fromdict(remove_underscore(jd), objtypes_i2s, objtypes_s2i)
+       validate_fromdict(remove_underscore(jd), objtypes_i2s, objtypes_s2i)
 
-    return jd, objtypes_s2i
+    return jd
 
 
 def indexentry_to_jsondict(ientry: TIndexEntry) -> TODObjJson:
@@ -725,12 +717,27 @@ def rearrage_for_json(obj: TODObjJson, node: "Node", objtypes_i2s: dict[int, str
         # Replace numeric type with string value
         if rich and "type" in sub:
             # FIXME: The cast is to ensure mypy is able keep track
-            sub["type"] = objtypes_i2s.get(cast(int, sub["type"]), sub["type"])
+            n = objtypes_i2s.get(cast(int, sub["type"]), sub["type"])
+            sub["type"] = f'@@"{n}"  // {sub["type"]}@@'
 
-        # # Add __type when rich format
+        # Add __type when rich format
         if info and "type" not in sub:
             sub["__type"] = objtypes_i2s.get(info["type"], info["type"])
 
+        # Replace value
+        if rich and "value" in sub:
+            ir = maps.INDEX_RANGES.get_index_range(index)
+            if i > 0 and ir and ir.name in ('rpdom', 'tpdom'):
+                value = sub["value"]
+                value_h = f"{value:08X}"
+                try:
+                    idx, subidx, _ = node.GetMapIndex(value)
+                    pdo = node.GetSubentryInfos(idx, subidx)
+                    name = pdo["name"]
+                except ValueError:
+                    name = '???'
+                sub["value"] = f'@@{value}  // 0x{value_h[0:4]}_{value_h[4:6]}_{value_h[6:]}  {name}@@'
+
     if 'each' in obj:
         each = obj["each"]
 
@@ -1414,8 +1421,8 @@ def diff_nodes(node1: "Node", node2: "Node", asdict=True, validate=True) -> TDif
     diffs: dict[int|str, list] = {}
 
     if asdict:
-        jd1, _ = node_todict(node1, sort=True, validate=validate)
-        jd2, _ = node_todict(node2, sort=True, validate=validate)
+        jd1 = node_todict(node1, sort=True, validate=validate)
+        jd2 = node_todict(node2, sort=True, validate=validate)
 
         dt = datetime.isoformat(datetime.now())
         jd1['$date'] = jd2['$date'] = dt

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen/nodemanager.py

@@ -482,9 +482,13 @@ class NodeManager:
                         node.AddEntry(index, 1, default)
                 # Second case entry is a record
                 else:
-                    # FIXME: How to retrieve the number of subentries?
-                    for i in range(1, node.GetSubentryLength(index) + 1):
-                        subentry_infos = node.GetSubentryInfos(index, i)
+                    i = 0
+                    while True:
+                        try:
+                            i += 1
+                            subentry_infos = node.GetSubentryInfos(index, i)
+                        except ValueError:
+                            break
                         if "default" in subentry_infos:
                             default = subentry_infos["default"]
                         else:

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen/ui/objdictedit.py

@@ -457,7 +457,8 @@ class ObjdictEdit(NodeEditorTemplate):
 
     def Save(self):
         try:
-            result = self.Manager.SaveCurrentInFile()
+            # Sort only applies if saving JSON file
+            result = self.Manager.SaveCurrentInFile(sort=True)
             if not result:
                 self.SaveAs()
             else:
@@ -487,8 +488,9 @@ class ObjdictEdit(NodeEditorTemplate):
             display_error_dialog(self, f"'{os.path.dirname(filepath)}' is not a valid folder!")
         else:
             try:
-                # Try and save the file and then update the filepath if successfull
-                if self.Manager.SaveCurrentInFile(filepath):
+                # Try and save the file and then update the filepath if successful
+                # Sort only applies if saving JSON file
+                if self.Manager.SaveCurrentInFile(filepath, sort=True):
                     self.Manager.SetCurrentFilePath(filepath)
                 self.RefreshBufferState()
             except Exception:  # pylint: disable=broad-except

{objdictgen-3.4 → objdictgen-3.5/src/objdictgen.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: objdictgen
-Version: 3.4
+Version: 3.5
 Summary: CanFestival Object Dictionary tool
 Home-page: https://github.com/Laerdal/python-objdictgen
 Author: Svein Seldal
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: jsonschema
 Requires-Dist: colorama
-Requires-Dist: deepdiff
+Requires-Dist: deepdiff<8.0.0
 Provides-Extra: ui
 Requires-Dist: wxPython; extra == "ui"
 Provides-Extra: dist
@@ -39,6 +39,7 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: freezegun; extra == "dev"
 
 # Objdictgen (`odg`)
 
@@ -70,8 +71,8 @@ To install into a virtual environment `venv`. Check out this repo and go to
 the top in a command-prompt (here assuming Windows and git bash):
 
     $ py -3 -mvenv venv
-    $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .[ui]    # [ui] will install GUI tools
+    $ venv/Scripts/python -mpip install --upgrade pip setuptools   # Optional
+    $ venv/Scripts/pip install objdictgen[ui]    # [ui] will install GUI tools
 
 After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
 from anywhere to run it.

{objdictgen-3.4 → objdictgen-3.5}/src/objdictgen.egg-info/requires.txt

@@ -1,6 +1,6 @@
 jsonschema
 colorama
-deepdiff
+deepdiff<8.0.0
 
 [dev]
 pylint
@@ -13,6 +13,7 @@ pytest
 coverage
 pytest-cov
 pytest-mock
+freezegun
 
 [dist]
 build

{objdictgen-3.4 → objdictgen-3.5}/tests/test_jsonod.py

@@ -1,5 +1,7 @@
-import pytest
+import re
 from pprint import pprint
+import datetime
+from freezegun import freeze_time
 from objdictgen import Node
 from objdictgen.jsonod import generate_jsonc, generate_node, remove_jsonc
 from .test_odcompare import shave_equal
@@ -103,3 +105,28 @@ def test_jsonod_roundtrip_internal(odjsoneds):
 
     a, b = shave_equal(m1, m2, ignore=["IndexOrder", "DefaultStringSize"])
     assert a == b
+
+
+def test_jsonod_timezone():
+    """ Test timezone handling in the jsonod module. """
+
+    for now, offset, cmp in [
+        ("2020-01-01 12:00:00", None, "2020-01-01T12:00:00"),
+        ("2020-01-01 12:00:00", 5, "2020-01-01T17:00:00"),
+        ("2020-01-01 12:00:00", -5, "2020-01-01T07:00:00"),
+    ]:
+        kw = {}
+        if offset is not None:
+            kw["tz_offset"] = offset
+        with freeze_time(now, **kw):
+            # The tzoffset is dependent on the current time, so we need to calculate it
+            tzoffset = datetime.datetime.now().astimezone().utcoffset()
+            tz = f"{tzoffset.seconds//3600:02}:{tzoffset.seconds%60:02}"
+            print(f"tzoffset: {tzoffset}, {type(tzoffset)} {tz}")
+
+            od = Node()
+            out = generate_jsonc(od, compact=False, sort=False, internal=False, validate=True)
+            m = re.search(r'^\s+"\$date": "(.*?)",$', out, re.M)
+            if m:
+                print(m[1])
+                assert m[1] == cmp + "+" + tz

{objdictgen-3.4 → objdictgen-3.5}/tests/test_main.py

@@ -28,21 +28,21 @@ def test_main_list_od(odpath, file):
 
     import argparse
     ns = argparse.Namespace(
-        no_sort=False, index=[], compact=False, short=False, unused=True,
+        sort=True, index=[], compact=False, short=False, unused=True,
         all=True, raw=False
     )
 
     lines = list(__main__.list_od(od, file, ns))
 
     ns = argparse.Namespace(
-        no_sort=False, index=[0x1000], compact=False, short=False, unused=True,
+        sort=True, index=[0x1000], compact=False, short=False, unused=True,
         all=True, raw=False
     )
 
     lines = list(__main__.list_od(od, file, ns))
 
     ns = argparse.Namespace(
-        no_sort=False, index=[0x5000], compact=False, short=False, unused=True,
+        sort=True, index=[0x5000], compact=False, short=False, unused=True,
         all=True, raw=False
     )
 

{objdictgen-3.4 → objdictgen-3.5}/tests/test_nodemanager.py

@@ -109,7 +109,7 @@ def test_nodemanager_setcurrententry(odpath):
                 continue
             assert d['value'] == inv
 
-        nd, _ = node_todict(node, rich=False)
+        nd = node_todict(node, rich=False)
         for jobj in nd['dictionary']:
             if jobj['index'] != index:
                 continue