Merge remote-tracking branch 'origin/develop' into experimental/registry_and_discovery_server

Author: Ornella33

.github/workflows/ci.yml

@@ -292,7 +292,7 @@ jobs:
 
     defaults:
       run:
-        working-directory: ./server/app
+        working-directory: ./server
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
@@ -302,26 +302,26 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install ../../sdk
+        python -m pip install ../sdk
         python -m pip install .[dev]
     - name: Check typing with MyPy
       run: |
-        python -m mypy .
+        python -m mypy app test
     - name: Check code style with PyCodestyle
       run: |
-        python -m pycodestyle --count --max-line-length 120 .
+        python -m pycodestyle --count --max-line-length 120 app test
 
-  server-package:
+  server-repository-docker:
     # This job checks if we can build our server package
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./server
+        working-directory: ./server/docker/repository
     steps:
       - uses: actions/checkout@v4
       - name: Build the Docker image
         run: |
-          docker build -t basyx-python-server -f Dockerfile ..
+          docker build -t basyx-python-server -f Dockerfile ../../..
       - name: Run container
         run: |
            docker run -d --name basyx-python-server basyx-python-server

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 the Eclipse BaSyx Authors
+Copyright (c) 2019-2026 the Eclipse BaSyx Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

compliance_tool/aas_compliance_tool/compliance_check_xml.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.

etc/scripts/set_copyright_year.sh

@@ -2,13 +2,17 @@
 # Usage: ./set_copyright_year.sh [PATHS]
 #
 # This is a small script for setting the correct copyright year
-# for each given file (i.e. the year the file was last changed).
-# Instead of file paths you can also specify directories, in which
-# case the script will attempt to set the copyright year for all
-# files in the given directories. Globbing is also possible.
+# for each given source file (i.e. the year the file was last
+# changed) and LICENSE file (i.e. the latest modification year
+# across all files). Instead of file paths you can also specify
+# directories, in which case the script will attempt to set the
+# copyright year for all files in the given directories.
+# Globbing is also possible.
 #
-# The script will check the first two lines for a copyright
-# notice (in case the first line is a shebang).
+# In source files, the script checks the first two lines for a
+# copyright notice (in case the first line is a shebang).
+# In the LICENSE file, it checks the first three lines for a
+# copyright notice containing a year range.
 #
 # Run this script with --check to have it raise an error if it
 # would change anything.
@@ -17,32 +21,56 @@
 EXIT_CODE=0
 
 # Set CHECK_MODE based on whether --check is passed
-    CHECK_MODE=false
-    if [[ "$1" == "--check" ]]; then
-        CHECK_MODE=true
-        shift # Remove --check from the arguments
-    fi
+CHECK_MODE=false
+if [[ "$1" == "--check" ]]; then
+    CHECK_MODE=true
+    shift # Remove --check from the arguments
+fi
+
+# Initialise a variable to track the latest modification year across all files
+max_year=""
 
+# Validate the copyright year of each source file
 while read -rd $'\0' year file; do
 
+    # Extract the current modification year and update variable
+    if [[ -z "$max_year" || "$year" -gt "$max_year" ]]; then
+        max_year="$year"
+    fi
+
     # Extract the first year from the copyright notice
     current_year=$(sed -n '1,2s/^\(# Copyright (c) \)\([[:digit:]]\{4,\}\).*/\2/p' "$file")
 
-    # Skip the file if no year is found
+    # Skip the source file if no year is found
     if [[ -z "$current_year" ]]; then
         continue
     fi
 
+    # If in check mode, report the incorrect copyright year
     if $CHECK_MODE && [[ "$current_year" != "$year" ]]; then
         echo "Error: Copyright year mismatch in file $file. Expected $year, found $current_year."
-        # Set ERROR_CODE to 1 to indicate mismatch
-	ERROR_CODE=1
+        # Set EXIT_CODE to 1 to indicate mismatch
+        EXIT_CODE=1
     fi
 
