sysmlpy 0.67.0__tar.gz → 0.69.0__tar.gz

sysmlpy-0.67.0/README.md → sysmlpy-0.69.0/PKG-INFO

@@ -1,3 +1,32 @@
+Metadata-Version: 2.4
+Name: sysmlpy
+Version: 0.69.0
+Summary: 
+License-File: LICENSE
+Author: Jon R. Fox (mycr0ft)
+Author-email: jon.fox@drfox.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: graph
+Provides-Extra: kuzu
+Provides-Extra: sim
+Provides-Extra: xlsx
+Requires-Dist: antlr4-python3-runtime (>=4.13)
+Requires-Dist: arrow (>=1.4.0,<2.0.0)
+Requires-Dist: kuzu (>=0.7,<0.12) ; extra == "kuzu"
+Requires-Dist: networkx (>=3.0) ; extra == "graph"
+Requires-Dist: openpyxl (>=3.1) ; extra == "xlsx"
+Requires-Dist: pint (>=0.24)
+Requires-Dist: pyyaml (>=6.0)
+Requires-Dist: transitions (>=0.9,<0.10) ; extra == "sim"
+Description-Content-Type: text/markdown
+
 # sysmlpy
 [![PyPI version](https://badge.fury.io/py/sysmlpy.svg)](https://badge.fury.io/py/sysmlpy)[![PyPI status](https://img.shields.io/pypi/status/sysmlpy.svg)](https://pypi.python.org/pypi/sysmlpy/)[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 
@@ -577,7 +606,7 @@ print(as_package_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.
+Corresponds to SysML v2 ``ActionFlowView`` (short name ``afv``). Shows actions with their control and object flows. Auto-includes connected flow elements. Control nodes render too: `first start` → solid initial dot, `decide`/`merge`/`fork`/`join` → hexagon nodes, `done`/`terminate` targets → final circle, with dotted succession edges (`..>`) and guard conditions as labels.
 
 ![Action Flow View](docs/plantuml-examples/10-action-flow-view.png)
 
@@ -586,6 +615,30 @@ from sysmlpy.plantuml import as_action_flow_view
 print(as_action_flow_view(model, style="bw"))
 ```
 
+#### Boxes Views — Java-free braille + SVG (v0.68.0)
+Native text/graphics rendering through the sibling `diagramboxes`
+package — no PlantUML/Java required. Interconnection, action flow and
+state transition views render to Unicode-braille text (terminal) or
+SVG. Monochrome by design (color-vision friendly).
+
+![Interconnection View (boxes)](docs/plantuml-examples/20-interconnection-boxes.svg)
+
+```python
+from sysmlpy.boxes_view import (
+    render_interconnection_view_boxes,   # iv: parts + ports + connection edges
+    render_action_flow_view_boxes,       # afv: actions + in/out ports + flows
+    render_state_transition_view,        # stv: nested composite state boxes
+)
+print(render_interconnection_view_boxes(model))
+```
+
+```
+    ⡰⠊⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠲⡀     ⡰⠊⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠲⡀
+    ⡇  «part»    ⡇     ⡇  «part»    ⡇
+    ⡇  engine    ⡇     ⡇   pump     ⡇
+    ⡇            ⡇     ⡇            ⡇
+```
+
 #### Interconnection View (IV) — `as_interconnection_view()` / `as_interconnection_diagram()`
 Corresponds to SysML v2 ``InterconnectionView`` (short name ``iv``). Focuses on connectors, bindings, and flow paths between ports and parts.
 
@@ -750,3 +803,4 @@ Two companion tools for the SysML v2 community, created by the same author:
 
 ## License
 sysmlpy is released under the MIT license, hence allowing commercial use of the library.
+

sysmlpy-0.67.0/PKG-INFO → sysmlpy-0.69.0/README.md

@@ -1,30 +1,3 @@
-Metadata-Version: 2.4
-Name: sysmlpy
-Version: 0.67.0
-Summary: 
-License-File: LICENSE
-Author: Jon R. Fox (mycr0ft)
-Author-email: jon.fox@drfox.com
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: graph
-Provides-Extra: kuzu
-Provides-Extra: xlsx
-Requires-Dist: antlr4-python3-runtime (>=4.13)
-Requires-Dist: arrow (>=1.4.0,<2.0.0)
-Requires-Dist: kuzu (>=0.7,<0.12) ; extra == "kuzu"
-Requires-Dist: networkx (>=3.0) ; extra == "graph"
-Requires-Dist: openpyxl (>=3.1) ; extra == "xlsx"
-Requires-Dist: pint (>=0.24)
-Requires-Dist: pyyaml (>=6.0)
-Description-Content-Type: text/markdown
-
 # sysmlpy
 [![PyPI version](https://badge.fury.io/py/sysmlpy.svg)](https://badge.fury.io/py/sysmlpy)[![PyPI status](https://img.shields.io/pypi/status/sysmlpy.svg)](https://pypi.python.org/pypi/sysmlpy/)[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 
@@ -604,7 +577,7 @@ print(as_package_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.
+Corresponds to SysML v2 ``ActionFlowView`` (short name ``afv``). Shows actions with their control and object flows. Auto-includes connected flow elements. Control nodes render too: `first start` → solid initial dot, `decide`/`merge`/`fork`/`join` → hexagon nodes, `done`/`terminate` targets → final circle, with dotted succession edges (`..>`) and guard conditions as labels.
 
 ![Action Flow View](docs/plantuml-examples/10-action-flow-view.png)
 
@@ -613,6 +586,30 @@ from sysmlpy.plantuml import as_action_flow_view
 print(as_action_flow_view(model, style="bw"))
 ```
 
+#### Boxes Views — Java-free braille + SVG (v0.68.0)
+Native text/graphics rendering through the sibling `diagramboxes`
+package — no PlantUML/Java required. Interconnection, action flow and
+state transition views render to Unicode-braille text (terminal) or
+SVG. Monochrome by design (color-vision friendly).
+
+![Interconnection View (boxes)](docs/plantuml-examples/20-interconnection-boxes.svg)
+
+```python
+from sysmlpy.boxes_view import (
+    render_interconnection_view_boxes,   # iv: parts + ports + connection edges
+    render_action_flow_view_boxes,       # afv: actions + in/out ports + flows
+    render_state_transition_view,        # stv: nested composite state boxes
+)
+print(render_interconnection_view_boxes(model))
+```
+
+```
+    ⡰⠊⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠲⡀     ⡰⠊⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠲⡀
+    ⡇  «part»    ⡇     ⡇  «part»    ⡇
+    ⡇  engine    ⡇     ⡇   pump     ⡇
+    ⡇            ⡇     ⡇            ⡇
+```
+
 #### Interconnection View (IV) — `as_interconnection_view()` / `as_interconnection_diagram()`
 Corresponds to SysML v2 ``InterconnectionView`` (short name ``iv``). Focuses on connectors, bindings, and flow paths between ports and parts.
 
@@ -777,4 +774,3 @@ Two companion tools for the SysML v2 community, created by the same author:
 
 ## License
 sysmlpy is released under the MIT license, hence allowing commercial use of the library.
-

{sysmlpy-0.67.0 → sysmlpy-0.69.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "sysmlpy"
-version = "0.67.0"
+version = "0.69.0"
 description = ""
 authors = [{ name = "Jon R. Fox (mycr0ft)", email = "jon.fox@drfox.com" }]
 readme = "README.md"
@@ -21,11 +21,13 @@ networkx = { version = ">=3.0", optional = true }
 kuzu = { version = ">=0.7,<0.12", optional = true }
 openpyxl = { version = ">=3.1", optional = true }
 arrow = "^1.4.0"
+transitions = {version = "^0.9", optional = true}
 
 [tool.poetry.extras]
 graph = ["networkx"]
 kuzu = ["kuzu"]
 xlsx = ["openpyxl"]
+sim = ["transitions"]
 
 [tool.poetry.scripts]
 sysmlpy = "sysmlpy.__main__:main"

{sysmlpy-0.67.0 → sysmlpy-0.69.0}/src/sysmlpy/__init__.py

@@ -28,12 +28,13 @@ __all__ = [
     "analyze", "AnalysisResult", "SemanticIssue", "SemanticAnalyzer",
     "SysMLSyntaxError", "PartialParseError",
     "loads_partial", "load_partial",
-    # boxes-backed optional renderers (require pip install -e ../boxes)
+    # diagramboxes-backed optional renderers (the sibling package formerly
+# named `boxes` — renamed in its v0.3.0; install with pip install -e ../boxes)
     "as_state_transition_view_boxes", "render_state_transition_view",
     "render_state_transition_view_svg", "boxes_view",
 ]
 __author__ = "Jon Fox"
-__version__ = "0.67.0"
+__version__ = "0.69.0"
 
 from sysmlpy.usage import (
     Item, Attribute, Part, Port, Action, Reference, UseCase, Requirement, Interface, Message,
@@ -413,10 +414,11 @@ from sysmlpy.semantic import analyze, AnalysisResult, SemanticIssue, SemanticAna
 
 from sysmlpy.project import load_files, load_project, load_with_dependencies
 
-# Optional boxes-backed state-machine renderer (lazy import on first use so
-# `import sysmlpy` works without `boxes` installed). The first call to any of
-# the functions below triggers `import sysmlpy.boxes_view`, which itself
-# raises ImportError with installation instructions if `boxes` is missing.
+# Optional diagramboxes-backed state-machine renderer (lazy import on first
+# use so `import sysmlpy` works without `diagramboxes` installed). The first
+# call to any of the functions below triggers `import sysmlpy.boxes_view`,
+# which itself raises ImportError with installation instructions if the
+# `diagramboxes` package is missing.
 def __getattr__(name):
     if name == "boxes_view":
         import sysmlpy.boxes_view as bv
@@ -429,5 +431,16 @@ def __getattr__(name):
         fn = getattr(bv, name)
         globals()[name] = fn
         return fn
+    if name in ("StateSimulator", "SimulationError",
+                "build_state_machine", "run_tui"):
+        from sysmlpy import sim as _sim
+        fn = getattr(sim, name)
+        globals()[name] = fn
+        return fn
+    if name == "set_stereotype_palette":
+        from sysmlpy import plantuml as _pu
+        fn = _pu.set_stereotype_palette
+        globals()[name] = fn
+        return fn
     raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
 

{sysmlpy-0.67.0 → sysmlpy-0.69.0}/src/sysmlpy/__main__.py

@@ -31,7 +31,8 @@ import sysmlpy
 from sysmlpy import loads
 
 # Subcommand table, also used to detect the legacy flat invocation form.
-SUBCOMMANDS = ("parse", "analyze", "view", "trace", "export", "import", "eval", "xlsx", "format", "fmt")
+SUBCOMMANDS = ("parse", "analyze", "view", "trace", "export", "import",
+               "eval", "xlsx", "sim", "format", "fmt")
 
 
 # ---------------------------------------------------------------------------
@@ -498,6 +499,52 @@ def _format_value(value):
     return str(value)
 
 
+def cmd_sim(args) -> int:
+    """Simulate the state machine of a model (interactive TUI)."""
+    try:
+        from sysmlpy.sim import run_tui
+    except ImportError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 2
+
+    paths = [Path(args.file)]
+    for p_ in _missing_files(paths):
+        print(f"Error: File '{p_}' not found.", file=sys.stderr)
+        return 2
+    try:
+        model = sysmlpy.load_files(paths, library=args.library)
+    except Exception as e:
+        print(f"Parse error: {e}", file=sys.stderr)
+        return 2
+
+    values = {}
+    for spec in args.set or []:
+        if "=" not in spec:
+            print(f"Error: --set expects NAME=VALUE, got {spec!r}",
+                  file=sys.stderr)
+            return 2
+        name, _, raw = spec.partition("=")
+        values[name.strip()] = _parse_eval_value(raw)
+
+    script = [t.strip() for t in (args.run or "").split(";") if t.strip()]
+    try:
+        from sysmlpy.sim import StateSimulator, SimulationError
+        sim = StateSimulator(model, focus=args.focus, values=values)
+    except (ImportError, SimulationError) as e:
+        print(f"Simulation error: {e}", file=sys.stderr)
+        return 2
+    for note in sim.notes:
+        print(f"note: {note}")
+    if script:
+        for trigger in script:
+            fired = sim.send(trigger)
+            print(f"{trigger}: {'fired' if fired else 'blocked'} "
+                  f"-> {sim.state!r}")
+        return 0
+    run_tui(model, focus=args.focus, values=values)
+    return 0
+
+
 def cmd_xlsx(args) -> int:
     """Export tabular views to an Excel workbook (v0.66.0, Goal 7)."""
     from sysmlpy.spreadsheet import write_xlsx
@@ -832,6 +879,38 @@ def build_parser() -> argparse.ArgumentParser:
     )
     p_eval.set_defaults(func=cmd_eval)
 
+    # -- sim (state-machine simulation, optional 'transitions' extra) -----
+    p_sim = sub.add_parser(
+        "sim",
+        help="Simulate a state machine (guards evaluated for real)",
+        description="Cameo-style state-machine simulation: fires "
+                    "transitions on triggers, evaluates guards against "
+                    "the model's attribute values (plus --set "
+                    "overrides), and logs effects. Interactive TUI "
+                    "(or a scripted run with --run). Requires the "
+                    "'sim' extra: pip install 'sysmlpy[sim]'.",
+    )
+    p_sim.add_argument("file", help="SysML v2 file with a state machine")
+    p_sim.add_argument(
+        "--focus",
+        help="Name of the state def/state machine to simulate "
+             "(default: the first one found)",
+    )
+    p_sim.add_argument(
+        "--set", action="append", metavar="NAME=VALUE",
+        help="Starting value for guards (repeatable)",
+    )
+    p_sim.add_argument(
+        "--run", metavar="TRIG1;TRIG2",
+        help="Fire this ';'-separated trigger sequence instead of "
+             "entering the interactive loop",
+    )
+    p_sim.add_argument(
+        "-l", "--library",
+        help="Path to SysML v2 library files to use for parsing",
+    )
+    p_sim.set_defaults(func=cmd_sim)
+
     # -- xlsx (v0.66.0, Goal 7) -------------------------------------------------
     p_xlsx = sub.add_parser(
         "xlsx",

{sysmlpy-0.67.0 → sysmlpy-0.69.0}/src/sysmlpy/antlr_visitor.py

@@ -5739,37 +5739,136 @@ def _visit_guard_expression_member(ctx):
     }
 
 
+def _ctx_spaced_text(ctx):
+    """Source text of an ANTLR context with single spaces between
+    tokens (``getText()`` glues terminals: ``send Alert to logger``
+    would come out ``sendAlerttologger``)."""
+    if ctx is None:
+        return None
+
+    parts = []
+
+    def _collect(node):
+        n = node.getChildCount() if hasattr(node, "getChildCount") else 0
+        if n == 0:
+            text = node.getText()
+            if text:
+                parts.append(text)
+            return
+        for i in range(n):
+            _collect(node.getChild(i))
+
+    _collect(ctx)
+    return " ".join(parts).strip() or None
+
+
 def _visit_effect_behavior_member(ctx):
-    """Visit an effectBehaviorMember context."""
+    """Visit an effectBehaviorMember context.
+
+    effectBehaviorMember : DO effectBehaviorUsage ;
+    effectBehaviorUsage  : emptyActionUsage_ | transitionPerformActionUsage
+                         | transitionAcceptActionUsage | transitionSendActionUsage
+                         | transitionAssignmentActionUsage ;
+
+    ``do <behavior-reference>`` (by far the common transition effect)
+    rides through transitionPerformActionUsage ->
+    performActionUsageDeclaration -> ownedReferenceSubsetting, whose
+    qualifiedName is the referenced behavior's name.  We emit the shape
+    the grammar classes expect (EffectBehaviorUsage / PerformedActionUsage
+    / PerformActionUsageDeclaration) so ``EffectBehaviorMember.dump()``
+    round-trips the effect.  The send/accept/assignment alternatives are
+    emitted as ``text`` fallbacks (readable, not class-constructed).
+    """
     if ctx is None:
         return None
-    
-    behavior = None
-    if hasattr(ctx, 'transitionEffect') and ctx.transitionEffect():
-        te = ctx.transitionEffect()
-        if isinstance(te, list):
-            te = te[0]
-        if te:
-            behavior = _visit_transition_effect(te)
-    
-    return {
+
+    behavior, fallback_text = None, None
+    if hasattr(ctx, 'effectBehaviorUsage') and ctx.effectBehaviorUsage():
+        behavior, fallback_text = _visit_effect_behavior_usage(
+            ctx.effectBehaviorUsage())
+
+    member = {
         "name": "EffectBehaviorMember",
         "ownedRelatedElement": behavior
     }
+    if fallback_text:
+        # Sibling key: read by the view extractors, ignored (and so
+        # safely dropped) by the grammar classes.
+        member["text"] = fallback_text
+    return member
 
 
-def _visit_transition_effect(ctx):
-    """Visit a transitionEffect context."""
+def _visit_effect_behavior_usage(ctx):
+    """Visit an effectBehaviorUsage context (one of five alternatives)."""
     if ctx is None:
         return None
-    
-    body = None
-    if hasattr(ctx, 'actionBody') and ctx.actionBody():
-        body = _visit_action_body(ctx.actionBody())
-    
+
+    if hasattr(ctx, 'transitionPerformActionUsage') and \
+            ctx.transitionPerformActionUsage():
+        pu = ctx.transitionPerformActionUsage()
+        if isinstance(pu, list):
+            pu = pu[0]
+        return _visit_transition_perform_action_usage(pu), None
+
+    # send / accept / assignment: no class-constructable shape yet —
+    # the caller surfaces the declaration via a sibling ``text`` on the
+    # EffectBehaviorMember dict (see _visit_effect_behavior_member).
+    for alt_name, kind in (
+        ('transitionSendActionUsage', 'send'),
+        ('transitionAcceptActionUsage', 'accept'),
+        ('transitionAssignmentActionUsage', 'assign'),
+    ):
+        if hasattr(ctx, alt_name):
+            sub = getattr(ctx, alt_name)()
+            if sub:
+                if isinstance(sub, list):
+                    sub = sub[0]
+                node = None
+                for decl_name in ('sendNodeDeclaration',
+                                   'acceptNodeDeclaration',
+                                   'assignmentNodeDeclaration'):
+                    if hasattr(sub, decl_name):
+                        node = getattr(sub, decl_name)()
+                        if node:
+                            break
+                # Spaced text; the ``send``/``accept`` keyword already
+                # sits in the declaration, no kind prefix needed.
+                text = _ctx_spaced_text(
+                    node if node is not None else sub)
+                return None, text
+    # emptyActionUsage_
+    return None, None
+
+
+def _visit_transition_perform_action_usage(ctx):
+    """transitionPerformActionUsage : performActionUsageDeclaration
+    ( LBRACE actionBodyItem* RBRACE )? ;"""
+    if ctx is None:
+        return None
+
+    declaration = None
+    if hasattr(ctx, 'performActionUsageDeclaration') and \
+            ctx.performActionUsageDeclaration():
+        declaration = _visit_perform_action_usage_declaration(
+            ctx.performActionUsageDeclaration())
+
+    items = []
+    if hasattr(ctx, 'actionBodyItem') and ctx.actionBodyItem():
+        body_items = ctx.actionBodyItem()
+        if not isinstance(body_items, list):
+            body_items = [body_items]
+        for item_ctx in body_items:
+            item_dict = _visit_action_body_item(item_ctx)
+            if item_dict:
+                items.append(item_dict)
+
     return {
-        "name": "TransitionEffect",
-        "body": body
+        "name": "EffectBehaviorUsage",
+        "usage": {
+            "name": "PerformedActionUsage",
+            "declaration": declaration,
+        },
+        "item": items,
     }