fix: use ClientAuth instead of RobotAuth in type annotations and in the documentation

Author: pbrassel

docs/user_guide.rst

@@ -14,7 +14,7 @@ respectively. The signature of the clients is always the same since they inherit
 
 When initializing a client, there are some things to keep in mind.
 
-* You *should* provide an instance of either :py:class:`.PasswordAuth` or :py:class:`.RobotAuth` to the ``auth``
+* You *should* provide an instance of either :py:class:`.PasswordAuth` or :py:class:`.ClientAuth` to the ``auth``
   argument as these are the two main authentication schemes supported by the FLAME Hub.
 * You *can* provide a custom ``base_url`` if you're hosting your own instance of the FLAME Hub, otherwise the client
   will use the default publicly available Hub instance https://privateaim.dev to connect to.

flame_hub/_auth_client.py

@@ -18,7 +18,7 @@
     UNSET_T,
 )
 from flame_hub._defaults import DEFAULT_AUTH_BASE_URL
-from flame_hub._auth_flows import RobotAuth, PasswordAuth
+from flame_hub._auth_flows import ClientAuth, PasswordAuth
 
 
 class CreateRealm(BaseModel):
@@ -281,7 +281,7 @@ class AuthClient(BaseClient):
     def __init__(
         self,
         base_url=DEFAULT_AUTH_BASE_URL,
-        auth: RobotAuth | PasswordAuth = None,
+        auth: ClientAuth | PasswordAuth = None,
         **kwargs: te.Unpack[ClientKwargs],
     ):
         super().__init__(base_url, auth, **kwargs)

flame_hub/_base_client.py

@@ -9,7 +9,7 @@
 from pydantic import BaseModel, ValidatorFunctionWrapHandler, ValidationError, ConfigDict
 
 from flame_hub._exceptions import new_hub_api_error_from_response
-from flame_hub._auth_flows import PasswordAuth, RobotAuth
+from flame_hub._auth_flows import PasswordAuth, ClientAuth
 
 
 class UNSET(BaseModel):
@@ -395,7 +395,7 @@ class BaseClient(object):
     ----------
     base_url : :py:class:`str`
         Base URL of the Hub service.
-    auth : :py:class:`.PasswordAuth` | :py:class:`.RobotAuth`, optional
+    auth : :py:class:`.PasswordAuth` | :py:class:`.ClientAuth`, optional
         Authenticator which is used to authenticate the client at the FLAME Hub instance. Defaults to :any:`None`.
     **kwargs : :py:class:`Unpack`\\[:py:class:`~flame_hub._base_client.ClientKwargs`]
         Currently used to pass an already instantiated HTTP client via the ``client`` keyword argument to bypass the
@@ -406,7 +406,7 @@ class BaseClient(object):
     :py:class:`.AuthClient`, :py:class:`.CoreClient`, :py:class:`.StorageClient`
     """
 
-    def __init__(self, base_url: str, auth: PasswordAuth | RobotAuth = None, **kwargs: te.Unpack[ClientKwargs]):
+    def __init__(self, base_url: str, auth: PasswordAuth | ClientAuth = None, **kwargs: te.Unpack[ClientKwargs]):
         client = kwargs.get("client", None)
         # Set a read timeout of 20 seconds here because the endpoint for registry projects is slow.
         self._client = client or httpx.Client(auth=auth, base_url=base_url, timeout=httpx.Timeout(5, read=20))

flame_hub/_core_client.py

@@ -24,7 +24,7 @@
 )
 from flame_hub._exceptions import new_hub_api_error_from_response
 from flame_hub._defaults import DEFAULT_CORE_BASE_URL
-from flame_hub._auth_flows import PasswordAuth, RobotAuth
+from flame_hub._auth_flows import PasswordAuth, ClientAuth
 from flame_hub._storage_client import Bucket, BucketFile
 
 RegistryCommand = t.Literal["setup", "cleanup"]
@@ -390,7 +390,7 @@ class CoreClient(BaseClient):
     def __init__(
         self,
         base_url: str = DEFAULT_CORE_BASE_URL,
-        auth: PasswordAuth | RobotAuth = None,
+        auth: PasswordAuth | ClientAuth = None,
         **kwargs: te.Unpack[ClientKwargs],
     ):
         super().__init__(base_url, auth, **kwargs)

flame_hub/_storage_client.py

@@ -6,7 +6,7 @@
 import typing_extensions as te
 from pydantic import BaseModel
 
-from flame_hub._auth_flows import PasswordAuth, RobotAuth
+from flame_hub._auth_flows import PasswordAuth, ClientAuth
 from flame_hub._base_client import (
     BaseClient,
     ResourceList,
@@ -78,7 +78,7 @@ class StorageClient(BaseClient):
     def __init__(
         self,
         base_url: str = DEFAULT_STORAGE_BASE_URL,
-        auth: PasswordAuth | RobotAuth = None,
+        auth: PasswordAuth | ClientAuth = None,
         **kwargs: te.Unpack[ClientKwargs],
     ):
         super().__init__(base_url, auth, **kwargs)