r4pm 0.3.1__cp37-cp37m-macosx_10_12_x86_64.whl

r4pm/__init__.py

@@ -0,0 +1,92 @@
+"""
+r4pm - Rust for process mining
+
+Import/Export:
+    - import_xes, export_xes: XES event logs
+    - import_ocel_xml, import_ocel_json: OCEL2 object-centric logs
+    
+Registry (for use with bindings):
+    - import_item, convert_item, export_item
+    - list_items, remove_item
+    - item_to_df
+
+Auto-generated bindings organized by module:
+    - Import from r4pm.bindings
+    - Submodules: bindings.discovery, bindings.core, etc.
+"""
+
+from .xes_import import import_xes
+from .xes_export import export_xes
+from .ocel_import import (
+    import_ocel,
+    import_ocel_pm4py,
+    import_ocel_xml, 
+    import_ocel_xml_pm4py, 
+    import_ocel_json, 
+    import_ocel_json_pm4py, 
+    rs_ocel_to_pm4py
+)
+from .ocel_export import export_ocel, export_ocel_pm4py
+
+from .r4pm import (
+    # Registry functions
+    import_item,
+    convert_item,
+    export_item,
+    item_to_df,
+    list_items,
+    remove_item,
+    import_item_from_df,
+    # Bindings introspection
+    list_bindings,
+    call_binding,
+    # Low-level import/export (used internally)
+    # import_xes_rs,
+    # export_xes_rs,
+    # import_ocel_xml_rs,
+    # import_ocel_json_rs,
+    __version__,
+)
+
+__all__ = [
+    # XES import/export
+    "xes_import",
+    "xes_export",
+    # OCEL import
+    "import_ocel_xml",
+    "import_ocel_xml_pm4py",
+    "import_ocel_json",
+    "import_ocel_json_pm4py",
+    "rs_ocel_to_pm4py",
+    # Registry
+    "import_item",
+    "convert_item",
+    "export_item",
+    "item_to_df",
+    "list_items",
+    "remove_item",
+    "import_item_from_df",
+    # Bindings introspection
+    "list_bindings",
+    "call_binding",
+    # Low-level Rust functions
+    # "import_xes_rs",
+    # "export_xes_rs",
+    # "import_ocel_xml_rs",
+    # "import_ocel_json_rs",
+    # Bindings submodule
+    "bindings",
+    "__version__",
+]
+
+# Import bindings submodule (auto-generated by build.rs during cargo build)
+try:
+    from . import bindings
+except ImportError:
+    # Bindings not available - create a placeholder with helpful error
+    class _BindingsNotGenerated:
+        def __getattr__(self, name):
+            raise ImportError(
+                "Bindings not available. Rebuild with: maturin develop --release"
+            )
+    bindings = _BindingsNotGenerated()

r4pm/__init__.pyi

