sysmlpy 0.12.2__tar.gz → 0.16.0__tar.gz

{sysmlpy-0.12.2 → sysmlpy-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sysmlpy
-Version: 0.12.2
+Version: 0.16.0
 Summary: SysML v2.0 Parser
 License: MIT License
          
@@ -32,7 +32,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Provides-Extra: graph
+Provides-Extra: kuzu
 Requires-Dist: antlr4-python3-runtime (>=4.13)
+Requires-Dist: kuzu (>=0.7,<0.12) ; extra == "kuzu"
 Requires-Dist: networkx (>=3.0) ; extra == "graph"
 Requires-Dist: pint (>=0.24)
 Requires-Dist: pyyaml (>=6.0)
@@ -56,7 +58,9 @@ The project had diverged so much from sysml2py that a new name, sysmlpy, was sel
 
 ![Lines of Code Over Time](loc_history.svg)
 
-**v0.12.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+**v0.14.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+
+**v0.14.1:** ISQ unit validation (300+ type-to-dimension mappings), US Customary unit support (21 custom definitions), PlantUML diagram generation with stereotype-based styling, strict import visibility enforcement, and comprehensive API documentation.
 
 ## Requirements
 sysmlpy requires the following Python packages:
@@ -66,6 +70,8 @@ sysmlpy requires the following Python packages:
 
 ### Optional Dependencies
 - [networkx](https://networkx.org/) — graph analysis backend (install with `pip install sysmlpy[graph]`)
+- [kuzu](https://kuzudb.com/) — embedded graph database with disk persistence and Cypher queries (install with `pip install sysmlpy[kuzu]`)
+- [PlantUML](https://plantuml.com/) **v1.2020.0+** — diagram rendering (requires Java + PlantUML JAR or [PlantUML server](https://www.plantuml.com/plantuml)). The generator uses `<style>` blocks and `skinparam` stereotype selectors introduced in v1.2020.
 
 ## Installation
 
@@ -221,6 +227,94 @@ print(tree.dump())
 
 **61% of the 56 grammar round-trip tests currently pass** (34/56), covering packages, parts, items, ports, interfaces, binding connectors, flow connections, all action forms (definition, shorthand, succession, decomposition), expressions, calculations, and constraints.
 
+## PlantUML Visualizations
+
+Generate SysML v2 structure diagrams from parsed models using the built-in PlantUML generator. Definitions render with sharp corners and usage elements with rounded corners. Relationships are differentiated by arrow style, thickness, and color — following the [official SysML v2 Pilot Implementation](https://github.com/Systems-Modeling/SysML-v2-Release) approach.
+
+```python
+from sysmlpy import loads
+from sysmlpy.plantuml import PlantUMLGenerator
+
+text = """package Vehicle {
+    part def Wheel {
+        attribute radius : LengthValue;
+        attribute pressure : PressureValue;
+    }
+
+    part def BrakeSystem {
+        attribute padThickness : LengthValue;
+    }
+
+    part def VehicleAssembly {
+        part frontLeft : Wheel;
+        part frontRight : Wheel;
+        part brakes : BrakeSystem;
+    }
+
+    part myVehicle : VehicleAssembly;
+}"""
+
+model = loads(text)
+gen = PlantUMLGenerator(model, title="Vehicle Structure")
+print(gen.generate())
+```
+
+Produces PlantUML source that renders as:
+
+```plantuml
+@startuml
+skinparam RoundCorner 0
+skinparam rectangle<<(D,#8B4513) part def>> {
+    RoundCorner 0
+    BackgroundColor #FFF8F0
+    BorderColor #8B4513
+}
+skinparam rectangle<<(P,#32CD32) part>> {
+    RoundCorner 15
+    BackgroundColor #F0FFF0
+    BorderColor #32CD32
+}
+
+title Vehicle Structure
+
+rectangle "Wheel" as Wheel <<(D,#8B4513) part def>>
+rectangle "BrakeSystem" as BrakeSystem <<(D,#8B4513) part def>>
+rectangle "VehicleAssembly" as VehicleAssembly <<(D,#8B4513) part def>>
+rectangle "myVehicle" as myVehicle <<(P,#32CD32) part>>
+
+VehicleAssembly *-- frontLeft : owns
+VehicleAssembly *-- frontRight : owns
+VehicleAssembly *-- brakes : owns
+myVehicle --:|> VehicleAssembly : types
+
+legend right
+  <b>Legend</b>
+  |= Element |= Notation |
+  | <<(D,#8B4513) part def>> | Definition (type) |
+  | <<(P,#32CD32) part>> | Usage (instance) |
+  | --:|> | Feature typing |
+  | *-- | Composite containment |
+endlegend
+@enduml
+```
+
+### Filtering and Focus
+
+The generator supports filtering to highlight specific elements:
+
+```python
+# Show only elements related to 'myVehicle'
+gen = PlantUMLGenerator(model, focus="myVehicle")
+
+# Show a custom set of elements
+gen = PlantUMLGenerator(model, elements=["Wheel", "BrakeSystem"])
+
+# Limit nesting depth
+gen = PlantUMLGenerator(model, max_depth=2)
+```
+
+See [`docs/plantuml-examples/`](docs/plantuml-examples/) for 9 rendered examples covering usage vs definition, relationships, vehicle structure, requirements, interconnections, state machines, and activity diagrams.
+
 ## Conformance
 
 **100% of 123 OMG XPect conformance tests pass** (123/123).

{sysmlpy-0.12.2 → sysmlpy-0.16.0}/README.md

@@ -14,7 +14,9 @@ The project had diverged so much from sysml2py that a new name, sysmlpy, was sel
 
 ![Lines of Code Over Time](loc_history.svg)
 
-**v0.12.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+**v0.14.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+
+**v0.14.1:** ISQ unit validation (300+ type-to-dimension mappings), US Customary unit support (21 custom definitions), PlantUML diagram generation with stereotype-based styling, strict import visibility enforcement, and comprehensive API documentation.
 
 ## Requirements
 sysmlpy requires the following Python packages:
@@ -24,6 +26,8 @@ sysmlpy requires the following Python packages:
 
 ### Optional Dependencies
 - [networkx](https://networkx.org/) — graph analysis backend (install with `pip install sysmlpy[graph]`)
+- [kuzu](https://kuzudb.com/) — embedded graph database with disk persistence and Cypher queries (install with `pip install sysmlpy[kuzu]`)
+- [PlantUML](https://plantuml.com/) **v1.2020.0+** — diagram rendering (requires Java + PlantUML JAR or [PlantUML server](https://www.plantuml.com/plantuml)). The generator uses `<style>` blocks and `skinparam` stereotype selectors introduced in v1.2020.
 
 ## Installation
 
@@ -179,6 +183,94 @@ print(tree.dump())
 
 **61% of the 56 grammar round-trip tests currently pass** (34/56), covering packages, parts, items, ports, interfaces, binding connectors, flow connections, all action forms (definition, shorthand, succession, decomposition), expressions, calculations, and constraints.
 
+## PlantUML Visualizations
+
+Generate SysML v2 structure diagrams from parsed models using the built-in PlantUML generator. Definitions render with sharp corners and usage elements with rounded corners. Relationships are differentiated by arrow style, thickness, and color — following the [official SysML v2 Pilot Implementation](https://github.com/Systems-Modeling/SysML-v2-Release) approach.
+
+```python
+from sysmlpy import loads
+from sysmlpy.plantuml import PlantUMLGenerator
+
+text = """package Vehicle {
+    part def Wheel {
+        attribute radius : LengthValue;
+        attribute pressure : PressureValue;
+    }
+
+    part def BrakeSystem {
+        attribute padThickness : LengthValue;
+    }
+
+    part def VehicleAssembly {
+        part frontLeft : Wheel;
+        part frontRight : Wheel;
+        part brakes : BrakeSystem;
+    }
+
+    part myVehicle : VehicleAssembly;
+}"""
+
+model = loads(text)
+gen = PlantUMLGenerator(model, title="Vehicle Structure")
+print(gen.generate())
+```
+
+Produces PlantUML source that renders as:
+
+```plantuml
+@startuml
+skinparam RoundCorner 0
+skinparam rectangle<<(D,#8B4513) part def>> {
+    RoundCorner 0
+    BackgroundColor #FFF8F0
+    BorderColor #8B4513
+}
+skinparam rectangle<<(P,#32CD32) part>> {
+    RoundCorner 15
+    BackgroundColor #F0FFF0
+    BorderColor #32CD32
+}
+
+title Vehicle Structure
+
+rectangle "Wheel" as Wheel <<(D,#8B4513) part def>>
+rectangle "BrakeSystem" as BrakeSystem <<(D,#8B4513) part def>>
+rectangle "VehicleAssembly" as VehicleAssembly <<(D,#8B4513) part def>>
+rectangle "myVehicle" as myVehicle <<(P,#32CD32) part>>
+
+VehicleAssembly *-- frontLeft : owns
+VehicleAssembly *-- frontRight : owns
+VehicleAssembly *-- brakes : owns
+myVehicle --:|> VehicleAssembly : types
+
+legend right
+  <b>Legend</b>
+  |= Element |= Notation |
+  | <<(D,#8B4513) part def>> | Definition (type) |
+  | <<(P,#32CD32) part>> | Usage (instance) |
+  | --:|> | Feature typing |
+  | *-- | Composite containment |
+endlegend
+@enduml
+```
+
+### Filtering and Focus
+
+The generator supports filtering to highlight specific elements:
+
+```python
+# Show only elements related to 'myVehicle'
+gen = PlantUMLGenerator(model, focus="myVehicle")
+
+# Show a custom set of elements
+gen = PlantUMLGenerator(model, elements=["Wheel", "BrakeSystem"])
+
+# Limit nesting depth
+gen = PlantUMLGenerator(model, max_depth=2)
+```
+
+See [`docs/plantuml-examples/`](docs/plantuml-examples/) for 9 rendered examples covering usage vs definition, relationships, vehicle structure, requirements, interconnections, state machines, and activity diagrams.
+
 ## Conformance
 
 **100% of 123 OMG XPect conformance tests pass** (123/123).

{sysmlpy-0.12.2 → sysmlpy-0.16.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "sysmlpy"
-version = "0.12.2"
+version = "0.16.0"
 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.12.2"
+version = "0.16.0"
 description = ""
 authors = ["Jon R. Fox (mycr0ft) <jon.fox@drfox.com>"]
 readme = "README.md"
@@ -126,9 +126,11 @@ pint = ">=0.24"
 pyyaml = ">=6.0"
 antlr4-python3-runtime = ">=4.13"
 networkx = { version = ">=3.0", optional = true }
+kuzu = { version = ">=0.7,<0.12", optional = true }
 
 [tool.poetry.extras]
 graph = ["networkx"]
+kuzu = ["kuzu"]
 
 [tool.poetry.scripts]
 sysmlpy = "sysmlpy.__main__:main"

{sysmlpy-0.12.2 → sysmlpy-0.16.0}/src/sysmlpy/__init__.py

@@ -10,10 +10,11 @@ Uses the ANTLR4 parser for full SysML v2 grammar support.
 __all__ = [
     "load", "loads", "load_grammar", "load_antlr", "load_grammar_antlr",
     "Searchable",
-    "Store", "InMemoryStore", "NetworkXStore", "create_store", "new_id",
+    "Store", "InMemoryStore", "NetworkXStore", "KuzuStore", "CayleyStore", "create_store", "new_id",
+    "to_plantuml", "PlantUMLGenerator",
 ]
 __author__ = "Jon Fox"
-__version__ = "0.12.2"
+__version__ = "0.15.0"
 
 from sysmlpy.usage import (
     Item, Attribute, Part, Port, Action, Reference, UseCase, Requirement, Interface, Message,
@@ -25,7 +26,7 @@ from sysmlpy.usage import (
 
 from sysmlpy.definition import Model, Package
 from sysmlpy.navigate import Searchable
-from sysmlpy.store import Store, InMemoryStore, NetworkXStore, create_store, new_id
+from sysmlpy.store import Store, InMemoryStore, NetworkXStore, KuzuStore, CayleyStore, create_store, new_id
 
 from sysmlpy.usage import ureg
 
@@ -224,3 +225,6 @@ def load_antlr(fp):
     return loads(fp.read())
 
 
+from sysmlpy.plantuml import to_plantuml, PlantUMLGenerator
+
+

{sysmlpy-0.12.2 → sysmlpy-0.16.0}/src/sysmlpy/antlr_visitor.py

@@ -4959,6 +4959,8 @@ def _make_calculation_usage_dict(ctx, prefix=None):
     name = None
     shortname = None
     typed_by = None
+    redefined_feature = None
+    
     if ctx is not None:
         cud = None
         # Try both actionUsageDeclaration and calculationUsageDeclaration
@@ -4971,6 +4973,21 @@ def _make_calculation_usage_dict(ctx, prefix=None):
         if cud and hasattr(cud, 'usageDeclaration') and cud.usageDeclaration():
             ud = cud.usageDeclaration()
         
+        # Check for redefinitions in featureSpecializationPart
+        if ud and hasattr(ud, 'featureSpecializationPart') and ud.featureSpecializationPart():
+            fsp = ud.featureSpecializationPart()
+            if hasattr(fsp, 'featureSpecialization') and fsp.featureSpecialization():
+                specs = fsp.featureSpecialization()
+                if not isinstance(specs, list):
+                    specs = [specs]
+                for spec in specs:
+                    if hasattr(spec, 'redefinitions') and spec.redefinitions():
+                        redef_text = spec.redefinitions().getText()
+                        # Extract name from :>>name
+                        if redef_text.startswith(':>>'):
+                            redefined_feature = redef_text[3:].strip()
+                            name = redefined_feature
+        
         if ud and hasattr(ud, 'identification') and ud.identification():
             ident = ud.identification()
             if hasattr(ident, 'name'):
@@ -4992,7 +5009,37 @@ def _make_calculation_usage_dict(ctx, prefix=None):
     body_parts = _visit_calculation_body_items(ctx)
     occ_prefix = _get_occurrence_usage_prefix(ctx) if ctx else None
     
-    return {
+    # Build declaration
+    declaration = {
+        "name": "CalculationUsageDeclaration",
+        "declaration": {
+            "name": "UsageDeclaration",
+            "declaration": {
+                "name": "FeatureDeclaration",
+                "identification": {
+                    "name": "Identification",
+                    "declaredShortName": shortname,
+                    "declaredName": name
+                },
+                "specialization": specialization
+            }
+        },
+        "valuepart": None
+    }
+    
+    # Build ownedRelationship for redefinitions
+    owned_relationship = []
+    if redefined_feature:
+        owned_relationship.append({
+            "name": "OwnedReferenceSubsetting",
+            "referencedFeature": {
+                "name": "QualifiedName",
+                "names": [redefined_feature]
+            },
+            "ownedRelatedElement": []
+        })
+    
+    result = {
         "name": "PackageMember",
         "prefix": None,
         "ownedRelatedElement": {
@@ -5004,22 +5051,7 @@ def _make_calculation_usage_dict(ctx, prefix=None):
                     "ownedRelationship": {
                         "name": "CalculationUsage",
                         "prefix": occ_prefix or prefix,
-                        "declaration": {
-                            "name": "CalculationUsageDeclaration",
-                            "declaration": {
-                                "name": "UsageDeclaration",
-                                "declaration": {
-                                    "name": "FeatureDeclaration",
-                                    "identification": {
-                                        "name": "Identification",
-                                        "declaredShortName": shortname,
-                                        "declaredName": name
-                                    },
-                                    "specialization": specialization
-                                }
-                            },
-                            "valuepart": None
-                        },
+                        "declaration": declaration,
                         "body": {
                             "name": "CalculationBody",
                             "part": body_parts
@@ -5029,6 +5061,11 @@ def _make_calculation_usage_dict(ctx, prefix=None):
             }
         }
     }
+    
+    if owned_relationship:
+        result["ownedRelatedElement"]["ownedRelatedElement"]["ownedRelatedElement"]["ownedRelationship"]["ownedRelationship"] = owned_relationship
+    
+    return result
 
 
 def _make_nested_calculation_usage_dict(ctx, prefix=None):
@@ -10691,9 +10728,33 @@ def _make_nested_analysis_case_usage_dict(ctx, prefix=None):
     if ctx is None:
         return None
     
-    name, shortname = _get_usage_identification(ctx)
+    # Extract name and specialization from constraintUsageDeclaration
+    name = None
+    shortname = None
+    specialization = None
+    
+    if hasattr(ctx, 'constraintUsageDeclaration') and ctx.constraintUsageDeclaration():
+        cud = ctx.constraintUsageDeclaration()
+        if hasattr(cud, 'usageDeclaration') and cud.usageDeclaration():
+            ud = cud.usageDeclaration()
+            if hasattr(ud, 'identification') and ud.identification():
+                ident = ud.identification()
+                if hasattr(ident, 'name'):
+                    name_list = ident.name()
+                    if name_list and isinstance(name_list, list):
+                        if len(name_list) == 2:
+                            shortname = name_list[0].getText()
+                            name = name_list[1].getText()
+                        elif len(name_list) == 1:
+                            name_text = name_list[0].getText()
+                            name, shortname = _extract_name_shortname(name_text)
+        
+        # Extract specialization (typing) from constraintUsageDeclaration
+        typed_by = _get_action_usage_typed_by(cud)
+        if typed_by:
+            specialization = _build_specialization(typed_by)
+    
     occ_prefix = _get_occurrence_usage_prefix(ctx) if ctx else None
-    specialization = _build_full_specialization_from_ctx(ctx)
     
     # Get body items from caseBody
     body_items = []
@@ -10809,7 +10870,63 @@ def _visit_case_body_item(cbi):
     if cbi is None:
         return None
     
-    # Handle nonOccurrenceUsageMember (in/out params, subject)
+    # Handle subjectMember
+    if hasattr(cbi, 'subjectMember') and cbi.subjectMember():
+        sm = cbi.subjectMember()
+        if isinstance(sm, list):
+            sm = sm[0]
+        if sm:
+            inner = _visit_subject_member_dict(sm)
+            if inner:
+                return {
+                    "name": "CaseBodyItem",
+                    "item": None,
+                    "ownedRelationship": inner
+                }
+    
+    # Handle objectiveMember
+    if hasattr(cbi, 'objectiveMember') and cbi.objectiveMember():
+        om = cbi.objectiveMember()
+        if isinstance(om, list):
+            om = om[0]
+        if om:
+            inner = _visit_objective_member_dict(om)
+            if inner:
+                return {
+                    "name": "CaseBodyItem",
+                    "item": None,
+                    "ownedRelationship": inner
+                }
+    
+    # Handle returnParameterMember
+    if hasattr(cbi, 'returnParameterMember') and cbi.returnParameterMember():
+        rpm = cbi.returnParameterMember()
+        if isinstance(rpm, list):
+            rpm = rpm[0]
+        if rpm:
+            inner = _visit_return_parameter_member(rpm)
+            if inner:
+                return {
+                    "name": "CaseBodyItem",
+                    "item": inner,
+                    "ownedRelationship": None
+                }
+    
+    # Handle actionBodyItem (for nested calc/action usages)
+    if hasattr(cbi, 'actionBodyItem') and cbi.actionBodyItem():
+        abi = cbi.actionBodyItem()
+        if isinstance(abi, list):
+            abi = abi[0]
+        if abi:
+            inner = _visit_action_body_item(abi)
+            if inner:
+                return {
+                    "name": "CaseBodyItem",
+                    "item": inner,
+                    "ownedRelationship": None
+                }
+    
+    # Handle nonOccurrenceUsageMember (in/out params)
     if hasattr(cbi, 'nonOccurrenceUsageMember') and cbi.nonOccurrenceUsageMember():
         nom = cbi.nonOccurrenceUsageMember()
         if isinstance(nom, list):