aas-core-codegen 0.0.15__tar.gz → 0.0.17__tar.gz

aas_core_codegen-0.0.17/AUTHORS

@@ -0,0 +1,9 @@
+Nico Braunisch (nico.braunisch@tu-dresden.de) for Dresden University of Technology - Institute of Applied Computer Science 
+Tom Gneuss (tom.gneuss@tu-dresden.de) for Dresden University of Technology - Institute of Applied Computer Science 
+Elodie Thiéblin (elodie.thieblin@logilab.fr) for Logilab and Siemens AG
+Fabien Amarger (fabien.amarger@logilab.fr) for Logilab and Siemens AG
+Igor Garmaev (i.garmaev@iat.rwth-aachen.de) for RWTH Aachen
+Marko Ristin (marko@ristin.ch, marko.ristin@gmail.com, rist@zhaw.ch) for Zurich University of Applied Sciences (ZHAW)
+Sebastian Heppner (s.heppner@iat.rwth-aachen.de) for RWTH Aachen
+Markus Böhm (Markus.Boehm@conplement.de) for conplement AG
+Tobias Langer (Tobias.Langer@conplement.de) for conplement AG

{aas-core-codegen-0.0.15 → aas_core_codegen-0.0.17}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Marko Ristin, Nico Braunisch, Robert Lehmann
+Copyright (c) 2023 aas-core-codegen AUTHORS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+Please see the file AUTHORS for the full list of the authors of aas-core3.0-codegen.

{aas-core-codegen-0.0.15 → aas_core_codegen-0.0.17}/PKG-INFO

@@ -1,20 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: aas-core-codegen
-Version: 0.0.15
-Summary: Generate different implementations and schemas based on an AAS meta-model.
-Home-page: https://github.com/aas-core-works/aas-core-codegen
-Author: Marko Ristin, Nico Braunisch, Robert Lehmann
-Author-email: marko@ristin.ch
-License: License :: OSI Approved :: MIT License
-Keywords: asset administration shell code generation industry 4.0 industrie i4.0
-Platform: UNKNOWN
+Version: 0.0.17
+Summary: Generate implementations and schemas based on an AAS meta-model.
+Author-email: Marko Ristin <marko@ristin.ch>, Nico Braunisch <nico.braunisch@tu-dresden.de>
+License: MIT
+Project-URL: Homepage, https://github.com/aas-core-works/aas-core-codegen
+Keywords: asset administration shell,code generation,industry 4.0,industrie 4.0,i4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Provides-Extra: dev
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
 License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: asttokens<3,>=2.0.8
+Requires-Dist: icontract<3,>=2.7.3
+Requires-Dist: sortedcontainers<3,>=2.4.0
+Requires-Dist: docutils==0.22.3
+Requires-Dist: more-itertools<9,>=8
+Requires-Dist: greenery==4.1.0
+Dynamic: license-file
 
 ****************
 aas-core-codegen
@@ -93,19 +101,6 @@ Here is a diagram to illustrate the whole process:
 
 .. image:: https://raw.githubusercontent.com/aas-core-works/aas-core-codegen/main/diagram.svg
 
-Warning about Stability
-=======================
-While we aim for long-term stability of the generators, mind that the current version of the meta-model, version 3 release candidate 2 (V3RC2) is in too much flux to make any solid claims about the short-term stability.
-
-For example, not even the set of basic types is still defined, and there is an on-going discussion in the UAG Verwaltungsschale what this set might be.
-Same holds about the definitions of references and how we should deal with them.
-
-Moreover, the serialization approaches are not finalized either.
-For example, the current JSON schema does not allow for one-pass serialization (a.k.a. streaming-based serialization).
-We are discussing in UAG Verwaltungsschale to use JSON tuples with the model type as prefix instead of JSON objects, but this discussion is still at an early stage.
-
-As long as V3RC2 does not stabilize, consider the generated code and schemas to be insufficient for any serious use (either experimental or in production).
-
 Installation
 ============
 Single-File Release
@@ -170,11 +165,12 @@ Call the generator with the appropriate target:
 
     usage: aas-core-codegen [-h] --model_path MODEL_PATH --snippets_dir
                             SNIPPETS_DIR --output_dir OUTPUT_DIR --target