@@ -0,0 +1,239 @@
+"""r4pm: Rust for Process Mining (Python Version)
+
+"""
+from typing import Any, Dict, List, Optional, Union
+import polars as pl
+
+# ============================================================================
+# XES Import/Export
+# ============================================================================
+
+def import_xes(
+    path: str,
+    date_format: Optional[str] = None,
+    print_debug: Optional[bool] = None
+) -> tuple[pl.DataFrame, str]:
+    """
+    Import XES event log.
+    
+    Args:
+        path: Path to .xes or .xes.gz file
+        date_format: Optional date format for parsing (see chrono strftime)
+        print_debug: Enable debug output
+    
+    Returns:
+        Tuple of (DataFrame with events, JSON string with log metadata)
+    """
+    ...
+
+def export_xes(df: pl.DataFrame, path: str) -> None:
+    """
+    Export DataFrame as XES file.
+    
+    Args:
+        df: Polars DataFrame with event data
+        path: Output path (.xes or .xes.gz)
+    """
+    ...
+
+# ============================================================================
+# OCEL Import
+# ============================================================================
+
+def rs_ocel_to_pm4py(ocel_rs: Dict[str, pl.DataFrame]) -> Any:
+    """
+    Convert Polars OCEL DataFrames to PM4PY OCEL object.
+    
+    Args:
+        ocel_rs: Dict of DataFrames from import_ocel_xml/json
+    
+    Returns:
+        PM4PY OCEL object
+    """
+    ...
+
+def import_ocel_xml(path: str) -> Dict[str, pl.DataFrame]:
+    """
+    Import OCEL2 from XML.
+    
+    Returns:
+        Dict with DataFrames: 'events', 'objects', 'relations', 'o2o', 'object_changes'
+    """
+    ...
+
+def import_ocel_xml_pm4py(path: str) -> Any:
+    """
+    Import OCEL2 XML and convert to PM4PY format.
+    """
+    ...
+
+def import_ocel_json(path: str) -> Dict[str, pl.DataFrame]:
+    """
+    Import OCEL2 from JSON.
+    
+    Returns:
+        Dict with DataFrames: 'events', 'objects', 'relations', 'o2o', 'object_changes'
+    """
+    ...
+
+def import_ocel_json_pm4py(path: str) -> Any:
+    """
+    Import OCEL2 JSON and convert to PM4PY format.
+    """
+    ...
+
+def import_ocel(path: str) -> dict[str, pl.DataFrame]:
+    """
+    Import OCEL2 from File.
+    
+    Returns:
+        Dict with DataFrames: 'events', 'objects', 'relations', 'o2o', 'object_changes'
+    """
+    ...
+
+def import_ocel_pm4py(path: str):
+    """Import OCEL2 JSON and convert to PM4PY format."""
+    ...
+
+
+def export_ocel(ocel: dict[str, pl.DataFrame], path: str):
+    """
+    Export Polars OCEL DataFrames to File
+    
+    Args:
+        ocel: Dict of DataFrames from import_ocel_xml/json
+        path: Output path (e.g., .ocel.xml or .ocel.json)
+    
+    """
+    ...
+
+def export_ocel_pm4py(ocel, path: str):
+    """
+    Export PM4Py OCEL to File
+    
+    Args:
+        ocel: PM4Py OCEL object
+        path: Output path (e.g., .ocel.xml or .ocel.json)
+    
+    """
+    ...
+
+# ============================================================================
+# Registry Functions
+# ============================================================================
+
+def import_item(item_type: str, file_path: str, item_id: Optional[str] = None) -> str:
+    """
+    Load a file into the registry.
+    
+    Args:
+        item_type: Type name (e.g., "OCEL", "EventLog", "IndexLinkedOCEL", "SlimLinkedOCEL")
+        file_path: Path to file to load
+        item_id: Optional custom ID (auto-generated if not provided)
+    
+    Returns:
+        Registry item ID
+    """
+    ...
+
+def convert_item(item_id: str, target_type: str, new_item_id: Optional[str] = None) -> str:
+    """
+    Convert a registry item to another type.
+    
+    Args:
+        item_id: ID of item to convert
+        target_type: Target type name (e.g., "IndexLinkedOCEL")
+        new_item_id: Optional ID for converted item (auto-generated if not provided)
+    
+    Returns:
+        New registry item ID
+    """
+    ...
+
+def export_item(item_id: str, file_path: str) -> None:
+    """Export a registry item to a file."""
+    ...
+
+def item_to_df(item_id: str) -> Union[pl.DataFrame, Dict[str, pl.DataFrame]]:
+    """
+    Get registry item as DataFrame(s).
+    
+    Returns:
+        Single DataFrame for EventLog, dict of DataFrames for OCEL
+    """
+    ...
+
+def list_items() -> List[Dict[str, str]]:
+    """
+    List all items in the registry.
+    
+    Returns:
+        List of dicts with 'id' and 'type' keys
+    """
+    ...
+
+def remove_item(item_id: str) -> bool:
+    """
+    Remove item from registry.
+    
+    Returns:
+        True if removed, False if not found
+    """
+    ...
+
+def import_item_from_df(
+    item_type: str,
+    data: Union[pl.DataFrame, Dict[str, pl.DataFrame]],
+    item_id: Optional[str] = None
+) -> str:
+    """
+    Create a registry item from DataFrame(s).
+    
+    Args:
+        item_type: Type of item to create ("EventLog" or "OCEL")
+        data: For EventLog: single DataFrame with event data.
+              For OCEL: dict with 'events', 'objects', 'relations', 'o2o' DataFrames
+        item_id: Optional custom ID (auto-generated if not provided)
+    
+    Returns:
+        Registry item ID
+    """
+    ...
+
+# ============================================================================
+# Bindings Introspection
+# ============================================================================
+
+def list_bindings() -> List[Dict[str, Any]]:
+    """
+    List all available binding functions.
+    
+    Returns:
+        List of function metadata dicts with keys: id, name, description, module, 
+        arguments, required_arguments, return_schema
+    """
+    ...
+
+def call_binding(function_id: str, args_json: str) -> str:
+    """
+    Call a binding function by ID.
+    
+    Args:
+        function_id: Function ID (e.g., "process_mining::bindings::num_events")
+        args_json: JSON string with function arguments
+    
+    Returns:
+        JSON string with result (value or registry ID)
+    """
+    ...
+
+# ============================================================================
+# Bindings Submodule
+# ============================================================================
+
+# Bindings submodule (organized by Rust module structure)
+from . import bindings as bindings
+
+__all__: List[str]
+
+__version__: str

