apify-client 3.2.2b6__tar.gz → 3.2.2b7__tar.gz

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/CHANGELOG.md

@@ -12,10 +12,13 @@ All notable changes to this project will be documented in this file.
 - Add live iteration over a run's dataset items ([#1079](https://github.com/apify/apify-client-python/pull/1079)) ([6aa8ead](https://github.com/apify/apify-client-python/commit/6aa8ead676a3520f6a418597eb62f319a3d19d30)) by [@vdusek](https://github.com/vdusek), closes [#1065](https://github.com/apify/apify-client-python/issues/1065)
 - Add max_total_charge_usd to task start() and call() ([#1097](https://github.com/apify/apify-client-python/pull/1097)) ([966d3d6](https://github.com/apify/apify-client-python/commit/966d3d687d8d45737bf706fb13de379e682897d5)) by [@vdusek](https://github.com/vdusek), closes [#1096](https://github.com/apify/apify-client-python/issues/1096)
 - Add missing Standby fields to Actor update and create ([#1107](https://github.com/apify/apify-client-python/pull/1107)) ([8dd5b67](https://github.com/apify/apify-client-python/commit/8dd5b678d1440143f47dc57e29d6a2ef251d041d)) by [@vdusek](https://github.com/vdusek), closes [#1101](https://github.com/apify/apify-client-python/issues/1101)
+- Add flatten to dataset stream_items ([#1106](https://github.com/apify/apify-client-python/pull/1106)) ([1d1e9f6](https://github.com/apify/apify-client-python/commit/1d1e9f65e6fb6bf752f5dd552b9a2424c73f52fe)) by [@vdusek](https://github.com/vdusek), closes [#1100](https://github.com/apify/apify-client-python/issues/1100)
 
 ### 🐛 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)
+- Rename `build_tag` to `build` in `validate_input()` ([#1110](https://github.com/apify/apify-client-python/pull/1110)) ([0616e1a](https://github.com/apify/apify-client-python/commit/0616e1a0a5354f609eb5759f3729f6795a3192c4)) by [@vdusek](https://github.com/vdusek), closes [#1091](https://github.com/apify/apify-client-python/issues/1091)
+- Type `example_run_input_body` as `str` ([#1105](https://github.com/apify/apify-client-python/pull/1105)) ([a1047fa](https://github.com/apify/apify-client-python/commit/a1047faee0c1065844b9639a47cb02422f9302ff)) by [@vdusek](https://github.com/vdusek), closes [#1102](https://github.com/apify/apify-client-python/issues/1102)
 
 ### ⚡ Performance
 

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apify_client
-Version: 3.2.2b6
+Version: 3.2.2b7
 Summary: Apify API client for Python
 Keywords: apify,api,client,automation,crawling,scraping
 Author: Apify Technologies s.r.o.

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "apify_client"
-version = "3.2.2b6"
+version = "3.2.2b7"
 description = "Apify API client for Python"
 license = "Apache-2.0"
 license-files = ["LICENSE"]

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "apify_client"
-version = "3.2.2b6"
+version = "3.2.2b7"
 description = "Apify API client for Python"
 authors = [{ name = "Apify Technologies s.r.o.", email = "support@apify.com" }]
 license = "Apache-2.0"

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/src/apify_client/_resource_clients/actor.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING, Any, Literal
 
 from pydantic import TypeAdapter
@@ -119,7 +120,7 @@ class ActorClient(ResourceClient):
         default_run_max_items: int | None = None,
         default_run_memory_mbytes: int | None = None,
         default_run_timeout: timedelta | None = None,
-        example_run_input_body: Any = None,
+        example_run_input_body: str | None = None,
         example_run_input_content_type: str | None = None,
         actor_standby_is_enabled: bool | None = None,
         actor_standby_desired_requests_per_actor_run: int | None = None,
@@ -155,7 +156,8 @@ class ActorClient(ResourceClient):
                 by runs of this Actor, if the Actor is charged per result.
             default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.
             default_run_timeout: Default timeout for the runs of this Actor.
-            example_run_input_body: Input to be prefilled as default input to new users of this Actor.
+            example_run_input_body: Input to be prefilled as default input to new users of this Actor, serialized
+                as a string (e.g. `json.dumps(input)` for a JSON input).
             example_run_input_content_type: The content type of the example run input.
             actor_standby_is_enabled: Whether the Actor Standby is enabled.
             actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for
@@ -575,9 +577,10 @@ class ActorClient(ResourceClient):
         self,
         run_input: Any = None,
         *,
-        build_tag: str | None = None,
+        build: str | None = None,
         content_type: str | None = None,
         timeout: Timeout = 'short',
+        build_tag: str | None = None,
     ) -> bool:
         """Validate an input for the Actor that defines an input schema.
 
@@ -586,13 +589,25 @@ class ActorClient(ResourceClient):
                 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.
+            build: The Actor build to validate the input against. It can be either a build tag or build number. By
+                default, the build specified in the default run configuration for the Actor (typically latest) is used.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.
+            build_tag: Deprecated alias of `build`. Will be removed in v4.
 
         Returns:
             True if the input is valid, else raise an exception with validation error details.
         """
+        if build_tag is not None:
+            warnings.warn(
+                'The `build_tag` argument is deprecated and will be removed in v4. Use `build` instead.',
+                DeprecationWarning,
+                stacklevel=3,
+            )
+            if build is not None:
+                raise ValueError('Pass only one of `build` and `build_tag`.')
+            build = build_tag
+
         run_input, content_type = encode_key_value_store_record_value(run_input, content_type=content_type)
 
         self._http_client.call(
@@ -600,7 +615,7 @@ class ActorClient(ResourceClient):
             method='POST',
             headers={'content-type': content_type},
             data=run_input,
-            params=self._build_params(build=build_tag),
+            params=self._build_params(build=build),
             timeout=timeout,
         )
 
@@ -661,7 +676,7 @@ class ActorClientAsync(ResourceClientAsync):
         default_run_max_items: int | None = None,
         default_run_memory_mbytes: int | None = None,
         default_run_timeout: timedelta | None = None,
-        example_run_input_body: Any = None,
+        example_run_input_body: str | None = None,
         example_run_input_content_type: str | None = None,
         actor_standby_is_enabled: bool | None = None,
         actor_standby_desired_requests_per_actor_run: int | None = None,
@@ -697,7 +712,8 @@ class ActorClientAsync(ResourceClientAsync):
                 by runs of this Actor, if the Actor is charged per result.
             default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.
             default_run_timeout: Default timeout for the runs of this Actor.
-            example_run_input_body: Input to be prefilled as default input to new users of this Actor.
+            example_run_input_body: Input to be prefilled as default input to new users of this Actor, serialized
+                as a string (e.g. `json.dumps(input)` for a JSON input).
             example_run_input_content_type: The content type of the example run input.
             actor_standby_is_enabled: Whether the Actor Standby is enabled.
             actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for
@@ -1118,9 +1134,10 @@ class ActorClientAsync(ResourceClientAsync):
         self,
         run_input: Any = None,
         *,
-        build_tag: str | None = None,
+        build: str | None = None,
         content_type: str | None = None,
         timeout: Timeout = 'short',
+        build_tag: str | None = None,
     ) -> bool:
         """Validate an input for the Actor that defines an input schema.
 
@@ -1129,13 +1146,25 @@ class ActorClientAsync(ResourceClientAsync):
                 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.
+            build: The Actor build to validate the input against. It can be either a build tag or build number. By
+                default, the build specified in the default run configuration for the Actor (typically latest) is used.
             content_type: The content type of the input.
             timeout: Timeout for the API HTTP request.
+            build_tag: Deprecated alias of `build`. Will be removed in v4.
 
         Returns:
             True if the input is valid, else raise an exception with validation error details.
         """
+        if build_tag is not None:
+            warnings.warn(
+                'The `build_tag` argument is deprecated and will be removed in v4. Use `build` instead.',
+                DeprecationWarning,
+                stacklevel=3,
+            )
+            if build is not None:
+                raise ValueError('Pass only one of `build` and `build_tag`.')
+            build = build_tag
+
         run_input, content_type = encode_key_value_store_record_value(run_input, content_type=content_type)
 
         await self._http_client.call(
@@ -1143,7 +1172,7 @@ class ActorClientAsync(ResourceClientAsync):
             method='POST',
             headers={'content-type': content_type},
             data=run_input,
-            params=self._build_params(build=build_tag),
+            params=self._build_params(build=build),
             timeout=timeout,
         )
 

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/src/apify_client/_resource_clients/actor_collection.py

@@ -123,7 +123,7 @@ class ActorCollectionClient(ResourceClient):
         default_run_max_items: int | None = None,
         default_run_memory_mbytes: int | None = None,
         default_run_timeout: timedelta | None = None,
-        example_run_input_body: Any = None,
+        example_run_input_body: str | None = None,
         example_run_input_content_type: str | None = None,
         actor_standby_is_enabled: bool | None = None,
         actor_standby_desired_requests_per_actor_run: int | None = None,
@@ -156,7 +156,8 @@ class ActorCollectionClient(ResourceClient):
                 of this Actor, if the Actor is charged per result.
             default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.
             default_run_timeout: Default timeout for the runs of this Actor.
-            example_run_input_body: Input to be prefilled as default input to new users of this Actor.
+            example_run_input_body: Input to be prefilled as default input to new users of this Actor, serialized
+                as a string (e.g. `json.dumps(input)` for a JSON input).
             example_run_input_content_type: The content type of the example run input.
             actor_standby_is_enabled: Whether the Actor Standby is enabled.
             actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for
@@ -310,7 +311,7 @@ class ActorCollectionClientAsync(ResourceClientAsync):
         default_run_max_items: int | None = None,
         default_run_memory_mbytes: int | None = None,
         default_run_timeout: timedelta | None = None,
-        example_run_input_body: Any = None,
+        example_run_input_body: str | None = None,
         example_run_input_content_type: str | None = None,
         actor_standby_is_enabled: bool | None = None,
         actor_standby_desired_requests_per_actor_run: int | None = None,
@@ -343,7 +344,8 @@ class ActorCollectionClientAsync(ResourceClientAsync):
                 of this Actor, if the Actor is charged per result.
             default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.
             default_run_timeout: Default timeout for the runs of this Actor.
-            example_run_input_body: Input to be prefilled as default input to new users of this Actor.
+            example_run_input_body: Input to be prefilled as default input to new users of this Actor, serialized
+                as a string (e.g. `json.dumps(input)` for a JSON input).
             example_run_input_content_type: The content type of the example run input.
             actor_standby_is_enabled: Whether the Actor Standby is enabled.
             actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for

{apify_client-3.2.2b6 → apify_client-3.2.2b7}/src/apify_client/_resource_clients/dataset.py

@@ -402,6 +402,7 @@ class DatasetClient(ResourceClient):
         skip_hidden: bool | None = None,
         xml_root: str | None = None,
         xml_row: str | None = None,
+        flatten: list[str] | None = None,
         signature: str | None = None,
         timeout: Timeout = 'long',
     ) -> Iterator[HttpResponse]:
@@ -445,6 +446,7 @@ class DatasetClient(ResourceClient):
             xml_root: Overrides default root element name of xml output. By default the root element is items.
             xml_row: Overrides default element name that wraps each page or page function result object in xml output.
                 By default the element name is item.
+            flatten: A list of fields that should be flattened.
             signature: Signature used to access the items.
             timeout: Timeout for the API HTTP request.
 
@@ -469,6 +471,7 @@ class DatasetClient(ResourceClient):
                 skipHidden=skip_hidden,
                 xmlRoot=xml_root,
                 xmlRow=xml_row,
+                flatten=flatten,
                 signature=signature,
             )
 
@@ -964,6 +967,7 @@ class DatasetClientAsync(ResourceClientAsync):
         skip_hidden: bool | None = None,
         xml_root: str | None = None,
         xml_row: str | None = None,
+        flatten: list[str] | None = None,
         signature: str | None = None,
         timeout: Timeout = 'long',
     ) -> AsyncIterator[HttpResponse]:
@@ -1007,6 +1011,7 @@ class DatasetClientAsync(ResourceClientAsync):
             xml_root: Overrides default root element name of xml output. By default the root element is items.
             xml_row: Overrides default element name that wraps each page or page function result object in xml output.
                 By default the element name is item.
+            flatten: A list of fields that should be flattened.
             signature: Signature used to access the items.
             timeout: Timeout for the API HTTP request.
 
@@ -1031,6 +1036,7 @@ class DatasetClientAsync(ResourceClientAsync):
                 skipHidden=skip_hidden,
                 xmlRoot=xml_root,
                 xmlRow=xml_row,
+                flatten=flatten,
                 signature=signature,
             )