objdictgen 3.5__tar.gz → 3.5.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: objdictgen
-Version: 3.5
+Version: 3.5.2
 Summary: CanFestival Object Dictionary tool
 Home-page: https://github.com/Laerdal/python-objdictgen
 Author: Svein Seldal
@@ -61,8 +61,8 @@ Laerdal Medical fork for the canfestival library:
 objdictgen is a tool to parse, view and manipulate files containing object
 dictionary (OD). An object dictionary is entries with data and configuration
 in CANopen devices. The `odg` executable is installed. It supports
-reading and writing OD files in `.json` format, in legacy XML `.od` and `.eds`
-files. It can generate c code for use with the canfestival library.
+reading and writing OD files in `.json`/`.jsonc` format, in legacy XML `.od`
+and `.eds` files. It can generate c code for use with the canfestival library.
 
 
 ## Install
@@ -119,14 +119,11 @@ descriptions, help with values and validate the file.
     "json.schemas": [
       {
         "fileMatch": [
-          "**.json"
+          "**.jsonc"
         ],
         "url": "./src/objdictgen/schema/od.schema.json"
       }
     ],
-    "files.associations": {
-        "*.json": "jsonc"
-    }
 ```
 
 ## Conversion
@@ -134,7 +131,7 @@ descriptions, help with values and validate the file.
 The recommended way to convert existing/legacy `.od` files to the new JSON
 format is:
 
-    $ odg generate <file.od> <file.json> --fix --drop-unused [--nosort]
+    $ odg generate <file.od> <file.jsonc> --fix --drop-unused [--nosort]
 
 The `--fix` option might be necessary if the OD-file contains internal
 inconsistencies. It is safe to run this option as it will not delete any active
@@ -145,10 +142,10 @@ parameter that might be used in the file.
 ## Motivation
 
 The biggest improvement with the new tool over the original implementation is
-the introduction of a new `.json` based format to store the object dictionary.
-The JSON format is well-known and easy to read. The tool supports jsonc,
+the introduction of a new `.jsonc` based format to store the object dictionary.
+The JSON format is well-known and easy to read. The tool use jsonc,
 allowing comments in the json file. `odg` will process the file in a repeatable
-manner, making it possible support diffing of the `.json` file output. `odg`
+manner, making it possible support diffing of the `.jsonc` file output. `odg`
 remains 100% compatible with the legacy `.od` format on both input and output.
 
 The original objdictedit and objdictgen tool were written in legacy python 2 and
@@ -159,6 +156,17 @@ This tool is a fork from upstream canfestival-3-asc repo:
 > https://github.com/Laerdal/canfestival-3-asc
 
 
+## Making objdictedit excutable
+
+To be able build an executable that can be run from anywhere:
+
+    $ pip install pyinstaller
+    $ pyinstaller packaging/objdictedit.spec
+
+The file `dist/objdictedit.exe` can now be used anywhere. It does not need any
+pre-installed software.
+
+
 ## License
 
 Objdictgen has been based on the python tool included in CanFestival. This

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

@@ -18,8 +18,8 @@ Laerdal Medical fork for the canfestival library:
 objdictgen is a tool to parse, view and manipulate files containing object
 dictionary (OD). An object dictionary is entries with data and configuration
 in CANopen devices. The `odg` executable is installed. It supports
-reading and writing OD files in `.json` format, in legacy XML `.od` and `.eds`
-files. It can generate c code for use with the canfestival library.
+reading and writing OD files in `.json`/`.jsonc` format, in legacy XML `.od`
+and `.eds` files. It can generate c code for use with the canfestival library.
 
 
 ## Install
@@ -76,14 +76,11 @@ descriptions, help with values and validate the file.
     "json.schemas": [
       {
         "fileMatch": [
-          "**.json"
+          "**.jsonc"
         ],
         "url": "./src/objdictgen/schema/od.schema.json"
       }
     ],
-    "files.associations": {
-        "*.json": "jsonc"
-    }
 ```
 
 ## Conversion
@@ -91,7 +88,7 @@ descriptions, help with values and validate the file.
 The recommended way to convert existing/legacy `.od` files to the new JSON
 format is:
 
