aas_core3_2.xmlization

Read and write model instances as XML.

For reading, we provide different reading functions, each handling a different kind of input. All the reading functions operate in one pass, i.e., the source is read incrementally and the complete XML is not held in memory.

We provide the following four reading functions (where X represents the name of the class):

  1. X_from_iterparse reads from a stream of (event, element) tuples coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]. If you do not trust the source, please consider using defusedxml.ElementTree.

  2. X_from_stream reads from the given text stream.

  3. X_from_file reads from a file on disk.

  4. X_from_str reads from the given string.

The functions X_from_stream, X_from_file and X_from_str provide an extra parameter, has_iterparse, which allows you to use a parsing library different from xml.etree.ElementTree. For example, you can pass in defusedxml.ElementTree.

All XML elements are expected to live in the NAMESPACE. The elements of the XML-RPC subset, over which a JSON-able value is de/serialized, are the one exception: they live in no namespace at all.

For writing, use the function aas_core3_2.xmlization.write() which translates the instance of the model into an XML document and writes it in one pass to the stream.

The writing raises a SerializationException if it can not serialize the instance, be it because the stream failed or because a value could not be written. The path of the exception points to the culprit as a Python access expression, e.g., .submodels[0].id, so that you can find it in the instance which you handed over.

Here is an example usage how to de-serialize from a file:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.read_extension_from_file(
    path
)

# Do something with the ``instance``

Here is another code example where we serialize the instance:

import pathlib

import aas_core3_2.types as our_types
import aas_core3_2.xmlization as our_xmlization

instance = Extension(
   ... # some constructor arguments
)

pth = pathlib.Path(...)
with pth.open("wt") as fid:
    our_xmlization.write(instance, fid)
aas_core3_2.xmlization.NAMESPACE = 'https://admin-shell.io/aas/3/2'

XML namespace in which all the elements are expected to reside

aas_core3_2.xmlization.has_semantics_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HasSemantics[source]

Read an instance of types.HasSemantics from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.has_semantics_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasSemantics read from iterator

aas_core3_2.xmlization.has_semantics_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasSemantics[source]

Read an instance of types.HasSemantics from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.has_semantics_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HasSemantics in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasSemantics read from stream

aas_core3_2.xmlization.has_semantics_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasSemantics[source]

Read an instance of types.HasSemantics from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.has_semantics_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HasSemantics in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasSemantics read from path

aas_core3_2.xmlization.has_semantics_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasSemantics[source]

Read an instance of types.HasSemantics from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.has_semantics_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HasSemantics in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasSemantics read from text

aas_core3_2.xmlization.extension_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Extension[source]

Read an instance of types.Extension from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.extension_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Extension read from iterator

aas_core3_2.xmlization.extension_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Extension[source]

Read an instance of types.Extension from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.extension_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Extension in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Extension read from stream

aas_core3_2.xmlization.extension_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Extension[source]

Read an instance of types.Extension from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.extension_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Extension in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Extension read from path

aas_core3_2.xmlization.extension_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Extension[source]

Read an instance of types.Extension from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.extension_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Extension in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Extension read from text

aas_core3_2.xmlization.has_extensions_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HasExtensions[source]

Read an instance of types.HasExtensions from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.has_extensions_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasExtensions read from iterator

aas_core3_2.xmlization.has_extensions_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasExtensions[source]

Read an instance of types.HasExtensions from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.has_extensions_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HasExtensions in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasExtensions read from stream

aas_core3_2.xmlization.has_extensions_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasExtensions[source]

Read an instance of types.HasExtensions from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.has_extensions_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HasExtensions in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasExtensions read from path

aas_core3_2.xmlization.has_extensions_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasExtensions[source]

Read an instance of types.HasExtensions from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.has_extensions_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HasExtensions in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasExtensions read from text

aas_core3_2.xmlization.referable_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Referable[source]

Read an instance of types.Referable from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.referable_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Referable read from iterator

aas_core3_2.xmlization.referable_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Referable[source]

Read an instance of types.Referable from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.referable_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Referable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Referable read from stream

aas_core3_2.xmlization.referable_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Referable[source]

Read an instance of types.Referable from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.referable_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Referable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Referable read from path

aas_core3_2.xmlization.referable_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Referable[source]

Read an instance of types.Referable from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.referable_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Referable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Referable read from text

aas_core3_2.xmlization.identifiable_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Identifiable[source]

Read an instance of types.Identifiable from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.identifiable_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Identifiable read from iterator

aas_core3_2.xmlization.identifiable_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Identifiable[source]

Read an instance of types.Identifiable from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.identifiable_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Identifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Identifiable read from stream

aas_core3_2.xmlization.identifiable_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Identifiable[source]

Read an instance of types.Identifiable from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.identifiable_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Identifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Identifiable read from path

aas_core3_2.xmlization.identifiable_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Identifiable[source]

Read an instance of types.Identifiable from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.identifiable_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Identifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Identifiable read from text

aas_core3_2.xmlization.has_kind_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HasKind[source]

Read an instance of types.HasKind from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.has_kind_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasKind read from iterator

aas_core3_2.xmlization.has_kind_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasKind[source]

Read an instance of types.HasKind from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.has_kind_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HasKind in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasKind read from stream

aas_core3_2.xmlization.has_kind_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasKind[source]

Read an instance of types.HasKind from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.has_kind_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HasKind in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasKind read from path

aas_core3_2.xmlization.has_kind_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasKind[source]

Read an instance of types.HasKind from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.has_kind_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HasKind in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasKind read from text

aas_core3_2.xmlization.has_data_specification_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HasDataSpecification[source]

Read an instance of types.HasDataSpecification from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.has_data_specification_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasDataSpecification read from iterator

aas_core3_2.xmlization.has_data_specification_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasDataSpecification[source]

Read an instance of types.HasDataSpecification from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.has_data_specification_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HasDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasDataSpecification read from stream

aas_core3_2.xmlization.has_data_specification_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasDataSpecification[source]

Read an instance of types.HasDataSpecification from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.has_data_specification_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HasDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasDataSpecification read from path

aas_core3_2.xmlization.has_data_specification_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HasDataSpecification[source]

Read an instance of types.HasDataSpecification from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.has_data_specification_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HasDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HasDataSpecification read from text

aas_core3_2.xmlization.administrative_information_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AdministrativeInformation[source]

Read an instance of types.AdministrativeInformation from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.administrative_information_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AdministrativeInformation read from iterator

aas_core3_2.xmlization.administrative_information_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AdministrativeInformation[source]

Read an instance of types.AdministrativeInformation from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.administrative_information_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AdministrativeInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AdministrativeInformation read from stream

aas_core3_2.xmlization.administrative_information_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AdministrativeInformation[source]

Read an instance of types.AdministrativeInformation from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.administrative_information_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AdministrativeInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AdministrativeInformation read from path

aas_core3_2.xmlization.administrative_information_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AdministrativeInformation[source]

Read an instance of types.AdministrativeInformation from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.administrative_information_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AdministrativeInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AdministrativeInformation read from text

aas_core3_2.xmlization.qualifiable_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Qualifiable[source]

Read an instance of types.Qualifiable from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.qualifiable_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifiable read from iterator

aas_core3_2.xmlization.qualifiable_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifiable[source]

Read an instance of types.Qualifiable from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.qualifiable_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Qualifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifiable read from stream

aas_core3_2.xmlization.qualifiable_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifiable[source]

Read an instance of types.Qualifiable from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.qualifiable_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Qualifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifiable read from path

aas_core3_2.xmlization.qualifiable_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifiable[source]

Read an instance of types.Qualifiable from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.qualifiable_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Qualifiable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifiable read from text

aas_core3_2.xmlization.qualifier_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Qualifier[source]

Read an instance of types.Qualifier from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.qualifier_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifier read from iterator

aas_core3_2.xmlization.qualifier_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifier[source]

Read an instance of types.Qualifier from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.qualifier_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Qualifier in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifier read from stream

aas_core3_2.xmlization.qualifier_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifier[source]

Read an instance of types.Qualifier from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.qualifier_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Qualifier in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifier read from path

aas_core3_2.xmlization.qualifier_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Qualifier[source]

Read an instance of types.Qualifier from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.qualifier_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Qualifier in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Qualifier read from text

aas_core3_2.xmlization.asset_administration_shell_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AssetAdministrationShell[source]

Read an instance of types.AssetAdministrationShell from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_administration_shell_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShell read from iterator

aas_core3_2.xmlization.asset_administration_shell_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShell[source]

Read an instance of types.AssetAdministrationShell from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_administration_shell_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AssetAdministrationShell in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShell read from stream

aas_core3_2.xmlization.asset_administration_shell_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShell[source]

Read an instance of types.AssetAdministrationShell from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_administration_shell_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AssetAdministrationShell in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShell read from path

aas_core3_2.xmlization.asset_administration_shell_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShell[source]

Read an instance of types.AssetAdministrationShell from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_administration_shell_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AssetAdministrationShell in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShell read from text

aas_core3_2.xmlization.asset_information_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AssetInformation[source]

Read an instance of types.AssetInformation from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_information_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetInformation read from iterator

aas_core3_2.xmlization.asset_information_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetInformation[source]

Read an instance of types.AssetInformation from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_information_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AssetInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetInformation read from stream

aas_core3_2.xmlization.asset_information_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetInformation[source]

Read an instance of types.AssetInformation from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_information_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AssetInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetInformation read from path

aas_core3_2.xmlization.asset_information_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetInformation[source]

Read an instance of types.AssetInformation from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_information_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AssetInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetInformation read from text

aas_core3_2.xmlization.resource_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Resource[source]

Read an instance of types.Resource from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.resource_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Resource read from iterator

aas_core3_2.xmlization.resource_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Resource[source]

Read an instance of types.Resource from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.resource_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Resource in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Resource read from stream

aas_core3_2.xmlization.resource_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Resource[source]

Read an instance of types.Resource from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.resource_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Resource in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Resource read from path

aas_core3_2.xmlization.resource_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Resource[source]

Read an instance of types.Resource from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.resource_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Resource in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Resource read from text

aas_core3_2.xmlization.specific_asset_id_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SpecificAssetID[source]

Read an instance of types.SpecificAssetID from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.specific_asset_id_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SpecificAssetID read from iterator

aas_core3_2.xmlization.specific_asset_id_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SpecificAssetID[source]

Read an instance of types.SpecificAssetID from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.specific_asset_id_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SpecificAssetID in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SpecificAssetID read from stream

aas_core3_2.xmlization.specific_asset_id_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SpecificAssetID[source]

Read an instance of types.SpecificAssetID from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.specific_asset_id_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SpecificAssetID in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SpecificAssetID read from path

aas_core3_2.xmlization.specific_asset_id_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SpecificAssetID[source]

Read an instance of types.SpecificAssetID from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.specific_asset_id_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SpecificAssetID in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SpecificAssetID read from text

aas_core3_2.xmlization.submodel_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Submodel[source]

Read an instance of types.Submodel from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Submodel read from iterator

aas_core3_2.xmlization.submodel_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Submodel[source]

Read an instance of types.Submodel from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Submodel in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Submodel read from stream

aas_core3_2.xmlization.submodel_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Submodel[source]

Read an instance of types.Submodel from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Submodel in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Submodel read from path

aas_core3_2.xmlization.submodel_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Submodel[source]

Read an instance of types.Submodel from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Submodel in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Submodel read from text

aas_core3_2.xmlization.submodel_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElement[source]

Read an instance of types.SubmodelElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElement read from iterator

aas_core3_2.xmlization.submodel_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElement[source]

Read an instance of types.SubmodelElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElement read from stream

aas_core3_2.xmlization.submodel_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElement[source]

Read an instance of types.SubmodelElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElement read from path

aas_core3_2.xmlization.submodel_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElement[source]

Read an instance of types.SubmodelElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElement read from text

aas_core3_2.xmlization.relationship_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RelationshipElement[source]

Read an instance of types.RelationshipElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.relationship_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElement read from iterator

aas_core3_2.xmlization.relationship_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElement[source]

Read an instance of types.RelationshipElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.relationship_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElement read from stream

aas_core3_2.xmlization.relationship_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElement[source]

Read an instance of types.RelationshipElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.relationship_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElement read from path

aas_core3_2.xmlization.relationship_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElement[source]

Read an instance of types.RelationshipElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.relationship_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElement read from text

aas_core3_2.xmlization.submodel_element_list_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementList[source]

Read an instance of types.SubmodelElementList from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_list_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementList read from iterator

aas_core3_2.xmlization.submodel_element_list_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementList[source]

Read an instance of types.SubmodelElementList from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_list_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElementList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementList read from stream

aas_core3_2.xmlization.submodel_element_list_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementList[source]

Read an instance of types.SubmodelElementList from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_list_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElementList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementList read from path

aas_core3_2.xmlization.submodel_element_list_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementList[source]

Read an instance of types.SubmodelElementList from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_list_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElementList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementList read from text

aas_core3_2.xmlization.submodel_element_collection_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementCollection[source]

Read an instance of types.SubmodelElementCollection from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_collection_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollection read from iterator

aas_core3_2.xmlization.submodel_element_collection_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollection[source]

Read an instance of types.SubmodelElementCollection from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_collection_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElementCollection in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollection read from stream

aas_core3_2.xmlization.submodel_element_collection_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollection[source]

Read an instance of types.SubmodelElementCollection from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_collection_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElementCollection in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollection read from path

aas_core3_2.xmlization.submodel_element_collection_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollection[source]

Read an instance of types.SubmodelElementCollection from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_collection_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElementCollection in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollection read from text

aas_core3_2.xmlization.data_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DataElement[source]

Read an instance of types.DataElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.data_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataElement read from iterator

aas_core3_2.xmlization.data_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataElement[source]

Read an instance of types.DataElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.data_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DataElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataElement read from stream

aas_core3_2.xmlization.data_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataElement[source]

Read an instance of types.DataElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.data_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DataElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataElement read from path

aas_core3_2.xmlization.data_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataElement[source]

Read an instance of types.DataElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.data_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DataElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataElement read from text

aas_core3_2.xmlization.property_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Property[source]

Read an instance of types.Property from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.property_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Property read from iterator

aas_core3_2.xmlization.property_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Property[source]

