Lehrstuhl für Informations- und Automatisierungssysteme issueshttps://git.rwth-aachen.de/groups/acplt/-/issues2021-10-28T21:15:44+02:00https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/119Remove Asset object2021-10-28T21:15:44+02:00Michael ThiesRemove Asset objectAfter updating to DotAAS version 3.0-rc1, we can remove the Asset object from our model, since it does not provide any information anymore.
To do so, we should:
* remove class `Asset`
* drop Assets in deserialized files silently
* still...After updating to DotAAS version 3.0-rc1, we can remove the Asset object from our model, since it does not provide any information anymore.
To do so, we should:
* remove class `Asset`
* drop Assets in deserialized files silently
* still, add an empty `Assets` list to serlized files to stay compliant to the schemas
* remove KeyElements.ASSET
* change Keys with type==Asset to type==GlobalReference in deserialized files silently
* Mention how we handled assets in (module) docstring(s)https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/115These docstrings may need a rework2021-02-25T11:11:48+01:00Sebastian Heppners.heppner@iat.rwth-aachen.deThese docstrings may need a reworkThis is a collection of docstrings that may need some reformulating. I am happy to provide it, though would like to discuss the content beforhand.
* [x] `model.__init__`: Update docstring
* [x] `aas` module docstring and `aas.Asset` sho...This is a collection of docstrings that may need some reformulating. I am happy to provide it, though would like to discuss the content beforhand.
* [x] `model.__init__`: Update docstring
* [x] `aas` module docstring and `aas.Asset` should have a note about how `Assets` are handled now
* [x] `aas.View`: Resolve "Todo: What does this do exactly?" and with resolving, update docstring to be clear about what it does.
* [x] `base.Qualifiable`: Unclear formulation
* [x] `base.HasExtension`: Unclear explanation of attribute `namespace_element_sets`
* [x] `base.Referable.parent`: Confusing by mentioning a `Reference`, even though it is actually a `Namespace`
* [x] `base.Reference.key`: Unclear formulation
* [x] `base.UnexpectedTypeError`: `base.Reference` does not have a method `resolve()`
* [x] `base.ValueReferencePair`: Unclear formulation, does not have any reference to any other part of the meta-model
* [x] `provider.AbstractObjectProvider.get_identifiable`:
* Docstring says "find identifiable by id_short", parameter is of type `base.Identifier` though.
* Missing docstring for ":param: identifier"
* ":raises: KeyError: Mentioning `Referable` here, while correct, may be confusing to some. Maybe use `Identifiable` here?
* [x] `provider.AbstractObjectStore.update`: Missing docstring
* [x] `submodel.OperationVariable`: is in fact, not a `SubmodelElement`
* [x] `submodel.RelationshipElement`: The mentioned subject-object relation is unclear to me. Disregard this, if this a concept I simply don't know
* [x] `Referable.display_name` description is unclear
* [x] `base.Formula`: If we don't support it anymore (in V30RC1, because formulas are not unambiguously identifiable), mention this somewhere where it makes sense
* [x] `aas.adapter.__init__`: Update docstring
* [x] `adapter.json.json_deserialization`: Second paragraph of module docstring seems outdated
* [x] `model.base.LangStringSet`: Has no Entry in the documentation (Due to it being Dict[str, str]) and no class
* [x] `model.base.ValueList`: Has not Entry in the documentation
* [x] `backend.__init__`: Missing module docstring
* [x] `backend.couchdb`: Missing module docstringSebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.dehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/113Make DictSupplementaryFileContainer iterable2020-11-25T10:42:59+01:00Igor GarmaevMake DictSupplementaryFileContainer iterableThe class `DictSupplementaryFileContainer` which will be used as file store is currently not iterable. I think it would make sense make it iterable through `_name_map`. Now it is not possible to get any file stored in `DictSupplementaryF...The class `DictSupplementaryFileContainer` which will be used as file store is currently not iterable. I think it would make sense make it iterable through `_name_map`. Now it is not possible to get any file stored in `DictSupplementaryFileContainer` with public methods or members without filenamehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/111compliance tool: Delete function "check if a given xml or json file is compli...2020-11-19T14:26:00+01:00Torben Minycompliance tool: Delete function "check if a given xml or json file is compliant to the official schema"This function suggests that a file conforms to the schema, but this is not true since many constraints are not included in the schema.This function suggests that a file conforms to the schema, but this is not true since many constraints are not included in the schema.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/110make `Namespace` iterable2020-11-25T10:42:59+01:00Leon Mauritz Möllermake `Namespace` iterable@zrgt suggested on Zulip, that classes like `Submodel` and `SubmodelElementCollection` should be iterable.
@mhthies suggested to make Namespaces iterable with an implementation similar to the following:
```py
class Namespace:
[…]
...@zrgt suggested on Zulip, that classes like `Submodel` and `SubmodelElementCollection` should be iterable.
@mhthies suggested to make Namespaces iterable with an implementation similar to the following:
```py
class Namespace:
[…]
def __iter__(self):
return itertools.chain.from_iterable(self.namespace_element_sets)
```
This would make all classes which inherit from `Namespace` iterable over their contained `NamespaceSet`s, namely `AssetAdministrationShell`, `Submodel`, `SubmodelElementCollection`, `AnnotatedRelationshipElement` and `Entity`.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/107aasx: OPCPackageWriter.write_relationships() is called twice when submodel_sp...2020-11-02T15:02:36+01:00Leon Mauritz Mölleraasx: OPCPackageWriter.write_relationships() is called twice when submodel_split_parts is TrueThe following warnings are logged when running the AASX tests:
```
/usr/lib/python3.8/zipfile.py:1517: UserWarning: Duplicate name: 'aasx/https___acplt_org_Test_AssetAdministrationShell/_rels/https___acplt_org_Test_AssetAdministrationShe...The following warnings are logged when running the AASX tests:
```
/usr/lib/python3.8/zipfile.py:1517: UserWarning: Duplicate name: 'aasx/https___acplt_org_Test_AssetAdministrationShell/_rels/https___acplt_org_Test_AssetAdministrationShell.aas.xml.rels'
return self._open_to_write(zinfo, force_zip64=force_zip64)
/usr/lib/python3.8/zipfile.py:1517: UserWarning: Duplicate name: 'aasx/https___acplt_org_Test_AssetAdministrationShell/_rels/https___acplt_org_Test_AssetAdministrationShell.aas.json.rels'
return self._open_to_write(zinfo, force_zip64=force_zip64)
```
These are caused by `AASXWriter.write_aas()` calling `write_relationships()` by itself when `submodel_split_parts` is `True`. Since `write_aas()` also calls `write_aas_objects()`, which also writes relationships, this results in two calls to `write_relationships()` for the same AAS, which in turn results in duplicate names being written to the file.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/105object store: Add functionality to get a referable object by path (Identifica...2020-10-28T16:44:53+01:00Torben Minyobject store: Add functionality to get a referable object by path (Identification, List(IdShort))https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/100model: Check idShort on change for duplicates in parent namespace2021-01-05T10:12:08+01:00Michael Thiesmodel: Check idShort on change for duplicates in parent namespacehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/99model: Most repr() funcs don't fulfill the requirement obj == eval(repr(obj))2020-11-16T15:08:43+01:00Igor Garmaevmodel: Most repr() funcs don't fulfill the requirement obj == eval(repr(obj)) Most repr() funcs of classes don't fulfill the requirement obj == eval(repr(obj))
For example:
repr of Key:
Current:
```python
def __repr__(self) -> str:
return "Key(local={}, id_type={}, value={})".format(self.local, sel... Most repr() funcs of classes don't fulfill the requirement obj == eval(repr(obj))
For example:
repr of Key:
Current:
```python
def __repr__(self) -> str:
return "Key(local={}, id_type={}, value={})".format(self.local, self.id_type.name, self.value)
```
Should be:
```python
def __repr__(self) -> str:
return "Key(type_={}, local={}, id_type={}, value={})".format(self.type, self.local, self.id_type.name, repr(self.value))
```
repr of Identifiable:
Current version looks like __str__ but not __repr__:
```python
def __repr__(self) -> str:
return "Identifier({}={})".format(self.id_type.name, self.id)
```
Should be:
```python
def __str__(self) -> str:
return "Identifier({}={})".format(self.id_type.name, self.id)
def __repr__(self) -> str:
return "Identifier(id_={}, id_type={})".format(repr(self.id), self.id_type.name)
```https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/98model: Bug in __repr__ of AdministrativeInformation2020-11-25T10:42:56+01:00Igor Garmaevmodel: Bug in __repr__ of AdministrativeInformationi is missed in "AdminstrativeInformation"
```python
def __repr__(self) -> str:
return "AdminstrativeInformation(version={}, revision={})".format(self.version, self.revision)
```i is missed in "AdminstrativeInformation"
```python
def __repr__(self) -> str:
return "AdminstrativeInformation(version={}, revision={})".format(self.version, self.revision)
```https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/97model: Remove `_`-suffix from parameters of `__init__` functions2020-11-25T10:42:57+01:00Leon Mauritz Möllermodel: Remove `_`-suffix from parameters of `__init__` functionsRemove `_`-suffix from parameters like `submodel_` and `security_` in the `__init__` function of all classes of the `model`, as Igor suggested on Zulip.Remove `_`-suffix from parameters like `submodel_` and `security_` in the `__init__` function of all classes of the `model`, as Igor suggested on Zulip.Stable library APIhttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/96examples.data.example_aas: Missing namespace initialization for `create_examp...2020-10-13T12:24:39+02:00Sebastian Heppners.heppner@iat.rwth-aachen.deexamples.data.example_aas: Missing namespace initialization for `create_example_submodel`If you try:
```
test_submodel = create_example_submodel()
test_submodel.get_referable("ExampleProperty")
```
you recieve:
```
KeyError: 'Referable with id_short ExampleProperty not found in this namespace'
```
This function (and possi...If you try:
```
test_submodel = create_example_submodel()
test_submodel.get_referable("ExampleProperty")
```
you recieve:
```
KeyError: 'Referable with id_short ExampleProperty not found in this namespace'
```
This function (and possibly all the other `create_example...`-functions) is/are missing the creation of a `NamespaceSet` containing all the sub-elements, something like:
```
example_submodel_namespace_set = NamespaceSet(parent=example_submodel, items=[example_property, ...])
example_submodel.namespace_element_sets = [example_submodel_namespace_set]
```
Though, shouldn't these namespaces in general be created automatically with initializing the objects?https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/95model: Make abstract classes really abstract2020-11-25T10:42:57+01:00Igor Garmaevmodel: Make abstract classes really abstractNow all classes that are meant to be abstract are instantiable. That means they are not abstract. To solve the issue these classes must have abstract methods. I suggest to make `__init__` abstract for all these classesNow all classes that are meant to be abstract are instantiable. That means they are not abstract. To solve the issue these classes must have abstract methods. I suggest to make `__init__` abstract for all these classeshttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/94aasx: Allow manual specification objects to be written to package2020-10-28T17:12:35+01:00Michael Thiesaasx: Allow manual specification objects to be written to packagehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/93aasx: Support AASX packages with XML + JSON parts (redundant serialization of...2020-10-28T11:52:35+01:00Michael Thiesaasx: Support AASX packages with XML + JSON parts (redundant serialization of same objects)https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/92compliance_tool: Use pretty-printing in example files2020-10-07T10:45:28+02:00Michael Thiescompliance_tool: Use pretty-printing in example filesThe compliance_tool should use the `pretty_print=True` resp. `indent=4` for the XML/JSON serializers when creating example files.
This way, it's easier to manually inspect the resulting files and a possible deserializer errors are easie...The compliance_tool should use the `pretty_print=True` resp. `indent=4` for the XML/JSON serializers when creating example files.
This way, it's easier to manually inspect the resulting files and a possible deserializer errors are easier to locate by their line numbers.Torben MinyTorben Minyhttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/90model: dataType of IEC61360ConceptDescription should be optional2020-10-07T17:17:51+02:00Torben Minymodel: dataType of IEC61360ConceptDescription should be optional**EDIT (MT)**: This is an issue in our Metamodel implementation. It must also be fixed in the deserialization and serialization accordingly.**EDIT (MT)**: This is an issue in our Metamodel implementation. It must also be fixed in the deserialization and serialization accordingly.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/88Inability to test for parameter `relative_path` in calls of `backends.Backend...2020-10-28T17:08:35+01:00Sebastian Heppners.heppner@iat.rwth-aachen.deInability to test for parameter `relative_path` in calls of `backends.Backend.update_object()` and `backends.Backend.commit_object()` from `model.base.Referable` using `unittest.mock.Mock`Especially during execution of the `model.base.Referable.commit()` function, the `relative_path` variable is built iteratively by traversing the Referable-tree. Whenever there is a nonempty source, the `backends.Backend.commit_object()` ...Especially during execution of the `model.base.Referable.commit()` function, the `relative_path` variable is built iteratively by traversing the Referable-tree. Whenever there is a nonempty source, the `backends.Backend.commit_object()` function is called with the current `relative_path`. Therefore, the `relative_path` variable is likely to change after a call. This is impractical, because `unittest.mock.call` seems to only log a reference to the variables that were used in that call, rather than saving a duplicate of the current state of those variables during function call.
Here is a minimal example that shows this behavior:
```
from unittest import mock
test_mock = mock.Mock()
test_parameter = ["only_entry_of_this_list"]
test_mock(argument=test_parameter)
test_parameter.append("another_entry_of_this_list")
test_mock.assert_has_calls([mock.call(argument=["only_entry_of_this_list"])])
```
leads to:
```
AssertionError: Calls not found.
Expected: [call(argument=['only_entry_of_this_list'])]
Actual: [call(argument=['only_entry_of_this_list', 'another_entry_of_this_list'])]
```
Therefore, it is impossible to check, if the `relative_path` has been correct during the time of the function call, using the `unittest.mock.Mock`-object.
While I have reviewed with the debugger, that the function gets called with the correct `relative_path` at each time, I don't see a way to "prove it" using unittests, without altering the actual code to allow for testing, which in my opinion shouldn't really be done.Sebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.dehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/87REST-API: vagueness/issues in specification2020-09-29T14:55:18+02:00Leon Mauritz MöllerREST-API: vagueness/issues in specificationThis is a collection of vagueness and issues of the [REST API specification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1):
- It is unclear how exactly the [depth parameter](https://app.swaggerhub.co...This is a collection of vagueness and issues of the [REST API specification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1):
- It is unclear how exactly the [depth parameter](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Asset%20Administration%20Shell%20Interface/RetrieveAssetAdministrationShell) should behave, or more precisely, which effect the possible values `core`, `deep`, `embedded` and `resolve` should have on the returned object.
- The [AAS respository interface](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Asset%20Administration%20Shell%20Repository%20Interface/RetrieveAssetAdministrationShellFromRepository) lacks specification.
- The response format is not specified for routes [`/submodel/values`](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Submodel%20Interface/RetrieveSubmodelAsValueObject) and [`/submodel/table`](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Submodel%20Interface/RetrieveSubmodelAsTable).
- Does the parameter [`identification.id`](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Asset%20Administration%20Shell%20Interface/RetrieveAllSubmodels) contain the whole `identification` object or just the id attribute? Or does it work like a **str in str** filter?
- Syntax and semantics are unspecified for parameter `filter` of [`/aas/views`](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-REST-API/v1#/Asset%20Administration%20Shell%20Interface/RetrieveAllViews).https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/85Improved update()/commit() functionality2020-11-02T09:16:47+01:00Michael ThiesImproved update()/commit() functionalityWe plan a full redesign of the `update()`/`commit()` functionality of AAS objects for synchronization with an external data source.
* Instead of overriding these functions for different data sources, all `Referable` objects will include...We plan a full redesign of the `update()`/`commit()` functionality of AAS objects for synchronization with an external data source.
* Instead of overriding these functions for different data sources, all `Referable` objects will include a `source` attribute with an URI representation of their data source. The URI's schema is used to determine the correct backend/client.
* `update()` and `commit()` should always effect the object itself and all (recursively) included objects
* If the object itself has no data source/backend itself, the next higher object with a data source is used to update the object's data.
* After the update, all included objects that are linked with an own data source are updated recursively in a top-down manner.
* An object is always committed to its own data source and the data sources of all its ancestors in the object hierarchy.
* The included objects are committed recursively. (TODO: Define order of committing.)Stable library APISebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.de