PyI40AAS issueshttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues2021-02-25T11:11:48+01:00https://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/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/126model: Add Iterable[...] with correct specialization as base class of Namespa...2021-01-12T13:30:48+01:00Michael Thiesmodel: Add Iterable[...] with correct specialization as base class of Namespace and inheriting classeshttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/80Missing `jsonschema` in `requirements.txt`2020-06-14T22:10:09+02:00Sebastian Heppners.heppner@iat.rwth-aachen.deMissing `jsonschema` in `requirements.txt`As far as I see, it is only used in the tests, though, so does it need to be added to the requirements?As far as I see, it is only used in the tests, though, so does it need to be added to the requirements?https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/75Change name of `timeout` parameter of update method2020-10-28T17:08:34+01:00Michael ThiesChange name of `timeout` parameter of update methodThe `timeout` is more like a "caching expiration timeout" of the object, not a timeout for the actual update.
Thus, we should rename it to avoid confusion.
Maybe we can introduce an additional (optional) timout parameter for the actual...The `timeout` is more like a "caching expiration timeout" of the object, not a timeout for the actual update.
Thus, we should rename it to avoid confusion.
Maybe we can introduce an additional (optional) timout parameter for the actual update (e.g. the HTTP timeout for the HTTP client and CouchDB client).Stable library APIhttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/74adapter.xml: Apply customizing pattern with class methods of json_deserializa...2020-10-28T09:26:32+01:00Michael Thiesadapter.xml: Apply customizing pattern with class methods of json_deserialization to xml_deserializationIn the `aas.adapter.json.json_deserialization` we introduced an elegant pattern to allow customizing the parser behaviour by subclassing the `AASFromJsonDecoder` class and overriding its constructor methods. This is used by the CouchDB a...In the `aas.adapter.json.json_deserialization` we introduced an elegant pattern to allow customizing the parser behaviour by subclassing the `AASFromJsonDecoder` class and overriding its constructor methods. This is used by the CouchDB adapter for example, to construct subclasses of the normal AAS model classes.
We could apply the same pattern to the `xml_deserialization` module.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/73adapter.json: Use error handling pattern from xml_deserialization for json_de...2021-01-12T13:37:17+01:00Michael Thiesadapter.json: Use error handling pattern from xml_deserialization for json_deserializationIn the `aas.adapter.xml.xml_deserialization` we introduced an elegant error handling pattern to reduce code dupliction, consisting of the `_failsafe_construct()` and `_failsafe_construct_multiple()`, which wrap a constructor function to ...In the `aas.adapter.xml.xml_deserialization` we introduced an elegant error handling pattern to reduce code dupliction, consisting of the `_failsafe_construct()` and `_failsafe_construct_multiple()`, which wrap a constructor function to handle its raised Exceptions. We should apply the same pattern to the JSON deserialization.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/32example: Move example data generators into package examples.data2020-01-21T12:24:27+01:00Michael Thiesexample: Move example data generators into package examples.datahttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/29model: Rename instance attributes to not contain trailing underscores2020-01-28T15:33:51+01:00Michael Thiesmodel: Rename instance attributes to not contain trailing underscoresTrailing underscores are nice for function parameters (including initializer parameters) to avoid name conflicts with global denominators (like module names and builtins). However, instance attributes form an own namespace and don't conf...Trailing underscores are nice for function parameters (including initializer parameters) to avoid name conflicts with global denominators (like module names and builtins). However, instance attributes form an own namespace and don't conflict with global denominators. Thus, trailing underscores are not required for them and I would prefer removing them to have less confusing attribute names.
However this should not be changed, before we merged the `features/json_adapter` branch.Leon Mauritz MöllerLeon Mauritz Möller