Read an instance of types.Property from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.property_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Property in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Property read from stream

aas_core3_2.xmlization.property_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Property[source]

Read an instance of types.Property from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.property_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Property in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Property read from path

aas_core3_2.xmlization.property_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Property[source]

Read an instance of types.Property from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.property_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Property in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Property read from text

aas_core3_2.xmlization.multi_language_property_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → MultiLanguageProperty[source]

Read an instance of types.MultiLanguageProperty from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.multi_language_property_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguageProperty read from iterator

aas_core3_2.xmlization.multi_language_property_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguageProperty[source]

Read an instance of types.MultiLanguageProperty from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.multi_language_property_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.MultiLanguageProperty in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguageProperty read from stream

aas_core3_2.xmlization.multi_language_property_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguageProperty[source]

Read an instance of types.MultiLanguageProperty from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.multi_language_property_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.MultiLanguageProperty in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguageProperty read from path

aas_core3_2.xmlization.multi_language_property_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguageProperty[source]

Read an instance of types.MultiLanguageProperty from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.multi_language_property_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.MultiLanguageProperty in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguageProperty read from text

aas_core3_2.xmlization.range_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Range[source]

Read an instance of types.Range from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.range_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Range read from iterator

aas_core3_2.xmlization.range_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Range[source]

Read an instance of types.Range from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.range_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Range in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Range read from stream

aas_core3_2.xmlization.range_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Range[source]

Read an instance of types.Range from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.range_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Range in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Range read from path

aas_core3_2.xmlization.range_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Range[source]

Read an instance of types.Range from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.range_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Range in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Range read from text

aas_core3_2.xmlization.reference_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ReferenceElement[source]

Read an instance of types.ReferenceElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.reference_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElement read from iterator

aas_core3_2.xmlization.reference_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElement[source]

Read an instance of types.ReferenceElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.reference_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ReferenceElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElement read from stream

aas_core3_2.xmlization.reference_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElement[source]

Read an instance of types.ReferenceElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.reference_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ReferenceElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElement read from path

aas_core3_2.xmlization.reference_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElement[source]

Read an instance of types.ReferenceElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.reference_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ReferenceElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElement read from text

aas_core3_2.xmlization.blob_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Blob[source]

Read an instance of types.Blob from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.blob_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Blob read from iterator

aas_core3_2.xmlization.blob_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Blob[source]

Read an instance of types.Blob from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.blob_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Blob in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Blob read from stream

aas_core3_2.xmlization.blob_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Blob[source]

Read an instance of types.Blob from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.blob_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Blob in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Blob read from path

aas_core3_2.xmlization.blob_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Blob[source]

Read an instance of types.Blob from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.blob_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Blob in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Blob read from text

aas_core3_2.xmlization.file_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → File[source]

Read an instance of types.File from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.file_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.File read from iterator

aas_core3_2.xmlization.file_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → File[source]

Read an instance of types.File from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.file_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.File in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.File read from stream

aas_core3_2.xmlization.file_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → File[source]

Read an instance of types.File from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.file_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.File in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.File read from path

aas_core3_2.xmlization.file_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → File[source]

Read an instance of types.File from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.file_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.File in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.File read from text

aas_core3_2.xmlization.annotated_relationship_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AnnotatedRelationshipElement[source]

Read an instance of types.AnnotatedRelationshipElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.annotated_relationship_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElement read from iterator

aas_core3_2.xmlization.annotated_relationship_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElement[source]

Read an instance of types.AnnotatedRelationshipElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.annotated_relationship_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AnnotatedRelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElement read from stream

aas_core3_2.xmlization.annotated_relationship_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElement[source]

Read an instance of types.AnnotatedRelationshipElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.annotated_relationship_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AnnotatedRelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElement read from path

aas_core3_2.xmlization.annotated_relationship_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElement[source]

Read an instance of types.AnnotatedRelationshipElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.annotated_relationship_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AnnotatedRelationshipElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElement read from text

aas_core3_2.xmlization.entity_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Entity[source]

Read an instance of types.Entity from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.entity_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Entity read from iterator

aas_core3_2.xmlization.entity_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Entity[source]

Read an instance of types.Entity from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.entity_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Entity in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Entity read from stream

aas_core3_2.xmlization.entity_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Entity[source]

Read an instance of types.Entity from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.entity_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Entity in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Entity read from path

aas_core3_2.xmlization.entity_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Entity[source]

Read an instance of types.Entity from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.entity_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Entity in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Entity read from text

aas_core3_2.xmlization.event_payload_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EventPayload[source]

Read an instance of types.EventPayload from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.event_payload_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventPayload read from iterator

aas_core3_2.xmlization.event_payload_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventPayload[source]

Read an instance of types.EventPayload from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.event_payload_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EventPayload in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventPayload read from stream

aas_core3_2.xmlization.event_payload_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventPayload[source]

Read an instance of types.EventPayload from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.event_payload_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EventPayload in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventPayload read from path

aas_core3_2.xmlization.event_payload_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventPayload[source]

Read an instance of types.EventPayload from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.event_payload_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EventPayload in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventPayload read from text

aas_core3_2.xmlization.event_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EventElement[source]

Read an instance of types.EventElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.event_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventElement read from iterator

aas_core3_2.xmlization.event_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventElement[source]

Read an instance of types.EventElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.event_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventElement read from stream

aas_core3_2.xmlization.event_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventElement[source]

Read an instance of types.EventElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.event_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventElement read from path

aas_core3_2.xmlization.event_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EventElement[source]

Read an instance of types.EventElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.event_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EventElement read from text

aas_core3_2.xmlization.basic_event_element_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BasicEventElement[source]

Read an instance of types.BasicEventElement from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.basic_event_element_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElement read from iterator

aas_core3_2.xmlization.basic_event_element_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElement[source]

Read an instance of types.BasicEventElement from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.basic_event_element_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BasicEventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElement read from stream

aas_core3_2.xmlization.basic_event_element_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElement[source]

Read an instance of types.BasicEventElement from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.basic_event_element_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BasicEventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElement read from path

aas_core3_2.xmlization.basic_event_element_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElement[source]

Read an instance of types.BasicEventElement from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.basic_event_element_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BasicEventElement in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElement read from text

aas_core3_2.xmlization.operation_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Operation[source]

Read an instance of types.Operation from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Operation read from iterator

aas_core3_2.xmlization.operation_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Operation[source]

Read an instance of types.Operation from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Operation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Operation read from stream

aas_core3_2.xmlization.operation_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Operation[source]

Read an instance of types.Operation from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Operation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Operation read from path

aas_core3_2.xmlization.operation_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Operation[source]

Read an instance of types.Operation from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Operation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Operation read from text

aas_core3_2.xmlization.operation_variable_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationVariable[source]

Read an instance of types.OperationVariable from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_variable_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationVariable read from iterator

aas_core3_2.xmlization.operation_variable_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationVariable[source]

Read an instance of types.OperationVariable from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_variable_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationVariable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationVariable read from stream

aas_core3_2.xmlization.operation_variable_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationVariable[source]

Read an instance of types.OperationVariable from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_variable_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationVariable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationVariable read from path

aas_core3_2.xmlization.operation_variable_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationVariable[source]

Read an instance of types.OperationVariable from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_variable_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationVariable in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationVariable read from text

aas_core3_2.xmlization.capability_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Capability[source]

Read an instance of types.Capability from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.capability_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Capability read from iterator

aas_core3_2.xmlization.capability_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Capability[source]

Read an instance of types.Capability from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.capability_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Capability in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Capability read from stream

aas_core3_2.xmlization.capability_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Capability[source]

Read an instance of types.Capability from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.capability_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Capability in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Capability read from path

aas_core3_2.xmlization.capability_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Capability[source]

Read an instance of types.Capability from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.capability_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Capability in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Capability read from text

aas_core3_2.xmlization.concept_description_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ConceptDescription[source]

Read an instance of types.ConceptDescription from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.concept_description_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescription read from iterator

aas_core3_2.xmlization.concept_description_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescription[source]

Read an instance of types.ConceptDescription from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.concept_description_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ConceptDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescription read from stream

aas_core3_2.xmlization.concept_description_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescription[source]

Read an instance of types.ConceptDescription from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.concept_description_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ConceptDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescription read from path

aas_core3_2.xmlization.concept_description_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescription[source]

Read an instance of types.ConceptDescription from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.concept_description_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ConceptDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescription read from text

aas_core3_2.xmlization.reference_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Reference[source]

Read an instance of types.Reference from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.reference_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Reference read from iterator

aas_core3_2.xmlization.reference_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Reference[source]

Read an instance of types.Reference from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.reference_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Reference in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Reference read from stream

aas_core3_2.xmlization.reference_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Reference[source]

Read an instance of types.Reference from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.reference_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Reference in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Reference read from path

aas_core3_2.xmlization.reference_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Reference[source]

Read an instance of types.Reference from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.reference_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Reference in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Reference read from text

aas_core3_2.xmlization.key_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Key[source]

Read an instance of types.Key from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.key_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Key read from iterator

aas_core3_2.xmlization.key_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Key[source]

Read an instance of types.Key from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.key_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Key in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Key read from stream

aas_core3_2.xmlization.key_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Key[source]

Read an instance of types.Key from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.key_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Key in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Key read from path

aas_core3_2.xmlization.key_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Key[source]

Read an instance of types.Key from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.key_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Key in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Key read from text

aas_core3_2.xmlization.abstract_lang_string_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AbstractLangString[source]

Read an instance of types.AbstractLangString from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.abstract_lang_string_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AbstractLangString read from iterator

aas_core3_2.xmlization.abstract_lang_string_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AbstractLangString[source]

Read an instance of types.AbstractLangString from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.abstract_lang_string_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AbstractLangString in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AbstractLangString read from stream

aas_core3_2.xmlization.abstract_lang_string_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AbstractLangString[source]

Read an instance of types.AbstractLangString from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.abstract_lang_string_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AbstractLangString in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AbstractLangString read from path

aas_core3_2.xmlization.abstract_lang_string_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AbstractLangString[source]

Read an instance of types.AbstractLangString from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.abstract_lang_string_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AbstractLangString in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AbstractLangString read from text

aas_core3_2.xmlization.lang_string_name_type_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringNameType[source]

Read an instance of types.LangStringNameType from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_name_type_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringNameType read from iterator

aas_core3_2.xmlization.lang_string_name_type_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringNameType[source]

Read an instance of types.LangStringNameType from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_name_type_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LangStringNameType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringNameType read from stream

aas_core3_2.xmlization.lang_string_name_type_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringNameType[source]

Read an instance of types.LangStringNameType from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_name_type_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LangStringNameType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringNameType read from path

aas_core3_2.xmlization.lang_string_name_type_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringNameType[source]

Read an instance of types.LangStringNameType from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_name_type_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LangStringNameType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringNameType read from text

aas_core3_2.xmlization.lang_string_text_type_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringTextType[source]

Read an instance of types.LangStringTextType from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_text_type_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringTextType read from iterator

aas_core3_2.xmlization.lang_string_text_type_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringTextType[source]

Read an instance of types.LangStringTextType from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_text_type_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LangStringTextType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringTextType read from stream

aas_core3_2.xmlization.lang_string_text_type_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringTextType[source]

Read an instance of types.LangStringTextType from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_text_type_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LangStringTextType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringTextType read from path

aas_core3_2.xmlization.lang_string_text_type_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringTextType[source]

Read an instance of types.LangStringTextType from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_text_type_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LangStringTextType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringTextType read from text

aas_core3_2.xmlization.environment_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Environment[source]

Read an instance of types.Environment from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.environment_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Environment read from iterator

aas_core3_2.xmlization.environment_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Environment[source]

Read an instance of types.Environment from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.environment_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Environment in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Environment read from stream

aas_core3_2.xmlization.environment_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Environment[source]

Read an instance of types.Environment from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.environment_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Environment in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Environment read from path

aas_core3_2.xmlization.environment_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Environment[source]

Read an instance of types.Environment from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.environment_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Environment in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Environment read from text

aas_core3_2.xmlization.data_specification_content_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DataSpecificationContent[source]

Read an instance of types.DataSpecificationContent from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.data_specification_content_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationContent read from iterator

aas_core3_2.xmlization.data_specification_content_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationContent[source]

Read an instance of types.DataSpecificationContent from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.data_specification_content_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DataSpecificationContent in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationContent read from stream

aas_core3_2.xmlization.data_specification_content_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationContent[source]

Read an instance of types.DataSpecificationContent from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.data_specification_content_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DataSpecificationContent in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationContent read from path

aas_core3_2.xmlization.data_specification_content_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationContent[source]

Read an instance of types.DataSpecificationContent from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.data_specification_content_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DataSpecificationContent in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationContent read from text

aas_core3_2.xmlization.embedded_data_specification_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EmbeddedDataSpecification[source]

Read an instance of types.EmbeddedDataSpecification from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.embedded_data_specification_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EmbeddedDataSpecification read from iterator

aas_core3_2.xmlization.embedded_data_specification_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EmbeddedDataSpecification[source]

Read an instance of types.EmbeddedDataSpecification from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.embedded_data_specification_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EmbeddedDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EmbeddedDataSpecification read from stream

aas_core3_2.xmlization.embedded_data_specification_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EmbeddedDataSpecification[source]

Read an instance of types.EmbeddedDataSpecification from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.embedded_data_specification_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EmbeddedDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EmbeddedDataSpecification read from path

aas_core3_2.xmlization.embedded_data_specification_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EmbeddedDataSpecification[source]

Read an instance of types.EmbeddedDataSpecification from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.embedded_data_specification_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EmbeddedDataSpecification in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EmbeddedDataSpecification read from text

aas_core3_2.xmlization.level_type_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LevelType[source]

Read an instance of types.LevelType from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.level_type_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LevelType read from iterator

aas_core3_2.xmlization.level_type_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LevelType[source]

Read an instance of types.LevelType from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.level_type_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LevelType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LevelType read from stream

aas_core3_2.xmlization.level_type_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LevelType[source]

Read an instance of types.LevelType from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.level_type_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LevelType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LevelType read from path

aas_core3_2.xmlization.level_type_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LevelType[source]

Read an instance of types.LevelType from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.level_type_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LevelType in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LevelType read from text

