aas_core_rc02.jsonization

Provide de/serialization of AAS classes to/from JSON.

We can not use one-pass deserialization for JSON since the object properties do not have fixed order, and hence we can not read modelType property ahead of the remaining properties.

class aas_core3_rc02.jsonization.PropertySegment(instance: Mapping[str, Any], name: str)

Represent a property on a path to the erroneous value.

__init__(instance: Mapping[str, Any], name: str) → None

Initialize with the given values.

instance: Final[Mapping[str, Any]]

Instance that contains the property

name: Final[str]

Name of the property

class aas_core3_rc02.jsonization.IndexSegment(container: Iterable[Any], index: int)

Represent an index access on a path to the erroneous value.

__init__(container: Iterable[Any], index: int) → None

Initialize with the given values.

container: Final[Iterable[Any]]

Container that contains the item

index: Final[int]

Index of the item

class aas_core3_rc02.jsonization.Path

Represent the relative path to the erroneous value.

__init__() → None

Initialize as an empty path.

property segments: Sequence[Union[PropertySegment, IndexSegment]]

Get the segments of the path.

__str__() → str

Return str(self).

exception aas_core3_rc02.jsonization.DeserializationException(cause: str)

Signal that the JSON de-serialization could not be performed.

__init__(cause: str) → None

Initialize with the given cause and an empty path.

cause: Final[str]

Human-readable explanation of the exception’s cause

path: Final[Path]

Relative path to the erroneous value

aas_core3_rc02.jsonization.has_semantics_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → HasSemantics

Parse an instance of types.HasSemantics from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.HasSemantics

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.extension_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Extension

Parse an instance of types.Extension from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Extension

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.has_extensions_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → HasExtensions

Parse an instance of types.HasExtensions from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.HasExtensions

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.referable_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Referable

Parse an instance of types.Referable from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.Referable

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.identifiable_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Identifiable

Parse an instance of types.Identifiable from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.Identifiable

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.modeling_kind_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ModelingKind

Convert the JSON-able structure jsonable to a literal of types.ModelingKind.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.has_kind_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → HasKind

Parse an instance of types.HasKind from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.HasKind

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.has_data_specification_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → HasDataSpecification

Parse an instance of types.HasDataSpecification from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.HasDataSpecification

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.administrative_information_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AdministrativeInformation

Parse an instance of types.AdministrativeInformation from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.AdministrativeInformation

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.qualifiable_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Qualifiable

Parse an instance of types.Qualifiable from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.Qualifiable

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.qualifier_kind_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → QualifierKind

Convert the JSON-able structure jsonable to a literal of types.QualifierKind.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.qualifier_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Qualifier

Parse an instance of types.Qualifier from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Qualifier

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.asset_administration_shell_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AssetAdministrationShell

Parse an instance of types.AssetAdministrationShell from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.AssetAdministrationShell

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.asset_information_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AssetInformation

Parse an instance of types.AssetInformation from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.AssetInformation

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.resource_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Resource

Parse an instance of types.Resource from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Resource

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.asset_kind_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AssetKind

Convert the JSON-able structure jsonable to a literal of types.AssetKind.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.specific_asset_id_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → SpecificAssetId

Parse an instance of types.SpecificAssetId from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.SpecificAssetId

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.submodel_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Submodel

Parse an instance of types.Submodel from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Submodel

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.submodel_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → SubmodelElement

Parse an instance of types.SubmodelElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.SubmodelElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.relationship_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → RelationshipElement

Parse an instance of types.RelationshipElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.RelationshipElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.aas_submodel_elements_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AasSubmodelElements

Convert the JSON-able structure jsonable to a literal of types.AasSubmodelElements.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.submodel_element_list_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → SubmodelElementList

Parse an instance of types.SubmodelElementList from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.SubmodelElementList

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.submodel_element_collection_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → SubmodelElementCollection

Parse an instance of types.SubmodelElementCollection from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.SubmodelElementCollection

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataElement

Parse an instance of types.DataElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.DataElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.property_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Property

