clarifai-protocol 0.0.31rc1__cp313-cp313-musllinux_1_2_x86_64.whl → 0.0.41__cp313-cp313-musllinux_1_2_x86_64.whl

{clarifai_protocol-0.0.31rc1.dist-info → clarifai_protocol-0.0.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai-protocol
-Version: 0.0.31rc1
+Version: 0.0.41
 Summary: Clarifai Python Runner Protocol
 Author-email: Clarifai <support@clarifai.com>
 License:                                  Apache License
@@ -230,5 +230,69 @@ Dynamic: license-file
 
 This is a proprietary protocol used by our runners to communicate with our API. This should be installed as part of our python SDK.
 
+## Request Cancellation Support
+
+The protocol now supports request cancellation, allowing models to abort in-flight requests to external inference servers when a user cancels their request.
+
+### Features
+
+- **Request ID Access**: Models can access the current request ID via `get_request_id()`
+- **Abort Callbacks**: Models can register a callback that will be invoked when requests are cancelled or when connections are aborted
+- **Thread Safety**: All operations are thread-safe and work correctly with concurrent requests
+- **Background Execution**: Abort callbacks run in background threads to avoid blocking the protocol
+
+### Usage
+
+```python
+from clarifai_protocol import get_request_id, register_abort_callback
+import requests
+
+class MyModel:
+    def __init__(self):
+        super().__init__()
+        self.sglang_url = "http://localhost:30000"
+        # Register abort callback during initialization
+        register_abort_callback(self._abort_sglang)
+    
+    def _abort_sglang(self, req_id: str) -> None:
+        """Abort handler called when requests are cancelled."""
+        try:
+            requests.post(
+                f"{self.sglang_url}/abort_request",
+                json={"rid": req_id},
+                timeout=2.0
+            )
+        except Exception:
+            pass  # Handle exceptions gracefully
+    
+    def generate(self, prompt: str):
+        """Generate text using external inference server."""
+        # Get the request ID to pass to the external server
+        req_id = get_request_id()
+        
+        # Use req_id when calling external services
+        for token in self._call_sglang(prompt, req_id):
+            yield token
+```
+
+### API Reference
+
+#### `get_request_id() -> Optional[str]`
+
+Returns the current request ID, or `None` if called outside of a request context.
+
+Use this as an identifier when calling external inference servers so that cancellation can properly abort the request.
+
+#### `register_abort_callback(callback: Callable[[str], None]) -> None`
+
+Register a function to be called when a request is cancelled or the connection is aborted.
+
+- Should be called once during model initialization
+- The callback receives the cancelled request's ID as a parameter
+- The callback runs in a background thread
+- **The callback should be idempotent** (safe to call multiple times with the same req_id)
+- Exceptions in the callback are logged but don't crash the protocol
+- Triggered when: explicit cancellation (`RUNNER_ITEM_CANCELLED`) or connection abort (stream done/cancelled)
+
 # Release instructions
 Bump the version in the file VERSION, merge it, pull master, git tag to the same version, push the tag to github to release.

clarifai_protocol-0.0.41.dist-info/RECORD

@@ -0,0 +1,8 @@
+clarifai_protocol.cpython-313-x86_64-linux-musl.so,sha256=_un-QG-gI9mU9AdgKh0xINweOHX2n4LLz7SE64VmWOo,1514200
+clarifai_protocol.pyi,sha256=fymVU4LzsXIN-gaxWcLwMum8Sd0CRog5UJHAv2xTc-E,990
+clarifai_protocol.build/.gitignore,sha256=aEiIwOuxfzdCmLZe4oB1JsBmCUxwG8x-u-HBCV9JT8E,1
+clarifai_protocol-0.0.41.dist-info/METADATA,sha256=x9tSueYZXTDZkW0NgfXiJFxoWQm-BhoNGDNVuxoo_a0,16893
+clarifai_protocol-0.0.41.dist-info/WHEEL,sha256=HQcsgt4_BRQYpTaaip_gA8-a0sREDElUnArgNw0oVvY,107
+clarifai_protocol-0.0.41.dist-info/top_level.txt,sha256=qwWV-wytBq70748luF3R1ouCIWiIm2R551LIVXUtpB8,18
+clarifai_protocol-0.0.41.dist-info/RECORD,,
+clarifai_protocol-0.0.41.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357

clarifai_protocol.pyi

@@ -1,7 +1,7 @@
 # This file was generated by Nuitka
 
 # Stubs included by default
-from base_runner import BaseRunner
+from base_runner import BaseRunner, get_item_id, register_item_abort_callback, shutdown_abort_executor
 
 
 __name__ = ...
@@ -10,14 +10,29 @@ __name__ = ...
 
 # Modules used internally, to allow implicit dependencies to be seen:
 import os
+import importlib
+import importlib.util
+import subprocess
+import threading
+import datetime
+import clarifai
+import clarifai.client
+import clarifai.client.input
+import clarifai.utils
+import clarifai.utils.logging
+import clarifai_grpc
+import clarifai_grpc.grpc
+import clarifai_grpc.grpc.api
+import clarifai_grpc.grpc.api.status
+import av
 import atexit
 import collections
 import concurrent
 import concurrent.futures
+import contextvars
 import itertools
 import signal
 import sys
-import threading
 import time
 import traceback
 import uuid
@@ -26,16 +41,9 @@ import concurrent.futures.ThreadPoolExecutor
 import queue
 import typing
 import grpc
-import clarifai
-import clarifai.client
 import clarifai.client.base
-import clarifai.utils
-import clarifai.utils.logging
-import clarifai_grpc
-import clarifai_grpc.grpc
-import clarifai_grpc.grpc.api
-import clarifai_grpc.grpc.api.status
 import grpc._cython
 import grpc._server
 import http
-import http.server
+import http.server
+import requests

clarifai_protocol-0.0.31rc1.dist-info/RECORD

@@ -1,8 +0,0 @@
-clarifai_protocol.cpython-313-x86_64-linux-musl.so,sha256=gexJgz8BHWlB6fLtQhvh9vq2wzYMKj3q8WVdLF-YsTo,1255992
-clarifai_protocol.pyi,sha256=0U76Jmy9bci3OioLcWj0jNp_SlkWS39rf45zz2BGj_A,775
-clarifai_protocol.build/.gitignore,sha256=aEiIwOuxfzdCmLZe4oB1JsBmCUxwG8x-u-HBCV9JT8E,1
-clarifai_protocol-0.0.31rc1.dist-info/METADATA,sha256=faLSaVYB-MNdYmqUr9-dN26iGtOE-Vpnhcuj9LvhubI,14366
-clarifai_protocol-0.0.31rc1.dist-info/WHEEL,sha256=HQcsgt4_BRQYpTaaip_gA8-a0sREDElUnArgNw0oVvY,107
-clarifai_protocol-0.0.31rc1.dist-info/top_level.txt,sha256=qwWV-wytBq70748luF3R1ouCIWiIm2R551LIVXUtpB8,18
-clarifai_protocol-0.0.31rc1.dist-info/RECORD,,
-clarifai_protocol-0.0.31rc1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357