aas_core3_2.xmlization.value_reference_pair_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ValueReferencePair[source]

Read an instance of types.ValueReferencePair from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.value_reference_pair_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueReferencePair read from iterator

aas_core3_2.xmlization.value_reference_pair_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueReferencePair[source]

Read an instance of types.ValueReferencePair from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.value_reference_pair_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ValueReferencePair in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueReferencePair read from stream

aas_core3_2.xmlization.value_reference_pair_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueReferencePair[source]

Read an instance of types.ValueReferencePair from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.value_reference_pair_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ValueReferencePair in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueReferencePair read from path

aas_core3_2.xmlization.value_reference_pair_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueReferencePair[source]

Read an instance of types.ValueReferencePair from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.value_reference_pair_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ValueReferencePair in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueReferencePair read from text

aas_core3_2.xmlization.value_list_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ValueList[source]

Read an instance of types.ValueList from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.value_list_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueList read from iterator

aas_core3_2.xmlization.value_list_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueList[source]

Read an instance of types.ValueList from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.value_list_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ValueList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueList read from stream

aas_core3_2.xmlization.value_list_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueList[source]

Read an instance of types.ValueList from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.value_list_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ValueList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueList read from path

aas_core3_2.xmlization.value_list_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ValueList[source]

Read an instance of types.ValueList from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.value_list_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ValueList in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ValueList read from text

aas_core3_2.xmlization.lang_string_preferred_name_type_iec_61360_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringPreferredNameTypeIEC61360[source]

Read an instance of types.LangStringPreferredNameTypeIEC61360 from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_preferred_name_type_iec_61360_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringPreferredNameTypeIEC61360 read from iterator

aas_core3_2.xmlization.lang_string_preferred_name_type_iec_61360_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringPreferredNameTypeIEC61360[source]

Read an instance of types.LangStringPreferredNameTypeIEC61360 from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_preferred_name_type_iec_61360_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringPreferredNameTypeIEC61360 read from stream

aas_core3_2.xmlization.lang_string_preferred_name_type_iec_61360_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringPreferredNameTypeIEC61360[source]

Read an instance of types.LangStringPreferredNameTypeIEC61360 from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_preferred_name_type_iec_61360_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringPreferredNameTypeIEC61360 read from path

aas_core3_2.xmlization.lang_string_preferred_name_type_iec_61360_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringPreferredNameTypeIEC61360[source]

Read an instance of types.LangStringPreferredNameTypeIEC61360 from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_preferred_name_type_iec_61360_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringPreferredNameTypeIEC61360 read from text

aas_core3_2.xmlization.lang_string_short_name_type_iec_61360_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringShortNameTypeIEC61360[source]

Read an instance of types.LangStringShortNameTypeIEC61360 from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_short_name_type_iec_61360_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringShortNameTypeIEC61360 read from iterator

aas_core3_2.xmlization.lang_string_short_name_type_iec_61360_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringShortNameTypeIEC61360[source]

Read an instance of types.LangStringShortNameTypeIEC61360 from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_short_name_type_iec_61360_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringShortNameTypeIEC61360 read from stream

aas_core3_2.xmlization.lang_string_short_name_type_iec_61360_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringShortNameTypeIEC61360[source]

Read an instance of types.LangStringShortNameTypeIEC61360 from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_short_name_type_iec_61360_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LangStringShortNameTypeIEC61360 in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringShortNameTypeIEC61360 read from path

aas_core3_2.xmlization.lang_string_short_name_type_iec_61360_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringShortNameTypeIEC61360[source]

Read an instance of types.LangStringShortNameTypeIEC61360 from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_short_name_type_iec_61360_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringShortNameTypeIEC61360 read from text

aas_core3_2.xmlization.lang_string_definition_type_iec_61360_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringDefinitionTypeIEC61360[source]

Read an instance of types.LangStringDefinitionTypeIEC61360 from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_definition_type_iec_61360_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringDefinitionTypeIEC61360 read from iterator

aas_core3_2.xmlization.lang_string_definition_type_iec_61360_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringDefinitionTypeIEC61360[source]

Read an instance of types.LangStringDefinitionTypeIEC61360 from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_definition_type_iec_61360_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringDefinitionTypeIEC61360 read from stream

aas_core3_2.xmlization.lang_string_definition_type_iec_61360_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringDefinitionTypeIEC61360[source]

Read an instance of types.LangStringDefinitionTypeIEC61360 from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_definition_type_iec_61360_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LangStringDefinitionTypeIEC61360 in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringDefinitionTypeIEC61360 read from path

aas_core3_2.xmlization.lang_string_definition_type_iec_61360_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringDefinitionTypeIEC61360[source]

Read an instance of types.LangStringDefinitionTypeIEC61360 from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_definition_type_iec_61360_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringDefinitionTypeIEC61360 read from text

aas_core3_2.xmlization.lang_string_uom_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LangStringUom[source]

Read an instance of types.LangStringUom from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.lang_string_uom_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringUom read from iterator

aas_core3_2.xmlization.lang_string_uom_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringUom[source]

Read an instance of types.LangStringUom from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.lang_string_uom_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LangStringUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringUom read from stream

aas_core3_2.xmlization.lang_string_uom_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringUom[source]

Read an instance of types.LangStringUom from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.lang_string_uom_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LangStringUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringUom read from path

aas_core3_2.xmlization.lang_string_uom_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LangStringUom[source]

Read an instance of types.LangStringUom from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.lang_string_uom_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LangStringUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LangStringUom read from text

aas_core3_2.xmlization.definition_type_uom_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DefinitionTypeUom[source]

Read an instance of types.DefinitionTypeUom from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.definition_type_uom_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DefinitionTypeUom read from iterator

aas_core3_2.xmlization.definition_type_uom_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DefinitionTypeUom[source]

Read an instance of types.DefinitionTypeUom from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.definition_type_uom_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DefinitionTypeUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DefinitionTypeUom read from stream

aas_core3_2.xmlization.definition_type_uom_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DefinitionTypeUom[source]

Read an instance of types.DefinitionTypeUom from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.definition_type_uom_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DefinitionTypeUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DefinitionTypeUom read from path

aas_core3_2.xmlization.definition_type_uom_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DefinitionTypeUom[source]

Read an instance of types.DefinitionTypeUom from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.definition_type_uom_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DefinitionTypeUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DefinitionTypeUom read from text

aas_core3_2.xmlization.data_specification_uom_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DataSpecificationUom[source]

Read an instance of types.DataSpecificationUom from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.data_specification_uom_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationUom read from iterator

aas_core3_2.xmlization.data_specification_uom_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationUom[source]

Read an instance of types.DataSpecificationUom from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.data_specification_uom_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DataSpecificationUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationUom read from stream

aas_core3_2.xmlization.data_specification_uom_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationUom[source]

Read an instance of types.DataSpecificationUom from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.data_specification_uom_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DataSpecificationUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationUom read from path

aas_core3_2.xmlization.data_specification_uom_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationUom[source]

Read an instance of types.DataSpecificationUom from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.data_specification_uom_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DataSpecificationUom in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationUom read from text

aas_core3_2.xmlization.data_specification_iec_61360_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DataSpecificationIEC61360[source]

Read an instance of types.DataSpecificationIEC61360 from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.data_specification_iec_61360_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationIEC61360 read from iterator

aas_core3_2.xmlization.data_specification_iec_61360_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationIEC61360[source]

Read an instance of types.DataSpecificationIEC61360 from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.data_specification_iec_61360_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DataSpecificationIEC61360 in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationIEC61360 read from stream

aas_core3_2.xmlization.data_specification_iec_61360_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationIEC61360[source]

Read an instance of types.DataSpecificationIEC61360 from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.data_specification_iec_61360_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DataSpecificationIEC61360 in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationIEC61360 read from path

aas_core3_2.xmlization.data_specification_iec_61360_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DataSpecificationIEC61360[source]

Read an instance of types.DataSpecificationIEC61360 from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.data_specification_iec_61360_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DataSpecificationIEC61360 in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DataSpecificationIEC61360 read from text

aas_core3_2.xmlization.descriptor_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Descriptor[source]

Read an instance of types.Descriptor from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.descriptor_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Descriptor read from iterator

aas_core3_2.xmlization.descriptor_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Descriptor[source]

Read an instance of types.Descriptor from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.descriptor_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Descriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Descriptor read from stream

aas_core3_2.xmlization.descriptor_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Descriptor[source]

Read an instance of types.Descriptor from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.descriptor_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Descriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Descriptor read from path

aas_core3_2.xmlization.descriptor_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Descriptor[source]

Read an instance of types.Descriptor from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.descriptor_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Descriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Descriptor read from text

aas_core3_2.xmlization.asset_administration_shell_descriptor_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AssetAdministrationShellDescriptor[source]

Read an instance of types.AssetAdministrationShellDescriptor from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_administration_shell_descriptor_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellDescriptor read from iterator

aas_core3_2.xmlization.asset_administration_shell_descriptor_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellDescriptor[source]

Read an instance of types.AssetAdministrationShellDescriptor from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_administration_shell_descriptor_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellDescriptor read from stream

aas_core3_2.xmlization.asset_administration_shell_descriptor_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellDescriptor[source]

Read an instance of types.AssetAdministrationShellDescriptor from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_administration_shell_descriptor_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellDescriptor read from path

aas_core3_2.xmlization.asset_administration_shell_descriptor_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellDescriptor[source]

Read an instance of types.AssetAdministrationShellDescriptor from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_administration_shell_descriptor_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellDescriptor read from text

aas_core3_2.xmlization.submodel_descriptor_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelDescriptor[source]

Read an instance of types.SubmodelDescriptor from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_descriptor_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelDescriptor read from iterator

aas_core3_2.xmlization.submodel_descriptor_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelDescriptor[source]

Read an instance of types.SubmodelDescriptor from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_descriptor_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelDescriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelDescriptor read from stream

aas_core3_2.xmlization.submodel_descriptor_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelDescriptor[source]

Read an instance of types.SubmodelDescriptor from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_descriptor_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelDescriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelDescriptor read from path

aas_core3_2.xmlization.submodel_descriptor_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelDescriptor[source]

Read an instance of types.SubmodelDescriptor from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_descriptor_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelDescriptor in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelDescriptor read from text

aas_core3_2.xmlization.endpoint_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Endpoint[source]

Read an instance of types.Endpoint from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.endpoint_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Endpoint read from iterator

aas_core3_2.xmlization.endpoint_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Endpoint[source]

Read an instance of types.Endpoint from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.endpoint_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Endpoint in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Endpoint read from stream

aas_core3_2.xmlization.endpoint_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Endpoint[source]

Read an instance of types.Endpoint from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.endpoint_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Endpoint in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Endpoint read from path

aas_core3_2.xmlization.endpoint_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Endpoint[source]

Read an instance of types.Endpoint from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.endpoint_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Endpoint in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Endpoint read from text

aas_core3_2.xmlization.protocol_information_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ProtocolInformation[source]

Read an instance of types.ProtocolInformation from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.protocol_information_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ProtocolInformation read from iterator

aas_core3_2.xmlization.protocol_information_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ProtocolInformation[source]

Read an instance of types.ProtocolInformation from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.protocol_information_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ProtocolInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ProtocolInformation read from stream

aas_core3_2.xmlization.protocol_information_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ProtocolInformation[source]

Read an instance of types.ProtocolInformation from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.protocol_information_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ProtocolInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ProtocolInformation read from path

aas_core3_2.xmlization.protocol_information_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ProtocolInformation[source]

Read an instance of types.ProtocolInformation from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.protocol_information_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ProtocolInformation in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ProtocolInformation read from text

aas_core3_2.xmlization.security_attribute_object_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SecurityAttributeObject[source]

Read an instance of types.SecurityAttributeObject from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.security_attribute_object_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SecurityAttributeObject read from iterator

aas_core3_2.xmlization.security_attribute_object_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SecurityAttributeObject[source]

Read an instance of types.SecurityAttributeObject from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.security_attribute_object_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SecurityAttributeObject in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SecurityAttributeObject read from stream

aas_core3_2.xmlization.security_attribute_object_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SecurityAttributeObject[source]

Read an instance of types.SecurityAttributeObject from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.security_attribute_object_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SecurityAttributeObject in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SecurityAttributeObject read from path

aas_core3_2.xmlization.security_attribute_object_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SecurityAttributeObject[source]

Read an instance of types.SecurityAttributeObject from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.security_attribute_object_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SecurityAttributeObject in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SecurityAttributeObject read from text

Read an instance of types.AssetLink from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_link_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetLink read from iterator

Read an instance of types.AssetLink from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_link_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AssetLink in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetLink read from stream

Read an instance of types.AssetLink from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_link_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AssetLink in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetLink read from path

Read an instance of types.AssetLink from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_link_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AssetLink in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetLink read from text

aas_core3_2.xmlization.service_description_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ServiceDescription[source]

Read an instance of types.ServiceDescription from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.service_description_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ServiceDescription read from iterator

aas_core3_2.xmlization.service_description_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ServiceDescription[source]

Read an instance of types.ServiceDescription from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.service_description_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ServiceDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ServiceDescription read from stream

aas_core3_2.xmlization.service_description_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ServiceDescription[source]

Read an instance of types.ServiceDescription from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.service_description_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ServiceDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ServiceDescription read from path

aas_core3_2.xmlization.service_description_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ServiceDescription[source]

Read an instance of types.ServiceDescription from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.service_description_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ServiceDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ServiceDescription read from text

aas_core3_2.xmlization.recent_change_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RecentChange[source]

Read an instance of types.RecentChange from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.recent_change_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RecentChange read from iterator

aas_core3_2.xmlization.recent_change_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RecentChange[source]

Read an instance of types.RecentChange from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.recent_change_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RecentChange read from stream

aas_core3_2.xmlization.recent_change_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RecentChange[source]

Read an instance of types.RecentChange from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.recent_change_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RecentChange read from path

aas_core3_2.xmlization.recent_change_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RecentChange[source]

Read an instance of types.RecentChange from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.recent_change_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RecentChange read from text

aas_core3_2.xmlization.asset_administration_shell_recent_change_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AssetAdministrationShellRecentChange[source]

Read an instance of types.AssetAdministrationShellRecentChange from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_administration_shell_recent_change_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellRecentChange read from iterator

