ocelescope-module-ocpn-editor 0.10.3__tar.gz

ocelescope_module_ocpn_editor-0.10.3/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.3
+Name: ocelescope-module-ocpn-editor
+Version: 0.10.3
+Summary: An OCPN Editor
+Author: Uy Sa Huynh
+Requires-Dist: ocelescope-backend>=0.10.2,<0.11.0
+Requires-Dist: ocelescope-module-filter>=0.10.2,<0.11.0
+Requires-Dist: ocelescope-module-ocel>=0.10.2,<0.11.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# OCPN Editor
+
+An OCPN Editor
+
+An [Ocelescope](https://www.ocelescope.org) backend module. It is a FastAPI app
+that `ocelescope-backend` discovers through the `ocelescope_backend.modules`
+entry point in `pyproject.toml` and serves under `/modules/ocpnEditor/v1`.
+
+- `src/ocelescope_module_ocpn_editor/module.py` — module class `OCPNEditor` (key `ocpnEditor`)
+- `src/ocelescope_module_ocpn_editor/routes.py` — API routes
+
+Install it next to `ocelescope-backend` (e.g. as a uv workspace member of an
+Ocelescope module project) and run `ocelescope-backend serve`.
+
+## Updating from the template
+
+This module was generated with [Copier](https://copier.readthedocs.io). To pull
+in later changes from the template, commit your work and run in this folder:
+
+```sh
+uvx copier update
+```

ocelescope_module_ocpn_editor-0.10.3/README.md

@@ -0,0 +1,22 @@
+# OCPN Editor
+
+An OCPN Editor
+
+An [Ocelescope](https://www.ocelescope.org) backend module. It is a FastAPI app
+that `ocelescope-backend` discovers through the `ocelescope_backend.modules`
+entry point in `pyproject.toml` and serves under `/modules/ocpnEditor/v1`.
+
+- `src/ocelescope_module_ocpn_editor/module.py` — module class `OCPNEditor` (key `ocpnEditor`)
+- `src/ocelescope_module_ocpn_editor/routes.py` — API routes
+
+Install it next to `ocelescope-backend` (e.g. as a uv workspace member of an
+Ocelescope module project) and run `ocelescope-backend serve`.
+
+## Updating from the template
+
+This module was generated with [Copier](https://copier.readthedocs.io). To pull
+in later changes from the template, commit your work and run in this folder:
+
+```sh
+uvx copier update
+```

ocelescope_module_ocpn_editor-0.10.3/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "ocelescope-module-ocpn-editor"
+version = "0.10.3"
+readme = "README.md"
+description = "An OCPN Editor"
+requires-python = ">=3.11"
+dependencies = [
+    "ocelescope-backend>=0.10.2,<0.11.0",
+    "ocelescope-module-filter>=0.10.2,<0.11.0",
+    "ocelescope-module-ocel>=0.10.2,<0.11.0",
+]
+
+[[project.authors]]
+name = "Uy Sa Huynh"
+
+[project.entry-points."ocelescope_backend.modules"]
+ocpnEditor = "ocelescope_module_ocpn_editor.module:OCPNEditor"
+
+[build-system]
+requires = ["uv_build>=0.9.26,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+package = true

ocelescope_module_ocpn_editor-0.10.3/pyproject.toml.orig

@@ -0,0 +1,22 @@
+[project]
+name = "ocelescope-module-ocpn-editor"
+version = "0.10.3"
+readme = "README.md"
+description = "An OCPN Editor"
+authors = [{ name = "Uy Sa Huynh" }]
+requires-python = ">=3.11"
+dependencies = [
+  "ocelescope-backend>=0.10.2,<0.11.0",
+  "ocelescope-module-filter>=0.10.2,<0.11.0",
+  "ocelescope-module-ocel>=0.10.2,<0.11.0",
+]
+
+[project.entry-points."ocelescope_backend.modules"]
+ocpnEditor = "ocelescope_module_ocpn_editor.module:OCPNEditor"
+
+[build-system]
+requires = ["uv_build>=0.9.26,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+package = true

ocelescope_module_ocpn_editor-0.10.3/src/ocelescope_module_ocpn_editor/model/editor_ocpn.py

@@ -0,0 +1,35 @@
+from pydantic import BaseModel
+
+
+class EditorPlace(BaseModel):
+    id: str
+
+
+class EditorTransition(BaseModel):
+    id: str
+    label: str | None = None
+
+
+class EditorArc(BaseModel):
+    nodes: tuple[str, str]
+    weight: int | None = None
+
+
+class EditorOCPN(BaseModel):
+    places: list[EditorPlace]
+    transitions: list[EditorTransition]
+    arcs: list[EditorArc]
+    initial_marking: dict[str, int] | None = None
+    final_marking: dict[str, int] | None = None
+
+
+class OcpnExportRequest(BaseModel):
+    petri_net: EditorOCPN
+    place_object_type: dict[str, str]
+    place_in_out_mult: dict[str, tuple[dict[str, bool], dict[str, bool]]] | None = None
+
+
+class OcpnImportResponse(BaseModel):
+    petri_net: EditorOCPN
+    place_object_type: dict[str, str]
+    place_in_out_mult: dict[str, tuple[dict[str, bool], dict[str, bool]]]

ocelescope_module_ocpn_editor-0.10.3/src/ocelescope_module_ocpn_editor/model/editor_pn.py

@@ -0,0 +1,53 @@
+from pydantic import BaseModel
+from ocelescope import Resource
+from pydantic import Field
+
+
+class ImportPlace(BaseModel):
+    id: str
+    tokens: int = 0
+    final_tokens: int = 0
+
+
+class ImportTransition(BaseModel):
+    id: str
+    label: str | None = None
+
+
+class ImportArc(BaseModel):
+    source: str
+    target: str
+    weight: int = 1
+
+
+class ImportResponse(BaseModel):
+    places: list[ImportPlace]
+    transitions: list[ImportTransition]
+    arcs: list[ImportArc]
+
+#Resource 
+
+class ClassicPlace(BaseModel):
+    id: str
+    tokens: int = 0
+    final_tokens: int = 0
+
+
+class ClassicTransition(BaseModel):
+    id: str
+    label: str | None = None
+
+
+class ClassicArc(BaseModel):
+    source: str
+    target: str
+    weight: int = 1
+
+
+class ClassicPetriNet(Resource):
+    label = "Classic Petri Net"
+    description = "A classic Petri net"
+
+    places: list[ClassicPlace] = Field(default_factory=list)
+    transitions: list[ClassicTransition] = Field(default_factory=list)
+    arcs: list[ClassicArc] = Field(default_factory=list)

ocelescope_module_ocpn_editor-0.10.3/src/ocelescope_module_ocpn_editor/module.py

@@ -0,0 +1,15 @@
+from fastapi import FastAPI
+from ocelescope_backend.app.modules import Module, ModuleMeta
+from packaging.version import Version
+from ocelescope_module_ocpn_editor.routes import router
+from ocelescope_module_ocpn_editor.model.editor_pn import ClassicPetriNet
+
+
+class OCPNEditor(Module):
+    meta = ModuleMeta(key="ocpnEditor", version=Version("1.0"))
+    resources = [ClassicPetriNet]
+    @classmethod
+    def create_app(cls) -> FastAPI:
+        app = FastAPI(title="OCPN Editor", version=str(cls.meta.version))
+        app.include_router(router)
+        return app

ocelescope_module_ocpn_editor-0.10.3/src/ocelescope_module_ocpn_editor/routes.py

@@ -0,0 +1,121 @@
+from fastapi import APIRouter, UploadFile
+import tempfile
+import os
+from r4pm.petri_net import export_pnml, import_pnml
+from fastapi.responses import PlainTextResponse
+from ocelescope_module_ocpn_editor.util.convert_format import convert_to_OCPN, convert_from_OCPN, convert_to_pnet_resource
+from ocelescope_module_ocpn_editor.model.editor_ocpn import OcpnExportRequest, OcpnImportResponse
+from ocelescope import PetriNet
+from ocelescope_module_ocpn_editor.util.convert_format import convert_from_pnml
+from ocelescope_module_ocpn_editor.model.editor_pn import ImportResponse, ClassicPetriNet
+from ocelescope_backend.app.dependencies import ApiOcel, ApiSession
+from ocelescope_backend.app.internal.model.resource import ResourceStore
+from typing import cast
+
+router = APIRouter()
+
+@router.get("/{ocel_id}/objects/types", operation_id="objectTypes")
+def get_object_types(ocel:ApiOcel) -> list[str]:
+    return ocel.objects.types
+
+
+@router.get("/{ocel_id}/events/activities", operation_id="eventActivities")
+def get_event_activities(ocel:ApiOcel) -> list[str]:
+    return ocel.events.activities
+
+
+# ============================================
+
+#              Classic Petri-Net
+
+# ============================================
+
+
+# Export/Import
+
+@router.post("/petri-net/export/pnml", operation_id="exportPetriNetPnml")
+def export_petri_net_pnml(net: dict) -> PlainTextResponse:
+    with tempfile.NamedTemporaryFile(suffix=".pnml", delete=False) as tmp:
+        tmp_path = tmp.name
+
+    try:
+        export_pnml(net, tmp_path)
+        with open(tmp_path, "r", encoding="utf-8") as f:
+            pnml_text = f.read()
+    finally:
+        os.unlink(tmp_path)
+
+    return PlainTextResponse(content=pnml_text)
+
+@router.post("/petri-net/import/pnml", operation_id="importPetriNetPnml")
+async def import_petri_net_pnml(file: UploadFile) -> ImportResponse:
+    input = await file.read()
+
+    with tempfile.NamedTemporaryFile(suffix=".pnml", delete=False) as tmp:
+        tmp.write(input)
+        tmp_path = tmp.name
+
+    try:
+        net = import_pnml(tmp_path)
+    finally:
+        os.unlink(tmp_path)
+
+    return convert_from_pnml(net)
+
+# Load/Save to Session
+
+@router.post("/petri-net/export/session")
+def save_to_session_classic(session: ApiSession, pnet: dict, name:str):
+    resource_pnet = convert_to_pnet_resource(pnet)
+    session.add_resource(ResourceStore.from_resource(resource_pnet, name=name))
+    print(session.list_resources())
+
+
+
+# ============================================
+
+#           Object-Centric Petri Net
+
+# ============================================
+
+
+# Export/Import
+
+@router.post("/ocpn/export/ocelescope", operation_id="exportOCPN")
+def export_ocpn(ocpn: OcpnExportRequest) -> PlainTextResponse:
+    pnet = convert_to_OCPN(ocpn)
+
+    with tempfile.NamedTemporaryFile(suffix=".ocelescope", delete=False) as tmp:
+        tmp_path = tmp.name
+
+    try:
+        written_path = pnet.write(tmp_path)
+        with open(written_path, "r", encoding="utf-8") as f:
+            content = f.read()
+    finally:
+        os.unlink(written_path)
+
+    return PlainTextResponse(content=content)
+
+
+@router.post("/ocpn/import/ocelescope", operation_id="importOCPN")
+async def import_ocpn(file: UploadFile) -> OcpnImportResponse:
+    input = await file.read()
+    pnet = PetriNet.model_validate_json(input)
+    return convert_from_OCPN(pnet)
+
+
+# Load/Save to session
+
+
+@router.post("/ocpn/export/session", operation_id="saveSession")
+def save_to_session(session: ApiSession, ocpn: OcpnExportRequest, name:str):
+    pnet = convert_to_OCPN(ocpn)
+    session.add_resource(ResourceStore.from_resource(pnet, name=name))
+
+
+@router.post("/ocpn/import/session", operation_id="loadSession")
+async def load_from_session(session:ApiSession, resource_id: str | None = None) -> OcpnImportResponse:
+    resource_store = cast(PetriNet,session.get_resource(resource_id))
+    petri_net = PetriNet(**resource_store.data)
+    return convert_from_OCPN(petri_net)

ocelescope_module_ocpn_editor-0.10.3/src/ocelescope_module_ocpn_editor/util/convert_format.py

@@ -0,0 +1,126 @@
+from ocelescope.resource.default.petri_net import Arc, ArcType, PetriNet, Place, Transition
+from ocelescope_module_ocpn_editor.model.editor_ocpn import OcpnExportRequest, OcpnImportResponse, EditorArc, EditorOCPN, EditorPlace, EditorTransition
+from ocelescope_module_ocpn_editor.model.editor_pn import ImportResponse, ImportPlace,ImportArc,ImportTransition
+from ocelescope_module_ocpn_editor.model.editor_pn import ClassicPetriNet, ClassicArc, ClassicPlace, ClassicTransition
+
+
+def convert_to_OCPN(ocpn: OcpnExportRequest) -> PetriNet:
+    net = ocpn.petri_net
+    object_types = ocpn.place_object_type
+    in_out_mult = ocpn.place_in_out_mult if ocpn.place_in_out_mult is not None else {}
+
+    ocpn = PetriNet()
+
+    for place in net.places:
+        ocpn.add_place(Place(name=place.id, object_type=object_types[place.id]))
+
+    for transition in net.transitions:
+        ocpn.add_transition(Transition(name=transition.id, label=transition.label))
+
+    place_ids = {place.name for place in ocpn.places}
+
+    def is_variable(source: str, target: str) -> bool:
+        if source in place_ids:
+            _, outgoing = in_out_mult.get(source, ({}, {}))
+            return bool(outgoing.get(target))
+        incoming, _ = in_out_mult.get(target, ({}, {}))
+        return bool(incoming.get(source))
+
+    for arc in net.arcs:
+        source, target = arc.nodes
+        ocpn.add_arc(
+            Arc(
+                source=source,
+                target=target,
+                type=ArcType.VARIABLE if is_variable(source, target) else ArcType.NORMAL,
+                weight=arc.weight if arc.weight is not None else 1,
+            )
+        )
+
+    ocpn.initial_marking = dict(net.initial_marking if net.initial_marking is not None else {})
+    ocpn.final_marking = dict(net.final_marking if net.final_marking is not None else {})
+
+    return ocpn
+
+
+def convert_from_OCPN(ocpn:PetriNet) -> OcpnImportResponse:
+    places = []
+    place_object_type = {}
+  
+
+    for place in ocpn.places:
+        places.append(EditorPlace(id=place.name))
+        place_object_type[place.name] = place.object_type
+
+    transitions = [EditorTransition(id=transition.name, label=transition.label) for transition in ocpn.transitions]
+    initial_marking = ocpn.initial_marking if ocpn.initial_marking is not None else {}
+    final_marking = ocpn.final_marking if ocpn.final_marking is not None else {}
+
+    place_ids = {place.id for place in places}
+    place_in_out_mult: dict[str, tuple[dict[str, bool], dict[str, bool]]] = {
+        ids: ({}, {}) for ids in place_ids
+    }
+
+
+    arcs = []
+    for arc in ocpn.arcs:
+        arcs.append(EditorArc(nodes=(arc.source,arc.target), weight=arc.weight))
+        if arc.type != ArcType.VARIABLE:
+            continue
+        if arc.source in place_ids:
+            place_id, transition_id = arc.source, arc.target
+            incoming, outgoing = place_in_out_mult[place_id]
+            place_in_out_mult[place_id] = (incoming, {**outgoing, transition_id: True})
+        else:
+            transition_id, place_id = arc.source, arc.target
+            incoming, outgoing = place_in_out_mult[place_id]
+            place_in_out_mult[place_id] = ({**incoming, transition_id: True}, outgoing)
+
+    return OcpnImportResponse(
+        petri_net= EditorOCPN(
+            places=places,
+            transitions=transitions,
+            arcs=arcs,
+            initial_marking=initial_marking,
+            final_marking=final_marking,
+        ),
+        place_object_type=place_object_type,
+        place_in_out_mult=place_in_out_mult,
+    )
+
+
+def convert_from_pnml(net:dict) -> ImportResponse:
+    initial_marking = net.get("initial_marking") if net.get("initial_marking") is not None else {} 
+    final_markings = net.get("final_markings") or []
+    final_marking = final_markings[0] if final_markings else {}
+
+    places = [
+        ImportPlace(
+            id=pid,
+            tokens=initial_marking.get(pid,0),
+            final_tokens=final_marking.get(pid,0)
+        ) 
+        for pid in net.get("places",{})
+    ]
+    transitions = [
+        ImportTransition(
+            id=tid,
+            label= transition.get("label")
+        )
+        for tid, transition in net.get("transitions",{}).items()
+    ]
+    arcs = []
+    for arc in net.get("arcs", []):
+        source, target = arc["from_to"]["nodes"]
+        arcs.append(ImportArc(source=source, target=target, weight=arc.get("weight", 1)))
+
+    return ImportResponse(places=places, transitions=transitions, arcs=arcs)
+
+
+def convert_to_pnet_resource(net: dict) -> ClassicPetriNet:
+    pnet = convert_from_pnml(net)
+    return ClassicPetriNet(
+        places=[ClassicPlace(**p.model_dump()) for p in pnet.places],
+        transitions=[ClassicTransition(**t.model_dump()) for t in pnet.transitions],
+        arcs=[ClassicArc(**a.model_dump()) for a in pnet.arcs],
+    )