sysmlpy 0.28.0__tar.gz → 0.28.1__tar.gz

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sysmlpy
-Version: 0.28.0
+Version: 0.28.1
 Summary: SysML v2.0 Parser
 License: MIT License
          
@@ -530,7 +530,7 @@ print(as_parametric_view(model, style="bw"))
 #### Action Flow View (AFV) — `as_action_flow_view()`
 Corresponds to SysML v2 ``ActionFlowView`` (short name ``afv``). Shows actions with their control and object flows. Auto-includes connected flow elements.
 
-![Action Flow View](docs/plantuml-examples/09-action-flow-view.png)
+![Action Flow View](docs/plantuml-examples/13-action-flow-view.png)
 
 ```python
 from sysmlpy.plantuml import as_action_flow_view
@@ -550,7 +550,7 @@ print(as_interconnection_view(model, style="bw"))
 #### State Transition View (STV) — `as_state_transition_view()`
 Corresponds to SysML v2 ``StateTransitionView`` (short name ``stv``). State machine diagram with hierarchical states and transitions. Auto-includes connected transition elements.
 
-![State Transition View](docs/plantuml-examples/10-state-transition-view.png)
+![State Transition View](docs/plantuml-examples/14-state-transition-view.png)
 
 ```python
 from sysmlpy.plantuml import as_state_transition_view
@@ -560,19 +560,17 @@ print(as_state_transition_view(model, style="bw"))
 #### Tree Diagram — `as_tree_diagram()`
 Hierarchical containment tree using nested PlantUML containers. Shows ownership hierarchy with sharp corners for definitions and rounded corners for usages.
 
-![Tree Diagram](docs/plantuml-examples/11-tree-diagram.png)
+![Tree Diagram](docs/plantuml-examples/15-tree-diagram.png)
 
 ```python
 from sysmlpy.plantuml import as_tree_diagram
 print(as_tree_diagram(model, style="bw"))
 ```
 
-### Tabular View Rendering Functions
-
 #### Element Table — `as_element_table()`
 A simple tabular listing with columns Name, Type, Kind, and Parent.
 
-![Element Table](docs/plantuml-examples/12-element-table.png)
+![Element Table](docs/plantuml-examples/16-element-table.png)
 
 ```python
 from sysmlpy.plantuml import as_element_table
@@ -582,7 +580,7 @@ print(as_element_table(model, style="bw"))
 #### Textual Notation — `as_textual_notation()`
 Indented text representation inside a PlantUML note, similar to the SysML v2 textual concrete syntax.
 
-![Textual Notation](docs/plantuml-examples/13-textual-notation.png)
+![Textual Notation](docs/plantuml-examples/17-textual-notation.png)
 
 ```python
 from sysmlpy.plantuml import as_textual_notation
@@ -593,20 +591,22 @@ print(as_textual_notation(model, style="bw"))
 
 Per the SysML v2 standard, ``GridView`` (short name ``grv``) presents exposed model elements and their relationships in a rectangular grid. It has three specializations, all supporting **three output formats**:
 
-| Format | Use case |
-|--------|----------|
-| `"plantuml"` (default) | PlantUML table / salt matrix — embed in diagrams |
-| `"markdown"` | Standard pipe table — for GitHub, MkDocs, or Jupyter |
-| `"html"` | Rich `<table>` with CSS classes — for web dashboards |
+| Format | Use case | Compatibility |
+|--------|----------|---------------|
+| `"markdown"` (default) | Standard pipe table — for GitHub, MkDocs, or Jupyter | ✅ Universal |
+| `"html"` | Rich `<table>` with CSS classes — for web dashboards | ✅ Universal |
+| `"plantuml"` | PlantUML table / salt matrix — embed in diagrams | ⚠️ PlantUML <1.2024.7 only |
+
+**Note:** PlantUML 1.2024.7+ removed support for legacy table syntax. Use `"markdown"` or `"html"` output format for compatibility with all PlantUML versions.
 
 #### Tabular View — `as_tabular_view()`
 Extensible table with configurable columns. Default columns: Name, Type, Kind, Parent, Typed By, Specializes.
 
