rocket-welder-sdk 1.1.33__py3-none-any.whl → 1.1.34__py3-none-any.whl

rocket_welder_sdk/session_id.py

@@ -0,0 +1,238 @@
+"""SessionId parsing utilities for NNG URL generation.
+
+SessionId format: ps-{guid} (e.g., ps-a1b2c3d4-e5f6-7890-abcd-ef1234567890)
+Prefix "ps" = PipelineSession.
+
+This module provides utilities to:
+1. Parse SessionId from environment variable
+2. Extract the Guid portion
+3. Generate NNG IPC URLs for streaming results
+4. Read explicit NNG URLs from environment variables (preferred)
+
+## URL Configuration Priority
+
+The SDK supports two ways to configure NNG URLs:
+
+1. **Explicit URLs (PREFERRED)** - Set by rocket-welder2:
+   - SEGMENTATION_SINK_URL
+   - KEYPOINTS_SINK_URL
+   - ACTIONS_SINK_URL
+
+2. **Derived from SessionId (FALLBACK)** - For backwards compatibility:
+   - SessionId env var → parse GUID → generate URLs
+
+Use `get_nng_urls_from_env()` for explicit URLs (preferred).
+Use `get_nng_urls(session_id)` for SessionId-derived URLs (fallback).
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+import uuid
+
+logger = logging.getLogger(__name__)
+
+SESSION_ID_PREFIX = "ps-"
+SESSION_ID_ENV_VAR = "SessionId"
+
+# Explicit URL environment variables (set by rocket-welder2)
+SEGMENTATION_SINK_URL_ENV = "SEGMENTATION_SINK_URL"
+KEYPOINTS_SINK_URL_ENV = "KEYPOINTS_SINK_URL"
+ACTIONS_SINK_URL_ENV = "ACTIONS_SINK_URL"
+
+
+def parse_session_id(session_id: str) -> uuid.UUID:
+    """Parse SessionId (ps-{guid}) to extract Guid.
+
+    Args:
+        session_id: SessionId string (e.g., "ps-a1b2c3d4-...")
+
+    Returns:
+        UUID extracted from SessionId
+
+    Raises:
+        ValueError: If session_id format is invalid
+
+    Examples:
+        >>> parse_session_id("ps-a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        UUID('a1b2c3d4-e5f6-7890-abcd-ef1234567890')
+        >>> parse_session_id("a1b2c3d4-e5f6-7890-abcd-ef1234567890")  # backwards compat
+        UUID('a1b2c3d4-e5f6-7890-abcd-ef1234567890')
+    """
+    if session_id.startswith(SESSION_ID_PREFIX):
+        return uuid.UUID(session_id[len(SESSION_ID_PREFIX) :])
+    # Fallback: try parsing as raw guid for backwards compatibility
+    return uuid.UUID(session_id)
+
+
+def get_session_id_from_env() -> str | None:
+    """Get SessionId from environment variable.
+
+    Returns:
+        SessionId string or None if not set
+    """
+    return os.environ.get(SESSION_ID_ENV_VAR)
+
+
+def get_nng_urls(session_id: str) -> dict[str, str]:
+    """Generate NNG IPC URLs from SessionId.
+
+    Args:
+        session_id: SessionId string (e.g., "ps-a1b2c3d4-...")
+
+    Returns:
+        Dictionary with 'segmentation', 'keypoints', 'actions' URLs
+
+    Examples:
+        >>> urls = get_nng_urls("ps-a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        >>> urls["segmentation"]
+        'ipc:///tmp/rw-a1b2c3d4-e5f6-7890-abcd-ef1234567890-seg.sock'
+    """
+    guid = parse_session_id(session_id)
+    return {
+        "segmentation": f"ipc:///tmp/rw-{guid}-seg.sock",
+        "keypoints": f"ipc:///tmp/rw-{guid}-kp.sock",
+        "actions": f"ipc:///tmp/rw-{guid}-actions.sock",
+    }
+
+
+def get_segmentation_url(session_id: str) -> str:
+    """Get NNG URL for segmentation stream.
+
+    Args:
+        session_id: SessionId string (e.g., "ps-a1b2c3d4-...")
+
+    Returns:
+        IPC URL for segmentation stream
+    """
+    guid = parse_session_id(session_id)
+    return f"ipc:///tmp/rw-{guid}-seg.sock"
+
+
+def get_keypoints_url(session_id: str) -> str:
+    """Get NNG URL for keypoints stream.
+
+    Args:
+        session_id: SessionId string (e.g., "ps-a1b2c3d4-...")
+
+    Returns:
+        IPC URL for keypoints stream
+    """
+    guid = parse_session_id(session_id)
+    return f"ipc:///tmp/rw-{guid}-kp.sock"
+
+
+def get_actions_url(session_id: str) -> str:
+    """Get NNG URL for actions stream.
+
+    Args:
+        session_id: SessionId string (e.g., "ps-a1b2c3d4-...")
+
+    Returns:
+        IPC URL for actions stream
+    """
+    guid = parse_session_id(session_id)
+    return f"ipc:///tmp/rw-{guid}-actions.sock"
+
+
+# ============================================================================
+# Explicit URL functions (PREFERRED - URLs set by rocket-welder2)
+# ============================================================================
+
+
+def get_nng_urls_from_env() -> dict[str, str | None]:
+    """Get NNG URLs from explicit environment variables.
+
+    This is the PREFERRED method for getting NNG URLs. rocket-welder2
+    sets these environment variables when starting containers.
+
+    Returns:
+        Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
+        Values are None if not configured.
+
+    Examples:
+        >>> os.environ["SEGMENTATION_SINK_URL"] = "ipc:///tmp/rw-abc-seg.sock"
+        >>> urls = get_nng_urls_from_env()
+        >>> urls["segmentation"]
+        'ipc:///tmp/rw-abc-seg.sock'
+    """
+    return {
+        "segmentation": os.environ.get(SEGMENTATION_SINK_URL_ENV),
+        "keypoints": os.environ.get(KEYPOINTS_SINK_URL_ENV),
+        "actions": os.environ.get(ACTIONS_SINK_URL_ENV),
+    }
+
+
+def get_segmentation_url_from_env() -> str | None:
+    """Get segmentation NNG URL from environment variable.
+
+    Returns:
+        IPC URL for segmentation stream, or None if not configured.
+    """
+    return os.environ.get(SEGMENTATION_SINK_URL_ENV)
+
+
+def get_keypoints_url_from_env() -> str | None:
+    """Get keypoints NNG URL from environment variable.
+
+    Returns:
+        IPC URL for keypoints stream, or None if not configured.
+    """
+    return os.environ.get(KEYPOINTS_SINK_URL_ENV)
+
+
+def get_actions_url_from_env() -> str | None:
+    """Get actions NNG URL from environment variable.
+
+    Returns:
+        IPC URL for actions stream, or None if not configured.
+    """
+    return os.environ.get(ACTIONS_SINK_URL_ENV)
+
+
+def has_explicit_nng_urls() -> bool:
+    """Check if explicit NNG URLs are configured.
+
+    Returns:
+        True if at least segmentation OR keypoints URL is configured.
+    """
+    urls = get_nng_urls_from_env()
+    return bool(urls["segmentation"] or urls["keypoints"])
+
+
+def get_configured_nng_urls() -> dict[str, str]:
+    """Get all configured NNG URLs (explicit or derived from SessionId).
+
+    Priority:
+    1. Explicit URLs from environment (SEGMENTATION_SINK_URL, etc.)
+    2. Derived from SessionId environment variable (fallback)
+
+    Returns:
+        Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
+        Only includes URLs that are actually configured.
+
+    Raises:
+        ValueError: If no NNG URLs are configured (neither explicit nor SessionId).
+    """
+    # Try explicit URLs first (preferred)
+    explicit_urls = get_nng_urls_from_env()
+    result: dict[str, str] = {}
+
+    for name, url in explicit_urls.items():
+        if url:
+            result[name] = url
+
+    # If we have at least one explicit URL, return what we have
+    if result:
+        return result
+
+    # Fallback: derive from SessionId
+    session_id = get_session_id_from_env()
+    if session_id:
+        return get_nng_urls(session_id)
+
+    raise ValueError(
+        "No NNG URLs configured. Set SEGMENTATION_SINK_URL/KEYPOINTS_SINK_URL "
+        "environment variables, or set SessionId for URL derivation."
+    )

rocket_welder_sdk/transport/__init__.py

@@ -28,11 +28,3 @@ __all__ = [
     "UnixSocketFrameSource",
     "UnixSocketServer",
 ]
-
-# NNG transport is optional (requires pynng package)
-try:
-    from .nng_transport import NngFrameSink, NngFrameSource
-
-    __all__.extend(["NngFrameSink", "NngFrameSource"])
-except ImportError:
-    pass  # pynng not installed

{rocket_welder_sdk-1.1.33.dist-info → rocket_welder_sdk-1.1.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.33
+Version: 1.1.34
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution

{rocket_welder_sdk-1.1.33.dist-info → rocket_welder_sdk-1.1.34.dist-info}/RECORD

@@ -1,24 +1,26 @@
-rocket_welder_sdk/__init__.py,sha256=nxaj88kgewtAbyTw7wLGvgjIkY9VOYUuBVtzw1MMW7c,2033
+rocket_welder_sdk/__init__.py,sha256=pcYOCqqYuK8oJwkFRnWej4uNfEkuYWXP6jcUhPSLgrc,3041
 rocket_welder_sdk/bytes_size.py,sha256=Myl29-wyWCIYdbMmgaxXebT8Dz8_Fwcr3fnfaNW81P0,7463
 rocket_welder_sdk/connection_string.py,sha256=NIC6OiOXF-DeBFCWzgMFOWsenrSS45hY81j_HLMSpgo,9974
-rocket_welder_sdk/controllers.py,sha256=X7D7OyiuHhGTrmrSNG2Tljsy1_4PGRObytB4dLyvRrg,32600
-rocket_welder_sdk/frame_metadata.py,sha256=8AbCgSQ17QeCHSzdQiSN0E1KxE5rrNpOlTYZ2em8kes,3903
+rocket_welder_sdk/controllers.py,sha256=tPfQ2GZRfLbj-M21uAa9X3cFzrBBvqSbxTUxPiaZ5xc,32690
+rocket_welder_sdk/frame_metadata.py,sha256=TMLIY47cIdIlxqk9xj7I3M8FZFmZ3GcVoLZht7prjQM,3929
 rocket_welder_sdk/gst_metadata.py,sha256=jEQvZX4BdR6OR3lqp12PV-HEXZhcxfiS010diA2CbMM,14213
 rocket_welder_sdk/keypoints_protocol.py,sha256=NKiSPrevWG4_RrD6jtFxPjwftlaPWe1CqoFVKRMwp4k,21858
 rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
 rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
 rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
-rocket_welder_sdk/rocket_welder_client.py,sha256=mguSN8E4nV8JsNOJvhHFNv7yIz7Ppb25_-9m68d6iD4,15244
+rocket_welder_sdk/rocket_welder_client.py,sha256=0SNsrP9SePTHNLbfKyt-71UYs2owrZwesiwOXNglI4c,18515
 rocket_welder_sdk/segmentation_result.py,sha256=q3n8m1sooPcattfXisL9em5gZKbEZ1ueGqeXfOrdaHY,13417
+rocket_welder_sdk/session_id.py,sha256=sRhzQw90shqq_DJVtrsSggcGZ775kz7cRfbI-1LMeSA,7027
 rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
 rocket_welder_sdk/external_controls/contracts.py,sha256=3DU6pdpteN50gF2fsS7C2279dGjDa0tZLrLntkBa2LM,2607
 rocket_welder_sdk/external_controls/contracts_old.py,sha256=XWriuXJZu5caTSS0bcTIOZcKnj-IRCm96voA4gqLBfU,2980
-rocket_welder_sdk/high_level/__init__.py,sha256=5oTCBL2qMGonCytHDckmX1b1U97-7Xb8Bg9Z70nR7fc,1759
-rocket_welder_sdk/high_level/connection_strings.py,sha256=4undnkbWZ837vY-o6ybIj1827F2VlUbCJX4m3Filz-s,10469
-rocket_welder_sdk/high_level/data_context.py,sha256=Pmwsl9MgBfKA9BqmBJmAVRvnaqPdjnq2rZEA_pzzYsw,4585
-rocket_welder_sdk/high_level/schema.py,sha256=UlefNAV2UL9eO_Th2q19a7tf_eoaeLE92fYZ5LNq7-M,4849
-rocket_welder_sdk/high_level/transport_protocol.py,sha256=lvLVHikW_MNZhXqaXlyXscT68OklyMbGs8DnDEMCtgE,4515
-rocket_welder_sdk/transport/__init__.py,sha256=L-wl0YWhVbSrof94Zt4g7SIM-wTPzujdVOsEfJHiJT4,978
+rocket_welder_sdk/high_level/__init__.py,sha256=C1Gan74Ce_JQZKJmXhpP3L3O11wvOClesBVaAxRZQaA,1305
+rocket_welder_sdk/high_level/client.py,sha256=kVtxpzP9qZgv-SYG_0glDckHapEod4MFl5NQ75TR_b4,9584
+rocket_welder_sdk/high_level/connection_strings.py,sha256=q1uZJQ7mt1RR-E8MJzIwG6vz3Ddruoc3pTCdTvg_pe4,10434
+rocket_welder_sdk/high_level/data_context.py,sha256=SXJvDpDBFi8Lm4XqSRSHK7YUUHuugXGo4ZRCb6_z5l0,4833
+rocket_welder_sdk/high_level/schema.py,sha256=7F5DfPACHUfOpbJE4YZJRpro9VL8tLa6Kt9ZJuY7R7w,5397
+rocket_welder_sdk/high_level/transport_protocol.py,sha256=EFF0bgNn9hxRMj67FwU6MVu-UiEFINSGhd2VC8agrgc,7393
+rocket_welder_sdk/transport/__init__.py,sha256=DYmZpohGPU7RhS6EdVT_BwCy5MZzyTQ6Eymm8TpmxJ8,751
 rocket_welder_sdk/transport/frame_sink.py,sha256=16dUefZF1QJv62Ig0ezPR6nEho_7A3WJu4M9_PPMqJM,2164
 rocket_welder_sdk/transport/frame_source.py,sha256=G1rBAQS1AgOOdtASB0_CYon8g20hUGXpP2exCp5hlhk,2169
 rocket_welder_sdk/transport/nng_transport.py,sha256=o-qgcmHCGnwtdPe-mwwrC-a9H0rgS-VdH2QvU-6kFlI,5838
@@ -31,7 +33,7 @@ rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE
 rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
 rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
 rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
-rocket_welder_sdk-1.1.33.dist-info/METADATA,sha256=WK6edMkZs55WIe1AOJjECFfHB2SmTMS31IpschstdpE,24847
-rocket_welder_sdk-1.1.33.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rocket_welder_sdk-1.1.33.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
-rocket_welder_sdk-1.1.33.dist-info/RECORD,,
+rocket_welder_sdk-1.1.34.dist-info/METADATA,sha256=zI8JTjId1nm1yfU6y-10l4vKl2vOiJqj6uL4GZUfkVc,24847
+rocket_welder_sdk-1.1.34.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rocket_welder_sdk-1.1.34.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
+rocket_welder_sdk-1.1.34.dist-info/RECORD,,