clarifai-protocol 0.0.7__cp312-cp312-macosx_11_0_universal2.whl → 0.0.40__cp312-cp312-macosx_11_0_universal2.whl

{clarifai_protocol-0.0.7.dist-info → clarifai_protocol-0.0.40.dist-info}/METADATA

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: clarifai-protocol
-Version: 0.0.7
+Version: 0.0.40
 Summary: Clarifai Python Runner Protocol
 Author-email: Clarifai <support@clarifai.com>
-License: Apache License
+License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
@@ -211,20 +211,88 @@ Keywords: clarifai,runners,python
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clarifai>=10.5.4
-Requires-Dist: clarifai-grpc>=10.6.4
+Requires-Dist: clarifai>=11.7.2
+Requires-Dist: clarifai-grpc>=11.7.8
+Dynamic: license-file
 
 # Clarifai Protocol
 
 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.40.dist-info/RECORD

@@ -0,0 +1,8 @@
+clarifai_protocol.cpython-312-darwin.so,sha256=QFWsLTrCvJ9eBOY81UlWauIkGVHM6ADojhCfGAjL_fQ,944376
+clarifai_protocol.pyi,sha256=fymVU4LzsXIN-gaxWcLwMum8Sd0CRog5UJHAv2xTc-E,990
+clarifai_protocol-0.0.40.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+clarifai_protocol.build/.gitignore,sha256=aEiIwOuxfzdCmLZe4oB1JsBmCUxwG8x-u-HBCV9JT8E,1
+clarifai_protocol-0.0.40.dist-info/METADATA,sha256=nVsu_ubyKv_N_qknzHVdp8qeB7Mka5-4lCs_FAmaGME,16893
+clarifai_protocol-0.0.40.dist-info/WHEEL,sha256=K2_moIlF6mA5-I1JEl7qWu8KIFR2Ytdqxl2ezOqILQE,109
+clarifai_protocol-0.0.40.dist-info/top_level.txt,sha256=qwWV-wytBq70748luF3R1ouCIWiIm2R551LIVXUtpB8,18
+clarifai_protocol-0.0.40.dist-info/RECORD,,

{clarifai_protocol-0.0.7.dist-info → clarifai_protocol-0.0.40.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: Nuitka (2.4.11)
+Generator: Nuitka (2.5.8)
 Root-Is-Purelib: false
 Tag: cp312-cp312-macosx_11_0_universal2
 

clarifai_protocol.build/.gitignore

@@ -0,0 +1 @@
+*

clarifai_protocol.pyi

@@ -1,45 +1,49 @@
-# This file was generated by Nuitka and describes the types of the
-# created shared library.
+# This file was generated by Nuitka
 
-# At this time it lists only the imports made and can be used by the
-# tools that bundle libraries, including Nuitka itself. For instance
-# standalone mode usage of the created library will need it.
+# Stubs included by default
+from base_runner import BaseRunner, get_item_id, register_item_abort_callback, shutdown_abort_executor
 
-# In the future, this will also contain type information for values
-# in the module, so IDEs will use this. Therefore please include it
-# when you make software releases of the extension module that it
-# describes.
 
+__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
 import abc
-import concurrent
-import concurrent.futures
 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
-
-# This is not Python source even if it looks so. Make it clear for
-# now. This was decided by PEP 484 designers.
-__name__ = ...
-
+import requests

clarifai_protocol-0.0.7.dist-info/RECORD

@@ -1,7 +0,0 @@
-clarifai_protocol.cpython-312-darwin.so,sha256=TpC8MfpXYFZsEWrlMG_rb-Bi60V6wGygqYL5ghV41nc,617928
-clarifai_protocol.pyi,sha256=HQ96MJ60MdL3XB-HNINSO_rVFGn50CkJzC7tuQz6FuU,1193
-clarifai_protocol-0.0.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-clarifai_protocol-0.0.7.dist-info/METADATA,sha256=E1Uq5Ern_q9FCvGuB9icOadt_wO7LhUkPtsCAhJxQ6k,14157
-clarifai_protocol-0.0.7.dist-info/WHEEL,sha256=C7A5CO1UkzeoTkUVlV1TGCNBYZghQ_seCGYtnvYr1Uk,110
-clarifai_protocol-0.0.7.dist-info/top_level.txt,sha256=qwWV-wytBq70748luF3R1ouCIWiIm2R551LIVXUtpB8,18
-clarifai_protocol-0.0.7.dist-info/RECORD,,