rocket-welder-sdk 1.1.34rc1__py3-none-any.whl → 1.1.35.dev12__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,22 @@ This module provides utilities to:
7
7
  1. Parse SessionId from environment variable
8
8
  2. Extract the Guid portion
9
9
  3. Generate NNG IPC URLs for streaming results
10
+ 4. Read explicit NNG URLs from environment variables (preferred)
11
+
12
+ ## URL Configuration Priority
13
+
14
+ The SDK supports two ways to configure NNG URLs:
15
+
16
+ 1. **Explicit URLs (PREFERRED)** - Set by rocket-welder2:
17
+ - SEGMENTATION_SINK_URL
18
+ - KEYPOINTS_SINK_URL
19
+ - ACTIONS_SINK_URL
20
+
21
+ 2. **Derived from SessionId (FALLBACK)** - For backwards compatibility:
22
+ - SessionId env var → parse GUID → generate URLs
23
+
24
+ Use `get_nng_urls_from_env()` for explicit URLs (preferred).
25
+ Use `get_nng_urls(session_id)` for SessionId-derived URLs (fallback).
10
26
  """
11
27
 
12
28
  from __future__ import annotations
@@ -20,6 +36,11 @@ logger = logging.getLogger(__name__)
20
36
  SESSION_ID_PREFIX = "ps-"
21
37
  SESSION_ID_ENV_VAR = "SessionId"
22
38
 
39
+ # Explicit URL environment variables (set by rocket-welder2)
40
+ SEGMENTATION_SINK_URL_ENV = "SEGMENTATION_SINK_URL"
41
+ KEYPOINTS_SINK_URL_ENV = "KEYPOINTS_SINK_URL"
42
+ ACTIONS_SINK_URL_ENV = "ACTIONS_SINK_URL"
43
+
23
44
 
24
45
  def parse_session_id(session_id: str) -> uuid.UUID:
25
46
  """Parse SessionId (ps-{guid}) to extract Guid.