aas_core3_2.xmlization.asset_administration_shell_recent_change_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellRecentChange[source]

Read an instance of types.AssetAdministrationShellRecentChange from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_administration_shell_recent_change_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellRecentChange read from stream

aas_core3_2.xmlization.asset_administration_shell_recent_change_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellRecentChange[source]

Read an instance of types.AssetAdministrationShellRecentChange from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_administration_shell_recent_change_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellRecentChange read from path

aas_core3_2.xmlization.asset_administration_shell_recent_change_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellRecentChange[source]

Read an instance of types.AssetAdministrationShellRecentChange from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_administration_shell_recent_change_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellRecentChange read from text

aas_core3_2.xmlization.concept_description_recent_change_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ConceptDescriptionRecentChange[source]

Read an instance of types.ConceptDescriptionRecentChange from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.concept_description_recent_change_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescriptionRecentChange read from iterator

aas_core3_2.xmlization.concept_description_recent_change_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescriptionRecentChange[source]

Read an instance of types.ConceptDescriptionRecentChange from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.concept_description_recent_change_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ConceptDescriptionRecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescriptionRecentChange read from stream

aas_core3_2.xmlization.concept_description_recent_change_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescriptionRecentChange[source]

Read an instance of types.ConceptDescriptionRecentChange from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.concept_description_recent_change_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ConceptDescriptionRecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescriptionRecentChange read from path

aas_core3_2.xmlization.concept_description_recent_change_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ConceptDescriptionRecentChange[source]

Read an instance of types.ConceptDescriptionRecentChange from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.concept_description_recent_change_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.ConceptDescriptionRecentChange read from text

aas_core3_2.xmlization.submodel_recent_change_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelRecentChange[source]

Read an instance of types.SubmodelRecentChange from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_recent_change_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelRecentChange read from iterator

aas_core3_2.xmlization.submodel_recent_change_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelRecentChange[source]

Read an instance of types.SubmodelRecentChange from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_recent_change_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelRecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelRecentChange read from stream

aas_core3_2.xmlization.submodel_recent_change_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelRecentChange[source]

Read an instance of types.SubmodelRecentChange from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_recent_change_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelRecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelRecentChange read from path

aas_core3_2.xmlization.submodel_recent_change_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelRecentChange[source]

Read an instance of types.SubmodelRecentChange from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_recent_change_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelRecentChange in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelRecentChange read from text

aas_core3_2.xmlization.result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Result[source]

Read an instance of types.Result from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Result read from iterator

aas_core3_2.xmlization.result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Result[source]

Read an instance of types.Result from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Result in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Result read from stream

aas_core3_2.xmlization.result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Result[source]

Read an instance of types.Result from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Result in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Result read from path

aas_core3_2.xmlization.result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Result[source]

Read an instance of types.Result from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Result in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Result read from text

aas_core3_2.xmlization.message_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Message[source]

Read an instance of types.Message from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.message_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Message read from iterator

aas_core3_2.xmlization.message_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Message[source]

Read an instance of types.Message from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.message_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Message in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Message read from stream

aas_core3_2.xmlization.message_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Message[source]

Read an instance of types.Message from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.message_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Message in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Message read from path

aas_core3_2.xmlization.message_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Message[source]

Read an instance of types.Message from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.message_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Message in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Message read from text

aas_core3_2.xmlization.operation_request_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationRequest[source]

Read an instance of types.OperationRequest from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_request_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequest read from iterator

aas_core3_2.xmlization.operation_request_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequest[source]

Read an instance of types.OperationRequest from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_request_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationRequest in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequest read from stream

aas_core3_2.xmlization.operation_request_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequest[source]

Read an instance of types.OperationRequest from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_request_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationRequest in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequest read from path

aas_core3_2.xmlization.operation_request_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequest[source]

Read an instance of types.OperationRequest from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_request_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationRequest in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequest read from text

aas_core3_2.xmlization.operation_request_async_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationRequestAsync[source]

Read an instance of types.OperationRequestAsync from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_request_async_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsync read from iterator

aas_core3_2.xmlization.operation_request_async_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsync[source]

Read an instance of types.OperationRequestAsync from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_request_async_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationRequestAsync in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsync read from stream

aas_core3_2.xmlization.operation_request_async_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsync[source]

Read an instance of types.OperationRequestAsync from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_request_async_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationRequestAsync in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsync read from path

aas_core3_2.xmlization.operation_request_async_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsync[source]

Read an instance of types.OperationRequestAsync from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_request_async_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationRequestAsync in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsync read from text

aas_core3_2.xmlization.operation_request_value_only_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationRequestValueOnly[source]

Read an instance of types.OperationRequestValueOnly from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_request_value_only_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestValueOnly read from iterator

aas_core3_2.xmlization.operation_request_value_only_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestValueOnly[source]

Read an instance of types.OperationRequestValueOnly from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_request_value_only_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationRequestValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestValueOnly read from stream

aas_core3_2.xmlization.operation_request_value_only_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestValueOnly[source]

Read an instance of types.OperationRequestValueOnly from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_request_value_only_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationRequestValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestValueOnly read from path

aas_core3_2.xmlization.operation_request_value_only_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestValueOnly[source]

Read an instance of types.OperationRequestValueOnly from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_request_value_only_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationRequestValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestValueOnly read from text

aas_core3_2.xmlization.operation_request_async_value_only_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationRequestAsyncValueOnly[source]

Read an instance of types.OperationRequestAsyncValueOnly from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_request_async_value_only_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsyncValueOnly read from iterator

aas_core3_2.xmlization.operation_request_async_value_only_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsyncValueOnly[source]

Read an instance of types.OperationRequestAsyncValueOnly from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_request_async_value_only_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationRequestAsyncValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsyncValueOnly read from stream

aas_core3_2.xmlization.operation_request_async_value_only_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsyncValueOnly[source]

Read an instance of types.OperationRequestAsyncValueOnly from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_request_async_value_only_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationRequestAsyncValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsyncValueOnly read from path

aas_core3_2.xmlization.operation_request_async_value_only_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationRequestAsyncValueOnly[source]

Read an instance of types.OperationRequestAsyncValueOnly from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_request_async_value_only_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationRequestAsyncValueOnly read from text

aas_core3_2.xmlization.base_operation_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BaseOperationResult[source]

Read an instance of types.BaseOperationResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.base_operation_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BaseOperationResult read from iterator

aas_core3_2.xmlization.base_operation_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BaseOperationResult[source]

Read an instance of types.BaseOperationResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.base_operation_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BaseOperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BaseOperationResult read from stream

aas_core3_2.xmlization.base_operation_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BaseOperationResult[source]

Read an instance of types.BaseOperationResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.base_operation_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BaseOperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BaseOperationResult read from path

aas_core3_2.xmlization.base_operation_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BaseOperationResult[source]

Read an instance of types.BaseOperationResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.base_operation_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BaseOperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BaseOperationResult read from text

aas_core3_2.xmlization.operation_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationResult[source]

Read an instance of types.OperationResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResult read from iterator

aas_core3_2.xmlization.operation_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResult[source]

Read an instance of types.OperationResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResult read from stream

aas_core3_2.xmlization.operation_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResult[source]

Read an instance of types.OperationResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResult read from path

aas_core3_2.xmlization.operation_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResult[source]

Read an instance of types.OperationResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResult read from text

aas_core3_2.xmlization.operation_result_value_only_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationResultValueOnly[source]

Read an instance of types.OperationResultValueOnly from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_result_value_only_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResultValueOnly read from iterator

aas_core3_2.xmlization.operation_result_value_only_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResultValueOnly[source]

Read an instance of types.OperationResultValueOnly from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_result_value_only_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationResultValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResultValueOnly read from stream

aas_core3_2.xmlization.operation_result_value_only_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResultValueOnly[source]

Read an instance of types.OperationResultValueOnly from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_result_value_only_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationResultValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResultValueOnly read from path

aas_core3_2.xmlization.operation_result_value_only_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationResultValueOnly[source]

Read an instance of types.OperationResultValueOnly from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_result_value_only_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationResultValueOnly in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationResultValueOnly read from text

aas_core3_2.xmlization.operation_handle_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationHandle[source]

Read an instance of types.OperationHandle from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_handle_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationHandle read from iterator

aas_core3_2.xmlization.operation_handle_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationHandle[source]

Read an instance of types.OperationHandle from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_handle_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationHandle in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationHandle read from stream

aas_core3_2.xmlization.operation_handle_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationHandle[source]

Read an instance of types.OperationHandle from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_handle_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationHandle in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationHandle read from path

aas_core3_2.xmlization.operation_handle_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationHandle[source]

Read an instance of types.OperationHandle from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_handle_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationHandle in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationHandle read from text

aas_core3_2.xmlization.paged_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → PagedResult[source]

Read an instance of types.PagedResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.paged_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagedResult read from iterator

aas_core3_2.xmlization.paged_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagedResult[source]

Read an instance of types.PagedResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.paged_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.PagedResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagedResult read from stream

aas_core3_2.xmlization.paged_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagedResult[source]

Read an instance of types.PagedResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.paged_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.PagedResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagedResult read from path

aas_core3_2.xmlization.paged_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagedResult[source]

Read an instance of types.PagedResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.paged_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.PagedResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagedResult read from text

aas_core3_2.xmlization.paging_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → PagingMetadata[source]

Read an instance of types.PagingMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.paging_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagingMetadata read from iterator

aas_core3_2.xmlization.paging_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagingMetadata[source]

Read an instance of types.PagingMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.paging_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.PagingMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagingMetadata read from stream

aas_core3_2.xmlization.paging_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagingMetadata[source]

Read an instance of types.PagingMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.paging_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.PagingMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagingMetadata read from path

aas_core3_2.xmlization.paging_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PagingMetadata[source]

Read an instance of types.PagingMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.paging_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.PagingMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PagingMetadata read from text

aas_core3_2.xmlization.package_description_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → PackageDescription[source]

Read an instance of types.PackageDescription from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.package_description_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.PackageDescription read from iterator

aas_core3_2.xmlization.package_description_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PackageDescription[source]

Read an instance of types.PackageDescription from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.package_description_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.PackageDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PackageDescription read from stream

aas_core3_2.xmlization.package_description_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PackageDescription[source]

Read an instance of types.PackageDescription from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.package_description_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.PackageDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PackageDescription read from path

aas_core3_2.xmlization.package_description_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PackageDescription[source]

Read an instance of types.PackageDescription from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.package_description_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.PackageDescription in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PackageDescription read from text

aas_core3_2.xmlization.submodel_element_attributes_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementAttributes[source]

Read an instance of types.SubmodelElementAttributes from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_attributes_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementAttributes read from iterator

aas_core3_2.xmlization.submodel_element_attributes_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementAttributes[source]

Read an instance of types.SubmodelElementAttributes from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_attributes_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElementAttributes in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementAttributes read from stream

aas_core3_2.xmlization.submodel_element_attributes_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementAttributes[source]

Read an instance of types.SubmodelElementAttributes from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_attributes_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElementAttributes in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementAttributes read from path

aas_core3_2.xmlization.submodel_element_attributes_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementAttributes[source]

Read an instance of types.SubmodelElementAttributes from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_attributes_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElementAttributes in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementAttributes read from text

aas_core3_2.xmlization.submodel_element_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementMetadata[source]

Read an instance of types.SubmodelElementMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementMetadata read from iterator

aas_core3_2.xmlization.submodel_element_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementMetadata[source]

Read an instance of types.SubmodelElementMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementMetadata read from stream

aas_core3_2.xmlization.submodel_element_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementMetadata[source]

Read an instance of types.SubmodelElementMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementMetadata read from path

aas_core3_2.xmlization.submodel_element_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementMetadata[source]

Read an instance of types.SubmodelElementMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementMetadata read from text

aas_core3_2.xmlization.property_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → PropertyMetadata[source]

Read an instance of types.PropertyMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.property_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.PropertyMetadata read from iterator

aas_core3_2.xmlization.property_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PropertyMetadata[source]

Read an instance of types.PropertyMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.property_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.PropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PropertyMetadata read from stream

aas_core3_2.xmlization.property_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PropertyMetadata[source]

Read an instance of types.PropertyMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.property_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.PropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PropertyMetadata read from path

aas_core3_2.xmlization.property_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → PropertyMetadata[source]

Read an instance of types.PropertyMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.property_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.PropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.PropertyMetadata read from text

aas_core3_2.xmlization.range_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RangeMetadata[source]

Read an instance of types.RangeMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.range_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeMetadata read from iterator

aas_core3_2.xmlization.range_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeMetadata[source]

Read an instance of types.RangeMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.range_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RangeMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeMetadata read from stream

aas_core3_2.xmlization.range_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeMetadata[source]

Read an instance of types.RangeMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.range_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RangeMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeMetadata read from path

aas_core3_2.xmlization.range_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeMetadata[source]

Read an instance of types.RangeMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.range_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RangeMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeMetadata read from text

aas_core3_2.xmlization.blob_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BlobMetadata[source]

Read an instance of types.BlobMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.blob_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobMetadata read from iterator

aas_core3_2.xmlization.blob_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobMetadata[source]

Read an instance of types.BlobMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.blob_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BlobMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobMetadata read from stream

aas_core3_2.xmlization.blob_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobMetadata[source]

Read an instance of types.BlobMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.blob_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BlobMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobMetadata read from path

aas_core3_2.xmlization.blob_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobMetadata[source]

Read an instance of types.BlobMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.blob_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BlobMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobMetadata read from text

aas_core3_2.xmlization.file_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → FileMetadata[source]

Read an instance of types.FileMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.file_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileMetadata read from iterator

aas_core3_2.xmlization.file_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileMetadata[source]

Read an instance of types.FileMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.file_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.FileMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileMetadata read from stream

aas_core3_2.xmlization.file_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileMetadata[source]

Read an instance of types.FileMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.file_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.FileMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileMetadata read from path

aas_core3_2.xmlization.file_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileMetadata[source]

Read an instance of types.FileMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.file_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.FileMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileMetadata read from text

aas_core3_2.xmlization.multi_language_property_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → MultiLanguagePropertyMetadata[source]