r4pm/bindings/__init__.py

@@ -0,0 +1,40 @@
+"""
+Auto-generated bindings organized by module.
+
+DO NOT EDIT - Generated by build.rs
+
+Import functions directly or use submodules:
+    from r4pm.bindings import discover_dfg
+    from r4pm.bindings.discovery.case_centric import dfg
+"""
+from typing import Any, Dict, List, Optional
+
+from . import bindings
+from . import core
+from . import discovery
+
+# Re-export all functions at top level
+from .discovery.case_centric.alphappp.full import discover_alphaplusplusplus
+from .discovery.case_centric.dfg import discover_dfg
+from .core.process_models.object_centric.ocdfg.object_centric_dfg_struct import discover_dfg_from_locel
+from .discovery.object_centric.oc_declare import discover_oc_declare
+from .bindings import index_link_ocel
+from .core.event_data.case_centric.utils.activity_projection import log_to_activity_projection
+from .bindings import num_events
+from .bindings import num_objects
+from .bindings import test_some_inputs
+
+__all__ = [
+    "bindings",
+    "core",
+    "discovery",
+    "discover_alphaplusplusplus",
+    "discover_dfg",
+    "discover_dfg_from_locel",
+    "discover_oc_declare",
+    "index_link_ocel",
+    "log_to_activity_projection",
+    "num_events",
+    "num_objects",
+    "test_some_inputs",
+]

r4pm/bindings/__init__.pyi