@@ -113,3 +134,105 @@ def get_actions_url(session_id: str) -> str:
113
134
  """
114
135
  guid = parse_session_id(session_id)
115
136
  return f"ipc:///tmp/rw-{guid}-actions.sock"
137
+
138
+
139
+ # ============================================================================
140
+ # Explicit URL functions (PREFERRED - URLs set by rocket-welder2)
141
+ # ============================================================================
142
+
143
+
144
+ def get_nng_urls_from_env() -> dict[str, str | None]:
145
+ """Get NNG URLs from explicit environment variables.
146
+
147
+ This is the PREFERRED method for getting NNG URLs. rocket-welder2
148
+ sets these environment variables when starting containers.
149
+
150
+ Returns:
151
+ Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
152
+ Values are None if not configured.
153
+
154
+ Examples:
155
+ >>> os.environ["SEGMENTATION_SINK_URL"] = "ipc:///tmp/rw-abc-seg.sock"
156
+ >>> urls = get_nng_urls_from_env()
157
+ >>> urls["segmentation"]
158
+ 'ipc:///tmp/rw-abc-seg.sock'
159
+ """
160
+ return {
161
+ "segmentation": os.environ.get(SEGMENTATION_SINK_URL_ENV),
162
+ "keypoints": os.environ.get(KEYPOINTS_SINK_URL_ENV),
163
+ "actions": os.environ.get(ACTIONS_SINK_URL_ENV),
164
+ }
165
+
166
+
167
+ def get_segmentation_url_from_env() -> str | None:
168
+ """Get segmentation NNG URL from environment variable.
169
+
170
+ Returns:
171
+ IPC URL for segmentation stream, or None if not configured.
172
+ """
173
+ return os.environ.get(SEGMENTATION_SINK_URL_ENV)
174
+
175
+
176
+ def get_keypoints_url_from_env() -> str | None:
177
+ """Get keypoints NNG URL from environment variable.
178
+
179
+ Returns:
180
+ IPC URL for keypoints stream, or None if not configured.
181
+ """
182
+ return os.environ.get(KEYPOINTS_SINK_URL_ENV)
183
+
184
+
185
+ def get_actions_url_from_env() -> str | None:
186
+ """Get actions NNG URL from environment variable.
187
+
188
+ Returns:
189
+ IPC URL for actions stream, or None if not configured.
190
+ """
191
+ return os.environ.get(ACTIONS_SINK_URL_ENV)
192
+
193
+
194
+ def has_explicit_nng_urls() -> bool:
195
+ """Check if explicit NNG URLs are configured.
196
+
197
+ Returns:
198
+ True if at least segmentation OR keypoints URL is configured.
199
+ """
200
+ urls = get_nng_urls_from_env()
201
+ return bool(urls["segmentation"] or urls["keypoints"])
202
+
203
+
204
+ def get_configured_nng_urls() -> dict[str, str]:
205
+ """Get all configured NNG URLs (explicit or derived from SessionId).
206
+
207
+ Priority:
208
+ 1. Explicit URLs from environment (SEGMENTATION_SINK_URL, etc.)
209
+ 2. Derived from SessionId environment variable (fallback)
210
+
211
+ Returns:
212
+ Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
213
+ Only includes URLs that are actually configured.
214
+
215
+ Raises:
216
+ ValueError: If no NNG URLs are configured (neither explicit nor SessionId).
217
+ """
218
+ # Try explicit URLs first (preferred)
219
+ explicit_urls = get_nng_urls_from_env()
220
+ result: dict[str, str] = {}
221
+
222
+ for name, url in explicit_urls.items():
223
+ if url:
224
+ result[name] = url
225
+
226
+ # If we have at least one explicit URL, return what we have
227
+ if result:
228
+ return result
229
+
230
+ # Fallback: derive from SessionId
231
+ session_id = get_session_id_from_env()
232
+ if session_id:
233
+ return get_nng_urls(session_id)
234
+
235
+ raise ValueError(
236
+ "No NNG URLs configured. Set SEGMENTATION_SINK_URL/KEYPOINTS_SINK_URL "
237
+ "environment variables, or set SessionId for URL derivation."
238
+ )
@@ -28,11 +28,3 @@ __all__ = [
28
28
  "UnixSocketFrameSource",
29
29
  "UnixSocketServer",
30
30
  ]
31
-
32
- # NNG transport is optional (requires pynng package)
33
- try:
34
- from .nng_transport import NngFrameSink, NngFrameSource
35
-
36
- __all__.extend(["NngFrameSink", "NngFrameSource"])
37
- except ImportError:
38
- pass # pynng not installed
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rocket-welder-sdk
3
- Version: 1.1.34rc1
3
+ Version: 1.1.35.dev12
4
4
  Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
5
5
  Home-page: https://github.com/modelingevolution/rocket-welder-sdk
6
6
  Author: ModelingEvolution
@@ -1,25 +1,26 @@
1
- rocket_welder_sdk/__init__.py,sha256=7jawqof-tt0S0G7CMMOmHRsVLbUf-o8sSREP1VxEeJ4,2400
1
+ rocket_welder_sdk/__init__.py,sha256=pcYOCqqYuK8oJwkFRnWej4uNfEkuYWXP6jcUhPSLgrc,3041
2
2
  rocket_welder_sdk/bytes_size.py,sha256=Myl29-wyWCIYdbMmgaxXebT8Dz8_Fwcr3fnfaNW81P0,7463
3
3
  rocket_welder_sdk/connection_string.py,sha256=NIC6OiOXF-DeBFCWzgMFOWsenrSS45hY81j_HLMSpgo,9974
4
- rocket_welder_sdk/controllers.py,sha256=X7D7OyiuHhGTrmrSNG2Tljsy1_4PGRObytB4dLyvRrg,32600
5
- rocket_welder_sdk/frame_metadata.py,sha256=8AbCgSQ17QeCHSzdQiSN0E1KxE5rrNpOlTYZ2em8kes,3903
4
+ rocket_welder_sdk/controllers.py,sha256=tPfQ2GZRfLbj-M21uAa9X3cFzrBBvqSbxTUxPiaZ5xc,32690
5
+ rocket_welder_sdk/frame_metadata.py,sha256=TMLIY47cIdIlxqk9xj7I3M8FZFmZ3GcVoLZht7prjQM,3929
6
6
  rocket_welder_sdk/gst_metadata.py,sha256=jEQvZX4BdR6OR3lqp12PV-HEXZhcxfiS010diA2CbMM,14213
7
7
  rocket_welder_sdk/keypoints_protocol.py,sha256=NKiSPrevWG4_RrD6jtFxPjwftlaPWe1CqoFVKRMwp4k,21858
8
8
  rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
9
9
  rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
10
10
  rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
11
- rocket_welder_sdk/rocket_welder_client.py,sha256=2tGL98hLXU_Xl2LzjhdLpQkp9oxzb4D3WmPOcMZMyw4,17474
11
+ rocket_welder_sdk/rocket_welder_client.py,sha256=0SNsrP9SePTHNLbfKyt-71UYs2owrZwesiwOXNglI4c,18515
12
12
  rocket_welder_sdk/segmentation_result.py,sha256=q3n8m1sooPcattfXisL9em5gZKbEZ1ueGqeXfOrdaHY,13417
13
- rocket_welder_sdk/session_id.py,sha256=4RVNxuMzJsJ3Me1LveTe_RSDevEUsOozlamSRMXfXGA,3114
13
+ rocket_welder_sdk/session_id.py,sha256=sRhzQw90shqq_DJVtrsSggcGZ775kz7cRfbI-1LMeSA,7027
14
14
  rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
15
15
  rocket_welder_sdk/external_controls/contracts.py,sha256=3DU6pdpteN50gF2fsS7C2279dGjDa0tZLrLntkBa2LM,2607
16
16
  rocket_welder_sdk/external_controls/contracts_old.py,sha256=XWriuXJZu5caTSS0bcTIOZcKnj-IRCm96voA4gqLBfU,2980
17
- rocket_welder_sdk/high_level/__init__.py,sha256=5oTCBL2qMGonCytHDckmX1b1U97-7Xb8Bg9Z70nR7fc,1759
18
- rocket_welder_sdk/high_level/connection_strings.py,sha256=4undnkbWZ837vY-o6ybIj1827F2VlUbCJX4m3Filz-s,10469
19
- rocket_welder_sdk/high_level/data_context.py,sha256=Pmwsl9MgBfKA9BqmBJmAVRvnaqPdjnq2rZEA_pzzYsw,4585
20
- rocket_welder_sdk/high_level/schema.py,sha256=UlefNAV2UL9eO_Th2q19a7tf_eoaeLE92fYZ5LNq7-M,4849
21
- rocket_welder_sdk/high_level/transport_protocol.py,sha256=lvLVHikW_MNZhXqaXlyXscT68OklyMbGs8DnDEMCtgE,4515
22
- rocket_welder_sdk/transport/__init__.py,sha256=L-wl0YWhVbSrof94Zt4g7SIM-wTPzujdVOsEfJHiJT4,978
17
+ rocket_welder_sdk/high_level/__init__.py,sha256=C1Gan74Ce_JQZKJmXhpP3L3O11wvOClesBVaAxRZQaA,1305
18
+ rocket_welder_sdk/high_level/client.py,sha256=kVtxpzP9qZgv-SYG_0glDckHapEod4MFl5NQ75TR_b4,9584
19
+ rocket_welder_sdk/high_level/connection_strings.py,sha256=q1uZJQ7mt1RR-E8MJzIwG6vz3Ddruoc3pTCdTvg_pe4,10434
20
+ rocket_welder_sdk/high_level/data_context.py,sha256=SXJvDpDBFi8Lm4XqSRSHK7YUUHuugXGo4ZRCb6_z5l0,4833
21
+ rocket_welder_sdk/high_level/schema.py,sha256=7F5DfPACHUfOpbJE4YZJRpro9VL8tLa6Kt9ZJuY7R7w,5397
22
+ rocket_welder_sdk/high_level/transport_protocol.py,sha256=EFF0bgNn9hxRMj67FwU6MVu-UiEFINSGhd2VC8agrgc,7393
23
+ rocket_welder_sdk/transport/__init__.py,sha256=DYmZpohGPU7RhS6EdVT_BwCy5MZzyTQ6Eymm8TpmxJ8,751
23
24
  rocket_welder_sdk/transport/frame_sink.py,sha256=16dUefZF1QJv62Ig0ezPR6nEho_7A3WJu4M9_PPMqJM,2164
24
25
  rocket_welder_sdk/transport/frame_source.py,sha256=G1rBAQS1AgOOdtASB0_CYon8g20hUGXpP2exCp5hlhk,2169
25
26
  rocket_welder_sdk/transport/nng_transport.py,sha256=o-qgcmHCGnwtdPe-mwwrC-a9H0rgS-VdH2QvU-6kFlI,5838
@@ -32,7 +33,7 @@ rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE
32
33
  rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
33
34
  rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
34
35
  rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
35
- rocket_welder_sdk-1.1.34rc1.dist-info/METADATA,sha256=JGM_TMQnCAX1MA9fN-pCS6PeSUTeAN5jgL4-nSJPOSg,24850
36
- rocket_welder_sdk-1.1.34rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
37
- rocket_welder_sdk-1.1.34rc1.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
38
- rocket_welder_sdk-1.1.34rc1.dist-info/RECORD,,
36
+ rocket_welder_sdk-1.1.35.dev12.dist-info/METADATA,sha256=ZKjUGUB7sxVMCH0-0EVSF0Gk0Y3H3NpRzIINuJJYJMI,24853
37
+ rocket_welder_sdk-1.1.35.dev12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
38
+ rocket_welder_sdk-1.1.35.dev12.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
39
+ rocket_welder_sdk-1.1.35.dev12.dist-info/RECORD,,