Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aasx.adapter: fix semantic id type deserialization of ModelReference #337

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

aasx.adapter: fix semantic id type deserialization of ModelReference #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa5d249
aas.adapter: skip writing `ExternalReference`s without log message
JGrothoff Nov 18, 2024
3de9498
aas.adapter.json: deserialize ModelReferences with last key type
JGrothoff Nov 18, 2024
f8b232a
aas.adapter: check semantic ids have same model reference type
JGrothoff Nov 21, 2024
a441d20
aas.adapter: raise error when model ref to cd is missing
JGrothoff Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions sdk/basyx/aas/adapter/aasx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,19 +402,22 @@ def write_aas(self,
concept_descriptions: List[model.ConceptDescription] = []
for identifiable in objects_to_be_written:
for semantic_id in traversal.walk_semantic_ids_recursive(identifiable):
if isinstance(semantic_id, model.ExternalReference):
continue
if not isinstance(semantic_id, model.ModelReference) \
or semantic_id.type is not model.ConceptDescription:
logger.info("semanticId %s does not reference a ConceptDescription.", str(semantic_id))
continue
try:
cd = semantic_id.resolve(object_store)
except KeyError:
logger.info("ConceptDescription for semanticId %s not found in object store.", str(semantic_id))
continue
raise KeyError("ConceptDescription for semanticId {} not found in object store.".format(
str(semantic_id)))
except model.UnexpectedTypeError as e:
logger.error("semanticId %s resolves to %s, which is not a ConceptDescription",
str(semantic_id), e.value)
continue
raise model.UnexpectedTypeError(
e.value,
"semanticId {} resolves to {}, which is not a ConceptDescription".format(
str(semantic_id), e.value))
concept_descriptions.append(cd)
objects_to_be_written.update(concept_descriptions)

Expand Down
6 changes: 4 additions & 2 deletions sdk/basyx/aas/adapter/json/json_deserialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,12 @@ def _construct_model_reference(cls, dct: Dict[str, object], type_: Type[T], obje
if reference_type is not model.ModelReference:
raise ValueError(f"Expected a reference of type {model.ModelReference}, got {reference_type}!")
keys = [cls._construct_key(key_data) for key_data in _get_ts(dct, "keys", list)]
if keys and not issubclass(KEY_TYPES_CLASSES_INVERSE.get(keys[-1].type, type(None)), type_):
last_key_type = KEY_TYPES_CLASSES_INVERSE.get(keys[-1].type, type(None))
if keys and not issubclass(last_key_type, type_):
logger.warning("type %s of last key of reference to %s does not match reference type %s",
keys[-1].type.name, " / ".join(str(k) for k in keys), type_.__name__)
return object_class(tuple(keys), type_, cls._construct_reference(_get_ts(dct, 'referredSemanticId', dict))
return object_class(tuple(keys), last_key_type,
cls._construct_reference(_get_ts(dct, 'referredSemanticId', dict))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope this won't introduce side effects, as the _construct_model_reference method is used frequently.
We could addittionaly add a check and fallback to type_ if last_key_type is type(None).

if 'referredSemanticId' in dct else None)

@classmethod
Expand Down
10 changes: 9 additions & 1 deletion sdk/basyx/aas/examples/data/_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,15 @@ def _check_has_semantics_equal(self, object_: model.HasSemantics, expected_objec
:param expected_object: The expected HasSemantic object
:return: The value of expression to be used in control statements
"""
self.check_attribute_equal(object_, "semantic_id", expected_object.semantic_id)
if self.check_attribute_equal(object_, "semantic_id", expected_object.semantic_id) and \
isinstance(expected_object.semantic_id, model.ModelReference):
if self.check(isinstance(object_.semantic_id, model.ModelReference),
'{} must be a ModelReference'.format(repr(object_))): # type: ignore
self.check(
object_.semantic_id.type == expected_object.semantic_id.type, # type: ignore
'ModelReference type {} of {} must be equal to {}'.format(object_.semantic_id.type, # type: ignore
repr(object_),
expected_object.semantic_id.type))
for suppl_semantic_id in expected_object.supplemental_semantic_id:
given_semantic_id = self._find_reference(suppl_semantic_id, object_.supplemental_semantic_id)
self.check(given_semantic_id is not None, f"{object_!r} must have supplementalSemanticId",
Expand Down
Loading