Read an instance of types.MultiLanguagePropertyMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.multi_language_property_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguagePropertyMetadata read from iterator

aas_core3_2.xmlization.multi_language_property_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguagePropertyMetadata[source]

Read an instance of types.MultiLanguagePropertyMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.multi_language_property_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.MultiLanguagePropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguagePropertyMetadata read from stream

aas_core3_2.xmlization.multi_language_property_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguagePropertyMetadata[source]

Read an instance of types.MultiLanguagePropertyMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.multi_language_property_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.MultiLanguagePropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguagePropertyMetadata read from path

aas_core3_2.xmlization.multi_language_property_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MultiLanguagePropertyMetadata[source]

Read an instance of types.MultiLanguagePropertyMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.multi_language_property_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.MultiLanguagePropertyMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MultiLanguagePropertyMetadata read from text

aas_core3_2.xmlization.reference_element_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ReferenceElementMetadata[source]

Read an instance of types.ReferenceElementMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.reference_element_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementMetadata read from iterator

aas_core3_2.xmlization.reference_element_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementMetadata[source]

Read an instance of types.ReferenceElementMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.reference_element_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ReferenceElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementMetadata read from stream

aas_core3_2.xmlization.reference_element_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementMetadata[source]

Read an instance of types.ReferenceElementMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.reference_element_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ReferenceElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementMetadata read from path

aas_core3_2.xmlization.reference_element_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementMetadata[source]

Read an instance of types.ReferenceElementMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.reference_element_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ReferenceElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementMetadata read from text

aas_core3_2.xmlization.relationship_element_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RelationshipElementMetadata[source]

Read an instance of types.RelationshipElementMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.relationship_element_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementMetadata read from iterator

aas_core3_2.xmlization.relationship_element_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementMetadata[source]

Read an instance of types.RelationshipElementMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.relationship_element_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RelationshipElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementMetadata read from stream

aas_core3_2.xmlization.relationship_element_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementMetadata[source]

Read an instance of types.RelationshipElementMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.relationship_element_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RelationshipElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementMetadata read from path

aas_core3_2.xmlization.relationship_element_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementMetadata[source]

Read an instance of types.RelationshipElementMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.relationship_element_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RelationshipElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementMetadata read from text

aas_core3_2.xmlization.annotated_relationship_element_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AnnotatedRelationshipElementMetadata[source]

Read an instance of types.AnnotatedRelationshipElementMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.annotated_relationship_element_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementMetadata read from iterator

aas_core3_2.xmlization.annotated_relationship_element_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementMetadata[source]

Read an instance of types.AnnotatedRelationshipElementMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.annotated_relationship_element_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementMetadata read from stream

aas_core3_2.xmlization.annotated_relationship_element_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementMetadata[source]

Read an instance of types.AnnotatedRelationshipElementMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.annotated_relationship_element_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementMetadata read from path

aas_core3_2.xmlization.annotated_relationship_element_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementMetadata[source]

Read an instance of types.AnnotatedRelationshipElementMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.annotated_relationship_element_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementMetadata read from text

aas_core3_2.xmlization.entity_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EntityMetadata[source]

Read an instance of types.EntityMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.entity_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityMetadata read from iterator

aas_core3_2.xmlization.entity_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityMetadata[source]

Read an instance of types.EntityMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.entity_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EntityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityMetadata read from stream

aas_core3_2.xmlization.entity_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityMetadata[source]

Read an instance of types.EntityMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.entity_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EntityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityMetadata read from path

aas_core3_2.xmlization.entity_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityMetadata[source]

Read an instance of types.EntityMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.entity_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EntityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityMetadata read from text

aas_core3_2.xmlization.capability_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → CapabilityMetadata[source]

Read an instance of types.CapabilityMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.capability_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.CapabilityMetadata read from iterator

aas_core3_2.xmlization.capability_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → CapabilityMetadata[source]

Read an instance of types.CapabilityMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.capability_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.CapabilityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.CapabilityMetadata read from stream

aas_core3_2.xmlization.capability_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → CapabilityMetadata[source]

Read an instance of types.CapabilityMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.capability_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.CapabilityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.CapabilityMetadata read from path

aas_core3_2.xmlization.capability_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → CapabilityMetadata[source]

Read an instance of types.CapabilityMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.capability_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.CapabilityMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.CapabilityMetadata read from text

aas_core3_2.xmlization.operation_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OperationMetadata[source]

Read an instance of types.OperationMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.operation_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationMetadata read from iterator

aas_core3_2.xmlization.operation_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationMetadata[source]

Read an instance of types.OperationMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.operation_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OperationMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationMetadata read from stream

aas_core3_2.xmlization.operation_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationMetadata[source]

Read an instance of types.OperationMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.operation_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OperationMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationMetadata read from path

aas_core3_2.xmlization.operation_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OperationMetadata[source]

Read an instance of types.OperationMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.operation_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OperationMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OperationMetadata read from text

aas_core3_2.xmlization.submodel_element_collection_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementCollectionMetadata[source]

Read an instance of types.SubmodelElementCollectionMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_collection_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollectionMetadata read from iterator

aas_core3_2.xmlization.submodel_element_collection_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollectionMetadata[source]

Read an instance of types.SubmodelElementCollectionMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_collection_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollectionMetadata read from stream

aas_core3_2.xmlization.submodel_element_collection_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollectionMetadata[source]

Read an instance of types.SubmodelElementCollectionMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_collection_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollectionMetadata read from path

aas_core3_2.xmlization.submodel_element_collection_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementCollectionMetadata[source]

Read an instance of types.SubmodelElementCollectionMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_collection_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementCollectionMetadata read from text

aas_core3_2.xmlization.basic_event_element_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BasicEventElementMetadata[source]

Read an instance of types.BasicEventElementMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.basic_event_element_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementMetadata read from iterator

aas_core3_2.xmlization.basic_event_element_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementMetadata[source]

Read an instance of types.BasicEventElementMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.basic_event_element_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BasicEventElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementMetadata read from stream

aas_core3_2.xmlization.basic_event_element_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementMetadata[source]

Read an instance of types.BasicEventElementMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.basic_event_element_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BasicEventElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementMetadata read from path

aas_core3_2.xmlization.basic_event_element_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementMetadata[source]

Read an instance of types.BasicEventElementMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.basic_event_element_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BasicEventElementMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementMetadata read from text

aas_core3_2.xmlization.submodel_element_list_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelElementListMetadata[source]

Read an instance of types.SubmodelElementListMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_element_list_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementListMetadata read from iterator

aas_core3_2.xmlization.submodel_element_list_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementListMetadata[source]

Read an instance of types.SubmodelElementListMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_element_list_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelElementListMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementListMetadata read from stream

aas_core3_2.xmlization.submodel_element_list_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementListMetadata[source]

Read an instance of types.SubmodelElementListMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_element_list_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelElementListMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementListMetadata read from path

aas_core3_2.xmlization.submodel_element_list_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelElementListMetadata[source]

Read an instance of types.SubmodelElementListMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_element_list_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelElementListMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelElementListMetadata read from text

aas_core3_2.xmlization.submodel_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → SubmodelMetadata[source]

Read an instance of types.SubmodelMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.submodel_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelMetadata read from iterator

aas_core3_2.xmlization.submodel_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelMetadata[source]

Read an instance of types.SubmodelMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.submodel_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.SubmodelMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelMetadata read from stream

aas_core3_2.xmlization.submodel_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelMetadata[source]

Read an instance of types.SubmodelMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.submodel_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.SubmodelMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelMetadata read from path

aas_core3_2.xmlization.submodel_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → SubmodelMetadata[source]

Read an instance of types.SubmodelMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.submodel_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.SubmodelMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.SubmodelMetadata read from text

aas_core3_2.xmlization.asset_administration_shell_metadata_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AssetAdministrationShellMetadata[source]

Read an instance of types.AssetAdministrationShellMetadata from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.asset_administration_shell_metadata_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellMetadata read from iterator

aas_core3_2.xmlization.asset_administration_shell_metadata_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellMetadata[source]

Read an instance of types.AssetAdministrationShellMetadata from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.asset_administration_shell_metadata_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellMetadata read from stream

aas_core3_2.xmlization.asset_administration_shell_metadata_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellMetadata[source]

Read an instance of types.AssetAdministrationShellMetadata from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.asset_administration_shell_metadata_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AssetAdministrationShellMetadata in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellMetadata read from path

aas_core3_2.xmlization.asset_administration_shell_metadata_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AssetAdministrationShellMetadata[source]

Read an instance of types.AssetAdministrationShellMetadata from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.asset_administration_shell_metadata_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AssetAdministrationShellMetadata read from text

aas_core3_2.xmlization.reference_element_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ReferenceElementValue[source]

Read an instance of types.ReferenceElementValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.reference_element_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementValue read from iterator

aas_core3_2.xmlization.reference_element_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementValue[source]

Read an instance of types.ReferenceElementValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.reference_element_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ReferenceElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementValue read from stream

aas_core3_2.xmlization.reference_element_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementValue[source]

Read an instance of types.ReferenceElementValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.reference_element_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ReferenceElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementValue read from path

aas_core3_2.xmlization.reference_element_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceElementValue[source]

Read an instance of types.ReferenceElementValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.reference_element_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ReferenceElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceElementValue read from text

aas_core3_2.xmlization.blob_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BlobValue[source]

Read an instance of types.BlobValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.blob_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobValue read from iterator

aas_core3_2.xmlization.blob_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobValue[source]

Read an instance of types.BlobValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.blob_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BlobValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobValue read from stream

aas_core3_2.xmlization.blob_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobValue[source]

Read an instance of types.BlobValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.blob_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BlobValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobValue read from path

aas_core3_2.xmlization.blob_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BlobValue[source]

Read an instance of types.BlobValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.blob_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BlobValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BlobValue read from text

aas_core3_2.xmlization.file_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → FileValue[source]

Read an instance of types.FileValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.file_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileValue read from iterator

aas_core3_2.xmlization.file_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileValue[source]

Read an instance of types.FileValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.file_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.FileValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileValue read from stream

aas_core3_2.xmlization.file_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileValue[source]

Read an instance of types.FileValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.file_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.FileValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileValue read from path

aas_core3_2.xmlization.file_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FileValue[source]

Read an instance of types.FileValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.file_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.FileValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FileValue read from text

aas_core3_2.xmlization.range_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RangeValue[source]

Read an instance of types.RangeValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.range_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeValue read from iterator

aas_core3_2.xmlization.range_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeValue[source]

Read an instance of types.RangeValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.range_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RangeValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeValue read from stream

aas_core3_2.xmlization.range_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeValue[source]

Read an instance of types.RangeValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.range_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RangeValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeValue read from path

aas_core3_2.xmlization.range_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RangeValue[source]

Read an instance of types.RangeValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.range_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RangeValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RangeValue read from text

aas_core3_2.xmlization.relationship_element_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RelationshipElementValue[source]

Read an instance of types.RelationshipElementValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.relationship_element_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementValue read from iterator

aas_core3_2.xmlization.relationship_element_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementValue[source]

Read an instance of types.RelationshipElementValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.relationship_element_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RelationshipElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementValue read from stream

aas_core3_2.xmlization.relationship_element_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementValue[source]

Read an instance of types.RelationshipElementValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.relationship_element_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RelationshipElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementValue read from path

aas_core3_2.xmlization.relationship_element_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RelationshipElementValue[source]

Read an instance of types.RelationshipElementValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.relationship_element_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RelationshipElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RelationshipElementValue read from text

aas_core3_2.xmlization.basic_event_element_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BasicEventElementValue[source]

Read an instance of types.BasicEventElementValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.basic_event_element_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementValue read from iterator

aas_core3_2.xmlization.basic_event_element_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementValue[source]

Read an instance of types.BasicEventElementValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.basic_event_element_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BasicEventElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementValue read from stream

aas_core3_2.xmlization.basic_event_element_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementValue[source]

Read an instance of types.BasicEventElementValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.basic_event_element_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BasicEventElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementValue read from path

aas_core3_2.xmlization.basic_event_element_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BasicEventElementValue[source]

Read an instance of types.BasicEventElementValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.basic_event_element_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BasicEventElementValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BasicEventElementValue read from text

aas_core3_2.xmlization.annotated_relationship_element_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AnnotatedRelationshipElementValue[source]

Read an instance of types.AnnotatedRelationshipElementValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.annotated_relationship_element_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementValue read from iterator

aas_core3_2.xmlization.annotated_relationship_element_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementValue[source]

Read an instance of types.AnnotatedRelationshipElementValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.annotated_relationship_element_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementValue read from stream

aas_core3_2.xmlization.annotated_relationship_element_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementValue[source]

Read an instance of types.AnnotatedRelationshipElementValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.annotated_relationship_element_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementValue read from path

aas_core3_2.xmlization.annotated_relationship_element_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AnnotatedRelationshipElementValue[source]

Read an instance of types.AnnotatedRelationshipElementValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.annotated_relationship_element_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.AnnotatedRelationshipElementValue read from text

aas_core3_2.xmlization.entity_value_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EntityValue[source]

Read an instance of types.EntityValue from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.entity_value_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityValue read from iterator

aas_core3_2.xmlization.entity_value_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityValue[source]

Read an instance of types.EntityValue from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.entity_value_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EntityValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityValue read from stream

aas_core3_2.xmlization.entity_value_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityValue[source]

Read an instance of types.EntityValue from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.entity_value_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EntityValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityValue read from path

aas_core3_2.xmlization.entity_value_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EntityValue[source]

Read an instance of types.EntityValue from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.entity_value_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EntityValue in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EntityValue read from text

aas_core3_2.xmlization.get_asset_administration_shells_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAssetAdministrationShellsResult[source]

Read an instance of types.GetAssetAdministrationShellsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_asset_administration_shells_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsResult read from iterator

aas_core3_2.xmlization.get_asset_administration_shells_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsResult[source]

Read an instance of types.GetAssetAdministrationShellsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_asset_administration_shells_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsResult read from stream

aas_core3_2.xmlization.get_asset_administration_shells_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsResult[source]

Read an instance of types.GetAssetAdministrationShellsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_asset_administration_shells_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsResult read from path

aas_core3_2.xmlization.get_asset_administration_shells_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsResult[source]

Read an instance of types.GetAssetAdministrationShellsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_asset_administration_shells_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsResult read from text

aas_core3_2.xmlization.get_asset_administration_shells_metadata_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAssetAdministrationShellsMetadataResult[source]

Read an instance of types.GetAssetAdministrationShellsMetadataResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_asset_administration_shells_metadata_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsMetadataResult read from iterator

aas_core3_2.xmlization.get_asset_administration_shells_metadata_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsMetadataResult[source]

Read an instance of types.GetAssetAdministrationShellsMetadataResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_asset_administration_shells_metadata_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsMetadataResult read from stream

aas_core3_2.xmlization.get_asset_administration_shells_metadata_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsMetadataResult[source]

Read an instance of types.GetAssetAdministrationShellsMetadataResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_asset_administration_shells_metadata_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsMetadataResult read from path

aas_core3_2.xmlization.get_asset_administration_shells_metadata_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellsMetadataResult[source]

Read an instance of types.GetAssetAdministrationShellsMetadataResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_asset_administration_shells_metadata_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellsMetadataResult read from text

aas_core3_2.xmlization.get_all_asset_administration_shells_recent_changes_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAllAssetAdministrationShellsRecentChangesResult[source]

Read an instance of types.GetAllAssetAdministrationShellsRecentChangesResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_all_asset_administration_shells_recent_changes_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllAssetAdministrationShellsRecentChangesResult read from iterator

aas_core3_2.xmlization.get_all_asset_administration_shells_recent_changes_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllAssetAdministrationShellsRecentChangesResult[source]

Read an instance of types.GetAllAssetAdministrationShellsRecentChangesResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_all_asset_administration_shells_recent_changes_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllAssetAdministrationShellsRecentChangesResult read from stream

aas_core3_2.xmlization.get_all_asset_administration_shells_recent_changes_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllAssetAdministrationShellsRecentChangesResult[source]

Read an instance of types.GetAllAssetAdministrationShellsRecentChangesResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_all_asset_administration_shells_recent_changes_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllAssetAdministrationShellsRecentChangesResult read from path

aas_core3_2.xmlization.get_all_asset_administration_shells_recent_changes_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllAssetAdministrationShellsRecentChangesResult[source]

Read an instance of types.GetAllAssetAdministrationShellsRecentChangesResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_all_asset_administration_shells_recent_changes_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllAssetAdministrationShellsRecentChangesResult read from text

aas_core3_2.xmlization.get_asset_administration_shell_descriptors_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAssetAdministrationShellDescriptorsResult[source]

Read an instance of types.GetAssetAdministrationShellDescriptorsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_asset_administration_shell_descriptors_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellDescriptorsResult read from iterator

aas_core3_2.xmlization.get_asset_administration_shell_descriptors_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellDescriptorsResult[source]

Read an instance of types.GetAssetAdministrationShellDescriptorsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_asset_administration_shell_descriptors_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellDescriptorsResult read from stream

aas_core3_2.xmlization.get_asset_administration_shell_descriptors_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellDescriptorsResult[source]

Read an instance of types.GetAssetAdministrationShellDescriptorsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_asset_administration_shell_descriptors_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellDescriptorsResult read from path

aas_core3_2.xmlization.get_asset_administration_shell_descriptors_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAssetAdministrationShellDescriptorsResult[source]

Read an instance of types.GetAssetAdministrationShellDescriptorsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_asset_administration_shell_descriptors_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAssetAdministrationShellDescriptorsResult read from text

aas_core3_2.xmlization.get_concept_descriptions_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetConceptDescriptionsResult[source]

Read an instance of types.GetConceptDescriptionsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_concept_descriptions_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetConceptDescriptionsResult read from iterator

aas_core3_2.xmlization.get_concept_descriptions_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetConceptDescriptionsResult[source]

Read an instance of types.GetConceptDescriptionsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_concept_descriptions_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetConceptDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetConceptDescriptionsResult read from stream

aas_core3_2.xmlization.get_concept_descriptions_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetConceptDescriptionsResult[source]

Read an instance of types.GetConceptDescriptionsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_concept_descriptions_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetConceptDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetConceptDescriptionsResult read from path

aas_core3_2.xmlization.get_concept_descriptions_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetConceptDescriptionsResult[source]

Read an instance of types.GetConceptDescriptionsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_concept_descriptions_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetConceptDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetConceptDescriptionsResult read from text

aas_core3_2.xmlization.get_all_concept_descriptions_recent_changes_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAllConceptDescriptionsRecentChangesResult[source]

Read an instance of types.GetAllConceptDescriptionsRecentChangesResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_all_concept_descriptions_recent_changes_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllConceptDescriptionsRecentChangesResult read from iterator

aas_core3_2.xmlization.get_all_concept_descriptions_recent_changes_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllConceptDescriptionsRecentChangesResult[source]

Read an instance of types.GetAllConceptDescriptionsRecentChangesResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_all_concept_descriptions_recent_changes_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllConceptDescriptionsRecentChangesResult read from stream

aas_core3_2.xmlization.get_all_concept_descriptions_recent_changes_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllConceptDescriptionsRecentChangesResult[source]

Read an instance of types.GetAllConceptDescriptionsRecentChangesResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_all_concept_descriptions_recent_changes_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllConceptDescriptionsRecentChangesResult read from path

aas_core3_2.xmlization.get_all_concept_descriptions_recent_changes_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllConceptDescriptionsRecentChangesResult[source]

Read an instance of types.GetAllConceptDescriptionsRecentChangesResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_all_concept_descriptions_recent_changes_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllConceptDescriptionsRecentChangesResult read from text

aas_core3_2.xmlization.get_package_descriptions_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetPackageDescriptionsResult[source]

Read an instance of types.GetPackageDescriptionsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_package_descriptions_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPackageDescriptionsResult read from iterator

aas_core3_2.xmlization.get_package_descriptions_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPackageDescriptionsResult[source]

Read an instance of types.GetPackageDescriptionsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_package_descriptions_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetPackageDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPackageDescriptionsResult read from stream

aas_core3_2.xmlization.get_package_descriptions_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPackageDescriptionsResult[source]

Read an instance of types.GetPackageDescriptionsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_package_descriptions_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetPackageDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPackageDescriptionsResult read from path

aas_core3_2.xmlization.get_package_descriptions_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPackageDescriptionsResult[source]

Read an instance of types.GetPackageDescriptionsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_package_descriptions_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetPackageDescriptionsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPackageDescriptionsResult read from text

aas_core3_2.xmlization.get_path_items_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetPathItemsResult[source]

Read an instance of types.GetPathItemsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_path_items_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPathItemsResult read from iterator

aas_core3_2.xmlization.get_path_items_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPathItemsResult[source]

Read an instance of types.GetPathItemsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_path_items_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetPathItemsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPathItemsResult read from stream

aas_core3_2.xmlization.get_path_items_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPathItemsResult[source]

Read an instance of types.GetPathItemsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_path_items_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetPathItemsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPathItemsResult read from path

aas_core3_2.xmlization.get_path_items_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetPathItemsResult[source]

Read an instance of types.GetPathItemsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_path_items_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetPathItemsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetPathItemsResult read from text

aas_core3_2.xmlization.get_references_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetReferencesResult[source]

Read an instance of types.GetReferencesResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_references_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetReferencesResult read from iterator

aas_core3_2.xmlization.get_references_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetReferencesResult[source]

Read an instance of types.GetReferencesResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_references_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetReferencesResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetReferencesResult read from stream

aas_core3_2.xmlization.get_references_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetReferencesResult[source]

Read an instance of types.GetReferencesResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_references_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetReferencesResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetReferencesResult read from path

aas_core3_2.xmlization.get_references_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetReferencesResult[source]

Read an instance of types.GetReferencesResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_references_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetReferencesResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetReferencesResult read from text

aas_core3_2.xmlization.get_submodel_descriptors_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelDescriptorsResult[source]

Read an instance of types.GetSubmodelDescriptorsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodel_descriptors_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelDescriptorsResult read from iterator

aas_core3_2.xmlization.get_submodel_descriptors_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelDescriptorsResult[source]

Read an instance of types.GetSubmodelDescriptorsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodel_descriptors_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelDescriptorsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelDescriptorsResult read from stream

aas_core3_2.xmlization.get_submodel_descriptors_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelDescriptorsResult[source]

Read an instance of types.GetSubmodelDescriptorsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodel_descriptors_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelDescriptorsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelDescriptorsResult read from path

aas_core3_2.xmlization.get_submodel_descriptors_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelDescriptorsResult[source]

Read an instance of types.GetSubmodelDescriptorsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodel_descriptors_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetSubmodelDescriptorsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelDescriptorsResult read from text

aas_core3_2.xmlization.get_submodel_elements_metadata_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelElementsMetadataResult[source]

Read an instance of types.GetSubmodelElementsMetadataResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodel_elements_metadata_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsMetadataResult read from iterator

aas_core3_2.xmlization.get_submodel_elements_metadata_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsMetadataResult[source]

Read an instance of types.GetSubmodelElementsMetadataResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodel_elements_metadata_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsMetadataResult read from stream

aas_core3_2.xmlization.get_submodel_elements_metadata_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsMetadataResult[source]

Read an instance of types.GetSubmodelElementsMetadataResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodel_elements_metadata_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsMetadataResult read from path

aas_core3_2.xmlization.get_submodel_elements_metadata_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsMetadataResult[source]

Read an instance of types.GetSubmodelElementsMetadataResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodel_elements_metadata_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsMetadataResult read from text

aas_core3_2.xmlization.get_submodel_elements_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelElementsResult[source]

Read an instance of types.GetSubmodelElementsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodel_elements_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsResult read from iterator

aas_core3_2.xmlization.get_submodel_elements_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsResult[source]

Read an instance of types.GetSubmodelElementsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodel_elements_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelElementsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsResult read from stream

aas_core3_2.xmlization.get_submodel_elements_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsResult[source]

Read an instance of types.GetSubmodelElementsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodel_elements_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelElementsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsResult read from path

aas_core3_2.xmlization.get_submodel_elements_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsResult[source]

Read an instance of types.GetSubmodelElementsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodel_elements_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetSubmodelElementsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsResult read from text

aas_core3_2.xmlization.get_submodel_elements_value_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelElementsValueResult[source]

Read an instance of types.GetSubmodelElementsValueResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodel_elements_value_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsValueResult read from iterator

aas_core3_2.xmlization.get_submodel_elements_value_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsValueResult[source]

Read an instance of types.GetSubmodelElementsValueResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodel_elements_value_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelElementsValueResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsValueResult read from stream

aas_core3_2.xmlization.get_submodel_elements_value_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsValueResult[source]

Read an instance of types.GetSubmodelElementsValueResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodel_elements_value_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelElementsValueResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsValueResult read from path

aas_core3_2.xmlization.get_submodel_elements_value_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelElementsValueResult[source]

Read an instance of types.GetSubmodelElementsValueResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodel_elements_value_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelElementsValueResult read from text

aas_core3_2.xmlization.get_all_submodels_recent_changes_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetAllSubmodelsRecentChangesResult[source]

Read an instance of types.GetAllSubmodelsRecentChangesResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_all_submodels_recent_changes_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllSubmodelsRecentChangesResult read from iterator

aas_core3_2.xmlization.get_all_submodels_recent_changes_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllSubmodelsRecentChangesResult[source]

Read an instance of types.GetAllSubmodelsRecentChangesResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_all_submodels_recent_changes_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllSubmodelsRecentChangesResult read from stream

aas_core3_2.xmlization.get_all_submodels_recent_changes_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllSubmodelsRecentChangesResult[source]

Read an instance of types.GetAllSubmodelsRecentChangesResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_all_submodels_recent_changes_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllSubmodelsRecentChangesResult read from path

aas_core3_2.xmlization.get_all_submodels_recent_changes_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetAllSubmodelsRecentChangesResult[source]

Read an instance of types.GetAllSubmodelsRecentChangesResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_all_submodels_recent_changes_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
Raise

DeserializationException if unexpected input

Returns

Instance of types.GetAllSubmodelsRecentChangesResult read from text

aas_core3_2.xmlization.get_submodels_metadata_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelsMetadataResult[source]

Read an instance of types.GetSubmodelsMetadataResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodels_metadata_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsMetadataResult read from iterator

aas_core3_2.xmlization.get_submodels_metadata_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsMetadataResult[source]

Read an instance of types.GetSubmodelsMetadataResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodels_metadata_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelsMetadataResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsMetadataResult read from stream

aas_core3_2.xmlization.get_submodels_metadata_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsMetadataResult[source]

Read an instance of types.GetSubmodelsMetadataResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodels_metadata_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelsMetadataResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsMetadataResult read from path

aas_core3_2.xmlization.get_submodels_metadata_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsMetadataResult[source]

Read an instance of types.GetSubmodelsMetadataResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodels_metadata_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetSubmodelsMetadataResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsMetadataResult read from text

aas_core3_2.xmlization.get_submodels_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelsResult[source]

Read an instance of types.GetSubmodelsResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodels_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsResult read from iterator

aas_core3_2.xmlization.get_submodels_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsResult[source]

Read an instance of types.GetSubmodelsResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodels_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsResult read from stream

aas_core3_2.xmlization.get_submodels_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsResult[source]

Read an instance of types.GetSubmodelsResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodels_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsResult read from path

aas_core3_2.xmlization.get_submodels_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsResult[source]

Read an instance of types.GetSubmodelsResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodels_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetSubmodelsResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsResult read from text

aas_core3_2.xmlization.get_submodels_value_result_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GetSubmodelsValueResult[source]

Read an instance of types.GetSubmodelsValueResult from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.get_submodels_value_result_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsValueResult read from iterator

aas_core3_2.xmlization.get_submodels_value_result_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsValueResult[source]

Read an instance of types.GetSubmodelsValueResult from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.get_submodels_value_result_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GetSubmodelsValueResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsValueResult read from stream

aas_core3_2.xmlization.get_submodels_value_result_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsValueResult[source]

Read an instance of types.GetSubmodelsValueResult from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.get_submodels_value_result_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GetSubmodelsValueResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsValueResult read from path

aas_core3_2.xmlization.get_submodels_value_result_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GetSubmodelsValueResult[source]

