Resolve change requests

Author: moritzsommer

compliance_tool/aas_compliance_tool/compliance_check_aasx.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.

compliance_tool/aas_compliance_tool/compliance_check_json.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -112,7 +112,7 @@ def check_deserialization(file_path: str, state_manager: ComplianceToolStateMana
     :param file_path: Given file which should be deserialized
     :param state_manager: :class:`~basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
     :param file_info: Additional information about the file for name of the steps
-    :return: The deserialized :class:`~basyx.aas.model.provider.DictObjectStore`
+    :return: The deserialized :class:`~basyx.aas.model.provider.DictIdentifiableStore`
     """
     logger = logging.getLogger('compliance_check')
     logger.addHandler(state_manager)

compliance_tool/test/test_aas_compliance_tool.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -138,10 +138,10 @@ def test_json_create_example(self) -> None:
         self.assertIn('SUCCESS:      Write data to file', str(output.stdout))
 
         with open(filename, "r", encoding='utf-8-sig') as f:
-            json_object_store = read_aas_json_file(f, failsafe=False)
+            json_identifiable_store = read_aas_json_file(f, failsafe=False)
             data = create_example()
             checker = AASDataChecker(raise_immediately=True)
-            checker.check_identifiable_store(json_object_store, data)
+            checker.check_identifiable_store(json_identifiable_store, data)
         os.unlink(filename)
 
     def test_json_deserialization(self) -> None:
@@ -184,10 +184,10 @@ def test_xml_create_example(self) -> None:
         self.assertIn('SUCCESS:      Write data to file', str(output.stdout))
 
         with open(filename, "rb") as f:
-            xml_object_store = read_aas_xml_file(f, failsafe=False)
+            xml_identifiable_store = read_aas_xml_file(f, failsafe=False)
             data = create_example()
             checker = AASDataChecker(raise_immediately=True)
-            checker.check_identifiable_store(xml_object_store, data)
+            checker.check_identifiable_store(xml_identifiable_store, data)
         os.unlink(filename)
 
     def test_xml_deseralization(self) -> None:

sdk/README.md

@@ -124,10 +124,10 @@ write_aas_xml_file(file='Simple_Submodel.xml', data=data)
 For further examples and tutorials, check out the `basyx.aas.examples`-package. Here is a quick overview:
 
 * [`tutorial_create_simple_aas`](./basyx/aas/examples/tutorial_create_simple_aas.py): Create an Asset Administration Shell, including an Asset object and a Submodel
-* [`tutorial_storage`](./basyx/aas/examples/tutorial_storage.py): Manage a larger number of Asset Administration Shells in an ObjectStore and resolve references
+* [`tutorial_storage`](./basyx/aas/examples/tutorial_storage.py): Manage a larger number of Asset Administration Shells in an IdentifiableStore and resolve references
 * [`tutorial_serialization_deserialization`](./basyx/aas/examples/tutorial_serialization_deserialization.py): Use the JSON and XML serialization/deserialization for single objects or full standard-compliant files
 * [`tutorial_aasx`](./basyx/aas/examples/tutorial_aasx.py): Export Asset Administration Shells with related objects and auxiliary files to AASX package files
-* [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *CouchDBObjectStore* to manage and retrieve AAS objects in a CouchDB document database
+* [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *CouchDBIdentifiableStore* to manage and retrieve AAS objects in a CouchDB document database
 
 
 ### Documentation

sdk/basyx/aas/adapter/__init__.py

@@ -18,13 +18,13 @@
 
 def load_directory(directory: Union[Path, str]) -> tuple[DictIdentifiableStore, DictSupplementaryFileContainer]:
     """
-    Create a new :class:`~basyx.aas.model.provider.DictObjectStore` and use it to load Asset Administration Shell and
-    Submodel files in ``AASX``, ``JSON`` and ``XML`` format from a given directory into memory. Additionally, load all
-    embedded supplementary files into a new :class:`~basyx.aas.adapter.aasx.DictSupplementaryFileContainer`.
+    Create a new :class:`~basyx.aas.model.provider.DictIdentifiableStore` and use it to load Asset Administration Shell
+    and Submodel files in ``AASX``, ``JSON`` and ``XML`` format from a given directory into memory. Additionally, load
+    all embedded supplementary files into a new :class:`~basyx.aas.adapter.aasx.DictSupplementaryFileContainer`.
 
     :param directory: :class:`~pathlib.Path` or ``str`` pointing to the directory containing all Asset Administration
         Shell and Submodel files to load
-    :return: Tuple consisting of a :class:`~basyx.aas.model.provider.DictObjectStore` and a
+    :return: Tuple consisting of a :class:`~basyx.aas.model.provider.DictIdentifiableStore` and a
         :class:`~basyx.aas.adapter.aasx.DictSupplementaryFileContainer` containing all loaded data
     """
 

sdk/basyx/aas/adapter/aasx.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -52,7 +52,7 @@ class AASXReader:
 
     .. code-block:: python
 
-        objects = DictObjectStore()
+        identifiables = DictIdentifiableStore()
         files = DictSupplementaryFileContainer()
         with AASXReader("filename.aasx") as reader:
             meta_data = reader.get_core_properties()
@@ -241,7 +241,7 @@ def _parse_aas_part(self, part_name: str, **kwargs) -> model.DictIdentifiableSto
         This method chooses and calls the correct parser.
 
         :param part_name: The OPC part name of the part to be parsed
-        :return: A DictObjectStore containing the parsed AAS objects
+        :return: A DictIdentifiableStore containing the parsed AAS objects
         """
         content_type = self.reader.get_content_type(part_name)
         extension = part_name.split("/")[-1].split(".")[-1]

sdk/basyx/aas/adapter/json/json_deserialization.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -21,7 +21,7 @@
 takes a complete AAS JSON file, reads its contents and stores the objects in the provided
 :class:`~basyx.aas.model.provider.AbstractObjectStore`. :meth:`read_aas_json_file` is a wrapper for this function.
 Instead of storing the objects in a given :class:`~basyx.aas.model.provider.AbstractObjectStore`,
-it returns a :class:`~basyx.aas.model.provider.DictObjectStore` containing parsed objects.
+it returns a :class:`~basyx.aas.model.provider.DictIdentifiableStore` containing parsed objects.
 
 The deserialization is performed in a bottom-up approach: The ``object_hook()`` method gets called for every parsed JSON
 object (as dict) and checks for existence of the ``modelType`` attribute. If it is present, the ``AAS_CLASS_PARSERS``
@@ -816,12 +816,12 @@ def read_aas_json_file_into(object_store: model.AbstractObjectStore, file: PathO
         -> Set[model.Identifier]:
     """
     Read an Asset Administration Shell JSON file according to 'Details of the Asset Administration Shell', chapter 5.5
-    into a given object store.
+    into a given ObjectStore.
 
     :param object_store: The :class:`ObjectStore <basyx.aas.model.provider.AbstractObjectStore>` in which the
                          identifiable objects should be stored
     :param file: A filename or file-like object to read the JSON-serialized data from
-    :param replace_existing: Whether to replace existing objects with the same identifier in the object store or not
+    :param replace_existing: Whether to replace existing objects with the same identifier in the ObjectStore or not
     :param ignore_existing: Whether to ignore existing objects (e.g. log a message) or raise an error.
                             This parameter is ignored if replace_existing is ``True``.
     :param failsafe: If ``True``, the document is parsed in a failsafe way: Missing attributes and elements are logged
@@ -901,8 +901,8 @@ def read_aas_json_file_into(object_store: model.AbstractObjectStore, file: PathO
 def read_aas_json_file(file: PathOrIO, failsafe: bool = True, **kwargs) -> model.DictIdentifiableStore:
     """
     A wrapper of :meth:`~basyx.aas.adapter.json.json_deserialization.read_aas_json_file_into`, that reads all objects
-    in an empty :class:`~basyx.aas.model.provider.DictObjectStore`. This function supports the same keyword arguments as
-    :meth:`~basyx.aas.adapter.json.json_deserialization.read_aas_json_file_into`.
+    in an empty :class:`~basyx.aas.model.provider.DictIdentifiableStore`. This function supports the same keyword
+    arguments as :meth:`~basyx.aas.adapter.json.json_deserialization.read_aas_json_file_into`.
 
     :param file: A filename or file-like object to read the JSON-serialized data from
     :param failsafe: If ``True``, the document is parsed in a failsafe way: Missing attributes and elements are logged
@@ -913,7 +913,7 @@ def read_aas_json_file(file: PathOrIO, failsafe: bool = True, **kwargs) -> model
         Errors during construction of the objects
     :raises TypeError: **Non-failsafe**: Encountered an element in the wrong list
                                          (e.g. an AssetAdministrationShell in ``submodels``)
-    :return: A :class:`~basyx.aas.model.provider.DictObjectStore` containing all AAS objects from the JSON file
+    :return: A :class:`~basyx.aas.model.provider.DictIdentifiableStore` containing all AAS objects from the JSON file
     """
     identifiable_store: model.DictIdentifiableStore = model.DictIdentifiableStore()
     read_aas_json_file_into(identifiable_store, file, failsafe=failsafe, **kwargs)

sdk/basyx/aas/adapter/json/json_serialization.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -17,7 +17,7 @@
 simple python types for an automatic JSON serialization.
 To simplify the usage of this module, the :meth:`write_aas_json_file` and :meth:`object_store_to_json` are provided.
 The former is used to serialize a given :class:`~basyx.aas.model.provider.AbstractObjectStore` to a file, while the
-latter serializes the object store to a string and returns it.
+latter serializes the ObjectStore to a string and returns it.
 
 The serialization is performed in an iterative approach: The :meth:`~.AASToJsonEncoder.default` function gets called for
 every object and checks if an object is an BaSyx Python SDK object. In this case, it calls a special function for the

sdk/basyx/aas/adapter/xml/xml_deserialization.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -15,7 +15,7 @@
 - :func:`read_aas_xml_file_into` constructs all elements of an XML document and stores them in a given
   :class:`ObjectStore <basyx.aas.model.provider.AbstractObjectStore>`
 - :func:`read_aas_xml_file` constructs all elements of an XML document and returns them in a
-  :class:`~basyx.aas.model.provider.DictObjectStore`
+  :class:`~basyx.aas.model.provider.DictIdentifiableStore`
 
 These functions take a decoder class as keyword argument, which allows parsing in failsafe (default) or non-failsafe
 mode. Parsing stripped elements - used in the HTTP adapter - is also possible. It is also possible to subclass the
@@ -1512,7 +1512,7 @@ def read_aas_xml_file(file: PathOrIO, failsafe: bool = True, **kwargs: Any)\
         -> model.DictIdentifiableStore:
     """
     A wrapper of :meth:`~basyx.aas.adapter.xml.xml_deserialization.read_aas_xml_file_into`, that reads all objects in an
-    empty :class:`~basyx.aas.model.provider.DictObjectStore`. This function supports
+    empty :class:`~basyx.aas.model.provider.DictIdentifiableStore`. This function supports
     the same keyword arguments as :meth:`~basyx.aas.adapter.xml.xml_deserialization.read_aas_xml_file_into`.
 
     :param file: A filename or file-like object to read the XML-serialized data from
@@ -1525,7 +1525,7 @@ def read_aas_xml_file(file: PathOrIO, failsafe: bool = True, **kwargs: Any)\
     :raises (~basyx.aas.model.base.AASConstraintViolation, KeyError, ValueError): **Non-failsafe**: Errors during
                                                                                   construction of the objects
     :raises TypeError: **Non-failsafe**: Encountered an undefined top-level list (e.g. ``<aas:submodels1>``)
-    :return: A :class:`~basyx.aas.model.provider.DictObjectStore` containing all AAS objects from the XML file
+    :return: A :class:`~basyx.aas.model.provider.DictIdentifiableStore` containing all AAS objects from the XML file
     """
     identifiable_store: model.DictIdentifiableStore[model.Identifiable] = model.DictIdentifiableStore()
     read_aas_xml_file_into(identifiable_store, file, failsafe=failsafe, **kwargs)

sdk/basyx/aas/backend/couchdb.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -8,7 +8,8 @@
 This module adds the functionality of storing and retrieving :class:`~basyx.aas.model.base.Identifiable` objects
 in a CouchDB.
 
-The :class:`~CouchDBObjectStore` handles adding, deleting and otherwise managing the AAS objects in a specific CouchDB.
+The :class:`~CouchDBIdentifiableStore` handles adding, deleting and otherwise managing the AAS objects in a specific
+CouchDB.
 """
 import threading
 import warnings
@@ -41,7 +42,7 @@ def register_credentials(url: str, username: str, password: str):
     .. Warning::
 
         Do not use this function, while other threads may be accessing the credentials via the
-        :class:`~.CouchDBObjectStore`!
+        :class:`~.CouchDBIdentifiableStore`!
 
     :param url: Toplevel URL
     :param username: Username to that CouchDB instance
@@ -93,13 +94,14 @@ class CouchDBIdentifiableStore(model.AbstractObjectStore[model.Identifier, model
     An ObjectStore implementation for :class:`~basyx.aas.model.base.Identifiable` BaSyx Python SDK objects backed
     by a CouchDB database server.
 
-    All methods of the ``CouchDBObjectStore`` are blocking, i.e. they stop the current thread's execution until they
-    receive a response from the CouchDB server (or encounter a timeout). However, the ``CouchDBObjectStore`` objects are
-    thread-safe, as long as no CouchDB credentials are added (via ``register_credentials()``) during transactions.
+    All methods of the ``CouchDBIdentifiableStore`` are blocking, i.e. they stop the current thread's execution until
+    they receive a response from the CouchDB server (or encounter a timeout). However, the ``CouchDBIdentifiableStore``
+    objects are thread-safe, as long as no CouchDB credentials are added (via ``register_credentials()``) during
+    transactions.
     """
     def __init__(self, url: str, database: str):
         """
-        Initializer of class CouchDBObjectStore
+        Initializer of class CouchDBIdentifiableStore
 
         :param url: URL to the CouchDB
         :param database: Name of the Database inside the CouchDB