-    $ odg generate <file.od> <file.json> --fix --drop-unused [--nosort]
+    $ odg generate <file.od> <file.jsonc> --fix --drop-unused [--nosort]
 
 The `--fix` option might be necessary if the OD-file contains internal
 inconsistencies. It is safe to run this option as it will not delete any active
@@ -102,10 +99,10 @@ parameter that might be used in the file.
 ## Motivation
 
 The biggest improvement with the new tool over the original implementation is
-the introduction of a new `.json` based format to store the object dictionary.
-The JSON format is well-known and easy to read. The tool supports jsonc,
+the introduction of a new `.jsonc` based format to store the object dictionary.
+The JSON format is well-known and easy to read. The tool use jsonc,
 allowing comments in the json file. `odg` will process the file in a repeatable
-manner, making it possible support diffing of the `.json` file output. `odg`
+manner, making it possible support diffing of the `.jsonc` file output. `odg`
 remains 100% compatible with the legacy `.od` format on both input and output.
 
 The original objdictedit and objdictgen tool were written in legacy python 2 and
@@ -116,6 +113,17 @@ This tool is a fork from upstream canfestival-3-asc repo:
 > https://github.com/Laerdal/canfestival-3-asc
 
 
+## Making objdictedit excutable
+
+To be able build an executable that can be run from anywhere:
+
+    $ pip install pyinstaller
+    $ pyinstaller packaging/objdictedit.spec
+
+The file `dist/objdictedit.exe` can now be used anywhere. It does not need any
+pre-installed software.
+
+
 ## License
 
 Objdictgen has been based on the python tool included in CanFestival. This

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

@@ -18,12 +18,15 @@
 # USA
 
 import os
+import sys
 from pathlib import Path
 
 from objdictgen.node import Node
 from objdictgen.nodemanager import NodeManager
 
-__version__ = "3.5"
+__version__ = "3.5.2"
+__version_tuple__ = (3, 5, 2, 0)
+__copyright__ = "(c) 2024 Svein Seldal, Laerdal Medical AS, and several. Licensed under GPLv2.1."
 
 # Shortcuts
 LoadFile = Node.LoadFile
@@ -31,7 +34,10 @@ LoadJson = Node.LoadJson
 
 ODG_PROGRAM = "odg"
 