-![Tabular View (BW)](docs/plantuml-examples/14-tabular-view.png)
+See [`18-tabular-view.md`](docs/plantuml-examples/18-tabular-view.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_tabular_view
-print(as_tabular_view(model, output_format="markdown"))
+print(as_tabular_view(model))  # Default: markdown output
 ```
 
 Custom columns and other output formats:
@@ -617,18 +617,18 @@ print(as_tabular_view(model,
     columns=["Name", "Type", "Parent", "Typed By"],
     output_format="html"))
 
-# Markdown for documentation
+# Markdown for documentation (default)
 print(as_tabular_view(model, output_format="markdown"))
 ```
 
 #### Data Value Tabular View — `as_data_value_tabular_view()`
 Attribute-specific version showing Element, Attribute, Value, Unit, and Type columns. Uses `Attribute.get_value()` for pint.Quantity extraction.
 
-![Data Value View](docs/plantuml-examples/15-data-value-view.png)
+See [`19-data-value-view.md`](docs/plantuml-examples/19-data-value-view.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_data_value_tabular_view
-print(as_data_value_tabular_view(model, output_format="html"))
+print(as_data_value_tabular_view(model))  # Default: markdown output
 ```
 
 #### Relationship Matrix View — `as_relationship_matrix_view()`
@@ -639,11 +639,11 @@ Pairwise element×element matrix showing relationship types:
 - **G** = Specialization (generalization)
 - **B** = Binding, **F** = Flow, **R** = Redefinition, etc.
 
-![Relationship Matrix](docs/plantuml-examples/16-relationship-matrix.png)
+See [`20-relationship-matrix.md`](docs/plantuml-examples/20-relationship-matrix.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_relationship_matrix_view
-print(as_relationship_matrix_view(model, output_format="markdown"))
+print(as_relationship_matrix_view(model))  # Default: markdown output
 ```
 
 Type filtering and HTML output:
@@ -660,10 +660,10 @@ All rendering functions accept `style="color"` for colored output with CSS-style
 
 ```python
 from sysmlpy.plantuml import as_tabular_view
-print(as_tabular_view(model, style="color"))
+print(as_tabular_view(model, output_format="html", style="color"))
 ```
 
-![Tabular View (Color)](docs/plantuml-examples/17-tabular-view-color.png)
+See [`21-tabular-view-color.html`](docs/plantuml-examples/21-tabular-view-color.html) for example output.
 
 ### Complete Example Gallery
 

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/README.md

@@ -485,7 +485,7 @@ print(as_parametric_view(model, style="bw"))
 #### Action Flow View (AFV) — `as_action_flow_view()`
 Corresponds to SysML v2 ``ActionFlowView`` (short name ``afv``). Shows actions with their control and object flows. Auto-includes connected flow elements.
 
-![Action Flow View](docs/plantuml-examples/09-action-flow-view.png)
+![Action Flow View](docs/plantuml-examples/13-action-flow-view.png)
 
 ```python
 from sysmlpy.plantuml import as_action_flow_view
@@ -505,7 +505,7 @@ print(as_interconnection_view(model, style="bw"))
 #### State Transition View (STV) — `as_state_transition_view()`
 Corresponds to SysML v2 ``StateTransitionView`` (short name ``stv``). State machine diagram with hierarchical states and transitions. Auto-includes connected transition elements.
 
-![State Transition View](docs/plantuml-examples/10-state-transition-view.png)
+![State Transition View](docs/plantuml-examples/14-state-transition-view.png)
 
 ```python
 from sysmlpy.plantuml import as_state_transition_view
@@ -515,19 +515,17 @@ print(as_state_transition_view(model, style="bw"))
 #### Tree Diagram — `as_tree_diagram()`
 Hierarchical containment tree using nested PlantUML containers. Shows ownership hierarchy with sharp corners for definitions and rounded corners for usages.
 
-![Tree Diagram](docs/plantuml-examples/11-tree-diagram.png)
+![Tree Diagram](docs/plantuml-examples/15-tree-diagram.png)
 
 ```python
 from sysmlpy.plantuml import as_tree_diagram
 print(as_tree_diagram(model, style="bw"))
 ```
 
-### Tabular View Rendering Functions
-
 #### Element Table — `as_element_table()`
 A simple tabular listing with columns Name, Type, Kind, and Parent.
 
-![Element Table](docs/plantuml-examples/12-element-table.png)
+![Element Table](docs/plantuml-examples/16-element-table.png)
 
 ```python
 from sysmlpy.plantuml import as_element_table
@@ -537,7 +535,7 @@ print(as_element_table(model, style="bw"))
 #### Textual Notation — `as_textual_notation()`
 Indented text representation inside a PlantUML note, similar to the SysML v2 textual concrete syntax.
 
-![Textual Notation](docs/plantuml-examples/13-textual-notation.png)
+![Textual Notation](docs/plantuml-examples/17-textual-notation.png)
 
 ```python
 from sysmlpy.plantuml import as_textual_notation
@@ -548,20 +546,22 @@ print(as_textual_notation(model, style="bw"))
 
 Per the SysML v2 standard, ``GridView`` (short name ``grv``) presents exposed model elements and their relationships in a rectangular grid. It has three specializations, all supporting **three output formats**:
 
-| Format | Use case |
-|--------|----------|
-| `"plantuml"` (default) | PlantUML table / salt matrix — embed in diagrams |
-| `"markdown"` | Standard pipe table — for GitHub, MkDocs, or Jupyter |
-| `"html"` | Rich `<table>` with CSS classes — for web dashboards |
+| Format | Use case | Compatibility |
+|--------|----------|---------------|
+| `"markdown"` (default) | Standard pipe table — for GitHub, MkDocs, or Jupyter | ✅ Universal |
+| `"html"` | Rich `<table>` with CSS classes — for web dashboards | ✅ Universal |
+| `"plantuml"` | PlantUML table / salt matrix — embed in diagrams | ⚠️ PlantUML <1.2024.7 only |
+
+**Note:** PlantUML 1.2024.7+ removed support for legacy table syntax. Use `"markdown"` or `"html"` output format for compatibility with all PlantUML versions.
 
 #### Tabular View — `as_tabular_view()`
 Extensible table with configurable columns. Default columns: Name, Type, Kind, Parent, Typed By, Specializes.
 
-![Tabular View (BW)](docs/plantuml-examples/14-tabular-view.png)
+See [`18-tabular-view.md`](docs/plantuml-examples/18-tabular-view.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_tabular_view
-print(as_tabular_view(model, output_format="markdown"))
+print(as_tabular_view(model))  # Default: markdown output
 ```
 
 Custom columns and other output formats:
@@ -572,18 +572,18 @@ print(as_tabular_view(model,
     columns=["Name", "Type", "Parent", "Typed By"],
     output_format="html"))
 
-# Markdown for documentation
+# Markdown for documentation (default)
 print(as_tabular_view(model, output_format="markdown"))
 ```
 
 #### Data Value Tabular View — `as_data_value_tabular_view()`
 Attribute-specific version showing Element, Attribute, Value, Unit, and Type columns. Uses `Attribute.get_value()` for pint.Quantity extraction.
 
-![Data Value View](docs/plantuml-examples/15-data-value-view.png)
+See [`19-data-value-view.md`](docs/plantuml-examples/19-data-value-view.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_data_value_tabular_view
-print(as_data_value_tabular_view(model, output_format="html"))
+print(as_data_value_tabular_view(model))  # Default: markdown output
 ```
 
 #### Relationship Matrix View — `as_relationship_matrix_view()`
@@ -594,11 +594,11 @@ Pairwise element×element matrix showing relationship types:
 - **G** = Specialization (generalization)
 - **B** = Binding, **F** = Flow, **R** = Redefinition, etc.
 
-![Relationship Matrix](docs/plantuml-examples/16-relationship-matrix.png)
+See [`20-relationship-matrix.md`](docs/plantuml-examples/20-relationship-matrix.md) for example output.
 
 ```python
 from sysmlpy.plantuml import as_relationship_matrix_view
-print(as_relationship_matrix_view(model, output_format="markdown"))
+print(as_relationship_matrix_view(model))  # Default: markdown output
 ```
 
 Type filtering and HTML output:
@@ -615,10 +615,10 @@ All rendering functions accept `style="color"` for colored output with CSS-style
 
 ```python
 from sysmlpy.plantuml import as_tabular_view
-print(as_tabular_view(model, style="color"))
+print(as_tabular_view(model, output_format="html", style="color"))
 ```
 
-![Tabular View (Color)](docs/plantuml-examples/17-tabular-view-color.png)
+See [`21-tabular-view-color.html`](docs/plantuml-examples/21-tabular-view-color.html) for example output.
 
 ### Complete Example Gallery
 

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "sysmlpy"
-version = "0.28.0"
+version = "0.28.1"
 description = "SysML v2.0 Parser"
 authors = [
   { name="Jon R. Fox (mycr0ft)", email="jon.fox@drfox.com" },
@@ -114,7 +114,7 @@ build_command = "pip install poetry && poetry build"
 
 [tool.poetry]
 name = "sysmlpy"
-version = "0.28.0"
+version = "0.28.1"
 description = ""
 authors = ["Jon R. Fox (mycr0ft) <jon.fox@drfox.com>"]
 readme = "README.md"

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/src/sysmlpy/__init__.py

@@ -20,7 +20,7 @@ __all__ = [
     "analyze", "SemanticIssue", "SemanticAnalyzer",
 ]
 __author__ = "Jon Fox"
-__version__ = "0.28.0"
+__version__ = "0.28.1"
 
 from sysmlpy.usage import (
     Item, Attribute, Part, Port, Action, Reference, UseCase, Requirement, Interface, Message,

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/src/sysmlpy/antlr_visitor.py

@@ -245,10 +245,138 @@ def _visit_comment_dict(ctx):
     }
 
 
+def _visit_textual_representation_dict(ctx):
+    """Visit a textualRepresentation context and return a TextualRepresentation dictionary.
+    
+    Grammar: (REP identification?)? LANGUAGE DOUBLE_STRING REGULAR_COMMENT
+    """
+    identification = None
+    if ctx.identification():
+        identification = _build_identification_dict(ctx.identification())
+    
+    language = ""
+    if ctx.DOUBLE_STRING():
+        language = ctx.DOUBLE_STRING().getText().strip('"')
+    
+    body = ""
+    if ctx.REGULAR_COMMENT():
+        body = ctx.REGULAR_COMMENT().getText()
+    
+    return {
+        "name": "TextualRepresentation",
+        "identification": identification,
+        "language": language,
+        "body": body
+    }
+
+
+def _visit_metadata_feature_dict(ctx):
+    """Visit a metadataFeature context and return a MetadataFeature dictionary.
+    
+    Grammar: (prefixMetadataMember)* (AT_SIGN | METADATA) metadataFeatureDeclaration (
+        ABOUT annotation ( COMMA annotation)*
+    )? metadataBody
+    """
+    prefix_members = []
+    for pm in ctx.prefixMetadataMember():
+        prefix_members.append(_visit_prefix_metadata_member_dict(pm))
+    
+    identification = None
+    owned_feature_typing = None
+    if ctx.metadataFeatureDeclaration():
+        mfd = ctx.metadataFeatureDeclaration()
+        if mfd.identification():
+            identification = _build_identification_dict(mfd.identification())
+        if mfd.ownedFeatureTyping():
+            owned_feature_typing = _visit_owned_feature_typing_dict(mfd.ownedFeatureTyping())
+    
+    annotations = []
+    if ctx.ABOUT():
+        for ann_idx in range(len(ctx.annotation())):
+            ann_ctx = ctx.annotation(ann_idx)
+            if ann_ctx and ann_ctx.qualifiedName():
+                qn_text = ann_ctx.qualifiedName().getText()
+                annotations.append({
+                    "name": "Annotation",
+                    "annotatedElement": {
+                        "name": "QualifiedName",
+                        "names": qn_text.split("::")
+                    }
+                })
+    
+    body = ""
+    if ctx.metadataBody() and ctx.metadataBody().SEMI():
+        body = ";"
+    
+    return {
+        "name": "MetadataFeature",
+        "prefixMetadataMember": prefix_members,
+        "identification": identification,
+        "ownedFeatureTyping": owned_feature_typing,
+        "ownedRelationship_about": annotations,
+        "body": body
+    }
+
+
+def _visit_prefix_metadata_member_dict(ctx):
+    """Visit a prefixMetadataMember context."""
+    visibility = ""
+    direction = ""
+    
+    if ctx.PRIVATE():
+        visibility = "private"
+    elif ctx.PROTECTED():
+        visibility = "protected"
+    elif ctx.PUBLIC():
+        visibility = "public"
+    
+    if ctx.IN():
+        direction = "in"
+    elif ctx.OUT():
+        direction = "out"
+    elif ctx.INOUT():
+        direction = "inout"
+    
+    return {
+        "name": "PrefixMetadataMember",
+        "visibility": visibility,
+        "direction": direction
+    }
+
+
+def _visit_owned_feature_typing_dict(ctx):
+    """Visit an ownedFeatureTyping context and return an OwnedFeatureTyping dictionary."""
+    if ctx is None:
+        return None
+    
+    if hasattr(ctx, 'qualifiedName') and ctx.qualifiedName():
+        qns = ctx.qualifiedName()
+        if not isinstance(qns, list):
+            qns = [qns]
+        names = []
+        for qn in qns:
+            if qn:
+                names.append(qn.getText())
+        if names:
+            return {
+                "name": "OwnedFeatureTyping",
+                "type": {
+                    "name": "FeatureType",
+                    "type": {
+                        "name": "QualifiedName",
+                        "names": names
+                    },
+                    "ownedRelatedElement": []
+                },
+                "ownedRelatedElement": []
+            }
+    return None
+
+
 def _visit_annotating_element_dict(annot_elem_ctx):
     """Visit an annotating element context and return an AnnotatingElement dictionary.
     
-    Dispatches to documentation or comment based on the context.
+    Dispatches to documentation, comment, textualRepresentation, or metadataFeature.
     """
     if annot_elem_ctx is None:
         return None
@@ -258,6 +386,10 @@ def _visit_annotating_element_dict(annot_elem_ctx):
         inner = _visit_documentation_dict(annot_elem_ctx.documentation())
     elif hasattr(annot_elem_ctx, 'comment') and annot_elem_ctx.comment():
         inner = _visit_comment_dict(annot_elem_ctx.comment())
+    elif hasattr(annot_elem_ctx, 'textualRepresentation') and annot_elem_ctx.textualRepresentation():
+        inner = _visit_textual_representation_dict(annot_elem_ctx.textualRepresentation())
+    elif hasattr(annot_elem_ctx, 'metadataFeature') and annot_elem_ctx.metadataFeature():
+        inner = _visit_metadata_feature_dict(annot_elem_ctx.metadataFeature())
     
     if inner is None:
         return None

{sysmlpy-0.28.0 → sysmlpy-0.28.1}/src/sysmlpy/grammar/classes.py

@@ -4225,6 +4225,142 @@ class Documentation:
         return output
 
 
+class TextualRepresentation:
+    # textualRepresentation
+    #   : (REP identification?)? LANGUAGE DOUBLE_STRING REGULAR_COMMENT
+    #   ;
+    def __init__(self, definition):
+        if valid_definition(definition, "TextualRepresentation"):
+            self.identification = None
+            if definition.get("identification") is not None:
+                self.identification = Identification(definition["identification"])
+            
+            self.language = definition.get("language", "")
+            self.body = definition.get("body", "")
+
+    def dump(self):
+        output = []
+        if self.identification is not None:
+            output.append("rep")
+            output.append(self.identification.dump())
+        output.append("language")
+        output.append(f'"{self.language}"')
+        output.append(self.body)
+        return " ".join(output)
+
+    def get_definition(self):
+        output = {
+            "name": self.__class__.__name__,
+            "identification": self.identification.get_definition() if self.identification else None,
+            "language": self.language,
+            "body": self.body
+        }
+        return output
+
+
+class MetadataFeature:
+    # metadataFeature
+    #   : (prefixMetadataMember)* (AT_SIGN | METADATA) metadataFeatureDeclaration (
+    #       ABOUT annotation ( COMMA annotation)*
+    #   )? metadataBody
+    #   ;
+    def __init__(self, definition):
+        if valid_definition(definition, "MetadataFeature"):
+            self.prefix = []
+            for p in definition.get("prefixMetadataMember", []):
+                self.prefix.append(PrefixMetadataMember(p))
+            
+            self.identification = None
+            if definition.get("identification") is not None:
+                self.identification = Identification(definition["identification"])
+            
+            self.typing = None
+            if definition.get("ownedFeatureTyping") is not None:
+                self.typing = OwnedFeatureTyping(definition["ownedFeatureTyping"])
+            
+            self.annotations = []
+            for ann in definition.get("ownedRelationship_about", []):
+                self.annotations.append(Annotation(ann))
+            
+            self.body = definition.get("body", "")
+
+    def dump(self):
+        output = []
+        for p in self.prefix:
+            output.append(p.dump())
+        output.append("@")
+        if self.identification is not None:
+            output.append(self.identification.dump())
+        if self.typing is not None:
+            output.append(":")
+            output.append(self.typing.dump())
+        if self.annotations:
+            output.append("about")
+            output.append(", ".join([a.dump() for a in self.annotations]))
+        if self.body:
+            output.append(self.body)
+        return " ".join(output)
+
+    def get_definition(self):
+        output = {
+            "name": self.__class__.__name__,
+            "prefixMetadataMember": [p.get_definition() for p in self.prefix],
+            "identification": self.identification.get_definition() if self.identification else None,
+            "ownedFeatureTyping": self.typing.get_definition() if self.typing else None,
+            "ownedRelationship_about": [a.get_definition() for a in self.annotations],
+            "body": self.body
+        }
+        return output
+
+
+class PrefixMetadataMember:
+    def __init__(self, definition):
+        if valid_definition(definition, "PrefixMetadataMember"):
+            self.visibility = definition.get("visibility", "")
+            self.direction = definition.get("direction", "")
+
+    def dump(self):
+        output = []
+        if self.visibility:
+            output.append(self.visibility)
+        if self.direction:
+            output.append(self.direction)
+        return " ".join(output)
+
+    def get_definition(self):
+        return {
+            "name": self.__class__.__name__,
+            "visibility": self.visibility,
+            "direction": self.direction
+        }
+
+
+class OccurrenceUsageBody:
+    # OccurrenceUsageBody — used by non-action occurrence usages
+    # Similar to ActionBody but for general occurrence usages
+    def __init__(self, definition):
+        if valid_definition(definition, "OccurrenceUsageBody"):
+            self.children = []
+            for item in definition.get("ownedRelationship", []):
+                if item.get("name") == "InitialNodeMember":
+                    self.children.append(InitialNodeMember(item))
+                elif item.get("name") == "ActionNodeMember":
+                    self.children.append(ActionNodeMember(item))
+                else:
+                    print(f"OccurrenceUsageBody: Unknown item type {item.get('name')}")
+
+    def dump(self):
+        if not self.children:
+            return ";"
+        return " { " + "; ".join([c.dump() for c in self.children]) + " }"
+
+    def get_definition(self):
+        return {
+            "name": self.__class__.__name__,
+            "ownedRelationship": [c.get_definition() for c in self.children]
+        }
+
+
 class AttributeDefinition:
     def __init__(self, definition=None):
         self.keyword = "attribute def"
@@ -6833,7 +6969,7 @@ class InterfaceEnd:
                 elif relationship["name"] == "OwnedMultiplicity":
                     self.relationships.append(OwnedMultiplicity(relationship))
                 else:
-                    return NotImplementedError
+                    print(f"InterfaceEnd: Unknown relationship type {relationship['name']}")
 
     def dump(self):
         output = []