-                            {csharp,jsonschema,rdf_shacl,xsd} [--version]
+                            {csharp,cpp,golang,java,jsonschema,python,typescript,rdf_shacl,xsd,jsonld_context,protobuf,python_protobuf,opcua}
+                            [--version]
 
-    Generate different implementations and schemas based on an AAS meta-model.
+    Generate implementations and schemas based on an AAS meta-model.
 
-    optional arguments:
+    options:
       -h, --help            show this help message and exit
       --model_path MODEL_PATH
                             path to the meta-model
@@ -183,7 +179,7 @@ Call the generator with the appropriate target:
                             specific code snippets
       --output_dir OUTPUT_DIR
                             path to the generated code
-      --target {csharp,jsonschema,rdf_shacl,xsd}
+      --target {csharp,cpp,golang,java,jsonschema,python,typescript,rdf_shacl,xsd,jsonld_context,protobuf,python_protobuf,opcua}
                             target language or schema
       --version             show the current version and exit
 
@@ -213,5 +209,3 @@ Contributions in code are also welcome!
 Please see `CONTRIBUTING.rst`_ for developing guidelines.
 
 .. _CONTRIBUTING.rst: https://github.com/aas-core-works/aas-core-codegen/blob/main/CONTRIBUTING.rst
-
-

{aas-core-codegen-0.0.15 → aas_core_codegen-0.0.17}/README.rst

@@ -75,19 +75,6 @@ Here is a diagram to illustrate the whole process:
 
 .. image:: https://raw.githubusercontent.com/aas-core-works/aas-core-codegen/main/diagram.svg
 
-Warning about Stability
-=======================
-While we aim for long-term stability of the generators, mind that the current version of the meta-model, version 3 release candidate 2 (V3RC2) is in too much flux to make any solid claims about the short-term stability.
-
-For example, not even the set of basic types is still defined, and there is an on-going discussion in the UAG Verwaltungsschale what this set might be.
-Same holds about the definitions of references and how we should deal with them.
-
-Moreover, the serialization approaches are not finalized either.
-For example, the current JSON schema does not allow for one-pass serialization (a.k.a. streaming-based serialization).
-We are discussing in UAG Verwaltungsschale to use JSON tuples with the model type as prefix instead of JSON objects, but this discussion is still at an early stage.
-
-As long as V3RC2 does not stabilize, consider the generated code and schemas to be insufficient for any serious use (either experimental or in production).
-
 Installation
 ============
 Single-File Release
@@ -152,11 +139,12 @@ Call the generator with the appropriate target:
 
     usage: aas-core-codegen [-h] --model_path MODEL_PATH --snippets_dir
                             SNIPPETS_DIR --output_dir OUTPUT_DIR --target
-                            {csharp,jsonschema,rdf_shacl,xsd} [--version]
+                            {csharp,cpp,golang,java,jsonschema,python,typescript,rdf_shacl,xsd,jsonld_context,protobuf,python_protobuf,opcua}
+                            [--version]
 
-    Generate different implementations and schemas based on an AAS meta-model.
+    Generate implementations and schemas based on an AAS meta-model.
 
-    optional arguments:
+    options:
       -h, --help            show this help message and exit
       --model_path MODEL_PATH
                             path to the meta-model
@@ -165,7 +153,7 @@ Call the generator with the appropriate target:
                             specific code snippets
       --output_dir OUTPUT_DIR
                             path to the generated code
-      --target {csharp,jsonschema,rdf_shacl,xsd}
+      --target {csharp,cpp,golang,java,jsonschema,python,typescript,rdf_shacl,xsd,jsonld_context,protobuf,python_protobuf,opcua}
                             target language or schema
       --version             show the current version and exit
 

aas_core_codegen-0.0.17/aas_core_codegen/__init__.py

@@ -0,0 +1,6 @@
+"""Generate implementations and schemas based on an AAS meta-model."""
+
+__version__ = "0.0.17"
+__author__ = "Marko Ristin, Nico Braunisch"
+__license__ = "License :: OSI Approved :: MIT License"
+__status__ = "Production/Stable"

{aas-core-codegen-0.0.15 → aas_core_codegen-0.0.17}/aas_core_codegen/__main__.py

@@ -4,5 +4,5 @@ import aas_core_codegen.main
 
 if __name__ == "__main__":
     # The ``prog`` needs to be set in the argparse.
