visionai-sdk-python 2.2.0.dev4__py3-none-any.whl → 2.2.0.dev5__py3-none-any.whl

visionai_sdk_python/async_client.py

@@ -58,7 +58,11 @@ class AsyncClient(_BaseClient):
     async def request(self, method: str, url: str, **kwargs) -> httpx.Response:
         """Send any request with this client's bearer token.
 
-        ``url`` is a full URL (the client has two bases); ``kwargs`` go to httpx.
+        ``url`` is a full URL (the client has two bases); ``kwargs`` go to httpx. The
+        bearer token goes to whatever host ``url`` names, so ``url`` must come from
+        configuration or code, never from a caller's input; redirects are not
+        followed unless asked, and httpx drops the header on a cross-origin redirect.
+
         With a ``credential``, a 401 buys one retry with the credential's current
         token, which it replaces when the rejected one is old enough to have been
         revoked (``REPLACE_COOLDOWN_S``); a 401 on the retry raises. Without a

visionai_sdk_python/auth/credentials.py

@@ -237,7 +237,8 @@ class AsyncClientCredentials(_Credentials):
 
     Pass it to ``AsyncClient(credential=...)`` and use ``await get_token()`` for
     requests the SDK does not make itself, such as a WebSocket upgrade. One
-    instance serves any number of clients and callers.
+    instance serves any number of clients and callers on one event loop; its
+    lock and ``httpx.AsyncClient`` bind to that loop.
     """
 
     def __init__(

visionai_sdk_python/client.py

@@ -58,7 +58,11 @@ class Client(_BaseClient):
     def request(self, method: str, url: str, **kwargs) -> httpx.Response:
         """Send any request with this client's bearer token.
 
-        ``url`` is a full URL (the client has two bases); ``kwargs`` go to httpx.
+        ``url`` is a full URL (the client has two bases); ``kwargs`` go to httpx. The
+        bearer token goes to whatever host ``url`` names, so ``url`` must come from
+        configuration or code, never from a caller's input; redirects are not
+        followed unless asked, and httpx drops the header on a cross-origin redirect.
+
         With a ``credential``, a 401 buys one retry with the credential's current
         token, which it replaces when the rejected one is old enough to have been
         revoked (``REPLACE_COOLDOWN_S``); a 401 on the retry raises. Without a

visionai_sdk_python/relay/__init__.py

@@ -9,6 +9,7 @@ from .protocol import (
     HEARTBEAT_INTERVAL_S,
     MAX_BODY_BYTES,
     MAX_FRAME_BYTES,
+    MAX_MESSAGE_CHARS,
     REGISTER_DEADLINE_S,
     RELAY_TIMEOUT_S,
     STALE_AFTER_S,
@@ -18,6 +19,7 @@ from .protocol import (
     Error,
     ErrorCode,
     Frame,
+    FrameTooLarge,
     Heartbeat,
     InvalidFrame,
     ModelEntry,
@@ -40,6 +42,7 @@ __all__ = [
     "HEARTBEAT_INTERVAL_S",
     "MAX_BODY_BYTES",
     "MAX_FRAME_BYTES",
+    "MAX_MESSAGE_CHARS",
     "REGISTER_DEADLINE_S",
     "RELAY_TIMEOUT_S",
     "STALE_AFTER_S",
@@ -49,6 +52,7 @@ __all__ = [
     "Error",
     "ErrorCode",
     "Frame",
+    "FrameTooLarge",
     "Heartbeat",
     "InvalidFrame",
     "ModelEntry",

visionai_sdk_python/relay/protocol.py

@@ -28,6 +28,8 @@ MAX_BODY_BYTES = 15 * 1024 * 1024
 # Timeouts nest: the agent waits for VS, the relay waits a little longer for the agent.
 AGENT_TIMEOUT_S = 100
 RELAY_TIMEOUT_S = 110.0
+# An `error` echoes parts of the peer's frame; cut them so the error fits a frame.
+MAX_MESSAGE_CHARS = 200
 
 # Platform workspace ids: lowercase hyphenated UUIDs.
 UUID_RE = re.compile(r"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")
@@ -58,6 +60,7 @@ class ErrorCode(StrEnum):
     PATH_NOT_ALLOWED = "path_not_allowed"
     UPSTREAM_UNREACHABLE = "upstream_unreachable"
     UPSTREAM_TIMEOUT = "upstream_timeout"
+    UPSTREAM_TOO_LARGE = "upstream_too_large"
 
 
 class Frame(BaseModel):
@@ -133,13 +136,30 @@ _relay_frame = TypeAdapter(Annotated[RelayFrame, Field(discriminator="type")])
 
 
 class InvalidFrame(ValueError):
-    """A frame the receiver cannot read; the text is safe to send back in an ``error``."""
+    """A frame the receiver cannot read; the text is safe to send back in an ``error``.
+
+    Parts of the text come from the peer's frame, so it is cut at ``MAX_MESSAGE_CHARS``
+    and a ``request_id`` longer than that is dropped.
+    """
 
     def __init__(self, message: str, request_id: str | None = None) -> None:
+        if len(message) > MAX_MESSAGE_CHARS:
+            message = message[: MAX_MESSAGE_CHARS - 1] + "…"
+        if request_id is not None and len(request_id) > MAX_MESSAGE_CHARS:
+            request_id = None
+            message += " (request_id too long, dropped)"
         super().__init__(message)
         self.request_id = request_id
 
 
+class FrameTooLarge(ValueError):
+    """The encoded frame exceeds ``MAX_FRAME_BYTES``; the receiver would close with 1009."""
+
+    def __init__(self, size: int) -> None:
+        super().__init__(f"frame is {size} bytes; the limit is {MAX_FRAME_BYTES}")
+        self.size = size
+
+
 def parse_agent_frame(text: str) -> AgentFrame:
     """A frame the relay received from an agent."""
     return _parse(text, _agent_frame)
@@ -175,4 +195,9 @@ def _parse(text: str, adapter: TypeAdapter):
 
 
 def dump_frame(frame: BaseModel) -> str:
-    return frame.model_dump_json(exclude_none=True)
+    """The frame as JSON text, or ``FrameTooLarge`` when a receiver would refuse it."""
+    text = frame.model_dump_json(exclude_none=True)
+    size = len(text.encode())
+    if size > MAX_FRAME_BYTES:
+        raise FrameTooLarge(size)
+    return text

{visionai_sdk_python-2.2.0.dev4.dist-info → visionai_sdk_python-2.2.0.dev5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: visionai-sdk-python
-Version: 2.2.0.dev4
+Version: 2.2.0.dev5
 Summary: VisionAI SDK for Python
 Author-email: Tony Yang <tonyyang@linkervision.com>
 Requires-Python: >=3.11
@@ -148,7 +148,8 @@ client = Client(auth_url="...", vlm_url="...", credential=cred)   # vlm.chat() u
 
 token = cred.get_token().token          # for a WebSocket upgrade or another library
 
-# Any other HTTP call with the same token; a 401 gets one fresh token and one retry
+# Any other HTTP call with the same token, sent to the host you name; a 401 gets one
+# fresh token and one retry
 nodes = client.request("GET", "https://vs.example.com/mgmt/nodes").json()
 ```
 
@@ -168,7 +169,7 @@ authentication wins. `vlm_url` is optional for clients that only authenticate.
 
 `visionai_sdk_python.relay` holds the wire format between platform-relay and
 platform-edge-agent: the frame models, the constants and `parse_agent_frame()` /
-`parse_relay_frame()` / `dump_frame()`. The spec is platform-service's
+`parse_relay_frame()` / `dump_frame()` (which refuses a frame over `MAX_FRAME_BYTES`). The spec is platform-service's
 `docs/adr/0001-relay-protocol.md`; both sides import this module instead of keeping a
 copy. The ADR's JSON examples ship with it (`visionai_sdk_python.relay.examples`:
 `example(name)` / `example_text(name)`), so every implementation tests against the same

{visionai_sdk_python-2.2.0.dev4.dist-info → visionai_sdk_python-2.2.0.dev5.dist-info}/RECORD

@@ -3,8 +3,8 @@ visionai_sdk_python/_base.py,sha256=q8Ybwk9uEdaAFh85IRCHvsSpXEvYFosFYGhJAeQNIr4,
 visionai_sdk_python/_jwt_verifier.py,sha256=h4CAK1iiDAJ-oKnXrLbCJw5rWcsVe94QNY12ne1Wzto,8442
 visionai_sdk_python/_request_attribution.py,sha256=zQk_bSLsu1RTp1Fe3MGUUX8YRzq3iqfBTmhhjM7BuRU,1907
 visionai_sdk_python/_source_header.py,sha256=DWiR-TGclET4UrqmAEO7bYPtf9XuLSE4FGQjZIgVWiY,5133
-visionai_sdk_python/async_client.py,sha256=JHx7Kz3l84PdyHvgGPhpTKprRdSabXxjqazqUVj--rY,5542
-visionai_sdk_python/client.py,sha256=0B3ut9iXsiZxveOIP8SEbTZwv3D0mDZ62D0ycIFOBC8,5352
+visionai_sdk_python/async_client.py,sha256=T_VyweNx6_u5BgQ21B5EMoj1U2LZh64wlDUtoVqYOow,5795
+visionai_sdk_python/client.py,sha256=3XzxP5Db-krmDSFbIJ7UnlZo11pIbmuDzlJkZiLX9Ys,5605
 visionai_sdk_python/constants.py,sha256=KWhoxZdlwqXwhUJDqERStq2mrms-MA8aRDqBwbIvNO0,1471
 visionai_sdk_python/endpoints.py,sha256=CC-AoxXzg39sMAhqx1CTS3gRWKx_H7VOqBANRLVotoU,183
 visionai_sdk_python/exceptions.py,sha256=BUpcoTgILc3z68lIQGyTYs7PCvu_BTSi228YMTx7ZWs,3020
@@ -13,11 +13,11 @@ visionai_sdk_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 visionai_sdk_python/auth/__init__.py,sha256=sWtanqUos5Q8P80IvjoyvOzXv6gYNkflop9qwDwsZk8,400
 visionai_sdk_python/auth/_mixin.py,sha256=EDDhEB9jHc_7wEoLx_MprhToTVLekL5CyJuLTK8GhNM,5022
 visionai_sdk_python/auth/async_resource.py,sha256=V6O51i7KyYSBkiQeKAbmw-EIKMVZIozO1gDexTX6tXw,5535
-visionai_sdk_python/auth/credentials.py,sha256=nsZkavY8pDT39gZxFaKUcl-X_JfKKkc3Nkv9fSFFP4Y,10892
+visionai_sdk_python/auth/credentials.py,sha256=SZFu1LAemkjdd7nfrHqtxK72w_TtBrCF03o0ys6Z1Xo,10968
 visionai_sdk_python/auth/models.py,sha256=u6MDFYaWMyf08XCrGZzwPHv43d6AElH9XO2QSjRsb3Q,449
 visionai_sdk_python/auth/resource.py,sha256=3PgcxH8N6unKTs2jSQhMeJT_lg6bTce0hz0bzuID12U,5446
-visionai_sdk_python/relay/__init__.py,sha256=N4DuhutN8P4EWZRFIaWTqvylNsLkzRSkHMRRF2pknFk,1296
-visionai_sdk_python/relay/protocol.py,sha256=Hy7J4kgDxaKy0WOrtkmqD5xUFXgKAVXwTWX4NQ9yQHE,5561
+visionai_sdk_python/relay/__init__.py,sha256=yqYdedHUBCo-E9wmVY9Xfa5r9zbOLeii-p6HYTdgzvY,1384
+visionai_sdk_python/relay/protocol.py,sha256=aIEr4fy7ZRx2g3aBki5mMGbjjnc7AhIAECqAPRARVSY,6611
 visionai_sdk_python/relay/examples/__init__.py,sha256=GvjlP-EtrhDVgqReOYqcf1mObND61vO6Q8CT_YFfgDM,732
 visionai_sdk_python/relay/examples/error_connection.json,sha256=stjkXo27Vkhoy0rNtPUti2OEXzioxJ8Aqgyq2hAdquA,81
 visionai_sdk_python/relay/examples/error_request.json,sha256=iUB11sSf1vuBAdzvoiHAoUoifZoG4-wGBK6gb0ConjA,228
@@ -33,7 +33,7 @@ visionai_sdk_python/vlm/async_resource.py,sha256=meMUfBDa0g1hk7vFZq2fDuIQ1-QUpU0
 visionai_sdk_python/vlm/models.py,sha256=yDFjo4LfAxqXYBnl6ZW7YUJQoKKRkQWtqBJi2ruI6Jw,984
 visionai_sdk_python/vlm/preprocess.py,sha256=ZpJJa13h8_YKwh_P7Pn8WIXV0x-r2xJi-ETgCFsGw-Y,7892
 visionai_sdk_python/vlm/resource.py,sha256=4eMQ4ACcgd7nUfdRyADWmPd8yZ--uqQC4zwzBft68lg,3386
-visionai_sdk_python-2.2.0.dev4.dist-info/METADATA,sha256=sTQXZIrAJy5ANXFc2Up7r5BIeY8adzLhErAmTJh0Bjw,30521
-visionai_sdk_python-2.2.0.dev4.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-visionai_sdk_python-2.2.0.dev4.dist-info/top_level.txt,sha256=79a5MCSLLv6Mbfun-8RS-G6O927hahBwDqJjeuWLdvM,20
-visionai_sdk_python-2.2.0.dev4.dist-info/RECORD,,
+visionai_sdk_python-2.2.0.dev5.dist-info/METADATA,sha256=LDZ7P4QHkvXJk6_6nHx9qLUOGYVBuExwt_ZSURtF2lk,30597
+visionai_sdk_python-2.2.0.dev5.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+visionai_sdk_python-2.2.0.dev5.dist-info/top_level.txt,sha256=79a5MCSLLv6Mbfun-8RS-G6O927hahBwDqJjeuWLdvM,20
+visionai_sdk_python-2.2.0.dev5.dist-info/RECORD,,