Parse an instance of types.Property from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Property

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.multi_language_property_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → MultiLanguageProperty

Parse an instance of types.MultiLanguageProperty from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.MultiLanguageProperty

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.range_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Range

Parse an instance of types.Range from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Range

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.reference_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ReferenceElement

Parse an instance of types.ReferenceElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.ReferenceElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.blob_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Blob

Parse an instance of types.Blob from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Blob

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.file_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → File

Parse an instance of types.File from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.File

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.annotated_relationship_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → AnnotatedRelationshipElement

Parse an instance of types.AnnotatedRelationshipElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.AnnotatedRelationshipElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.entity_type_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → EntityType

Convert the JSON-able structure jsonable to a literal of types.EntityType.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.entity_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Entity

Parse an instance of types.Entity from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Entity

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.direction_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Direction

Convert the JSON-able structure jsonable to a literal of types.Direction.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.state_of_event_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → StateOfEvent

Convert the JSON-able structure jsonable to a literal of types.StateOfEvent.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.event_payload_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → EventPayload

Parse an instance of types.EventPayload from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.EventPayload

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.event_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → EventElement

Parse an instance of types.EventElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.EventElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.basic_event_element_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → BasicEventElement

Parse an instance of types.BasicEventElement from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.BasicEventElement

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.operation_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Operation

Parse an instance of types.Operation from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Operation

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.operation_variable_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → OperationVariable

Parse an instance of types.OperationVariable from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.OperationVariable

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.capability_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Capability

Parse an instance of types.Capability from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Capability

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.concept_description_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ConceptDescription

Parse an instance of types.ConceptDescription from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.ConceptDescription

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.reference_types_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ReferenceTypes

Convert the JSON-able structure jsonable to a literal of types.ReferenceTypes.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.reference_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Reference

Parse an instance of types.Reference from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Reference

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.key_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Key

Parse an instance of types.Key from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Key

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.key_types_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → KeyTypes

Convert the JSON-able structure jsonable to a literal of types.KeyTypes.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_type_def_xsd_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataTypeDefXsd

Convert the JSON-able structure jsonable to a literal of types.DataTypeDefXsd.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.lang_string_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → LangString

Parse an instance of types.LangString from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.LangString

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.environment_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → Environment

Parse an instance of types.Environment from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.Environment

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_specification_content_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataSpecificationContent

Parse an instance of types.DataSpecificationContent from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Concrete instance of types.DataSpecificationContent

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.embedded_data_specification_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → EmbeddedDataSpecification

Parse an instance of types.EmbeddedDataSpecification from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.EmbeddedDataSpecification

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_type_iec_61360_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataTypeIEC61360

Convert the JSON-able structure jsonable to a literal of types.DataTypeIEC61360.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.level_type_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → LevelType

Convert the JSON-able structure jsonable to a literal of types.LevelType.

Parameters

jsonable – JSON-able structure to be parsed

Returns

parsed literal

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.value_reference_pair_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ValueReferencePair

Parse an instance of types.ValueReferencePair from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.ValueReferencePair

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.value_list_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → ValueList

Parse an instance of types.ValueList from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.ValueList

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_specification_iec_61360_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataSpecificationIEC61360

Parse an instance of types.DataSpecificationIEC61360 from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.DataSpecificationIEC61360

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.data_specification_physical_unit_from_jsonable(jsonable: Union[bool, int, float, str, Sequence[Any], Mapping[str, Any]]) → DataSpecificationPhysicalUnit

Parse an instance of types.DataSpecificationPhysicalUnit from the JSON-able structure jsonable.

Parameters

jsonable – structure to be parsed

Returns

Parsed instance of types.DataSpecificationPhysicalUnit

Raise

DeserializationException if unexpected jsonable

aas_core3_rc02.jsonization.to_jsonable(that: Class) → Union[bool, int, float, str, List[Any], MutableMapping[str, Any]]

Convert that to a JSON-able structure.

Parameters

that – AAS data to be recursively converted to a JSON-able structure

Returns

JSON-able structure which can be further encoded with, e.g., json