-SCRIPT_DIRECTORY = Path(__file__).parent
+if hasattr(sys, '_MEIPASS'):
+    SCRIPT_DIRECTORY = Path(sys._MEIPASS) / 'objdictgen'
+else:
+    SCRIPT_DIRECTORY = Path(__file__).resolve().parent
 
 PROFILE_DIRECTORIES: list[Path] = [
     SCRIPT_DIRECTORY / 'config'

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

@@ -220,7 +220,7 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
     subp.add_argument('-x', '--exclude', action="append", help="OD Index to exclude.")
     subp.add_argument('-f', '--fix', action="store_true",
                         help="Fix any inconsistency errors in OD before generate output")
-    subp.add_argument('-t', '--type', choices=['od', 'eds', 'json', 'c'],
+    subp.add_argument('-t', '--type', choices=['od', 'eds', 'json', 'jsonc', 'c'],
                         help="Select output file type")
     subp.add_argument('--drop-unused', action="store_true", help="Remove unused parameters")
     subp.add_argument('--internal', action="store_true",
@@ -351,8 +351,9 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
 
         # Write the data
         od.DumpFile(opts.out,
-            filetype=opts.type, sort=not opts.no_sort,
-            internal=opts.internal, validate=not opts.novalidate
+            filetype=opts.type,
+            # These additional options are only used for JSON output
+            sort=not opts.no_sort, internal=opts.internal, validate=not opts.novalidate
         )
 
 

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

@@ -58,12 +58,13 @@ class ValidationError(Exception):
 # 1 - Default JSON format
 JSON_ID = "od data"
 JSON_DESCRIPTION = "Canfestival object dictionary data"
+JSON_SCHEMA = "https://raw.githubusercontent.com/Laerdal/python-objdictgen/main/src/objdictgen/schema/od.schema.json"
 JSON_INTERNAL_VERSION = "0"
 JSON_VERSION = "1"
 
 # Output order in JSON file
 JSON_TOP_ORDER = (
-    "$id", "$version", "$description", "$tool", "$date", "$schema",
+    "$id", "$version", "$description", "$schema", "$tool", "$date", "$schema",
     "name", "description", "type", "id", "profile",
     "default_string_size", "dictionary",
 )
@@ -117,6 +118,7 @@ FIELDS_DATA_MUST = {
 }
 FIELDS_DATA_OPT = {
     '$description',         # info only
+    '$schema',              # info only
     '$tool',                # info only
     '$date',                # info only
     'id',                   # default 0
@@ -357,7 +359,8 @@ def compare_profile(profilename: TPath, params: ODMapping, menu: TProfileMenu|No
         return False, False
 
 
-def generate_jsonc(node: "Node", compact=False, sort=False, internal=False, validate=True) -> str:
+def generate_jsonc(node: "Node", compact=False, sort=False, internal=False,
+                   validate=True, jsonc=True) -> str:
     """ Export a JSONC string representation of the node """
 
     # Get the dict representation
@@ -374,20 +377,37 @@ def generate_jsonc(node: "Node", compact=False, sort=False, internal=False, vali
     text = json.dumps(jd, separators=(',', ': '), indent=2)
 
     # Convert the special __ fields to jsonc comments
+    # Syntax:  "__<field>: <value>"
     text = re.sub(
         r'^(\s*)"__(\w+)": "(.*)",?$',
-        r'\1// "\2": "\3"',
+        # In regular json files, __* fields are omitted from output
+        # In jsonc files, the __* entry is converted to a comment:
+        #     "// <field>: <value>"
+        r'\1// "\2": "\3"' if jsonc else '',
         text,
         flags=re.MULTILINE,
     )
 
+    if jsonc:
+        # In jsonc the field is converted to "<field>,  // <comment>"
+        repl = lambda m: m[1].replace('\\"', '"') + m[3] + m[2]
+    else:
+        # In json the field is converted to "<field>,"
+        repl = lambda m: m[1].replace('\\"', '"') + m[3]
+
     # Convert the special @@ fields to jsonc comments
+    # Syntax:  "@@<field>,  // <comment>@@"
     text = re.sub(
         r'"@@(.*?)(\s*//.*?)?@@"(.*)$',
-        lambda m: m[1].replace('\\"', '"') + m[3] + m[2],
+        repl,
         text,
         flags=re.MULTILINE,
     )
+
+    # In case the json contains empty lines, remove them
+    if not jsonc:
+        text = "\n".join(line for line in text.splitlines() if line.strip())
+
     return text
 
 
@@ -501,6 +521,7 @@ def node_todict(node: "Node", sort=False, rich=True, internal=False, validate=Tr
         '$id': JSON_ID,
         '$version': JSON_INTERNAL_VERSION if internal else JSON_VERSION,
         '$description': JSON_DESCRIPTION,
+        '$schema': JSON_SCHEMA,
         '$tool': str(objdictgen.ODG_PROGRAM) + ' ' + str(objdictgen.__version__),
         '$date': datetime.now().astimezone().isoformat(),
         'name': node.Name,
@@ -722,7 +743,7 @@ def rearrage_for_json(obj: TODObjJson, node: "Node", objtypes_i2s: dict[int, str
 
         # Add __type when rich format
         if info and "type" not in sub:
-            sub["__type"] = objtypes_i2s.get(info["type"], info["type"])
+            sub["__type"] = f'@@"{objtypes_i2s.get(info["type"], info["type"])}"  // {info["type"]}@@'
 
         # Replace value
         if rich and "value" in sub:
@@ -744,7 +765,8 @@ def rearrage_for_json(obj: TODObjJson, node: "Node", objtypes_i2s: dict[int, str
         # Replace numeric type with string value
         if rich and "type" in each:
             # FIXME: The cast is to ensure mypy is able keep track
-            each["type"] = objtypes_i2s.get(cast(int, each["type"]), each["type"])
+            n = objtypes_i2s.get(cast(int, each["type"]), each["type"])
+            each["type"] = f'@@"{n}"  // {each["type"]}@@'
 
     # Rearrage order of 'sub' and 'each'
     obj["sub"] = [
@@ -1148,6 +1170,7 @@ def validate_fromdict(jsonobj: TODJson, objtypes_i2s: dict[int, str], objtypes_s
     #   "type" (must)
     # Y "dictionary" (must)
     #   "$description" (optional)
+    #   "$schema" (optional)
     #   "$tool" (optional)
     #   "$date" (optional)
     #   "id" (optional, default 0)

{objdictgen-3.5 → objdictgen-3.5.2}/src/objdictgen/node.py

@@ -196,14 +196,14 @@ class Node(NodeProtocol):
         """ Import a new Node from a JSON string """
         return jsonod.generate_node(contents)
 
-    def DumpFile(self, filepath: TPath, filetype: str|None = "json", **kwargs):
+    def DumpFile(self, filepath: TPath, filetype: str|None = "jsonc", **kwargs):
         """ Save node into file """
 
         # Attempt to determine the filetype from the filepath
         if not filetype:
             filetype = Path(filepath).suffix[1:]
         if not filetype:
-            filetype = "json"
+            filetype = "jsonc"
 
         if filetype == 'od':
             log.debug("Writing XML OD '%s'", filepath)
@@ -219,9 +219,11 @@ class Node(NodeProtocol):
                 f.write(content)
             return
 
-        if filetype == 'json':
+        if filetype in ('json', 'jsonc'):
             log.debug("Writing JSON OD '%s'", filepath)
-            jdata = self.DumpJson(**kwargs)
+            kw = kwargs.copy()
+            kw['jsonc'] = filetype == 'jsonc'
+            jdata = self.DumpJson(**kw)
             with open(filepath, "w", encoding="utf-8") as f:
                 f.write(jdata)
             return
@@ -234,10 +236,10 @@ class Node(NodeProtocol):
 
         raise ValueError("Unknown file suffix, unable to write file")
 
-    def DumpJson(self, compact=False, sort=False, internal=False, validate=True) -> str:
+    def DumpJson(self, compact=False, sort=False, internal=False, validate=True, jsonc=True) -> str:
         """ Dump the node into a JSON string """
         return jsonod.generate_jsonc(
-            self, compact=compact, sort=sort, internal=internal, validate=validate
+            self, compact=compact, sort=sort, internal=internal, validate=validate, jsonc=jsonc
         )
 
     def asdict(self) -> dict[str, Any]:

{objdictgen-3.5 → objdictgen-3.5.2}/src/objdictgen/schema/od.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema",
-    "$id": "https://raw.githubusercontent.com/laerdal-svg/python-objdictgen/main/src/objdictgen/schema/od.schema.json",
+    "$id": "https://raw.githubusercontent.com/Laerdal/python-objdictgen/main/src/objdictgen/schema/od.schema.json",
     "title": "Object Dictionary",
     "description": "A Object Dictionary description for canfestival",
     "type": "object",
@@ -21,6 +21,10 @@
             "description": "Description about the file",
             "type": "string"
         },
+        "$schema": {
+            "description": "The schema that this file is based on",
+            "type": "string"
+        },
         "$tool": {
             "description": "Tool that generated this file (optional)",
             "type": "string"

{objdictgen-3.5 → objdictgen-3.5.2}/src/objdictgen/ui/networkedit.py

@@ -18,6 +18,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 # USA
 
+import ctypes
 import getopt
 import logging
 import os
@@ -415,6 +416,12 @@ class NetworkEdit(NetworkEditorTemplate):
 
 
 def uimain(project):
+
+    # Set the application ID for Windows taskbar
+    if sys.platform == "win32":
+        myappid = 'objdictgen.objdictedit.' + objdictgen.__version__
+        ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
+
     app = wx.PySimpleApp()
 
     wx.InitAllImageHandlers()

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

@@ -18,6 +18,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 # USA
 
+import ctypes
 import getopt
 import logging
 import os
@@ -196,9 +197,9 @@ class ObjdictEdit(NodeEditorTemplate):
 
     def _init_ctrls(self, parent):
         wx.Frame.__init__(
-            self, id=ID_OBJDICTEDIT, name='objdictedit',
+            self, id=ID_OBJDICTEDIT, name=self.title,
             parent=parent, pos=wx.Point(149, 178), size=wx.Size(1000, 700),
-            style=wx.DEFAULT_FRAME_STYLE, title='Objdictedit',
+            style=wx.DEFAULT_FRAME_STYLE, title=self.title,
         )
         self._init_utils()
         self.SetClientSize(wx.Size(1000, 700))
@@ -228,6 +229,8 @@ class ObjdictEdit(NodeEditorTemplate):
         self.SetStatusBar(self.HelpBar)
 
     def __init__(self, parent, manager: NodeManager|None = None, filesopen: list[TPath]|None = None):
+        self.title = f"Object dictionary editor v{objdictgen.__version__}"
+
         filesopen = filesopen or []
         if manager is None:
             NodeEditorTemplate.__init__(self, NodeManager(), True)
@@ -322,9 +325,9 @@ class ObjdictEdit(NodeEditorTemplate):
 
     def RefreshTitle(self):
         if self.FileOpened.GetPageCount() > 0:
-            self.SetTitle(f"Objdictedit - {self.Manager.GetCurrentFilename()}")
+            self.SetTitle(self.title + f" - {self.Manager.GetCurrentFilename()}")
         else:
-            self.SetTitle("Objdictedit")
+            self.SetTitle(self.title)
 
     def RefreshCurrentIndexList(self):
         selected = self.FileOpened.GetSelection()
@@ -424,7 +427,7 @@ class ObjdictEdit(NodeEditorTemplate):
 
         with wx.FileDialog(
             self, "Choose a file", directory, "",
-            "OD files (*.json;*.od;*.eds)|*.json;*.od;*.eds|All files|*.*",
+            wildcard="OD JSON file (*.jsonc;*.json)|*.jsonc;*.json|Legacy OD file (*.od)|*.od|EDS file (*.eds)|*.eds|All files|*.*",
             style=wx.FD_OPEN | wx.FD_CHANGE_DIR,
         ) as dialog:
             if dialog.ShowModal() != wx.ID_OK:
@@ -475,7 +478,7 @@ class ObjdictEdit(NodeEditorTemplate):
 
         with wx.FileDialog(
             self, "Choose a file", directory, filename,
-            wildcard="OD JSON file (*.json)|*.json;|OD file (*.od)|*.od;|EDS file (*.eds)|*.eds",
+            wildcard="OD JSON file (*.jsonc;*.json)|*.jsonc;*.json|Legacy OD file (*.od)|*.od|EDS file (*.eds)|*.eds",
             style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT | wx.FD_CHANGE_DIR,
         ) as dialog:
             if dialog.ShowModal() != wx.ID_OK:
@@ -608,6 +611,12 @@ class ObjdictEdit(NodeEditorTemplate):
 
 
 def uimain(args):
+
+    # Set the application ID for Windows taskbar
+    if sys.platform == "win32":
+        myappid = 'objdictgen.objdictedit.' + objdictgen.__version__
+        ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
+
     app = wx.App()
 
     wx.InitAllImageHandlers()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: objdictgen
-Version: 3.5
+Version: 3.5.2
 Summary: CanFestival Object Dictionary tool
 Home-page: https://github.com/Laerdal/python-objdictgen
 Author: Svein Seldal
@@ -61,8 +61,8 @@ Laerdal Medical fork for the canfestival library:
 objdictgen is a tool to parse, view and manipulate files containing object
 dictionary (OD). An object dictionary is entries with data and configuration
 in CANopen devices. The `odg` executable is installed. It supports
-reading and writing OD files in `.json` format, in legacy XML `.od` and `.eds`
-files. It can generate c code for use with the canfestival library.
+reading and writing OD files in `.json`/`.jsonc` format, in legacy XML `.od`
+and `.eds` files. It can generate c code for use with the canfestival library.
 
 
 ## Install
@@ -119,14 +119,11 @@ descriptions, help with values and validate the file.
     "json.schemas": [
       {
         "fileMatch": [
-          "**.json"
+          "**.jsonc"
         ],
         "url": "./src/objdictgen/schema/od.schema.json"
       }
     ],
-    "files.associations": {
-        "*.json": "jsonc"
-    }
 ```
 
 ## Conversion
@@ -134,7 +131,7 @@ descriptions, help with values and validate the file.
 The recommended way to convert existing/legacy `.od` files to the new JSON
 format is:
 
-    $ odg generate <file.od> <file.json> --fix --drop-unused [--nosort]
+    $ odg generate <file.od> <file.jsonc> --fix --drop-unused [--nosort]
 
 The `--fix` option might be necessary if the OD-file contains internal
 inconsistencies. It is safe to run this option as it will not delete any active
@@ -145,10 +142,10 @@ parameter that might be used in the file.
 ## Motivation
 
 The biggest improvement with the new tool over the original implementation is
-the introduction of a new `.json` based format to store the object dictionary.
-The JSON format is well-known and easy to read. The tool supports jsonc,
+the introduction of a new `.jsonc` based format to store the object dictionary.
+The JSON format is well-known and easy to read. The tool use jsonc,
 allowing comments in the json file. `odg` will process the file in a repeatable
-manner, making it possible support diffing of the `.json` file output. `odg`
+manner, making it possible support diffing of the `.jsonc` file output. `odg`
 remains 100% compatible with the legacy `.od` format on both input and output.
 
 The original objdictedit and objdictgen tool were written in legacy python 2 and
@@ -159,6 +156,17 @@ This tool is a fork from upstream canfestival-3-asc repo:
 > https://github.com/Laerdal/canfestival-3-asc
 
 
+## Making objdictedit excutable
+
+To be able build an executable that can be run from anywhere:
+
+    $ pip install pyinstaller
+    $ pyinstaller packaging/objdictedit.spec
+
+The file `dist/objdictedit.exe` can now be used anywhere. It does not need any
+pre-installed software.
+
+
 ## License
 
 Objdictgen has been based on the python tool included in CanFestival. This

{objdictgen-3.5 → objdictgen-3.5.2}/src/objdictgen.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ src/objdictgen/ui/nodeeditortemplate.py
 src/objdictgen/ui/objdictedit.py
 src/objdictgen/ui/subindextable.py
 tests/test_imports.py
+tests/test_installer.py
 tests/test_jsonod.py
 tests/test_knownfailures.py
 tests/test_main.py

objdictgen-3.5.2/tests/test_installer.py

@@ -0,0 +1,38 @@
+
+import pytest
+from unittest import mock
+import os
+import sys
+
+@pytest.fixture
+def setenvvar(monkeypatch):
+    with mock.patch.dict(os.environ, {"TEST": "foobar"}):
+        yield
+
+
+def test_filereplacer(basepath, wd, setenvvar):
+
+    sys.path.append(str(basepath / "packaging"))
+    os.chdir(basepath)
+    from filereplacer import convert
+
+    tests = [
+        (1, "Test data", "Test data"),
+        (2, "@@{name}", "objdictgen"),
+        (3, "@@{TEST}", "foobar"),  # Read from the mocked environment variable
+        (4, "@@{nonexisting}", "non-existing"),
+    ]
+
+    for i, data, result in tests:
+        infile = wd / "test.txt"
+        outfile = wd / "out.txt"
+        with open(infile, "w", encoding="utf-8") as f:
+            f.write(data)
+        if i == 4:
+            with pytest.raises(KeyError):
+                convert(infile, outfile)
+            continue
+        else:
+            convert(infile, outfile)
+            with open(outfile, "r", encoding="utf-8") as f:
+                assert f.read() == result

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

@@ -130,3 +130,33 @@ def test_jsonod_timezone():
             if m:
                 print(m[1])
                 assert m[1] == cmp + "+" + tz
+
+
+def test_jsonod_comments(odpath):
+    """ Test that the json file exports comments correctly. """
+
+    fname_jsonc = odpath / "jsonod-comments.jsonc"
+    fname_json = odpath / "jsonod-comments.json"
+
+    m1 = Node.LoadFile(fname_jsonc)
+
+    with open(fname_jsonc, "r") as f:
+        jsonc_data = f.read()
+    with open(fname_json, "r") as f:
+        json_data = f.read()
+
+    out = generate_jsonc(m1, compact=False, sort=False, internal=False, validate=True, jsonc=True)
+
+    # Compare the jsonc data with the generated data
+    for a, b in zip(jsonc_data.splitlines(), out.splitlines()):
+        if '"$date"' in a or '"$tool"' in a:
+            continue
+        assert a == b
+
+    out = generate_jsonc(m1, compact=False, sort=False, internal=False, validate=True, jsonc=False)
+
+    # Compare the json data with the generated data
+    for a, b in zip(json_data.splitlines(), out.splitlines()):
+        if '"$date"' in a or '"$tool"' in a:
+            continue
+        assert a == b