apify-client 3.2.1b4__tar.gz → 3.2.2b2__tar.gz

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/CHANGELOG.md

@@ -3,7 +3,20 @@
 All notable changes to this project will be documented in this file.
 
 <!-- git-cliff-unreleased-start -->
-## 3.2.1 - **not yet released**
+## 3.2.2 - **not yet released**
+
+### 🚀 Features
+
+- Stream request bodies from files, iterables, and responses ([#1060](https://github.com/apify/apify-client-python/pull/1060)) ([9be215b](https://github.com/apify/apify-client-python/commit/9be215b23a13de0abc4a255a18450cc764e7a6c7)) by [@vdusek](https://github.com/vdusek), closes [#972](https://github.com/apify/apify-client-python/issues/972)
+- Retry starting a run on memory and concurrent-runs limits ([#1081](https://github.com/apify/apify-client-python/pull/1081)) ([3dd8ca5](https://github.com/apify/apify-client-python/commit/3dd8ca5fe4d2537cb009cb310ba12b39927a9558)) by [@vdusek](https://github.com/vdusek), closes [#1071](https://github.com/apify/apify-client-python/issues/1071)
+
+### 🐛 Bug Fixes
+
+- Add missing `readme` field to `Profile` model ([#1086](https://github.com/apify/apify-client-python/pull/1086)) ([ae17148](https://github.com/apify/apify-client-python/commit/ae1714891c4f70d66ab4964c1783fee0a96776f1)) by [@apify-service-account](https://github.com/apify-service-account)
+
+
+<!-- git-cliff-unreleased-end -->
+## [3.2.1](https://github.com/apify/apify-client-python/releases/tag/v3.2.1) (2026-09-25)
 
 ### 🐛 Bug Fixes
 
@@ -12,7 +25,6 @@ All notable changes to this project will be documented in this file.
 - Make `JsonSerializable` type alias read-only ([#1072](https://github.com/apify/apify-client-python/pull/1072)) ([bd82a26](https://github.com/apify/apify-client-python/commit/bd82a2645d3c64f0e4a30de3a016c16d92d48340)) by [@Pijukatel](https://github.com/Pijukatel)
 
 
-<!-- git-cliff-unreleased-end -->
 ## [3.2.0](https://github.com/apify/apify-client-python/releases/tag/v3.2.0) (2026-09-03)
 
 ### 🚀 Features

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apify_client
-Version: 3.2.1b4
+Version: 3.2.2b2
 Summary: Apify API client for Python
 Keywords: apify,api,client,automation,crawling,scraping
 Author: Apify Technologies s.r.o.
@@ -170,7 +170,7 @@ For a guided walkthrough — authenticating, running an Actor, and reading its r
 - **Fully typed responses** — every method returns a [Pydantic](https://docs.pydantic.dev/) model generated from the Apify OpenAPI spec, with IDE autocomplete and runtime validation ([Typed models](https://docs.apify.com/api/client/python/docs/concepts/typed-models)).
 - **Automatic retries** — exponential backoff for network errors, HTTP 429, and 5xx responses, configurable per client ([Retries](https://docs.apify.com/api/client/python/docs/concepts/retries)).
 - **Tiered timeouts** — short / medium / long tiers picked per endpoint, overridable per call ([Timeouts](https://docs.apify.com/api/client/python/docs/concepts/timeouts)).
-- **Pagination and streaming** — iterate datasets, key-value store keys, or live logs without manual paging or buffering ([Pagination](https://docs.apify.com/api/client/python/docs/concepts/pagination), [Streaming](https://docs.apify.com/api/client/python/docs/concepts/streaming-resources)).
+- **Pagination and streaming** — iterate datasets, key-value store keys, or live logs without manual paging or buffering, and upload large records straight from a file or another stream ([Pagination](https://docs.apify.com/api/client/python/docs/concepts/pagination), [Streaming](https://docs.apify.com/api/client/python/docs/concepts/streaming-resources)).
 - **Convenience methods** — `call()`, `wait_for_finish()`, nested resource access, and other shortcuts that hide platform quirks ([Convenience methods](https://docs.apify.com/api/client/python/docs/concepts/convenience-methods)).
 - **Pluggable HTTP layer** — use the default [Impit](https://github.com/apify/impit)-based client, opt in to the built-in [HTTPX2](https://github.com/pydantic/httpx2) client, or plug in any custom implementation ([HTTP clients](https://docs.apify.com/api/client/python/docs/concepts/custom-http-clients)).
 - **Structured errors** — every API error surfaces as an [`ApifyApiError`](https://docs.apify.com/api/client/python/reference/class/ApifyApiError) with HTTP-specific subclasses for precise handling ([Error handling](https://docs.apify.com/api/client/python/docs/concepts/error-handling)).

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/README.md

@@ -133,7 +133,7 @@ For a guided walkthrough — authenticating, running an Actor, and reading its r
 - **Fully typed responses** — every method returns a [Pydantic](https://docs.pydantic.dev/) model generated from the Apify OpenAPI spec, with IDE autocomplete and runtime validation ([Typed models](https://docs.apify.com/api/client/python/docs/concepts/typed-models)).
 - **Automatic retries** — exponential backoff for network errors, HTTP 429, and 5xx responses, configurable per client ([Retries](https://docs.apify.com/api/client/python/docs/concepts/retries)).
 - **Tiered timeouts** — short / medium / long tiers picked per endpoint, overridable per call ([Timeouts](https://docs.apify.com/api/client/python/docs/concepts/timeouts)).
-- **Pagination and streaming** — iterate datasets, key-value store keys, or live logs without manual paging or buffering ([Pagination](https://docs.apify.com/api/client/python/docs/concepts/pagination), [Streaming](https://docs.apify.com/api/client/python/docs/concepts/streaming-resources)).
+- **Pagination and streaming** — iterate datasets, key-value store keys, or live logs without manual paging or buffering, and upload large records straight from a file or another stream ([Pagination](https://docs.apify.com/api/client/python/docs/concepts/pagination), [Streaming](https://docs.apify.com/api/client/python/docs/concepts/streaming-resources)).
 - **Convenience methods** — `call()`, `wait_for_finish()`, nested resource access, and other shortcuts that hide platform quirks ([Convenience methods](https://docs.apify.com/api/client/python/docs/concepts/convenience-methods)).
 - **Pluggable HTTP layer** — use the default [Impit](https://github.com/apify/impit)-based client, opt in to the built-in [HTTPX2](https://github.com/pydantic/httpx2) client, or plug in any custom implementation ([HTTP clients](https://docs.apify.com/api/client/python/docs/concepts/custom-http-clients)).
 - **Structured errors** — every API error surfaces as an [`ApifyApiError`](https://docs.apify.com/api/client/python/reference/class/ApifyApiError) with HTTP-specific subclasses for precise handling ([Error handling](https://docs.apify.com/api/client/python/docs/concepts/error-handling)).

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "apify_client"
-version = "3.2.1b4"
+version = "3.2.2b2"
 description = "Apify API client for Python"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
@@ -178,6 +178,7 @@ indent-style = "space"
 addopts = "-r a --verbose --dist worksteal"
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"
+filterwarnings = ["ignore:Streaming a request body is experimental:UserWarning"]
 pythonpath = ["."]
 timeout = 1800
 
@@ -245,7 +246,7 @@ disable_timestamp = true
 keep_model_order = true
 
 [tool.apify.openapi-spec]
-version = "v2-2026-08-31T125154Z"
+version = "v2-2026-10-01T153946Z"
 
 [tool.uv]
 exclude-newer = "24 hours"

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "apify_client"
-version = "3.2.1b4"
+version = "3.2.2b2"
 description = "Apify API client for Python"
 authors = [{ name = "Apify Technologies s.r.o.", email = "support@apify.com" }]
 license = "Apache-2.0"
@@ -187,6 +187,10 @@ max-branches = 18
 addopts = "-r a --verbose --dist worksteal"
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"
+filterwarnings = [
+    # The tests stream request bodies throughout, and the warning has a unit test of its own.
+    "ignore:Streaming a request body is experimental:UserWarning",
+]
 pythonpath = ["."]
 timeout = 1800
 
@@ -246,7 +250,7 @@ keep_model_order = true
 # workflow committing nothing unless the models changed. A local regeneration that only moves this line is that
 # same case - drop it rather than committing it alone.
 [tool.apify.openapi-spec]
-version = "v2-2026-08-31T125154Z"
+version = "v2-2026-10-01T153946Z"
 
 [tool.uv]
 # Minimal defense against supply-chain atatcks.

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/src/apify_client/_consts.py

@@ -42,6 +42,15 @@ A smaller body already fits in a single network packet, so compressing it costs
 saving a round trip.
 """
 
+STREAMED_BODY_CHUNK_SIZE = 64 * 1024
+"""Size of the chunks a streamed request body reads from an `io.IOBase` source, in bytes from a binary stream and in
+characters from a text-mode one.
+
+A chunk is the most of a streamed body that is in memory at once, and in the asynchronous client every chunk costs
+one worker-thread hop, so the size balances memory against per-chunk overhead. It matches the buffer size the
+standard library and common HTTP libraries use to copy files.
+"""
+
 ALREADY_COMPRESSED_MEDIA_TYPE_PREFIXES = ('audio/', 'image/', 'video/')
 """Media type prefixes whose payloads carry their own compression, so compressing the request body is wasted work."""
 

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/src/apify_client/_models.py

@@ -595,6 +595,12 @@ class Build(BaseModel):
     build_number: Annotated[
         str, Field(examples=['0.1.1'], pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$')
     ]
+    image_digest: Annotated[
+        str | None, Field(examples=['1b2f1e8c0d5a4c7f9e3b6a2d8c4e0f7a5b9d3c1e6f8a2b4d0c7e9f1a3b5d7c9e'])
+    ] = None
+    """
+    Digest of the built Docker image manifest, without the `sha256:` prefix. Compare digests of two builds to find out whether their image contents differ. `null` if the digest is not available.
+    """
     act_version: Annotated[ActVersion | None, Field(title='BuildActVersion')] = None
     """
     Snapshot of the Actor version that this build was created from.
@@ -2280,6 +2286,10 @@ class Profile(BaseModel):
         alias_generator=to_camel,
     )
     bio: Annotated[str | None, Field(examples=['I started web scraping in 1985 using Altair BASIC.'])] = None
+    readme: Annotated[str | None, Field(examples=['### Hello world 👋🏻\nI build web scrapers.'])] = None
+    """
+    Markdown README shown on the user's public profile page.
+    """
     name: Annotated[str | None, Field(examples=['Jane Doe'])] = None
     picture_url: Annotated[AnyUrl | None, Field(examples=['https://apify.com/img/anonymous_user_picture.png'])] = None
     github_username: Annotated[str | None, Field(examples=['torvalds.'])] = None

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/src/apify_client/_resource_clients/actor.py

@@ -26,6 +26,11 @@ from apify_client._resource_clients._resource_client import ResourceClient, Reso
 from apify_client._utils.encoding import encode_key_value_store_record_value, encode_webhooks_to_base64
 from apify_client._utils.http import response_to_dict
 from apify_client._utils.time import to_seconds
+from apify_client._utils.wait_for_resources import (
+    prepare_resendable_body,
+    start_waiting_for_resources,
+    start_waiting_for_resources_async,
+)
 
 if TYPE_CHECKING:
     from datetime import timedelta
@@ -229,6 +234,7 @@ class ActorClient(ResourceClient):
         force_permission_level: ActorPermissionLevel | None = None,
         wait_for_finish: int | None = None,
         webhooks: WebhooksList | None = None,
+        wait_for_resources: bool | timedelta = False,
         timeout: Timeout = 'medium',
     ) -> Run:
         """Start the Actor and immediately return the Run object.
@@ -236,7 +242,10 @@ class ActorClient(ResourceClient):
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
 
         Args:
-            run_input: The input to pass to the Actor run.
+            run_input: The input to pass to the Actor run. Accepts the same values as
+                `KeyValueStoreClient.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
@@ -260,12 +269,21 @@ class ActorClient(ResourceClient):
                     * `event_types`: List of `WebhookEventType` values which trigger the webhook.
                     * `request_url`: URL to which to send the webhook HTTP request.
                     * `payload_template`: Optional template for the request payload.
+            wait_for_resources: Retry the start while the account lacks the memory or a concurrent-run slot for the run,
+                that is while the API rejects it with an `ApifyApiError` of type `actor-memory-limit-exceeded` or
+                `concurrent-runs-limit-exceeded`. Both clear as other runs or builds finish. The start is retried
+                every 10 seconds, and any other error is raised right away. `True` retries until the run starts, a
+                `timedelta` stops retrying after that long and raises the last error. A run that requests more memory
+                than the whole memory limit of the account is rejected with `actor-memory-limit-exceeded` as well and
+                never starts, so `True` retries it forever. A streamed `run_input` that cannot be rewound, such as a
+                generator, is sent only once, so its start is not retried.
             timeout: Timeout for the API HTTP request.
 
         Returns:
             The run object.
         """
         run_input, content_type = encode_key_value_store_record_value(run_input, content_type=content_type)
+        run_input, wait_for_resources = prepare_resendable_body(run_input, wait_for_resources=wait_for_resources)
 
         request_params = self._build_params(
             build=build,
@@ -279,13 +297,16 @@ class ActorClient(ResourceClient):
             webhooks=encode_webhooks_to_base64(webhooks),
         )
 
-        response = self._http_client.call(
-            url=self._build_url('runs'),
-            method='POST',
-            headers={'content-type': content_type},
-            data=run_input,
-            params=request_params,
-            timeout=timeout,
+        response = start_waiting_for_resources(
+            lambda: self._http_client.call(
+                url=self._build_url('runs'),
+                method='POST',
+                headers={'content-type': content_type},
+                data=run_input,
+                params=request_params,
+                timeout=timeout,
+            ),
+            wait_for_resources=wait_for_resources,
         )
 
         result = response_to_dict(response)
@@ -305,6 +326,7 @@ class ActorClient(ResourceClient):
         webhooks: WebhooksList | None = None,
         force_permission_level: ActorPermissionLevel | None = None,
         wait_duration: timedelta | None = None,
+        wait_for_resources: bool | timedelta = False,
         logger: Logger | Literal['default'] | None = 'default',
         timeout: Timeout = 'no_timeout',
     ) -> Run | None:
@@ -315,7 +337,10 @@ class ActorClient(ResourceClient):
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
 
         Args:
-            run_input: The input to pass to the Actor run.
+            run_input: The input to pass to the Actor run. Accepts the same values as
+                `KeyValueStoreClient.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
@@ -335,6 +360,14 @@ class ActorClient(ResourceClient):
                 a webhook set up for the Actor, you do not have to add it again here.
             wait_duration: The maximum time the server waits for the run to finish. If not provided,
                 waits indefinitely.
+            wait_for_resources: Retry the start while the account lacks the memory or a concurrent-run slot for the run,
+                that is while the API rejects it with an `ApifyApiError` of type `actor-memory-limit-exceeded` or
+                `concurrent-runs-limit-exceeded`. Both clear as other runs or builds finish. The start is retried
+                every 10 seconds, and any other error is raised right away. `True` retries until the run starts, a
+                `timedelta` stops retrying after that long and raises the last error. A run that requests more memory
+                than the whole memory limit of the account is rejected with `actor-memory-limit-exceeded` as well and
+                never starts, so `True` retries it forever. The time spent retrying doesn't count toward
+                `wait_duration`.
             logger: Logger used to redirect logs from the Actor run. Using "default" literal means that a predefined
                 default logger will be used. Setting `None` will disable any log propagation. Passing custom logger
                 will redirect logs to the provided logger. The logger is also used to capture status and status message
@@ -355,6 +388,7 @@ class ActorClient(ResourceClient):
             run_timeout=run_timeout,
             webhooks=webhooks,
             force_permission_level=force_permission_level,
+            wait_for_resources=wait_for_resources,
             timeout=timeout,
         )
         run_client = self._client_registry.run_client(
@@ -540,7 +574,10 @@ class ActorClient(ResourceClient):
         """Validate an input for the Actor that defines an input schema.
 
         Args:
-            run_input: The input to validate.
+            run_input: The input to validate. Accepts the same values as `KeyValueStoreClient.set_record`,
+                including an `io.IOBase` stream such as an open file, an iterable of byte chunks, or a streamed
+                `HttpResponse`, which are uploaded in chunks without being held in memory. Streaming is experimental,
+                and its behavior may change in future versions.
             build_tag: The Actor's build tag.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.
@@ -731,6 +768,7 @@ class ActorClientAsync(ResourceClientAsync):
         force_permission_level: ActorPermissionLevel | None = None,
         wait_for_finish: int | None = None,
         webhooks: WebhooksList | None = None,
+        wait_for_resources: bool | timedelta = False,
         timeout: Timeout = 'medium',
     ) -> Run:
         """Start the Actor and immediately return the Run object.
@@ -738,7 +776,10 @@ class ActorClientAsync(ResourceClientAsync):
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
 
         Args:
-            run_input: The input to pass to the Actor run.
+            run_input: The input to pass to the Actor run. Accepts the same values as
+                `KeyValueStoreClientAsync.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
@@ -762,12 +803,21 @@ class ActorClientAsync(ResourceClientAsync):
                     * `event_types`: List of `WebhookEventType` values which trigger the webhook.
                     * `request_url`: URL to which to send the webhook HTTP request.
                     * `payload_template`: Optional template for the request payload.
+            wait_for_resources: Retry the start while the account lacks the memory or a concurrent-run slot for the run,
+                that is while the API rejects it with an `ApifyApiError` of type `actor-memory-limit-exceeded` or
+                `concurrent-runs-limit-exceeded`. Both clear as other runs or builds finish. The start is retried
+                every 10 seconds, and any other error is raised right away. `True` retries until the run starts, a
+                `timedelta` stops retrying after that long and raises the last error. A run that requests more memory
+                than the whole memory limit of the account is rejected with `actor-memory-limit-exceeded` as well and
+                never starts, so `True` retries it forever. A streamed `run_input` that cannot be rewound, such as a
+                generator, is sent only once, so its start is not retried.
             timeout: Timeout for the API HTTP request.
 
         Returns:
             The run object.
         """
         run_input, content_type = encode_key_value_store_record_value(run_input, content_type=content_type)
+        run_input, wait_for_resources = prepare_resendable_body(run_input, wait_for_resources=wait_for_resources)
 
         request_params = self._build_params(
             build=build,
@@ -781,13 +831,16 @@ class ActorClientAsync(ResourceClientAsync):
             webhooks=encode_webhooks_to_base64(webhooks),
         )
 
-        response = await self._http_client.call(
-            url=self._build_url('runs'),
-            method='POST',
-            headers={'content-type': content_type},
-            data=run_input,
-            params=request_params,
-            timeout=timeout,
+        response = await start_waiting_for_resources_async(
+            lambda: self._http_client.call(
+                url=self._build_url('runs'),
+                method='POST',
+                headers={'content-type': content_type},
+                data=run_input,
+                params=request_params,
+                timeout=timeout,
+            ),
+            wait_for_resources=wait_for_resources,
         )
 
         result = response_to_dict(response)
@@ -807,6 +860,7 @@ class ActorClientAsync(ResourceClientAsync):
         webhooks: WebhooksList | None = None,
         force_permission_level: ActorPermissionLevel | None = None,
         wait_duration: timedelta | None = None,
+        wait_for_resources: bool | timedelta = False,
         logger: Logger | Literal['default'] | None = 'default',
         timeout: Timeout = 'no_timeout',
     ) -> Run | None:
@@ -817,7 +871,10 @@ class ActorClientAsync(ResourceClientAsync):
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
 
         Args:
-            run_input: The input to pass to the Actor run.
+            run_input: The input to pass to the Actor run. Accepts the same values as
+                `KeyValueStoreClientAsync.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
@@ -837,6 +894,14 @@ class ActorClientAsync(ResourceClientAsync):
                 a webhook set up for the Actor, you do not have to add it again here.
             wait_duration: The maximum time the server waits for the run to finish. If not provided,
                 waits indefinitely.
+            wait_for_resources: Retry the start while the account lacks the memory or a concurrent-run slot for the run,
+                that is while the API rejects it with an `ApifyApiError` of type `actor-memory-limit-exceeded` or
+                `concurrent-runs-limit-exceeded`. Both clear as other runs or builds finish. The start is retried
+                every 10 seconds, and any other error is raised right away. `True` retries until the run starts, a
+                `timedelta` stops retrying after that long and raises the last error. A run that requests more memory
+                than the whole memory limit of the account is rejected with `actor-memory-limit-exceeded` as well and
+                never starts, so `True` retries it forever. The time spent retrying doesn't count toward
+                `wait_duration`.
             logger: Logger used to redirect logs from the Actor run. Using "default" literal means that a predefined
                 default logger will be used. Setting `None` will disable any log propagation. Passing custom logger
                 will redirect logs to the provided logger. The logger is also used to capture status and status message
@@ -857,6 +922,7 @@ class ActorClientAsync(ResourceClientAsync):
             run_timeout=run_timeout,
             webhooks=webhooks,
             force_permission_level=force_permission_level,
+            wait_for_resources=wait_for_resources,
             timeout=timeout,
         )
 
@@ -1043,7 +1109,10 @@ class ActorClientAsync(ResourceClientAsync):
         """Validate an input for the Actor that defines an input schema.
 
         Args:
-            run_input: The input to validate.
+            run_input: The input to validate. Accepts the same values as `KeyValueStoreClientAsync.set_record`,
+                including an `io.IOBase` stream such as an open file, an iterable of byte chunks, or a streamed
+                `HttpResponse`, which are uploaded in chunks without being held in memory. Streaming is experimental,
+                and its behavior may change in future versions.
             build_tag: The Actor's build tag.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/src/apify_client/_resource_clients/key_value_store.py

@@ -369,14 +369,19 @@ class KeyValueStoreClient(ResourceClient):
 
         Args:
             key: The key of the record to save the value to.
-            value: The value to save into the record.
+            value: The value to save into the record. An `io.IOBase` stream such as an open file, an iterable of byte
+                chunks, or a streamed `HttpResponse` is uploaded in chunks as it is read, without being held in memory
+                whole or compressed. Any other object with a callable `read` is read whole and sent uncompressed. Only
+                a seekable `io.IOBase` value can be retried; any other streamed value gets a single attempt. See
+                `StreamedRequestBody` for details. Streaming is experimental, and its behavior may change in future
+                versions.
             content_type: The content type of the saved value.
             content_encoding: The encoding already applied to `value`, sent as the `Content-Encoding` header. Pass it
                 to upload a pre-compressed value - the client then forwards the bytes as they are instead of
                 compressing them itself. The API accepts `gzip`, `br`, `deflate`, and `identity`, and stores the
-                record exactly as uploaded, so this also becomes the encoding the record is served with. Only a
-                bytes-like `value`, or a file-like one that reads into bytes, can carry a compression - anything
-                else raises `TypeError` instead of being stored under a header that misdescribes it.
+                record exactly as uploaded, so this also becomes the encoding the record is served with. A `str`, a
+                JSON-serializable object, or a text-mode file cannot be carrying a compression and raises
+                `TypeError`; a streamed value is taken at its word, since its bytes are only seen as they are sent.
             timeout: Timeout for the API HTTP request.
         """
         value, content_type = encode_key_value_store_record_value(
@@ -802,14 +807,19 @@ class KeyValueStoreClientAsync(ResourceClientAsync):
 
         Args:
             key: The key of the record to save the value to.
-            value: The value to save into the record.
+            value: The value to save into the record. An `io.IOBase` stream such as an open file, an iterable of byte
+                chunks, or a streamed `HttpResponse` is uploaded in chunks as it is read, without being held in memory
+                whole or compressed. Any other object with a callable `read` is read whole and sent uncompressed. Only
+                a seekable `io.IOBase` value can be retried; any other streamed value gets a single attempt. See
+                `StreamedRequestBody` for details. Streaming is experimental, and its behavior may change in future
+                versions.
             content_type: The content type of the saved value.
             content_encoding: The encoding already applied to `value`, sent as the `Content-Encoding` header. Pass it
                 to upload a pre-compressed value - the client then forwards the bytes as they are instead of
                 compressing them itself. The API accepts `gzip`, `br`, `deflate`, and `identity`, and stores the
-                record exactly as uploaded, so this also becomes the encoding the record is served with. Only a
-                bytes-like `value`, or a file-like one that reads into bytes, can carry a compression - anything
-                else raises `TypeError` instead of being stored under a header that misdescribes it.
+                record exactly as uploaded, so this also becomes the encoding the record is served with. A `str`, a
+                JSON-serializable object, or a text-mode file cannot be carrying a compression and raises
+                `TypeError`; a streamed value is taken at its word, since its bytes are only seen as they are sent.
             timeout: Timeout for the API HTTP request.
         """
         value, content_type = encode_key_value_store_record_value(

{apify_client-3.2.1b4 → apify_client-3.2.2b2}/src/apify_client/_resource_clients/run.py

@@ -180,7 +180,10 @@ class RunClient(ResourceClient):
             target_actor_build: The build of the target Actor. It can be either a build tag or build number.
                 By default, the run uses the build specified in the default run configuration for the target Actor
                 (typically the latest build).
-            run_input: The input to pass to the new run.
+            run_input: The input to pass to the new run. Accepts the same values as
+                `KeyValueStoreClient.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.
 
@@ -608,7 +611,10 @@ class RunClientAsync(ResourceClientAsync):
             target_actor_build: The build of the target Actor. It can be either a build tag or build number.
                 By default, the run uses the build specified in the default run configuration for the target Actor
                 (typically the latest build).
-            run_input: The input to pass to the new run.
+            run_input: The input to pass to the new run. Accepts the same values as
+                `KeyValueStoreClientAsync.set_record`, including an `io.IOBase` stream such as an open file, an iterable
+                of byte chunks, or a streamed `HttpResponse`, which are uploaded in chunks without being held in
+                memory. Streaming is experimental, and its behavior may change in future versions.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.