Abstract open method is removed from storage clients

Author: vdusek

pyproject.toml

@@ -37,7 +37,7 @@ dependencies = [
     "apify-client>=1.12.0",
     "apify-shared>=1.3.0",
     "cachetools>=5.5.0",
-    "crawlee@git+https://github.com/apify/crawlee-python.git@bc50990dd09eb5c2b66783b2fa62a8bc689a7737",
+    "crawlee@git+https://github.com/apify/crawlee-python.git@new-storage-clients",
     "cryptography>=42.0.0",
     "httpx>=0.27.0",
     # TODO: ensure compatibility with the latest version of lazy-object-proxy

src/apify/storage_clients/_apify/_dataset_client.py

@@ -71,7 +71,6 @@ def __init__(
     def metadata(self) -> DatasetMetadata:
         return self._metadata
 
-    @override
     @classmethod
     async def open(
         cls,
@@ -80,6 +79,28 @@ async def open(
         name: str | None,
         configuration: Configuration,
     ) -> ApifyDatasetClient:
+        """Open an Apify dataset client.
+
+        This method creates and initializes a new instance of the Apify dataset client.
+        It handles authentication, storage lookup/creation, and metadata retrieval.
+
+        Args:
+            id: The ID of an existing dataset to open. If provided, the client will connect to this specific storage.
+                Cannot be used together with `name`.
+            name: The name of a dataset to get or create. If a storage with this name exists, it will be opened;
+                otherwise, a new one will be created. Cannot be used together with `id`.
+            configuration: The configuration object containing API credentials and settings. Must include a valid
+                `token` and `api_base_url`. May also contain a `default_dataset_id` for fallback when neither
+                `id` nor `name` is provided.
+
+        Returns:
+            An instance for the opened or created storage client.
+
+        Raises:
+            ValueError: If the configuration is missing required fields (token, api_base_url), if both `id` and `name`
+                are provided, or if neither `id` nor `name` is provided and no default storage ID is available in
+                the configuration.
+        """
         token = getattr(configuration, 'token', None)
         if not token:
             raise ValueError(f'Apify storage client requires a valid token in Configuration (token={token}).')

src/apify/storage_clients/_apify/_key_value_store_client.py

@@ -61,7 +61,6 @@ def __init__(
     def metadata(self) -> KeyValueStoreMetadata:
         return self._metadata
 
-    @override
     @classmethod
     async def open(
         cls,
@@ -70,6 +69,28 @@ async def open(
         name: str | None,
         configuration: Configuration,
     ) -> ApifyKeyValueStoreClient:
+        """Open an Apify key-value store client.
+
+        This method creates and initializes a new instance of the Apify key-value store client.
+        It handles authentication, storage lookup/creation, and metadata retrieval.
+
+        Args:
+            id: The ID of an existing key-value store to open. If provided, the client will connect to this specific
+                storage. Cannot be used together with `name`.
+            name: The name of a key-value store to get or create. If a storage with this name exists, it will be
+                opened; otherwise, a new one will be created. Cannot be used together with `id`.
+            configuration: The configuration object containing API credentials and settings. Must include a valid
+                `token` and `api_base_url`. May also contain a `default_key_value_store_id` for fallback when
+                neither `id` nor `name` is provided.
+
+        Returns:
+            An instance for the opened or created storage client.
+
+        Raises:
+            ValueError: If the configuration is missing required fields (token, api_base_url), if both `id` and `name`
+                are provided, or if neither `id` nor `name` is provided and no default storage ID is available
+                in the configuration.
+        """
         token = getattr(configuration, 'token', None)
         if not token:
             raise ValueError(f'Apify storage client requires a valid token in Configuration (token={token}).')
@@ -201,6 +222,9 @@ async def get_public_url(self, key: str) -> str:
 
         Args:
             key: The key for which the URL should be generated.
+
+        Returns:
+            A public URL that can be used to access the value of the given key in the KVS.
         """
         if self._api_client.resource_id is None:
             raise ValueError('resource_id cannot be None when generating a public URL')
@@ -209,11 +233,9 @@ async def get_public_url(self, key: str) -> str:
             URL(self._api_client.base_url) / 'v2' / 'key-value-stores' / self._api_client.resource_id / 'records' / key
         )
 
-        key_value_store = self.metadata
-
-        if key_value_store and key_value_store.model_extra:
-            url_signing_secret_key = key_value_store.model_extra.get('urlSigningSecretKey')
-            if url_signing_secret_key:
+        if self.metadata.model_extra is not None:
+            url_signing_secret_key = self.metadata.model_extra.get('urlSigningSecretKey')
+            if url_signing_secret_key is not None:
                 public_url = public_url.with_query(signature=create_hmac_signature(url_signing_secret_key, key))
 
         return str(public_url)

src/apify/storage_clients/_apify/_request_queue_client.py

@@ -91,7 +91,6 @@ def __init__(
     def metadata(self) -> RequestQueueMetadata:
         return self._metadata
 
-    @override
     @classmethod
     async def open(
         cls,
@@ -100,6 +99,29 @@ async def open(
         name: str | None,
         configuration: Configuration,
     ) -> ApifyRequestQueueClient:
+        """Open an Apify request queue client.
+
+        This method creates and initializes a new instance of the Apify request queue client. It handles
+        authentication, storage lookup/creation, and metadata retrieval, and sets up internal caching and queue
+        management structures.
+
+        Args:
+            id: The ID of an existing request queue to open. If provided, the client will connect to this specific
+                storage. Cannot be used together with `name`.
+            name: The name of a request queue to get or create. If a storage with this name exists, it will be opened;
+                otherwise, a new one will be created. Cannot be used together with `id`.
+            configuration: The configuration object containing API credentials and settings. Must include a valid
+                `token` and `api_base_url`. May also contain a `default_request_queue_id` for fallback when neither
+                `id` nor `name` is provided.
+
+        Returns:
+            An instance for the opened or created storage client.
+
+        Raises:
+            ValueError: If the configuration is missing required fields (token, api_base_url), if both `id` and `name`
+                are provided, or if neither `id` nor `name` is provided and no default storage ID is available
+                in the configuration.
+        """
         token = getattr(configuration, 'token', None)
         if not token:
             raise ValueError(f'Apify storage client requires a valid token in Configuration (token={token}).')

tests/integration/test_actor_key_value_store.py

@@ -201,30 +201,16 @@ async def test_generate_public_url_for_kvs_record(
     run_actor: RunActorFunction,
 ) -> None:
     async def main() -> None:
-        import os
-
         from apify._crypto import create_hmac_signature
 
         async with Actor:
             public_api_url = Actor.config.api_public_base_url
-
-            default_kvs_id = (
-                os.environ.get(
-                    'ACTOR_DEFAULT_KEY_VALUE_STORE_ID',
-                    None,
-                )
-                or os.environ.get(
-                    'APIFY_DEFAULT_KEY_VALUE_STORE_ID',
-                    None,
-                )
-                or 'default'
-            )
-
+            default_kvs_id = Actor.config.default_key_value_store_id
             record_key = 'public-record-key'
 
             kvs = await Actor.open_key_value_store()
+            assert kvs.metadata.model_extra is not None
 
-            assert isinstance(kvs.metadata.model_extra, dict)
             url_signing_secret_key = kvs.metadata.model_extra.get('urlSigningSecretKey')
             assert url_signing_secret_key is not None