clarifai 9.7.0__py3-none-any.whl → 9.7.2__py3-none-any.whl

clarifai/auth/__init__.py

@@ -0,0 +1,6 @@
+# Note: clarifai.auth is just added for backwards compatibility. It will be removed in the future.
+
+from clarifai.client.auth.register import V2Stub
+from clarifai.client.auth.stub import create_stub
+
+__all__ = ('V2Stub', 'create_stub')

clarifai/auth/helper.py

@@ -14,12 +14,14 @@ base_https_cache = {}
 ui_https_cache = {}
 
 
-def clear_cache():
+def clear_cache() -> None:
+  """Clears the cache."""
   base_https_cache.clear()
   ui_https_cache.clear()
 
 
-def https_cache(cache, url):
+def https_cache(cache: dict, url: str) -> str:
+  """This is a helper function to cache whether a url is http or https."""
   HTTPS = True
   HTTP = False
 
@@ -72,17 +74,17 @@ class ClarifaiAuthHelper:
         Note: only one of personal access token (pat) or a session token (token) can be provided.
         Always use PATs in your code and never session tokens, those are only provided internal UI code.
 
-        Args:
-          user_id: a user id who owns the resource you want to make calls to.
-          app_id: an app id for the application that owns the resource you want to interact with
-          pat: a personal access token.
-          token: a session token (internal use only, always use a PAT).
-          base: a url to the API endpoint to hit. Examples include api.clarifai.com,
-        https://api.clarifai.com (default), https://host:port, http://host:port, host:port (will be treated as http, not https). It's highly recommended to include the http:// or https:// otherwise we need to check the endpoint to determine if it has SSL during this __init__
-          ui: a url to the UI. Examples include clarifai.com,
-        https://clarifai.com (default), https://host:port, http://host:port, host:port (will be treated as http, not https). It's highly recommended to include the http:// or https:// otherwise we need to check the endpoint to determine if it has SSL during this __init__
-          validate: whether to validate the inputs. This is useful for overriding vars then validating
-        """
+    Args:
+      user_id: a user id who owns the resource you want to make calls to.
+      app_id: an app id for the application that owns the resource you want to interact with
+      pat: a personal access token.
+      token: a session token (internal use only, always use a PAT).
+      base: a url to the API endpoint to hit. Examples include api.clarifai.com,
+    https://api.clarifai.com (default), https://host:port, http://host:port, host:port (will be treated as http, not https). It's highly recommended to include the http:// or https:// otherwise we need to check the endpoint to determine if it has SSL during this __init__
+      ui: a url to the UI. Examples include clarifai.com,
+    https://clarifai.com (default), https://host:port, http://host:port, host:port (will be treated as http, not https). It's highly recommended to include the http:// or https:// otherwise we need to check the endpoint to determine if it has SSL during this __init__
+      validate: whether to validate the inputs. This is useful for overriding vars then validating
+    """
 
     self.user_id = user_id
     self.app_id = app_id
@@ -182,10 +184,10 @@ class ClarifaiAuthHelper:
           optionally:
             base: as 'base' in query_params.
 
-        Args:
-          query_params: the streamlit.experimental_get_query_params() response or an empty dict to fall
-        back to using env vars.
-        """
+    Args:
+      query_params: the streamlit.experimental_get_query_params() response or an empty dict to fall
+    back to using env vars.
+    """
     error_description = """
 Please check the following required query params are in the url:
  - 'user_id': the user ID accessing the module.
@@ -225,7 +227,7 @@ Additionally, these optional params are supported:
           token: CLARIFAI_SESSION_TOKEN env var.
           pat: CLARIFAI_PAT env var.
         base: CLARIFAI_API_BASE env var.
-        """
+    """
     error_description = """
 Please check the following required vars are in your env:
  - 'CLARIFAI_USER_ID': the user ID accessing the module.
@@ -249,28 +251,26 @@ Additionally, these optional params are supported:
       user_id: str = None,
       app_id: str = None,
   ) -> resources_pb2.UserAppIDSet:
-    """
-        Get the gRPC metadata that contains either the session token or the PAT to use.
+    """Get the gRPC metadata that contains either the session token or the PAT to use.
 
-        Args:
-          user_id: optional user_id to override the default
-          app_id: optional app_id to override the default.
+    Args:
+      user_id: optional user_id to override the default
+      app_id: optional app_id to override the default.
 
-        Returns:
-          metadata: the metadata need to send with all grpc API calls in the API client.
-        """
+    Returns:
+      metadata: the metadata need to send with all grpc API calls in the API client.
+    """
     user_id = self.user_id if user_id is None else user_id
     app_id = self.app_id if app_id is None else app_id
     return resources_pb2.UserAppIDSet(user_id=user_id, app_id=app_id)
 
   @property
   def metadata(self):