-    # Otherwise the program name in the help shown to the user will be ``__main__``.
+    # Otherwise, the program name in the help shown to the user will be ``__main__``.
     aas_core_codegen.main.main(prog="aas_core_codegen")

{aas-core-codegen-0.0.15 → aas_core_codegen-0.0.17}/aas_core_codegen/common.py

@@ -2,6 +2,7 @@
 import ast
 import inspect
 import io
+import itertools
 import re
 import textwrap
 from typing import (
@@ -16,15 +17,57 @@ from typing import (
     NoReturn,
     Any,
     Iterable,
+    TypeVar,
 )
 
 import asttokens
-from icontract import require, DBC
+from icontract import require, DBC, ensure
 
+
+class Rstripped(str):
+    """
+    Represent a block of text without trailing whitespace.
+
+    The block can be both single-line or multi-line.
+    """
+
+    @require(
+        lambda block: not block.endswith("\n")
+        and not block.endswith(" ")
+        and not block.endswith("\t")
+    )
+    def __new__(cls, block: str) -> "Rstripped":
+        return cast(Rstripped, block)
+
+
+def is_stripped(text: str) -> bool:
+    """Check that the ``text`` does not have leading and trailing whitespace."""
+    return (
+        not text.startswith("\n")
+        and not text.startswith(" ")
+        and not text.startswith("\t")
+    ) and (
+        not text.endswith("\n") and not text.endswith(" ") and not text.endswith("\t")
+    )
+
+
+class Stripped(Rstripped):
+    """
+    Represent a block of text without leading and trailing whitespace.
+
+    The block of text can be both single-line and multi-line.
+    """
+
+    @require(lambda block: is_stripped(block))
+    def __new__(cls, block: str) -> "Stripped":
+        return cast(Stripped, block)
+
+
+# noinspection RegExpSimplifiable
 IDENTIFIER_RE = re.compile(r"[a-zA-Z_][a-zA-Z_0-9]*")
 
 
-class Identifier(DBC, str):
+class Identifier(DBC, Stripped):
     """Represent an identifier."""
 
     @require(lambda value: IDENTIFIER_RE.fullmatch(value))
@@ -139,10 +182,6 @@ class Lines(DBC):
         """
         return cast(Lines, lines)
 
-    def __add__(self, other: "Lines") -> "Lines":
-        """Concatenate two list of lines."""
-        raise NotImplementedError("Only for type annotations")
-
     # pylint: disable=function-redefined
 
     @overload
@@ -159,12 +198,16 @@ class Lines(DBC):
         """Get the line(s) at the given index."""
         raise NotImplementedError("Only for type annotations")
 
+    def __iter__(self) -> Iterator[str]:
+        """Iterate over the lines."""
+        raise NotImplementedError("Only for type annotations")
+
     def __len__(self) -> int:
         """Return the number of the lines."""
         raise NotImplementedError("Only for type annotations")
 
-    def __iter__(self) -> Iterator[str]:
-        """Iterate over the lines."""
+    def __add__(self, other: "Lines") -> "Lines":
+        """Concatenate two list of lines."""
         raise NotImplementedError("Only for type annotations")
 
 
@@ -178,47 +221,6 @@ def assert_never(value: NoReturn) -> NoReturn:
     assert False, f"Unhandled value: {value} ({type(value).__name__})"
 
 
-class Rstripped(str):
-    """
-    Represent a block of text without trailing whitespace.
-
-    The block can be both single-line or multi-line.
-    """
-
-    @require(
-        lambda block: not block.endswith("\n")
-        and not block.endswith(" ")
-        and not block.endswith("\t")
-    )
-    def __new__(cls, block: str) -> "Rstripped":
-        return cast(Rstripped, block)
-
-
-class Stripped(Rstripped):
-    """
-    Represent a block of text without leading and trailing whitespace.
-
-    The block of text can be both single-line and multi-line.
-    """
-
-    # fmt: off
-    @require(
-        lambda block:
-        not block.startswith('\n')
-        and not block.startswith(' ')
-        and not block.startswith('\t')
-    )
-    @require(
-        lambda block:
-        not block.endswith('\n')
-        and not block.endswith(' ')
-        and not block.endswith('\t')
-    )
-    # fmt: on
-    def __new__(cls, block: str) -> "Stripped":
-        return cast(Stripped, block)
-
-
 def indent_but_first_line(text: str, indention: str) -> str:
     """
     Indent all but the first of the given ``text`` by ``indention``.
@@ -254,7 +256,7 @@ def assert_union_of_descendants_exhaustive(union: Any, base_class: Any) -> None:
     else:
         raise NotImplementedError(f"We do not know how to handle the union: {union}")
 
-    # We have to recursively figure out the sub-classes.
+    # We have to recursively figure out the subclasses.
     concrete_subclasses = []  # type: List[Any]
 
     stack = base_class.__subclasses__()  # type: List[Any]
@@ -392,3 +394,107 @@ def assert_union_without_excluded(
         )
 
     # endregion
+
+
+@ensure(lambda text, result: text == "".join(result))
+def wrap_text_into_lines(text: str, line_width: int = 60) -> List[str]:
+    """
+    Wrap the ``text`` into multiple lines.
+
+    The tokens are split based on the whitespace. We make sure the articles are not
+    left hanging between the lines. A line should observe the ``line_limit``,
+    if possible.
+
+    No new lines are added — the description should be given to the user in the original
+    formatting. We merely split it in string literals for better code readability.
+    """
+    parts = text.split(" ")
+    if len(parts) == 1:
+        return [text]
+
+    # NOTE (mristin, 2022-04-08):
+    # We do not want to cut out "the", "a" and "an" on separate lines, so we split
+    # the text once more in tokens where the articles are kept in the same token as
+    # the word.
+    tokens = []  # type: List[str]
+
+    article = None  # type: Optional[str]
+    for part in parts:
+        if article is None:
+            if part in ("a", "an", "the"):
+                article = part
+                continue
+            else:
+                tokens.append(part)
+        else:
+            if part in ("a", "an", "the"):
+                # Append the previously observed ``article``;
+                # the ``part`` becomes a new article.
+                tokens.append(article)
+                article = part
+                continue
+
+            tokens.append(f"{article} {part}")
+            article = None
+
+    if article is not None:
+        tokens.append(article)
+
+    # NOTE (mristin, 2022-04-08):
+    # We add space to the tokens so that it is easier to re-flow them.
+    tokens = [
+        f"{token} " if i < len(tokens) - 1 else token for i, token in enumerate(tokens)
+    ]
+    assert "".join(tokens) == text
+
+    segments = []  # type: List[str]
+
+    accumulation_len = 0
+    accumulation = []  # type: List[str]
+
+    for token in tokens:
+        if len(token) > line_width:
+            segments.append("".join(accumulation))
+            segments.append(token)
+            accumulation_len = 0
+            accumulation = []
+
+        elif accumulation_len + len(token) > line_width:
+            segments.append("".join(accumulation))
+            accumulation_len = len(token)
+            accumulation = [token]
+        else:
+            accumulation_len += len(token)
+            accumulation.append(token)
+
+    if accumulation_len > 0:
+        segments.append("".join(accumulation))
+
+    return segments
+
+
+T = TypeVar("T")
+
+
+def pairwise(iterable: Iterable[T]) -> Iterator[Tuple[T, T]]:
+    """
+    Iterate pair-wise over the iterator.
+
+    >>> list(pairwise("ABCDE"))
+    [('A', 'B'), ('B', 'C'), ('C', 'D'), ('D', 'E')]
+    """
+    a, b = itertools.tee(iterable)
+    next(b, None)
+    return zip(a, b)
+
+
+def iterate_except_first(iterable: Iterable[T]) -> Iterator[T]:
+    """
+    Iterate over ``iterable``, but skip the first item.
+
+    >>> list(iterate_except_first("ABCD"))
+    ['B', 'C', 'D']
+    """
+    iterator = iter(iterable)
+    next(iterator, None)
+    yield from iterator

aas_core_codegen-0.0.17/aas_core_codegen/cpp/__init__.py

@@ -0,0 +1 @@
+"""Generate C++ code based on the intermediate meta-model."""

aas_core_codegen-0.0.17/aas_core_codegen/cpp/aas_common/__init__.py

@@ -0,0 +1,6 @@
+"""Generate C++ code for common functions."""
+
+from aas_core_codegen.cpp.aas_common import _generate
+
+generate_header = _generate.generate_header
+generate_implementation = _generate.generate_implementation