+    # Otherwise rewrite the incorrect copyright year
     if ! $CHECK_MODE && [[ "$current_year" != "$year" ]]; then
         sed -i "1,2s/^\(# Copyright (c) \)[[:digit:]]\{4,\}/\1$year/" "$file"
         echo "Updated copyright year in $file"
     fi
 done < <(git ls-files -z "$@" | xargs -0I{} git log -1 -z --format="%cd {}" --date="format:%Y" -- "{}")
 
+# Validate the copyright year of the LICENSE file
+license_current_year=$(sed -n '1,3{s/^Copyright (c) [[:digit:]]\{4\}-\([[:digit:]]\{4\}\).*/\1/p}' LICENSE)
+
+if $CHECK_MODE && [[ -n "$license_current_year" && "$license_current_year" != "$max_year" ]]; then
+    echo "Error: Copyright year mismatch in file LICENSE. Expected $max_year, found $license_current_year."
+    EXIT_CODE=1
+fi
+
+if ! $CHECK_MODE && [[ -n "$license_current_year" && "$license_current_year" != "$max_year" ]]; then
+    sed -i "1,3s/^\(Copyright (c) [[:digit:]]\{4\}-\)[[:digit:]]\{4\}/\1$max_year/" LICENSE
+    echo "Updated copyright year in LICENSE"
+fi
+
 exit $EXIT_CODE

sdk/README.md

@@ -124,7 +124,8 @@ 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 IdentifiableStore and resolve references
+* [`tutorial_navigate_aas`](./basyx/aas/examples/tutorial_navigate_aas.py): Navigate Asset Administration Shell Submodels using IdShorts and IdShortPaths
+* [`tutorial_storage`](./basyx/aas/examples/tutorial_storage.py): Manage a larger number of Asset Administration Shells in an ObjectStore 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 *CouchDBIdentifiableStore* to manage and retrieve AAS objects in a CouchDB document database

sdk/basyx/aas/backend/local_file.py

@@ -123,7 +123,7 @@ def discard(self, x: model.Identifiable) -> None:
         except FileNotFoundError as e:
             raise KeyError("No AAS object with id {} exists in local file database".format(x.id)) from e
         with self._object_cache_lock:
-            del self._object_cache[x.id]
+            self._object_cache.pop(x.id, None)
 
     def __contains__(self, x: object) -> bool:
         """

sdk/basyx/aas/examples/tutorial_navigate_aas.py

@@ -0,0 +1,199 @@
+#!/usr/bin/env python3
+# This work is licensed under a Creative Commons CCZero 1.0 Universal License.
+# See http://creativecommons.org/publicdomain/zero/1.0/ for more information.
+"""
+Tutorial for navigating a Submodel's hierarchy using IdShorts and IdShortPaths.
+"""
+
+from basyx.aas import model
+from typing import cast
+
+# In this tutorial, you will learn how to create a Submodel with different kinds of SubmodelElements and how to navigate
+# through them using IdShorts and IdShortPaths.
+#
+# Step-by-Step Guide:
+# Step 1: Create a Submodel with a Property, a SubmodelElementCollection of Properties, a SubmodelElementList of
+#         Properties and a SubmodelElementList of SubmodelElementCollections
+#
+#         Submodel "https://iat.rwth-aachen.de/Simple_Submodel"
+#         ├── Property "MyProperty"
+#         │
+#         ├── SubmodelElementCollection "MyPropertyCollection"
+#         │   ├── Property "MyProperty0"
+#         │   └── Property "MyProperty1"
+#         │
+#         ├── SubmodelElementList "MyPropertyList"
+#         │   ├── Property [0]
+#         │   └── Property [1]
+#         │
+#         └── SubmodelElementList "MyCollectionList"
+#             ├── SubmodelElementCollection [0]
+#             │   └── Property "MyProperty"
+#             ├── SubmodelElementCollection [1]
+#             │   └── Property "MyProperty"
+#             └── SubmodelElementCollection [2]
+#                 └── Property "MyProperty"
+#
+# Step 2: Navigate through the Submodel using IdShorts and IdShortPaths
+
+
+########################################################################
+# Step 1: Create a Submodel with a navigable SubmodelElement hierarchy #
+########################################################################
+
+# Step 1.1: Create a Submodel
+submodel = model.Submodel(id_="https://iat.rwth-aachen.de/Simple_Submodel")
+
+# Step 1.2: Add a single Property to the Submodel
+my_property = model.Property(
+    id_short="MyProperty",
+    value_type=model.datatypes.String,
+    value="I am a simple Property"
+)
+submodel.submodel_element.add(my_property)
+
+# Step 1.3: Add a SubmodelElementCollection of Properties to the Submodel
+my_property_collection = model.SubmodelElementCollection(
+    id_short="MyPropertyCollection",
+    value={
+        model.Property(
+            id_short="MyProperty0",
+            value_type=model.datatypes.String,
+            value="I am the first of two Properties within a SubmodelElementCollection"
+        ),
+        model.Property(
+            id_short="MyProperty1",
+            value_type=model.datatypes.String,
+            value="I am the second of two Properties within a SubmodelElementCollection"
+        )
+    }
+)
+submodel.submodel_element.add(my_property_collection)
+
+# Step 1.4: Add a SubmodelElementList of Properties to the Submodel
+my_property_list = model.SubmodelElementList(
+    id_short="MyPropertyList",
+    type_value_list_element=model.Property,
+    value_type_list_element=model.datatypes.String,
+    order_relevant=True,
+    value=[
+        model.Property(
+            id_short=None,
+            value_type=model.datatypes.String,
+            value="I am Property 0 within a SubmodelElementList"
+        ),
+        model.Property(
+            id_short=None,
+            value_type=model.datatypes.String,
+            value="I am Property 1 within a SubmodelElementList"
+        )
+    ]
+)
+submodel.submodel_element.add(my_property_list)
+
+# Step 1.5: Add a SubmodelElementList of SubmodelElementCollections to the Submodel
+my_property_collection_0 = model.SubmodelElementCollection(
+    id_short=None,
+    value={model.Property(
+        id_short="MyProperty",
+        value_type=model.datatypes.String,
+        value="I am a simple Property within SubmodelElementCollection 0"
+    )}
+)
+my_property_collection_1 = model.SubmodelElementCollection(
+    id_short=None,
+    value={model.Property(
+        id_short="MyProperty",
+        value_type=model.datatypes.String,
+        value="I am a simple Property within SubmodelElementCollection 1"
+    )}
+)
+my_property_collection_2 = model.SubmodelElementCollection(
+    id_short=None,
+    value={model.Property(
+        id_short="MyProperty",
+        value_type=model.datatypes.String,
+        value="I am a simple Property within SubmodelElementCollection 2"
+    )}
+)
+my_collection_list = model.SubmodelElementList(
+    id_short="MyCollectionList",
+    type_value_list_element=model.SubmodelElementCollection,
+    order_relevant=True,
+    value=[my_property_collection_0, my_property_collection_1, my_property_collection_2]
+)
+submodel.submodel_element.add(my_collection_list)
+
+
+#########################################################################
+# Step 2: Navigate through the Submodel using IdShorts and IdShortPaths #
+#########################################################################
+
+# Step 2.1: Access a single Property via its IdShort
+my_property = cast(model.Property, submodel.get_referable("MyProperty"))
+print(f"my_property: id_short = {my_property.id_short}, value = {my_property.value}\n")
+
+# Step 2.2: Navigate through a SubmodelElementCollection of Properties
+# Step 2.2.1: Access a Property within a SubmodelElementCollection step by step via its IdShort
+my_property_collection = cast(model.SubmodelElementCollection, submodel.get_referable("MyPropertyCollection"))
+my_property_collection_property_0 = cast(model.Property, my_property_collection.get_referable("MyProperty0"))
+print(
+    f"my_property_collection_property_0: "
+    f"id_short = {my_property_collection_property_0}, "
+    f"value = {my_property_collection_property_0.value}"
+)
+
+# Step 2.2.2: Access a Property within a SubmodelElementCollection via its IdShortPath
+my_property_collection_property_1 = cast(
+    model.Property,
+    submodel.get_referable(["MyPropertyCollection", "MyProperty1"])
+)
+print(
+    f"my_property_collection_property_1: "
+    f"id_short = {my_property_collection_property_1}, "
+    f"value = {my_property_collection_property_1.value}\n"
+)
+
+# Step 2.3: Navigate through a SubmodelElementList of Properties
+# Step 2.3.1: Access a Property within a SubmodelElementList step by step via its index
+my_property_list = cast(model.SubmodelElementList, submodel.get_referable("MyPropertyList"))
+my_property_list_property_0 = cast(model.Property, my_property_list.get_referable("0"))
+print(
+    f"my_property_list_property_0: "
+    f"id_short = {my_property_list_property_0}, "
+    f"value = {my_property_list_property_0.value}"
+)
+
+# Step 2.3.2: Access a Property within a SubmodelElementList via its IdShortPath
+my_property_list_property_1 = cast(model.Property, submodel.get_referable(["MyPropertyList", "1"]))
+print(
+    f"my_property_list_property_1: "
+    f"id_short = {my_property_list_property_1}, "
+    f"value = {my_property_list_property_1.value}\n"
+)
+
+# Step 2.4: Navigate through a SubmodelElementList of SubmodelElementCollections
+# Step 2.4.1: Access a Property within a SubmodelElementList of SubmodelElementCollections step by step via its index
+# and IdShort
+my_collection_list = cast(model.SubmodelElementList, submodel.get_referable("MyCollectionList"))
+my_collection_list_collection_0 = cast(model.SubmodelElementCollection, my_collection_list.get_referable("0"))
+my_collection_list_collection_0_property_0 = cast(
+    model.Property,
+    my_collection_list_collection_0.get_referable("MyProperty")
+)
+print(
+    f"my_collection_list_collection_0_property_0: "
+    f"id_short = {my_collection_list_collection_0_property_0}, "
+    f"value = {my_collection_list_collection_0_property_0.value}"
+)
+
+# Step 2.4.2: Access a Property within a SubmodelElementList of SubmodelElementCollections via its IdShortPath
+my_collection_list_collection_2_property_0 = cast(
+    model.Property,
+    submodel.get_referable(["MyCollectionList", "2", "MyProperty"])
+)
+print(
+    f"my_collection_list_collection_2_property_0: "
+    f"id_short = {my_collection_list_collection_2_property_0}, "
+    f"value = {my_collection_list_collection_2_property_0.value}"
+)

sdk/basyx/aas/model/provider.py

@@ -78,20 +78,6 @@ def sync(self, other: Iterable[_VALUE], overwrite: bool) -> Tuple[int, int, int]
         for value in other:
             if value in self:
                 if overwrite:
-
-                    # TODO: This is a quick fix. Yes it works. The underlying problem with the subclass
-                    # `LocalFileIdentifiableStore` will be solved in a separate issue
-                    # (https://github.com/eclipse-basyx/basyx-python-sdk/issues/438).
-                    # Think of this as pythonic duct tape.
-                    #
-                    # The problem is that the `_object_cache` isn't initialised together with the
-                    # `LocalFileIdentifiableStore`, leading to an error when `discard()` is called on the empty cache.
-                    # The for-loop calls `__iter__` calls `get_identifiable_by_hash()` calls
-                    # `self._object_cache[obj.id] = obj`, adding all identifiables to the cache and therefore avoiding
-                    # the error.
-                    for element in self:
-                        pass
-
                     self.discard(value)
                     self.add(value)
                     overwritten += 1

sdk/basyx/aas/util/identification.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.