-    """
-        Get the gRPC metadata that contains either the session token or the PAT to use.
+    """Get the gRPC metadata that contains either the session token or the PAT to use.
 
-        Returns:
-          metadata: the metadata need to send with all grpc API calls in the API client.
-        """
+    Returns:
+      metadata: the metadata need to send with all grpc API calls in the API client.
+    """
     if self._pat != "":
       return (("authorization", "Key %s" % self._pat),)
     elif self._token != "":
@@ -279,12 +279,11 @@ Additionally, these optional params are supported:
       raise Exception("'token' or 'pat' needed to be provided in the query params or env vars.")
 
   def get_stub(self) -> service_pb2_grpc.V2Stub:
-    """
-        Get the API gRPC stub using the right channel based on the API endpoint base.
+    """Get the API gRPC stub using the right channel based on the API endpoint base.
 
-        Returns:
-          stub: The service_pb2_grpc.V2Stub stub for the API.
-        """
+    Returns:
+      stub: The service_pb2_grpc.V2Stub stub for the API.
+    """
     if self._base not in base_https_cache:
       raise Exception("Cannot determine if base %s is https" % self._base)
 

clarifai/auth/register.py

@@ -0,0 +1,23 @@
+import abc
+import grpc
+
+from clarifai_grpc.grpc.api import service_pb2_grpc
+
+
+class V2Stub(abc.ABC):
+  """Abstract base class of clarifai api rpc client stubs"""
+
+
+class RpcCallable(abc.ABC):
+  """Abstract base class of clarifai api rpc callables"""
+
+
+# add grpc classes as subclasses of the abcs, so they also succeed in isinstance calls
+def _register_classes():
+  V2Stub.register(service_pb2_grpc.V2Stub)
+  for name in dir(grpc):
+    if name.endswith('Callable'):
+      RpcCallable.register(getattr(grpc, name))
+
+
+_register_classes()

clarifai/{client → auth}/stub.py

@@ -5,8 +5,8 @@ from concurrent.futures import ThreadPoolExecutor
 import grpc
 from clarifai_grpc.grpc.api.status import status_code_pb2
 
-from clarifai.auth.helper import ClarifaiAuthHelper
-from clarifai.client.abc import RpcCallable, V2Stub
+from clarifai.client.auth.helper import ClarifaiAuthHelper
+from clarifai.client.auth.register import RpcCallable, V2Stub
 
 throttle_status_codes = {
     status_code_pb2.CONN_THROTTLED,
@@ -20,15 +20,15 @@ retry_codes_grpc = {
 _threadpool = ThreadPoolExecutor(100)
 
 
-def create_stub(auth_helper=None, max_retry_attempts=10):
-  '''
+def create_stub(auth_helper: ClarifaiAuthHelper = None, max_retry_attempts: int = 10) -> V2Stub:
+  """
   Create client stub that handles authorization and basic retries for
   unavailable or throttled connections.
 
   Args:
     auth_helper:  ClarifaiAuthHelper to use for auth metadata (default: from env)
     max_retry_attempts:  max attempts to retry rpcs with retryable failures
-  '''
+  """
   stub = AuthorizedStub(auth_helper)
   if max_retry_attempts > 0:
     return RetryStub(stub, max_retry_attempts)
@@ -36,9 +36,7 @@ def create_stub(auth_helper=None, max_retry_attempts=10):
 
 
 class AuthorizedStub(V2Stub):
-  '''
-  V2Stub proxy that inserts metadata authorization in rpc calls.
-  '''
+  """V2Stub proxy that inserts metadata authorization in rpc calls."""
 
   def __init__(self, auth_helper: ClarifaiAuthHelper = None):
     if auth_helper is None:
@@ -54,6 +52,7 @@ class AuthorizedStub(V2Stub):
 
 
 class _AuthorizedRpcCallable(RpcCallable):
+  """Adds metadata(authorization header) to rpc calls"""
 
   def __init__(self, func, metadata):
     self.f = func
@@ -75,9 +74,9 @@ class _AuthorizedRpcCallable(RpcCallable):
 
 
 class RetryStub(V2Stub):
-  '''
+  """
   V2Stub proxy that retries requests (currently on unavailable server or throttle codes)
-  '''
+  """
 
   def __init__(self, stub, max_attempts=10, backoff_time=5):
     self.stub = stub
@@ -92,6 +91,7 @@ class RetryStub(V2Stub):
 
 
 class _RetryRpcCallable(RpcCallable):
+  """Retries rpc calls on unavailable server or throttle codes"""
 
   def __init__(self, func, max_attempts, backoff_time):
     self.f = func

clarifai/client/__init__.py

@@ -1,4 +1 @@
-from clarifai.client.abc import V2Stub
-from clarifai.client.stub import create_stub
-
-__all__ = ('V2Stub', 'create_stub')
+# Note: This is just added for backwards compatibility. It will be removed in the future.