Read an instance of types.GetSubmodelsValueResult from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.get_submodels_value_result_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GetSubmodelsValueResult in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GetSubmodelsValueResult read from text

aas_core3_2.xmlization.claim_attribute_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ClaimAttribute[source]

Read an instance of types.ClaimAttribute from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.claim_attribute_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ClaimAttribute read from iterator

aas_core3_2.xmlization.claim_attribute_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ClaimAttribute[source]

Read an instance of types.ClaimAttribute from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.claim_attribute_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ClaimAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ClaimAttribute read from stream

aas_core3_2.xmlization.claim_attribute_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ClaimAttribute[source]

Read an instance of types.ClaimAttribute from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.claim_attribute_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ClaimAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ClaimAttribute read from path

aas_core3_2.xmlization.claim_attribute_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ClaimAttribute[source]

Read an instance of types.ClaimAttribute from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.claim_attribute_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ClaimAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ClaimAttribute read from text

aas_core3_2.xmlization.global_attribute_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GlobalAttribute[source]

Read an instance of types.GlobalAttribute from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.global_attribute_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GlobalAttribute read from iterator

aas_core3_2.xmlization.global_attribute_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GlobalAttribute[source]

Read an instance of types.GlobalAttribute from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.global_attribute_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GlobalAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GlobalAttribute read from stream

aas_core3_2.xmlization.global_attribute_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GlobalAttribute[source]

Read an instance of types.GlobalAttribute from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.global_attribute_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GlobalAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GlobalAttribute read from path

aas_core3_2.xmlization.global_attribute_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GlobalAttribute[source]

Read an instance of types.GlobalAttribute from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.global_attribute_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GlobalAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GlobalAttribute read from text

aas_core3_2.xmlization.reference_attribute_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ReferenceAttribute[source]

Read an instance of types.ReferenceAttribute from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.reference_attribute_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceAttribute read from iterator

aas_core3_2.xmlization.reference_attribute_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceAttribute[source]

Read an instance of types.ReferenceAttribute from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.reference_attribute_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ReferenceAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceAttribute read from stream

aas_core3_2.xmlization.reference_attribute_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceAttribute[source]

Read an instance of types.ReferenceAttribute from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.reference_attribute_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ReferenceAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceAttribute read from path

aas_core3_2.xmlization.reference_attribute_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ReferenceAttribute[source]

Read an instance of types.ReferenceAttribute from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.reference_attribute_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ReferenceAttribute in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ReferenceAttribute read from text

aas_core3_2.xmlization.date_time_attribute_item_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DateTimeAttributeItem[source]

Read an instance of types.DateTimeAttributeItem from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.date_time_attribute_item_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeItem read from iterator

aas_core3_2.xmlization.date_time_attribute_item_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeItem[source]

Read an instance of types.DateTimeAttributeItem from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.date_time_attribute_item_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DateTimeAttributeItem in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeItem read from stream

aas_core3_2.xmlization.date_time_attribute_item_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeItem[source]

Read an instance of types.DateTimeAttributeItem from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.date_time_attribute_item_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DateTimeAttributeItem in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeItem read from path

aas_core3_2.xmlization.date_time_attribute_item_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeItem[source]

Read an instance of types.DateTimeAttributeItem from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.date_time_attribute_item_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DateTimeAttributeItem in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeItem read from text

aas_core3_2.xmlization.field_operand_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → FieldOperand[source]

Read an instance of types.FieldOperand from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.field_operand_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.FieldOperand read from iterator

aas_core3_2.xmlization.field_operand_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FieldOperand[source]

Read an instance of types.FieldOperand from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.field_operand_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.FieldOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FieldOperand read from stream

aas_core3_2.xmlization.field_operand_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FieldOperand[source]

Read an instance of types.FieldOperand from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.field_operand_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.FieldOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FieldOperand read from path

aas_core3_2.xmlization.field_operand_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → FieldOperand[source]

Read an instance of types.FieldOperand from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.field_operand_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.FieldOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.FieldOperand read from text

aas_core3_2.xmlization.string_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → StringLiteral[source]

Read an instance of types.StringLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.string_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringLiteral read from iterator

aas_core3_2.xmlization.string_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringLiteral[source]

Read an instance of types.StringLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.string_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.StringLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringLiteral read from stream

aas_core3_2.xmlization.string_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringLiteral[source]

Read an instance of types.StringLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.string_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.StringLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringLiteral read from path

aas_core3_2.xmlization.string_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringLiteral[source]

Read an instance of types.StringLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.string_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.StringLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringLiteral read from text

aas_core3_2.xmlization.attribute_operand_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AttributeOperand[source]

Read an instance of types.AttributeOperand from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.attribute_operand_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AttributeOperand read from iterator

aas_core3_2.xmlization.attribute_operand_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AttributeOperand[source]

Read an instance of types.AttributeOperand from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.attribute_operand_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AttributeOperand read from stream

aas_core3_2.xmlization.attribute_operand_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AttributeOperand[source]

Read an instance of types.AttributeOperand from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.attribute_operand_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AttributeOperand read from path

aas_core3_2.xmlization.attribute_operand_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AttributeOperand[source]

Read an instance of types.AttributeOperand from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.attribute_operand_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AttributeOperand read from text

aas_core3_2.xmlization.number_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → NumberLiteral[source]

Read an instance of types.NumberLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.number_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberLiteral read from iterator

aas_core3_2.xmlization.number_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberLiteral[source]

Read an instance of types.NumberLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.number_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.NumberLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberLiteral read from stream

aas_core3_2.xmlization.number_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberLiteral[source]

Read an instance of types.NumberLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.number_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.NumberLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberLiteral read from path

aas_core3_2.xmlization.number_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberLiteral[source]

Read an instance of types.NumberLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.number_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.NumberLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberLiteral read from text

aas_core3_2.xmlization.hex_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HexLiteral[source]

Read an instance of types.HexLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.hex_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexLiteral read from iterator

aas_core3_2.xmlization.hex_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexLiteral[source]

Read an instance of types.HexLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.hex_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HexLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexLiteral read from stream

aas_core3_2.xmlization.hex_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexLiteral[source]

Read an instance of types.HexLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.hex_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HexLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexLiteral read from path

aas_core3_2.xmlization.hex_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexLiteral[source]

Read an instance of types.HexLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.hex_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HexLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexLiteral read from text

aas_core3_2.xmlization.date_time_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DateTimeLiteral[source]

Read an instance of types.DateTimeLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.date_time_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeLiteral read from iterator

aas_core3_2.xmlization.date_time_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeLiteral[source]

Read an instance of types.DateTimeLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.date_time_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DateTimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeLiteral read from stream

aas_core3_2.xmlization.date_time_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeLiteral[source]

Read an instance of types.DateTimeLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.date_time_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DateTimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeLiteral read from path

aas_core3_2.xmlization.date_time_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeLiteral[source]

Read an instance of types.DateTimeLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.date_time_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DateTimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeLiteral read from text

aas_core3_2.xmlization.time_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → TimeLiteral[source]

Read an instance of types.TimeLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.time_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeLiteral read from iterator

aas_core3_2.xmlization.time_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeLiteral[source]

Read an instance of types.TimeLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.time_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.TimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeLiteral read from stream

aas_core3_2.xmlization.time_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeLiteral[source]

Read an instance of types.TimeLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.time_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.TimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeLiteral read from path

aas_core3_2.xmlization.time_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeLiteral[source]

Read an instance of types.TimeLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.time_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.TimeLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeLiteral read from text

aas_core3_2.xmlization.boolean_literal_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BooleanLiteral[source]

Read an instance of types.BooleanLiteral from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.boolean_literal_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanLiteral read from iterator

aas_core3_2.xmlization.boolean_literal_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanLiteral[source]

Read an instance of types.BooleanLiteral from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.boolean_literal_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BooleanLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanLiteral read from stream

aas_core3_2.xmlization.boolean_literal_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanLiteral[source]

Read an instance of types.BooleanLiteral from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.boolean_literal_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BooleanLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanLiteral read from path

aas_core3_2.xmlization.boolean_literal_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanLiteral[source]

Read an instance of types.BooleanLiteral from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.boolean_literal_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BooleanLiteral in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanLiteral read from text

aas_core3_2.xmlization.string_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → StringCast[source]

Read an instance of types.StringCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.string_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringCast read from iterator

aas_core3_2.xmlization.string_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringCast[source]

Read an instance of types.StringCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.string_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.StringCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringCast read from stream

aas_core3_2.xmlization.string_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringCast[source]

Read an instance of types.StringCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.string_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.StringCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringCast read from path

aas_core3_2.xmlization.string_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StringCast[source]

Read an instance of types.StringCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.string_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.StringCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StringCast read from text

aas_core3_2.xmlization.number_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → NumberCast[source]

Read an instance of types.NumberCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.number_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberCast read from iterator

aas_core3_2.xmlization.number_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberCast[source]

Read an instance of types.NumberCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.number_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.NumberCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberCast read from stream

aas_core3_2.xmlization.number_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberCast[source]

Read an instance of types.NumberCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.number_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.NumberCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberCast read from path

aas_core3_2.xmlization.number_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NumberCast[source]

Read an instance of types.NumberCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.number_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.NumberCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NumberCast read from text

aas_core3_2.xmlization.hex_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → HexCast[source]

Read an instance of types.HexCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.hex_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexCast read from iterator

aas_core3_2.xmlization.hex_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexCast[source]

Read an instance of types.HexCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.hex_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.HexCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexCast read from stream

aas_core3_2.xmlization.hex_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexCast[source]

Read an instance of types.HexCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.hex_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.HexCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexCast read from path

aas_core3_2.xmlization.hex_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → HexCast[source]

Read an instance of types.HexCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.hex_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.HexCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.HexCast read from text

aas_core3_2.xmlization.boolean_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → BooleanCast[source]

Read an instance of types.BooleanCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.boolean_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanCast read from iterator

aas_core3_2.xmlization.boolean_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanCast[source]

Read an instance of types.BooleanCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.boolean_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.BooleanCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanCast read from stream

aas_core3_2.xmlization.boolean_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanCast[source]

Read an instance of types.BooleanCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.boolean_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.BooleanCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanCast read from path

aas_core3_2.xmlization.boolean_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → BooleanCast[source]

Read an instance of types.BooleanCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.boolean_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.BooleanCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.BooleanCast read from text

aas_core3_2.xmlization.date_time_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DateTimeCast[source]

Read an instance of types.DateTimeCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.date_time_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeCast read from iterator

aas_core3_2.xmlization.date_time_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeCast[source]

Read an instance of types.DateTimeCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.date_time_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DateTimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeCast read from stream

aas_core3_2.xmlization.date_time_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeCast[source]

Read an instance of types.DateTimeCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.date_time_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DateTimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeCast read from path

aas_core3_2.xmlization.date_time_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeCast[source]

Read an instance of types.DateTimeCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.date_time_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DateTimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeCast read from text

aas_core3_2.xmlization.time_cast_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → TimeCast[source]

Read an instance of types.TimeCast from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.time_cast_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeCast read from iterator

aas_core3_2.xmlization.time_cast_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeCast[source]

Read an instance of types.TimeCast from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.time_cast_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.TimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeCast read from stream

aas_core3_2.xmlization.time_cast_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeCast[source]

Read an instance of types.TimeCast from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.time_cast_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.TimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeCast read from path

aas_core3_2.xmlization.time_cast_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → TimeCast[source]

Read an instance of types.TimeCast from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.time_cast_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.TimeCast in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.TimeCast read from text

aas_core3_2.xmlization.day_of_week_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DayOfWeek[source]

Read an instance of types.DayOfWeek from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.day_of_week_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfWeek read from iterator

aas_core3_2.xmlization.day_of_week_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfWeek[source]

Read an instance of types.DayOfWeek from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.day_of_week_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DayOfWeek in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfWeek read from stream

aas_core3_2.xmlization.day_of_week_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfWeek[source]

Read an instance of types.DayOfWeek from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.day_of_week_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DayOfWeek in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfWeek read from path

aas_core3_2.xmlization.day_of_week_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfWeek[source]

Read an instance of types.DayOfWeek from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.day_of_week_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DayOfWeek in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfWeek read from text

aas_core3_2.xmlization.day_of_month_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DayOfMonth[source]

Read an instance of types.DayOfMonth from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.day_of_month_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfMonth read from iterator

aas_core3_2.xmlization.day_of_month_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfMonth[source]

Read an instance of types.DayOfMonth from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.day_of_month_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DayOfMonth in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfMonth read from stream

aas_core3_2.xmlization.day_of_month_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfMonth[source]

Read an instance of types.DayOfMonth from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.day_of_month_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DayOfMonth in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfMonth read from path

aas_core3_2.xmlization.day_of_month_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DayOfMonth[source]

Read an instance of types.DayOfMonth from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.day_of_month_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DayOfMonth in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DayOfMonth read from text

aas_core3_2.xmlization.month_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Month[source]

Read an instance of types.Month from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.month_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Month read from iterator

aas_core3_2.xmlization.month_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Month[source]

Read an instance of types.Month from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.month_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Month in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Month read from stream

aas_core3_2.xmlization.month_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Month[source]

Read an instance of types.Month from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.month_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Month in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Month read from path

aas_core3_2.xmlization.month_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Month[source]

Read an instance of types.Month from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.month_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Month in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Month read from text

aas_core3_2.xmlization.year_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Year[source]

Read an instance of types.Year from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.year_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Year read from iterator

aas_core3_2.xmlization.year_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Year[source]

Read an instance of types.Year from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.year_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Year in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Year read from stream

aas_core3_2.xmlization.year_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Year[source]

Read an instance of types.Year from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.year_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Year in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Year read from path

aas_core3_2.xmlization.year_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Year[source]

Read an instance of types.Year from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.year_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Year in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Year read from text

aas_core3_2.xmlization.date_time_attribute_operand_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → DateTimeAttributeOperand[source]

Read an instance of types.DateTimeAttributeOperand from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.date_time_attribute_operand_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeOperand read from iterator

aas_core3_2.xmlization.date_time_attribute_operand_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeOperand[source]

Read an instance of types.DateTimeAttributeOperand from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.date_time_attribute_operand_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.DateTimeAttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeOperand read from stream

aas_core3_2.xmlization.date_time_attribute_operand_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeOperand[source]

