Tidy up import paths and remove _WeaviateClientBase

tsmith023 · tsmith023 · commit 99e49cbebc72 · 2025-04-01T11:52:02.000+01:00
diff --git a/weaviate/client.py b/weaviate/client.py
@@ -9,11 +9,10 @@
 
 from .auth import AuthCredentials
 from .backup import _BackupAsync, _Backup
-from .client_base import _WeaviateClientBase
+from weaviate.client_executor import _WeaviateClientExecutor
 from .collections.batch.client import _BatchClientWrapper
 from .collections.cluster import _Cluster, _ClusterAsync
-from .collections.collections.async_ import _CollectionsAsync
-from .collections.collections.sync import _Collections
+from .collections.collections import _Collections, _CollectionsAsync
 from .config import AdditionalConfig
 from .connect import executor
 from .connect.base import (
@@ -30,7 +29,7 @@
 
 
 @executor.wrap("async")
-class WeaviateAsyncClient(_WeaviateClientBase[ConnectionAsync]):
+class WeaviateAsyncClient(_WeaviateClientExecutor[ConnectionAsync]):
     """
     The v4 Python-native Weaviate Client class that encapsulates Weaviate functionalities in one object.
 
@@ -42,11 +41,17 @@ class WeaviateAsyncClient(_WeaviateClientBase[ConnectionAsync]):
 
     Attributes:
         `backup`
-            A `Backup` object instance connected to the same Weaviate instance as the Client.
+            A `_BackupAsync` object instance connected to the same Weaviate instance as the Client.
         `cluster`
-            A `Cluster` object instance connected to the same Weaviate instance as the Client.
+            A `ClusterAsync` object instance connected to the same Weaviate instance as the Client.
         `collections`
             A `_CollectionsAsync` object instance connected to the same Weaviate instance as the Client.
+        `debug`
+            A `_DebugAsync` object instance connected to the same Weaviate instance as the Client.
+        `roles`
+            A `_RolesAsync` object instance connected to the same Weaviate instance as the Client.
+        `users`
+            A `_UsersAsync` object instance connected to the same Weaviate instance as the Client.
     """
 
     def __init__(
@@ -96,7 +101,7 @@ async def __aexit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None
 
 
 @executor.wrap("sync")
-class WeaviateClient(_WeaviateClientBase[ConnectionSync]):
+class WeaviateClient(_WeaviateClientExecutor[ConnectionSync]):
     """
     The v4 Python-native Weaviate Client class that encapsulates Weaviate functionalities in one object.
 
@@ -117,6 +122,12 @@ class WeaviateClient(_WeaviateClientBase[ConnectionSync]):
             A `Cluster` object instance connected to the same Weaviate instance as the Client.
         `collections`
             A `_Collections` object instance connected to the same Weaviate instance as the Client.
+        `debug`
+            A `_Debug` object instance connected to the same Weaviate instance as the Client.
+        `roles`
+            A `_Roles` object instance connected to the same Weaviate instance as the Client.
+        `users`
+            A `_Users` object instance connected to the same Weaviate instance as the Client.
     """
 
     def __init__(
diff --git a/weaviate/client.pyi b/weaviate/client.pyi
@@ -21,14 +21,10 @@ from .types import NUMBER
 
 TIMEOUT_TYPE = Union[Tuple[NUMBER, NUMBER], NUMBER]
 
-from weaviate.client_base import _WeaviateClientBase
+from weaviate.client_executor import _WeaviateClientExecutor
 from weaviate.connect.v4 import ConnectionAsync, ConnectionSync
 
-# Must define stubs here for WeaviateClient due to runtime patching of async -> sync methods
-# Cannot move Client nor WeaviateClient definitions away from client.py due to BC concerns
-# Must therefore duplicate the interface for all clients hiding their methods inside client.py
-
-class WeaviateAsyncClient(_WeaviateClientBase[ConnectionAsync]):
+class WeaviateAsyncClient(_WeaviateClientExecutor[ConnectionAsync]):
     _connection: ConnectionAsync
     backup: _BackupAsync
     collections: _CollectionsAsync
@@ -48,7 +44,7 @@ class WeaviateAsyncClient(_WeaviateClientBase[ConnectionAsync]):
     async def __aenter__(self) -> "WeaviateAsyncClient": ...
     async def __aexit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None: ...
 
-class WeaviateClient(_WeaviateClientBase[ConnectionSync]):
+class WeaviateClient(_WeaviateClientExecutor[ConnectionSync]):
     _connection: ConnectionSync
     backup: _Backup
     batch: _BatchClientWrapper
diff --git a/weaviate/client_executor.py b/weaviate/client_executor.py
@@ -36,8 +36,102 @@
 
 
 class _WeaviateClientExecutor(Generic[ConnectionType]):
-    def __init__(self, connection: ConnectionType):
-        self._connection = connection
+    _connection_type: Type[ConnectionType]
+
+    def __init__(
+        self,
+        connection_params: Optional[ConnectionParams] = None,
+        embedded_options: Optional[EmbeddedOptions] = None,
+        auth_client_secret: Optional[AuthCredentials] = None,
+        additional_headers: Optional[dict] = None,
+        additional_config: Optional[AdditionalConfig] = None,
+        skip_init_checks: bool = False,
+    ) -> None:
+        """Initialise a WeaviateClient/WeaviateClientAsync class instance to use when interacting with Weaviate.
+
+        Use this specific initializer when you want to create a custom Client specific to your Weaviate setup.
+
+        To simplify connections to Weaviate Cloud or local instances, use the weaviate.connect_to_weaviate_cloud
+        or weaviate.connect_to_local helper functions.
+
+        Arguments:
+            - `connection_params`: `weaviate.connect.ConnectionParams` or None, optional
+                - The connection parameters to use for the underlying HTTP requests.
+            - `embedded_options`: `weaviate.EmbeddedOptions` or None, optional
+                - The options to use when provisioning an embedded Weaviate instance.
+            - `auth_client_secret`: `weaviate.AuthCredentials` or None, optional
+                - Authenticate to weaviate by using one of the given authentication modes:
+                    - `weaviate.auth.AuthBearerToken` to use existing access and (optionally, but recommended) refresh tokens
+                    - `weaviate.auth.AuthClientPassword` to use username and password for oidc Resource Owner Password flow
+                    - `weaviate.auth.AuthClientCredentials` to use a client secret for oidc client credential flow
+            - `additional_headers`: `dict` or None, optional
+                - Additional headers to include in the requests.
+                    - Can be used to set OpenAI/HuggingFace/Cohere etc. keys.
+                    - [Here](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-openai#providing-the-key-to-weaviate) is an
+                    example of how to set API keys within this parameter.
+            - `additional_config`: `weaviate.AdditionalConfig` or None, optional
+                - Additional and advanced configuration options for Weaviate.
+            - `skip_init_checks`: `bool`, optional
+                - If set to `True` then the client will not perform any checks including ensuring that weaviate has started. This is useful for air-gapped environments and high-performance setups.
+        """
+        connection_params, embedded_db = self.__parse_connection_params_and_embedded_db(
+            connection_params, embedded_options
+        )
+        config = additional_config or AdditionalConfig()
+
+        self._connection = (
+            self._connection_type(  # pyright: ignore reportIncompatibleVariableOverride
+                connection_params=connection_params,
+                auth_client_secret=auth_client_secret,
+                timeout_config=config.timeout,
+                additional_headers=additional_headers,
+                embedded_db=embedded_db,
+                connection_config=config.connection,
+                proxies=config.proxies,
+                trust_env=config.trust_env,
+                skip_init_checks=skip_init_checks,
+            )
+        )
+
+        self.integrations = _Integrations(self._connection)
+
+    def __parse_connection_params_and_embedded_db(
+        self,
+        connection_params: Optional[ConnectionParams],
+        embedded_options: Optional[EmbeddedOptions],
+    ) -> Tuple[ConnectionParams, Optional[EmbeddedV4]]:
+        if connection_params is None and embedded_options is None:
+            raise TypeError("Either connection_params or embedded_options must be present.")
+        elif connection_params is not None and embedded_options is not None:
+            raise TypeError(
+                f"connection_params is not expected to be set when using embedded_options but connection_params was {connection_params}"
+            )
+
+        if embedded_options is not None:
+            _validate_input(
+                _ValidateArgument([EmbeddedOptions], "embedded_options", embedded_options)
+            )
+
+            embedded_db = EmbeddedV4(options=embedded_options)
+            embedded_db.start()
+            return (
+                ConnectionParams(
+                    http=ProtocolParams(
+                        host="localhost", port=embedded_db.options.port, secure=False
+                    ),
+                    grpc=ProtocolParams(
+                        host="localhost", port=embedded_options.grpc_port, secure=False
+                    ),
+                ),
+                embedded_db,
+            )
+
+        if not isinstance(connection_params, ConnectionParams):
+            raise TypeError(
+                f"connection_params is expected to be a ConnectionParams object but is {type(connection_params)}"
+            )
+
+        return connection_params, None
 
     async def __close_async(self) -> None:
         await executor.aresult(self._connection.close("async"))
@@ -184,106 +278,6 @@ def get_open_id_configuration(
             method=self._connection.get_open_id_configuration,
         )
 
-
-class _WeaviateClientBase(Generic[ConnectionType], _WeaviateClientExecutor[ConnectionType]):
-    _connection: ConnectionType
-    _connection_type: Type[ConnectionType]
-
-    def __init__(
-        self,
-        connection_params: Optional[ConnectionParams] = None,
-        embedded_options: Optional[EmbeddedOptions] = None,
-        auth_client_secret: Optional[AuthCredentials] = None,
-        additional_headers: Optional[dict] = None,
-        additional_config: Optional[AdditionalConfig] = None,
-        skip_init_checks: bool = False,
-    ) -> None:
-        """Initialise a WeaviateClient/WeaviateClientAsync class instance to use when interacting with Weaviate.
-
-        Use this specific initializer when you want to create a custom Client specific to your Weaviate setup.
-
-        To simplify connections to Weaviate Cloud or local instances, use the weaviate.connect_to_weaviate_cloud
-        or weaviate.connect_to_local helper functions.
-
-        Arguments:
-            - `connection_params`: `weaviate.connect.ConnectionParams` or None, optional
-                - The connection parameters to use for the underlying HTTP requests.
-            - `embedded_options`: `weaviate.EmbeddedOptions` or None, optional
-                - The options to use when provisioning an embedded Weaviate instance.
-            - `auth_client_secret`: `weaviate.AuthCredentials` or None, optional
-                - Authenticate to weaviate by using one of the given authentication modes:
-                    - `weaviate.auth.AuthBearerToken` to use existing access and (optionally, but recommended) refresh tokens
-                    - `weaviate.auth.AuthClientPassword` to use username and password for oidc Resource Owner Password flow
-                    - `weaviate.auth.AuthClientCredentials` to use a client secret for oidc client credential flow
-            - `additional_headers`: `dict` or None, optional
-                - Additional headers to include in the requests.
-                    - Can be used to set OpenAI/HuggingFace/Cohere etc. keys.
-                    - [Here](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-openai#providing-the-key-to-weaviate) is an
-                    example of how to set API keys within this parameter.
-            - `additional_config`: `weaviate.AdditionalConfig` or None, optional
-                - Additional and advanced configuration options for Weaviate.
-            - `skip_init_checks`: `bool`, optional
-                - If set to `True` then the client will not perform any checks including ensuring that weaviate has started. This is useful for air-gapped environments and high-performance setups.
-        """
-        connection_params, embedded_db = self.__parse_connection_params_and_embedded_db(
-            connection_params, embedded_options
-        )
-        config = additional_config or AdditionalConfig()
-
-        connection = self._connection_type(  # pyright: ignore reportIncompatibleVariableOverride
-            connection_params=connection_params,
-            auth_client_secret=auth_client_secret,
-            timeout_config=config.timeout,
-            additional_headers=additional_headers,
-            embedded_db=embedded_db,
-            connection_config=config.connection,
-            proxies=config.proxies,
-            trust_env=config.trust_env,
-            skip_init_checks=skip_init_checks,
-        )
-
-        self.integrations = _Integrations(connection)
-
-        super().__init__(connection)
-
-    def __parse_connection_params_and_embedded_db(
-        self,
-        connection_params: Optional[ConnectionParams],
-        embedded_options: Optional[EmbeddedOptions],
-    ) -> Tuple[ConnectionParams, Optional[EmbeddedV4]]:
-        if connection_params is None and embedded_options is None:
-            raise TypeError("Either connection_params or embedded_options must be present.")
-        elif connection_params is not None and embedded_options is not None:
-            raise TypeError(
-                f"connection_params is not expected to be set when using embedded_options but connection_params was {connection_params}"
-            )
-
-        if embedded_options is not None:
-            _validate_input(
-                _ValidateArgument([EmbeddedOptions], "embedded_options", embedded_options)
-            )
-
-            embedded_db = EmbeddedV4(options=embedded_options)
-            embedded_db.start()
-            return (
-                ConnectionParams(
-                    http=ProtocolParams(
-                        host="localhost", port=embedded_db.options.port, secure=False
-                    ),
-                    grpc=ProtocolParams(
-                        host="localhost", port=embedded_options.grpc_port, secure=False
-                    ),
-                ),
-                embedded_db,
-            )
-
-        if not isinstance(connection_params, ConnectionParams):
-            raise TypeError(
-                f"connection_params is expected to be a ConnectionParams object but is {type(connection_params)}"
-            )
-
-        return connection_params, None
-
     @executor.no_wrapping
     def is_connected(self) -> bool:
         """Check if the client is connected to Weaviate.
diff --git a/weaviate/collections/cluster/__init__.py b/weaviate/collections/cluster/__init__.py
@@ -1,4 +1,4 @@
-from weaviate.collections.cluster.async_ import _ClusterAsync
+from .async_ import _ClusterAsync
 from .sync import _Cluster
 
 __all__ = [
diff --git a/weaviate/collections/collection/__init__.py b/weaviate/collections/collection/__init__.py
@@ -1,4 +1,4 @@
-from weaviate.collections.collection.async_ import CollectionAsync
-from weaviate.collections.collection.sync import Collection
+from .async_ import CollectionAsync
+from .sync import Collection
 
 __all__ = ["CollectionAsync", "Collection"]
diff --git a/weaviate/collections/collections/__init__.py b/weaviate/collections/collections/__init__.py
@@ -0,0 +1,7 @@
+from .async_ import _CollectionsAsync
+from .sync import _Collections
+
+__all__ = [
+    "_CollectionsAsync",
+    "_Collections",
+]
diff --git a/weaviate/collections/data/__init__.py b/weaviate/collections/data/__init__.py
@@ -1,4 +1,4 @@
-from weaviate.collections.data.async_ import _DataCollectionAsync
+from .async_ import _DataCollectionAsync
 from .sync import _DataCollection
 
 __all__ = ["_DataCollectionAsync", "_DataCollection"]

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from weaviate.collections.cluster.async_ import _ClusterAsync`
	`1`	`+from .async_ import _ClusterAsync`
`2`	`2`	`from .sync import _Cluster`
`3`	`3`
`4`	`4`	`__all__ = [`