@@ -0,0 +1,128 @@
+"""
+Type stubs for bindings module.
+
+DO NOT EDIT - Generated by build.rs
+"""
+from typing import Any, Dict, List, Optional
+
+from . import bindings as bindings
+from . import core as core
+from . import discovery as discovery
+
+def test_some_inputs(s: str, n: int, i: int, f: float, b: bool) -> str:
+    """
+    This is a test function.
+    **This should be bold**, *this is italic*, `and this code`.
+
+    Args:
+        s: str
+        n: int
+        i: int
+        f: float
+        b: bool
+
+    Returns:
+        str
+    """
+    ...
+
+def num_events(ocel: str) -> int:
+    """
+    Get the number of events in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    ...
+
+def num_objects(ocel: str) -> int:
+    """
+    Get the number of objects in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    ...
+
+def index_link_ocel(ocel: str) -> str:
+    """
+    Convert an [`OCEL`] to an [`IndexLinkedOCEL`]
+
+    Args:
+        ocel: Registry ID for OCEL
+
+    Returns:
+        str
+    """
+    ...
+
+def log_to_activity_projection(log: str) -> str:
+    """
+    Convert an [`EventLog`] into an [`EventLogActivityProjection`]
+    All traces with the same activity sequence are aggregated into one trace with a frequency count
+
+    Args:
+        log: Registry ID for EventLog
+
+    Returns:
+        str
+    """
+    ...
+
+def discover_dfg_from_locel(locel: str) -> Dict[str, Any]:
+    """
+    Construct a [`OCDirectlyFollowsGraph`] from an [`IndexLinkedOCEL`]
+
+    Args:
+        locel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        Dict[str, Any]
+    """
+    ...
+
+def discover_alphaplusplusplus(log_proj: str, config: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    """
+    Discover a [`PetriNet`] using the Alpha+++ Process Discovery algorithm
+
+    Args:
+        log_proj: Registry ID for EventLogActivityProjection
+        config: Algorithm parameters for Alpha+++
+
+    Returns:
+        Dict[str, Any]
+    """
+    ...
+
+def discover_dfg(event_log: str) -> Dict[str, Any]:
+    """
+    Discover [`DirectlyFollowsGraph`] with default classifier
+
+    Args:
+        event_log: Registry ID for EventLog
+
+    Returns:
+        Dict[str, Any]
+    """
+    ...
+
+def discover_oc_declare(locel: str, options: Optional[Dict[str, Any]] = None) -> List[Any]:
+    """
+    Discover behavioral OC-DECLARE constraints
+
+    Args:
+        locel: Registry ID for SlimLinkedOCEL
+        options: Options for the automatic discovery of OC-DECLARE constraints
+
+    Returns:
+        List[Any]
+    """
+    ...
+
+__all__: List[str]

r4pm/bindings/bindings.py

@@ -0,0 +1,90 @@
+"""
+Auto-generated bindings for bindings
+
+DO NOT EDIT - Generated by build.rs
+"""
+from typing import Any, Dict, List, Optional
+
+def test_some_inputs(s: str, n: int, i: int, f: float, b: bool) -> str:
+    """
+    This is a test function.
+    **This should be bold**, *this is italic*, `and this code`.
+
+    Args:
+        s: str
+        n: int
+        i: int
+        f: float
+        b: bool
+
+    Returns:
+        str
+    """
+    import json
+    from ..r4pm import call_binding
+    args_dict = {}
+    args_dict["s"] = s
+    args_dict["n"] = n
+    args_dict["i"] = i
+    args_dict["f"] = f
+    args_dict["b"] = b
+    result = call_binding("process_mining::bindings::test_some_inputs", json.dumps(args_dict))
+    return json.loads(result)
+
+def num_events(ocel: str) -> int:
+    """
+    Get the number of events in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    import json
+    from ..r4pm import call_binding
+    args_dict = {}
+    args_dict["ocel"] = ocel
+    result = call_binding("process_mining::bindings::num_events", json.dumps(args_dict))
+    return json.loads(result)
+
+def num_objects(ocel: str) -> int:
+    """
+    Get the number of objects in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    import json
+    from ..r4pm import call_binding
+    args_dict = {}
+    args_dict["ocel"] = ocel
+    result = call_binding("process_mining::bindings::num_objects", json.dumps(args_dict))
+    return json.loads(result)
+
+def index_link_ocel(ocel: str) -> str:
+    """
+    Convert an [`OCEL`] to an [`IndexLinkedOCEL`]
+
+    Args:
+        ocel: Registry ID for OCEL
+
+    Returns:
+        Registry ID for IndexLinkedOCEL
+    """
+    import json
+    from ..r4pm import call_binding
+    args_dict = {}
+    args_dict["ocel"] = ocel
+    result = call_binding("process_mining::bindings::index_link_ocel", json.dumps(args_dict))
+    return json.loads(result)
+
+__all__ = [
+    "test_some_inputs",
+    "num_events",
+    "num_objects",
+    "index_link_ocel",
+]

r4pm/bindings/bindings.pyi

@@ -0,0 +1,61 @@
+"""
+Type stubs for bindings
+
+DO NOT EDIT - Generated by build.rs
+"""
+from typing import Any, Dict, List, Optional
+
+def test_some_inputs(s: str, n: int, i: int, f: float, b: bool) -> str:
+    """
+    This is a test function.
+    **This should be bold**, *this is italic*, `and this code`.
+
+    Args:
+        s: str
+        n: int
+        i: int
+        f: float
+        b: bool
+
+    Returns:
+        str
+    """
+    ...
+
+def num_events(ocel: str) -> int:
+    """
+    Get the number of events in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    ...
+
+def num_objects(ocel: str) -> int:
+    """
+    Get the number of objects in an [`OCEL`]
+
+    Args:
+        ocel: Registry ID for IndexLinkedOCEL
+
+    Returns:
+        int
+    """
+    ...
+
+def index_link_ocel(ocel: str) -> str:
+    """
+    Convert an [`OCEL`] to an [`IndexLinkedOCEL`]
+
+    Args:
+        ocel: Registry ID for OCEL
+
+    Returns:
+        str
+    """
+    ...
+
+__all__: List[str]

r4pm/bindings/core/__init__.py

@@ -0,0 +1,6 @@
+"""Auto-generated module."""
+
+from . import event_data
+from . import process_models
+
+__all__ = ["event_data", "process_models"]

r4pm/bindings/core/__init__.pyi

@@ -0,0 +1,7 @@
+"""Type stubs."""
+from typing import List
+
+from . import event_data as event_data
+from . import process_models as process_models
+
+__all__: List[str]

r4pm/bindings/core/event_data/__init__.py

@@ -0,0 +1,5 @@
+"""Auto-generated module."""
+
+from . import case_centric
+
+__all__ = ["case_centric"]

r4pm/bindings/core/event_data/__init__.pyi

@@ -0,0 +1,6 @@
+"""Type stubs."""
+from typing import List
+
+from . import case_centric as case_centric
+
+__all__: List[str]

r4pm/bindings/core/event_data/case_centric/__init__.py

@@ -0,0 +1,5 @@
+"""Auto-generated module."""
+
+from . import utils
+
+__all__ = ["utils"]

r4pm/bindings/core/event_data/case_centric/__init__.pyi

@@ -0,0 +1,6 @@
+"""Type stubs."""
+from typing import List
+
+from . import utils as utils
+
+__all__: List[str]

r4pm/bindings/core/event_data/case_centric/utils/__init__.py

@@ -0,0 +1,5 @@
+"""Auto-generated module."""
+
+from .activity_projection import *
+
+__all__ = []