Read an instance of types.DateTimeAttributeOperand from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.date_time_attribute_operand_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.DateTimeAttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeOperand read from path

aas_core3_2.xmlization.date_time_attribute_operand_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → DateTimeAttributeOperand[source]

Read an instance of types.DateTimeAttributeOperand from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.date_time_attribute_operand_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.DateTimeAttributeOperand in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.DateTimeAttributeOperand read from text

aas_core3_2.xmlization.equal_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EqualComparison[source]

Read an instance of types.EqualComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.equal_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EqualComparison read from iterator

aas_core3_2.xmlization.equal_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EqualComparison[source]

Read an instance of types.EqualComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.equal_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EqualComparison read from stream

aas_core3_2.xmlization.equal_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EqualComparison[source]

Read an instance of types.EqualComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.equal_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EqualComparison read from path

aas_core3_2.xmlization.equal_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EqualComparison[source]

Read an instance of types.EqualComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.equal_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EqualComparison read from text

aas_core3_2.xmlization.not_equal_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → NotEqualComparison[source]

Read an instance of types.NotEqualComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.not_equal_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotEqualComparison read from iterator

aas_core3_2.xmlization.not_equal_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotEqualComparison[source]

Read an instance of types.NotEqualComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.not_equal_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.NotEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotEqualComparison read from stream

aas_core3_2.xmlization.not_equal_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotEqualComparison[source]

Read an instance of types.NotEqualComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.not_equal_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.NotEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotEqualComparison read from path

aas_core3_2.xmlization.not_equal_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotEqualComparison[source]

Read an instance of types.NotEqualComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.not_equal_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.NotEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotEqualComparison read from text

aas_core3_2.xmlization.greater_than_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GreaterThanComparison[source]

Read an instance of types.GreaterThanComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.greater_than_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanComparison read from iterator

aas_core3_2.xmlization.greater_than_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanComparison[source]

Read an instance of types.GreaterThanComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.greater_than_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GreaterThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanComparison read from stream

aas_core3_2.xmlization.greater_than_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanComparison[source]

Read an instance of types.GreaterThanComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.greater_than_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GreaterThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanComparison read from path

aas_core3_2.xmlization.greater_than_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanComparison[source]

Read an instance of types.GreaterThanComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.greater_than_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GreaterThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanComparison read from text

aas_core3_2.xmlization.greater_than_or_equal_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → GreaterThanOrEqualComparison[source]

Read an instance of types.GreaterThanOrEqualComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.greater_than_or_equal_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanOrEqualComparison read from iterator

aas_core3_2.xmlization.greater_than_or_equal_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanOrEqualComparison[source]

Read an instance of types.GreaterThanOrEqualComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.greater_than_or_equal_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.GreaterThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanOrEqualComparison read from stream

aas_core3_2.xmlization.greater_than_or_equal_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanOrEqualComparison[source]

Read an instance of types.GreaterThanOrEqualComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.greater_than_or_equal_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.GreaterThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanOrEqualComparison read from path

aas_core3_2.xmlization.greater_than_or_equal_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → GreaterThanOrEqualComparison[source]

Read an instance of types.GreaterThanOrEqualComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.greater_than_or_equal_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.GreaterThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.GreaterThanOrEqualComparison read from text

aas_core3_2.xmlization.less_than_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LessThanComparison[source]

Read an instance of types.LessThanComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.less_than_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanComparison read from iterator

aas_core3_2.xmlization.less_than_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanComparison[source]

Read an instance of types.LessThanComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.less_than_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LessThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanComparison read from stream

aas_core3_2.xmlization.less_than_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanComparison[source]

Read an instance of types.LessThanComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.less_than_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LessThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanComparison read from path

aas_core3_2.xmlization.less_than_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanComparison[source]

Read an instance of types.LessThanComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.less_than_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LessThanComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanComparison read from text

aas_core3_2.xmlization.less_than_or_equal_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → LessThanOrEqualComparison[source]

Read an instance of types.LessThanOrEqualComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.less_than_or_equal_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanOrEqualComparison read from iterator

aas_core3_2.xmlization.less_than_or_equal_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanOrEqualComparison[source]

Read an instance of types.LessThanOrEqualComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.less_than_or_equal_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.LessThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanOrEqualComparison read from stream

aas_core3_2.xmlization.less_than_or_equal_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanOrEqualComparison[source]

Read an instance of types.LessThanOrEqualComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.less_than_or_equal_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.LessThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanOrEqualComparison read from path

aas_core3_2.xmlization.less_than_or_equal_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → LessThanOrEqualComparison[source]

Read an instance of types.LessThanOrEqualComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.less_than_or_equal_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.LessThanOrEqualComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.LessThanOrEqualComparison read from text

aas_core3_2.xmlization.contains_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → ContainsComparison[source]

Read an instance of types.ContainsComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.contains_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.ContainsComparison read from iterator

aas_core3_2.xmlization.contains_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ContainsComparison[source]

Read an instance of types.ContainsComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.contains_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.ContainsComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ContainsComparison read from stream

aas_core3_2.xmlization.contains_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ContainsComparison[source]

Read an instance of types.ContainsComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.contains_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.ContainsComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ContainsComparison read from path

aas_core3_2.xmlization.contains_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → ContainsComparison[source]

Read an instance of types.ContainsComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.contains_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.ContainsComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.ContainsComparison read from text

aas_core3_2.xmlization.starts_with_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → StartsWithComparison[source]

Read an instance of types.StartsWithComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.starts_with_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.StartsWithComparison read from iterator

aas_core3_2.xmlization.starts_with_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StartsWithComparison[source]

Read an instance of types.StartsWithComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.starts_with_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.StartsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StartsWithComparison read from stream

aas_core3_2.xmlization.starts_with_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StartsWithComparison[source]

Read an instance of types.StartsWithComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.starts_with_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.StartsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StartsWithComparison read from path

aas_core3_2.xmlization.starts_with_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → StartsWithComparison[source]

Read an instance of types.StartsWithComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.starts_with_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.StartsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.StartsWithComparison read from text

aas_core3_2.xmlization.ends_with_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → EndsWithComparison[source]

Read an instance of types.EndsWithComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.ends_with_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.EndsWithComparison read from iterator

aas_core3_2.xmlization.ends_with_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EndsWithComparison[source]

Read an instance of types.EndsWithComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.ends_with_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.EndsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EndsWithComparison read from stream

aas_core3_2.xmlization.ends_with_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EndsWithComparison[source]

Read an instance of types.EndsWithComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.ends_with_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.EndsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EndsWithComparison read from path

aas_core3_2.xmlization.ends_with_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → EndsWithComparison[source]

Read an instance of types.EndsWithComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.ends_with_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.EndsWithComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.EndsWithComparison read from text

aas_core3_2.xmlization.regex_comparison_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → RegexComparison[source]

Read an instance of types.RegexComparison from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.regex_comparison_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.RegexComparison read from iterator

aas_core3_2.xmlization.regex_comparison_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RegexComparison[source]

Read an instance of types.RegexComparison from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.regex_comparison_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.RegexComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RegexComparison read from stream

aas_core3_2.xmlization.regex_comparison_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RegexComparison[source]

Read an instance of types.RegexComparison from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.regex_comparison_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.RegexComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RegexComparison read from path

aas_core3_2.xmlization.regex_comparison_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → RegexComparison[source]

Read an instance of types.RegexComparison from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.regex_comparison_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.RegexComparison in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.RegexComparison read from text

aas_core3_2.xmlization.match_clause_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → MatchClause[source]

Read an instance of types.MatchClause from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.match_clause_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.MatchClause read from iterator

aas_core3_2.xmlization.match_clause_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MatchClause[source]

Read an instance of types.MatchClause from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.match_clause_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.MatchClause in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MatchClause read from stream

aas_core3_2.xmlization.match_clause_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MatchClause[source]

Read an instance of types.MatchClause from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.match_clause_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.MatchClause in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MatchClause read from path

aas_core3_2.xmlization.match_clause_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → MatchClause[source]

Read an instance of types.MatchClause from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.match_clause_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.MatchClause in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.MatchClause read from text

aas_core3_2.xmlization.and_expression_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → AndExpression[source]

Read an instance of types.AndExpression from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.and_expression_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.AndExpression read from iterator

aas_core3_2.xmlization.and_expression_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AndExpression[source]

Read an instance of types.AndExpression from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.and_expression_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.AndExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AndExpression read from stream

aas_core3_2.xmlization.and_expression_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AndExpression[source]

Read an instance of types.AndExpression from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.and_expression_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.AndExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AndExpression read from path

aas_core3_2.xmlization.and_expression_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → AndExpression[source]

Read an instance of types.AndExpression from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.and_expression_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.AndExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.AndExpression read from text

aas_core3_2.xmlization.or_expression_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → OrExpression[source]

Read an instance of types.OrExpression from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.or_expression_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.OrExpression read from iterator

aas_core3_2.xmlization.or_expression_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OrExpression[source]

Read an instance of types.OrExpression from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.or_expression_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.OrExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OrExpression read from stream

aas_core3_2.xmlization.or_expression_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OrExpression[source]

Read an instance of types.OrExpression from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.or_expression_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.OrExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OrExpression read from path

aas_core3_2.xmlization.or_expression_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → OrExpression[source]

Read an instance of types.OrExpression from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.or_expression_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.OrExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.OrExpression read from text

aas_core3_2.xmlization.not_expression_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → NotExpression[source]

Read an instance of types.NotExpression from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.not_expression_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotExpression read from iterator

aas_core3_2.xmlization.not_expression_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotExpression[source]

Read an instance of types.NotExpression from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.not_expression_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.NotExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotExpression read from stream

aas_core3_2.xmlization.not_expression_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotExpression[source]

Read an instance of types.NotExpression from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.not_expression_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.NotExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotExpression read from path

aas_core3_2.xmlization.not_expression_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → NotExpression[source]

Read an instance of types.NotExpression from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.not_expression_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.NotExpression in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.NotExpression read from text

aas_core3_2.xmlization.query_filter_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → QueryFilter[source]

Read an instance of types.QueryFilter from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.query_filter_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.QueryFilter read from iterator

aas_core3_2.xmlization.query_filter_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → QueryFilter[source]

Read an instance of types.QueryFilter from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.query_filter_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.QueryFilter in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.QueryFilter read from stream

aas_core3_2.xmlization.query_filter_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → QueryFilter[source]

Read an instance of types.QueryFilter from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.query_filter_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.QueryFilter in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.QueryFilter read from path

aas_core3_2.xmlization.query_filter_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → QueryFilter[source]

Read an instance of types.QueryFilter from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.query_filter_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.QueryFilter in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.QueryFilter read from text

aas_core3_2.xmlization.query_from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Query[source]

Read an instance of types.Query from the iterator.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.query_from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Query read from iterator

aas_core3_2.xmlization.query_from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Query[source]

Read an instance of types.Query from the stream.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.query_from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance of types.Query in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Query read from stream

aas_core3_2.xmlization.query_from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Query[source]

Read an instance of types.Query from the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.query_from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance of types.Query in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Query read from path

aas_core3_2.xmlization.query_from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Query[source]

Read an instance of types.Query from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.query_from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance of types.Query in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance of types.Query read from text

aas_core3_2.xmlization.from_iterparse(iterator: Iterator[Tuple[str, Element]]) → Class[source]

Read an instance from the iterator.

The type of the instance is determined by the very first start element.

Example usage:

import pathlib
import xml.etree.ElementTree as ET

import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
with path.open("rt") as fid:
    iterator = ET.iterparse(
        source=fid,
        events=['start', 'end']
    )
    instance = our_xmlization.from_iterparse(
        iterator
    )

# Do something with the ``instance``
Parameters

iterator – Input stream of (event, element) coming from xml.etree.ElementTree.iterparse() with the argument events=["start", "end"]

Raise

DeserializationException if unexpected input

Returns

Instance of types.Class read from the iterator

aas_core3_2.xmlization.from_stream(stream: ~typing.TextIO, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Class[source]

Read an instance from the stream.

The type of the instance is determined by the very first start element.

Example usage:

import aas_core3_2.xmlization as our_xmlization

with open_some_stream_over_network(...) as stream:
    instance = our_xmlization.from_stream(
        stream
    )

# Do something with the ``instance``
Parameters
  • stream – representing an instance in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance read from stream

aas_core3_2.xmlization.from_file(path: ~os.PathLike, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Class[source]

Read an instance from the file at the path.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

path = pathlib.Path(...)
instance = our_xmlization.from_file(
    path
)

# Do something with the ``instance``
Parameters
  • path – to the file representing an instance in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance read from the file at path

aas_core3_2.xmlization.from_str(text: str, has_iterparse: ~aas_core3_2.xmlcommon.HasIterparse = <module 'xml.etree.ElementTree' from '/opt/hostedtoolcache/Python/3.10.22/x64/lib/python3.10/xml/etree/ElementTree.py'>) → Class[source]

Read an instance from the text.

Example usage:

import pathlib
import aas_core3_2.xmlization as our_xmlization

text = "<...>...</...>"
instance = our_xmlization.from_str(
    text
)

# Do something with the ``instance``
Parameters
  • text – representing an instance in XML

  • has_iterparse –

    Module containing iterparse function.

    Default is to use xml.etree.ElementTree from the standard library. If you have to deal with malicious input, consider using a library such as defusedxml.ElementTree.

Raise

DeserializationException if unexpected input

Returns

Instance read from text

aas_core3_2.xmlization.write(instance: Class, stream: TextIO) → None[source]

Write the XML representation of instance to stream.

Example usage:

import pathlib

import aas_core3_2.types as our_types
import aas_core3_2.xmlization as our_xmlization

instance = Extension(
   ... # some constructor arguments
)

pth = pathlib.Path(...)
with pth.open("wt") as fid:
    our_xmlization.write(instance, fid)
Parameters
  • instance – to be serialized

  • stream – to write to

Raise

SerializationException if instance could not be serialized

aas_core3_2.xmlization.to_str(that: Class) → str[source]

Serialize that to an XML-encoded text.

Parameters

that – instance to be serialized

Raise

SerializationException if that could not be serialized

Returns

that serialized to XML serialized to text