Changeset 2c46d2d in rtems-central

Timestamp:

07/28/22 08:51:22 (17 months ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

master

Children:

bb633e2

Parents:

e0980df

git-author:

Sebastian Huber <sebastian.huber@…> (07/28/22 08:51:22)

git-committer:

Sebastian Huber <sebastian.huber@…> (07/28/22 09:26:30)

Message:

items: Add JSONItemCache

Location:

rtemsspec

Files:

• items.py (modified) (10 diffs)
• tests/spec-json/a.json (added)
• tests/spec-json/d/b.json (added)
• tests/test_items_item.py (modified) (2 diffs)

rtemsspec/items.py

@@ -2 +2 @@
 """ This module provides specification items and an item cache. """
 
-# Copyright (C) 2019, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+# Copyright (C) 2019, 2022 embedded brains GmbH (http://www.embedded-brains.de)
 #
 # Redistribution and use in source and binary forms, with or without
@@ -32 +32 @@
 import stat
 from typing import Any, Callable, Dict, Iterable, Iterator, List, NamedTuple, \
-    Optional, Set, Tuple, Union
+    Optional, Set, TextIO, Tuple, Union
+import json
 import yaml
 
@@ -417 +418 @@
     def save(self):
         """ Saves the item to the corresponding file. """
-        with open(self.file, "w") as dst:
-            data = {}
-            for key, value in self._data.items():
-                if not key.startswith("_"):
-                    data[key] = value
-            dst.write(
-                yaml.dump(data, default_flow_style=False, allow_unicode=True))
+        self._cache.save_data(self.file, self._data)
 
     def load(self):
         """ Loads the item from the corresponding file. """
-        filename = self.file
-        with open(filename, "r") as src:
-            self._data = yaml.safe_load(src.read())
-            self._data["_file"] = filename
+        self._data = self._cache.load_data(self.file, self._uid)
 
 
@@ -620 +612 @@
 
 
-def _load_item(path: str, uid: str) -> Any:
+def _load_yaml_data(path: str, uid: str) -> Any:
     with open(path, "r") as src:
         try:
@@ -633 +625 @@
 
 
+def _load_json_data(path: str, uid: str) -> Any:
+    with open(path, "r") as src:
+        try:
+            data = json.load(src)
+        except json.JSONDecodeError as err:
+            msg = ("JSON error while loading specification item file "
+                   f"'{path}': {str(err)}")
+            raise IOError(msg) from err
+        data["_file"] = os.path.abspath(path)
+        data["_uid"] = uid
+    return data
+
+
 class ItemCache:
     """ This class provides a cache of specification items. """
@@ -642 +647 @@
         self._types = set()  # type: Set[str]
         self._updates = 0
-        cache_dir = os.path.abspath(config["cache-directory"])
-        for index, path in enumerate(config["paths"]):
-            self._load_items_recursive(str(index), path, path, cache_dir)
+        self._load_items(config)
         if post_process_load:
             post_process_load(self._items)
@@ -696 +699 @@
         The item is not added to the persistent cache storage.
         """
-        return self.add_volatile_item(uid, _load_item(path, uid))
+        return self.add_volatile_item(uid, self.load_data(path, uid))
 
     def _add_item(self, uid: str, data: Any) -> Item:
@@ -713 +716 @@
                     uid = "/" + os.path.relpath(path2, base).replace(
                         ".yml", "")
-                    data_by_uid[uid] = _load_item(path2, uid)
+                    data_by_uid[uid] = _load_yaml_data(path2, uid)
             os.makedirs(os.path.dirname(cache_file), exist_ok=True)
             with open(cache_file, "wb") as out:
@@ -745 +748 @@
         self._load_items_in_dir(base, path, cache_file, update_cache)
 
+    def _load_items(self, config: Any):
+        cache_dir = os.path.abspath(config["cache-directory"])
+        for index, path in enumerate(config["paths"]):
+            self._load_items_recursive(str(index), path, path, cache_dir)
+
+    def load_data(self, path: str, uid: str) -> Any:
+        """ Loads the item data from the file specified by path. """
+        # pylint: disable=no-self-use
+        return _load_yaml_data(path, uid)
+
+    def _save_data(self, file: TextIO, data: Any) -> None:
+        # pylint: disable=no-self-use
+        file.write(
+            yaml.dump(data, default_flow_style=False, allow_unicode=True))
+
+    def save_data(self, path: str, data: Any) -> None:
+        """ Saves the item data to the file specified by path. """
+        print('save-data', path, data)
+        with open(path, "w") as file:
+            data2 = {}
+            for key, value in data.items():
+                if not key.startswith("_"):
+                    data2[key] = value
+            self._save_data(file, data2)
+
     def _init_parents(self) -> None:
         for item in self._items.values():
@@ -776 +804 @@
 
 
+class JSONItemCache(ItemCache):
+    """ This class provides a cache of specification items using JSON. """
+    def _load_json_items(self, base: str, path: str) -> None:
+        for name in os.listdir(path):
+            path2 = os.path.join(path, name)
+            if name.endswith(".json") and not name.startswith("."):
+                uid = "/" + os.path.relpath(path2, base).replace(".json", "")
+                self._add_item(uid, _load_json_data(path2, uid))
+            else:
+                if stat.S_ISDIR(os.lstat(path2).st_mode):
+                    self._load_json_items(base, path2)
+
+    def _load_items(self, config: Any):
+        for path in config["paths"]:
+            self._load_json_items(path, path)
+
+    def load_data(self, path: str, uid: str) -> Any:
+        # pylint: disable=no-self-use
+        return _load_json_data(path, uid)
+
+    def _save_data(self, file: TextIO, data: Any) -> None:
+        # pylint: disable=no-self-use
+        json.dump(data, file, sort_keys=True, indent=2)
+
+
 class EmptyItem(Item):
     """ Objects of this class represent empty items. """

rtemsspec/tests/test_items_item.py

@@ -28 +28 @@
 import pytest
 
-from rtemsspec.items import EmptyItemCache, Item, ItemCache, \
-    ItemGetValueContext, Link
+from rtemsspec.items import EmptyItemCache, Item, ItemGetValueContext, \
+    JSONItemCache, Link
 
 
@@ -267 +267 @@
 
 
+def test_save_and_load_json(tmpdir):
+    spec_dir = os.path.join(os.path.dirname(__file__), "spec-json")
+    config = {"paths": [spec_dir], "spec-type-root-uid": None}
+    item_cache = JSONItemCache(config)
+    item = item_cache["/d/b"].parent("b")
+    file = os.path.join(tmpdir, "file")
+    item.file = file
+    assert item["enabled-by"]
+    item["enabled-by"] = False
+    item.save()
+    with open(file, "r") as src:
+        assert src.read() == """{
+  "SPDX-License-Identifier": "CC-BY-SA-4.0 OR BSD-2-Clause",
+  "copyrights": [
+    "Copyright (C) 2022 embedded brains GmbH (http://www.embedded-brains.de)"
+  ],
+  "enabled-by": false,
+  "links": [],
+  "type": "a"
+}"""
+    item.load()
+    with open(file, "w") as dst:
+        dst.write("invalid")
+    with pytest.raises(IOError):
+        item.load()
+
+
 def test_item_get_value_arg():
     item = Item(EmptyItemCache(), "i", {})