aas-core-codegen 0.0.26__tar.gz → 0.0.27rc2__tar.gz

{aas_core_codegen-0.0.26/aas_core_codegen.egg-info → aas_core_codegen-0.0.27rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-core-codegen
-Version: 0.0.26
+Version: 0.0.27rc2
 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

{aas_core_codegen-0.0.26 → aas_core_codegen-0.0.27rc2}/aas_core_codegen/__init__.py

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

{aas_core_codegen-0.0.26 → aas_core_codegen-0.0.27rc2}/aas_core_codegen/common.py

@@ -6,6 +6,7 @@ import itertools
 import re
 import textwrap
 from typing import (
+    Final,
     Optional,
     Tuple,
     cast,
@@ -63,6 +64,18 @@ class Stripped(Rstripped):
         return cast(Stripped, block)
 
 
+#: Note in the documentation of the transpiled methods which mutate their instance
+#:
+#: We deliberately do not enforce the invariants of the instance after a method call,
+#: as that would be too inefficient. The generators append this note, as plain text,
+#: to the documentation so that the users of the SDKs are not surprised.
+NOTE_ON_INVARIANTS_OF_MUTATING_METHODS: Final[str] = (
+    "The invariants of the instance are not checked after this method changes it,\n"
+    "as that would be too inefficient. Please verify the instance explicitly\n"
+    "once you are done with the changes."
+)
+
+
 # noinspection RegExpSimplifiable
 IDENTIFIER_RE = re.compile(r"[a-zA-Z_][a-zA-Z_0-9]*")
 
@@ -75,6 +88,32 @@ class Identifier(DBC, Stripped):
         return cast(Identifier, value)
 
 
+# noinspection RegExpSimplifiable
+#: Match a valid local (*i.e.*, unprefixed) XML tag name, a simplified,
+#: ASCII-only subset of the ``NCName`` production, see:
+#: https://www.w3.org/TR/xml-names/#NT-NCName
+#:
+#: The colon (``:``) is deliberately excluded as it is reserved for
+#: namespace prefixes, and this codegen only ever emits unprefixed tag names.
+XML_TAG_NAME_RE = re.compile(r"[a-zA-Z_][a-zA-Z_0-9.\-]*")
+
+
+class XMLTagName(DBC, Stripped):
+    """Represent a valid local (unprefixed) XML tag name."""
+
+    @require(lambda value: XML_TAG_NAME_RE.fullmatch(value))
+    def __new__(cls, value: str) -> "XMLTagName":
+        return cast(XMLTagName, value)
+
+
+class NonEmptyString(DBC, str):
+    """Represent a string with at least one character."""
+
+    @require(lambda value: len(value) > 0)
+    def __new__(cls, value: str) -> "NonEmptyString":
+        return cast(NonEmptyString, value)
+
+
 class Error:
     """
     Represent an unexpected input.
@@ -412,7 +451,7 @@ def wrap_text_into_lines(text: str, line_width: int = 60) -> List[str]:
     if len(parts) == 1:
         return [text]
 
-    # NOTE (mristin, 2022-04-08):
+    # NOTE (mristin):
     # 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.
@@ -440,7 +479,7 @@ def wrap_text_into_lines(text: str, line_width: int = 60) -> List[str]:
     if article is not None:
         tokens.append(article)
 
-    # NOTE (mristin, 2022-04-08):
+    # NOTE (mristin):
     # 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)