rocket-welder-sdk 1.1.33__tar.gz → 1.1.34a2__tar.gz

{rocket_welder_sdk-1.1.33 → rocket_welder_sdk-1.1.34a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.33
+Version: 1.1.34a2
 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.34a2/VERSION

@@ -0,0 +1 @@
+1.1.34a2

{rocket_welder_sdk-1.1.33 → rocket_welder_sdk-1.1.34a2}/rocket_welder_sdk/__init__.py

@@ -15,6 +15,14 @@ from .gst_metadata import GstCaps, GstMetadata
 from .opencv_controller import OpenCvController
 from .periodic_timer import PeriodicTimer, PeriodicTimerSync
 from .rocket_welder_client import RocketWelderClient
+from .session_id import (
+    get_actions_url,
+    get_keypoints_url,
+    get_nng_urls,
+    get_segmentation_url,
+    get_session_id_from_env,
+    parse_session_id,
+)
 
 # Alias for backward compatibility and README examples
 Client = RocketWelderClient
@@ -58,4 +66,11 @@ __all__ = [
     "PeriodicTimerSync",
     "Protocol",
     "RocketWelderClient",
+    # SessionId utilities for NNG URL generation
+    "get_actions_url",
+    "get_keypoints_url",
+    "get_nng_urls",
+    "get_segmentation_url",
+    "get_session_id_from_env",
+    "parse_session_id",
 ]

{rocket_welder_sdk-1.1.33 → rocket_welder_sdk-1.1.34a2}/rocket_welder_sdk/rocket_welder_client.py

@@ -16,6 +16,8 @@ from .connection_string import ConnectionMode, ConnectionString, Protocol
 from .controllers import DuplexShmController, IController, OneWayShmController
 from .frame_metadata import FrameMetadata  # noqa: TC001 - used at runtime in callbacks
 from .opencv_controller import OpenCvController
+from .session_id import get_nng_urls, get_session_id_from_env
+from .transport.nng_transport import NngFrameSink
 
 if TYPE_CHECKING:
     import numpy.typing as npt
@@ -53,6 +55,9 @@ class RocketWelderClient:
         self._controller: Optional[IController] = None
         self._lock = threading.Lock()
 
+        # NNG publishers for streaming results (auto-created if SessionId env var is set)
+        self._nng_publishers: dict[str, NngFrameSink] = {}
+
         # Preview support
         self._preview_enabled = (
             self._connection.parameters.get("preview", "false").lower() == "true"
@@ -72,6 +77,44 @@ class RocketWelderClient:
         with self._lock:
             return self._controller is not None and self._controller.is_running
 
+    @property
+    def nng_publishers(self) -> dict[str, NngFrameSink]:
+        """Get NNG publishers for streaming results.
+
+        Returns:
+            Dictionary with 'segmentation', 'keypoints', 'actions' keys.
+            Empty if SessionId env var was not set at startup.
+
+        Example:
+            client.nng_publishers["segmentation"].write_frame(seg_data)
+        """
+        return self._nng_publishers
+
+    def _create_nng_publishers(self, session_id: str) -> None:
+        """Create NNG publishers for result streaming.
+
+        Args:
+            session_id: SessionId string (e.g., "ps-{guid}")
+        """
+        try:
+            urls = get_nng_urls(session_id)
+
+            for name, url in urls.items():
+                sink = NngFrameSink.create_publisher(url)
+                self._nng_publishers[name] = sink
+                logger.info("NNG publisher ready: %s at %s", name, url)
+
+            logger.info(
+                "NNG publishers created for SessionId=%s: seg=%s, kp=%s, actions=%s",
+                session_id,
+                urls["segmentation"],
+                urls["keypoints"],
+                urls["actions"],
+            )
+        except Exception as ex:
+            logger.warning("Failed to create NNG publishers: %s", ex)
+            # Don't fail start() - NNG is optional for backwards compatibility
+
     def get_metadata(self) -> Optional[GstMetadata]:
         """
         Get the current GStreamer metadata.
@@ -119,6 +162,11 @@ class RocketWelderClient:
             else:
                 raise ValueError(f"Unsupported protocol: {self._connection.protocol}")
 
+            # Auto-create NNG publishers if SessionId env var is set
+            session_id = get_session_id_from_env()
+            if session_id:
+                self._create_nng_publishers(session_id)
+
             # If preview is enabled, wrap the callback to capture frames
             if self._preview_enabled:
                 self._original_callback = on_frame
@@ -189,6 +237,15 @@ class RocketWelderClient:
                 if self._preview_enabled:
                     self._preview_queue.put(None)  # Sentinel value
 
+                # Clean up NNG publishers
+                for name, sink in self._nng_publishers.items():
+                    try:
+                        sink.close()
+                        logger.debug("Closed NNG publisher: %s", name)
+                    except Exception as ex:
+                        logger.warning("Failed to close NNG publisher %s: %s", name, ex)
+                self._nng_publishers.clear()
+
                 logger.info("RocketWelder client stopped")
 
     def show(self, cancellation_token: Optional[threading.Event] = None) -> None:

rocket_welder_sdk-1.1.34a2/rocket_welder_sdk/session_id.py

@@ -0,0 +1,115 @@
+"""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
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+import uuid
+
+logger = logging.getLogger(__name__)
+
+SESSION_ID_PREFIX = "ps-"
+SESSION_ID_ENV_VAR = "SessionId"
+
+
+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"

{rocket_welder_sdk-1.1.33 → rocket_welder_sdk-1.1.34a2}/rocket_welder_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.33
+Version: 1.1.34a2
 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 → rocket_welder_sdk-1.1.34a2}/rocket_welder_sdk.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ rocket_welder_sdk/periodic_timer.py
 rocket_welder_sdk/py.typed
 rocket_welder_sdk/rocket_welder_client.py
 rocket_welder_sdk/segmentation_result.py
+rocket_welder_sdk/session_id.py
 rocket_welder_sdk.egg-info/PKG-INFO
 rocket_welder_sdk.egg-info/SOURCES.txt
 rocket_welder_sdk.egg-info/dependency_links.txt
@@ -57,6 +58,7 @@ tests/test_keypoints_protocol.py
 tests/test_rocket_welder_client.py
 tests/test_segmentation_cross_platform.py
 tests/test_segmentation_result.py
+tests/test_session_id.py
 tests/test_transport_cross_platform.py
 tests/test_ui_controls.py
 tests/test_ui_service_happy_path.py

rocket_welder_sdk-1.1.34a2/tests/test_session_id.py

@@ -0,0 +1,130 @@
+"""Tests for session_id module."""
+
+import os
+import uuid
+from unittest import mock
+
+import pytest
+
+from rocket_welder_sdk.session_id import (
+    SESSION_ID_PREFIX,
+    get_actions_url,
+    get_keypoints_url,
+    get_nng_urls,
+    get_segmentation_url,
+    get_session_id_from_env,
+    parse_session_id,
+)
+
+
+class TestParseSessionId:
+    """Tests for parse_session_id function."""
+
+    def test_parse_with_prefix(self) -> None:
+        """parse_session_id handles ps-{guid} format."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = f"ps-{guid}"
+
+        result = parse_session_id(session_id)
+
+        assert result == guid
+
+    def test_parse_without_prefix(self) -> None:
+        """parse_session_id handles raw guid for backwards compat."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = str(guid)
+
+        result = parse_session_id(session_id)
+
+        assert result == guid
+
+    def test_parse_invalid_raises_value_error(self) -> None:
+        """parse_session_id raises ValueError for invalid input."""
+        with pytest.raises(ValueError):
+            parse_session_id("invalid-session-id")
+
+    def test_parse_empty_raises_value_error(self) -> None:
+        """parse_session_id raises ValueError for empty string."""
+        with pytest.raises(ValueError):
+            parse_session_id("")
+
+
+class TestGetNngUrls:
+    """Tests for get_nng_urls function."""
+
+    def test_generates_correct_urls(self) -> None:
+        """get_nng_urls generates correct IPC URLs."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = f"ps-{guid}"
+
+        urls = get_nng_urls(session_id)
+
+        assert urls["segmentation"] == f"ipc:///tmp/rw-{guid}-seg.sock"
+        assert urls["keypoints"] == f"ipc:///tmp/rw-{guid}-kp.sock"
+        assert urls["actions"] == f"ipc:///tmp/rw-{guid}-actions.sock"
+
+    def test_works_with_raw_guid(self) -> None:
+        """get_nng_urls works with raw guid for backwards compat."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = str(guid)
+
+        urls = get_nng_urls(session_id)
+
+        assert f"{guid}" in urls["segmentation"]
+
+
+class TestGetIndividualUrls:
+    """Tests for individual URL getter functions."""
+
+    def test_get_segmentation_url(self) -> None:
+        """get_segmentation_url returns correct URL."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = f"ps-{guid}"
+
+        url = get_segmentation_url(session_id)
+
+        assert url == f"ipc:///tmp/rw-{guid}-seg.sock"
+
+    def test_get_keypoints_url(self) -> None:
+        """get_keypoints_url returns correct URL."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = f"ps-{guid}"
+
+        url = get_keypoints_url(session_id)
+
+        assert url == f"ipc:///tmp/rw-{guid}-kp.sock"
+
+    def test_get_actions_url(self) -> None:
+        """get_actions_url returns correct URL."""
+        guid = uuid.UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+        session_id = f"ps-{guid}"
+
+        url = get_actions_url(session_id)
+
+        assert url == f"ipc:///tmp/rw-{guid}-actions.sock"
+
+
+class TestGetSessionIdFromEnv:
+    """Tests for get_session_id_from_env function."""
+
+    def test_returns_value_when_set(self) -> None:
+        """get_session_id_from_env returns value when SessionId is set."""
+        with mock.patch.dict(os.environ, {"SessionId": "ps-test-guid"}):
+            result = get_session_id_from_env()
+            assert result == "ps-test-guid"
+
+    def test_returns_none_when_not_set(self) -> None:
+        """get_session_id_from_env returns None when SessionId not set."""
+        with mock.patch.dict(os.environ, clear=True):
+            # Ensure SessionId is not set
+            os.environ.pop("SessionId", None)
+            result = get_session_id_from_env()
+            assert result is None
+
+
+class TestSessionIdPrefix:
+    """Tests for SESSION_ID_PREFIX constant."""
+
+    def test_prefix_is_ps_dash(self) -> None:
+        """SESSION_ID_PREFIX is 'ps-'."""
+        assert SESSION_ID_PREFIX == "ps-"

rocket_welder_sdk-1.1.33/VERSION

@@ -1 +0,0 @@
-1.1.33