Skip to content

feat: add max_total_charge_usd to task start() and call() #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vdusek merged 2 commits into from
Oct 7, 2026
Merged

feat: add max_total_charge_usd to task start() and call() #1097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e043321
feat: add max_total_charge_usd to task start() and call()
vdusek Oct 7, 2026
ef817a1
test: run task start params test on both HTTP clients
vdusek Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/apify_client/_resource_clients/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

if TYPE_CHECKING:
from datetime import timedelta
from decimal import Decimal

from apify_client._literals import ActorJobStatus, RunOrigin
from apify_client._resource_clients import (
Expand Down Expand Up @@ -217,6 +218,7 @@ def start(
task_input: TaskInputDict | TaskInput | None = None,
build: str | None = None,
max_items: int | None = None,
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
run_timeout: timedelta | None = None,
restart_on_error: bool | None = None,
Expand All @@ -235,6 +237,7 @@ def start(
the run uses the build specified in the task settings (typically latest).
max_items: Maximum number of results that will be returned by this run. If the Actor is charged
per result, you will not be charged for more results than the given limit.
max_total_charge_usd: A limit on the total charged amount for pay-per-event Actors.
memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
in the task settings.
run_timeout: Optional timeout for the run. By default, the run uses timeout specified
Expand Down Expand Up @@ -268,6 +271,7 @@ def start(
request_params = self._build_params(
build=build,
maxItems=max_items,
maxTotalChargeUsd=max_total_charge_usd,
memory=memory_mbytes,
timeout=to_seconds(run_timeout, as_int=True),
restartOnError=restart_on_error,
Expand Down Expand Up @@ -296,6 +300,7 @@ def call(
task_input: TaskInputDict | TaskInput | None = None,
build: str | None = None,
max_items: int | None = None,
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
run_timeout: timedelta | None = None,
restart_on_error: bool | None = None,
Expand All @@ -316,6 +321,7 @@ def call(
the run uses the build specified in the task settings (typically latest).
max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,
you will not be charged for more results than the given limit.
max_total_charge_usd: A limit on the total charged amount for pay-per-event Actors.
memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
in the task settings.
run_timeout: Optional timeout for the run. By default, the run uses timeout specified
Expand Down Expand Up @@ -344,6 +350,7 @@ def call(
task_input=task_input,
build=build,
max_items=max_items,
max_total_charge_usd=max_total_charge_usd,
memory_mbytes=memory_mbytes,
run_timeout=run_timeout,
restart_on_error=restart_on_error,
Expand Down Expand Up @@ -619,6 +626,7 @@ async def start(
task_input: TaskInputDict | TaskInput | None = None,
build: str | None = None,
max_items: int | None = None,
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
run_timeout: timedelta | None = None,
restart_on_error: bool | None = None,
Expand All @@ -637,6 +645,7 @@ async def start(
the run uses the build specified in the task settings (typically latest).
max_items: Maximum number of results that will be returned by this run. If the Actor is charged
per result, you will not be charged for more results than the given limit.
max_total_charge_usd: A limit on the total charged amount for pay-per-event Actors.
memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
in the task settings.
run_timeout: Optional timeout for the run. By default, the run uses timeout specified
Expand Down Expand Up @@ -670,6 +679,7 @@ async def start(
request_params = self._build_params(
build=build,
maxItems=max_items,
maxTotalChargeUsd=max_total_charge_usd,
memory=memory_mbytes,
timeout=to_seconds(run_timeout, as_int=True),
restartOnError=restart_on_error,
Expand Down Expand Up @@ -698,6 +708,7 @@ async def call(
task_input: TaskInputDict | TaskInput | None = None,
build: str | None = None,
max_items: int | None = None,
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
run_timeout: timedelta | None = None,
restart_on_error: bool | None = None,
Expand All @@ -718,6 +729,7 @@ async def call(
the run uses the build specified in the task settings (typically latest).
max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,
you will not be charged for more results than the given limit.
max_total_charge_usd: A limit on the total charged amount for pay-per-event Actors.
memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
in the task settings.
run_timeout: Optional timeout for the run. By default, the run uses timeout specified
Expand Down Expand Up @@ -746,6 +758,7 @@ async def call(
task_input=task_input,
build=build,
max_items=max_items,
max_total_charge_usd=max_total_charge_usd,
memory_mbytes=memory_mbytes,
run_timeout=run_timeout,
restart_on_error=restart_on_error,
Expand Down
75 changes: 75 additions & 0 deletions tests/unit/test_task_start_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
from __future__ import annotations

import inspect
from decimal import Decimal
from typing import TYPE_CHECKING, Any

import pytest

from apify_client import ApifyClient, ApifyClientAsync

if TYPE_CHECKING:
from collections.abc import Callable

from pytest_httpserver import HTTPServer

pytestmark = pytest.mark.usefixtures('http_client_classes')

RUN = {
'id': 'run-id',
'actId': 'actor-id',
'userId': 'user-id',
'startedAt': '2019-11-30T07:34:24.202Z',
'status': 'SUCCEEDED',
'meta': {'origin': 'API'},
'stats': {'restartCount': 0, 'resurrectCount': 0, 'computeUnits': 0.1},
'options': {'build': 'latest', 'timeoutSecs': 300, 'memoryMbytes': 1024, 'diskMbytes': 2048},
'buildId': 'build-id',
'generalAccess': 'RESTRICTED',
'defaultKeyValueStoreId': 'kvs-id',
'defaultDatasetId': 'dataset-id',
'defaultRequestQueueId': 'rq-id',
'buildNumber': '0.0.1',
'containerUrl': 'https://test.runs.apify.net',
}

STARTERS = [
pytest.param(lambda c, **kw: c.task('task-id').start(**kw), id='start'),
pytest.param(lambda c, **kw: c.task('task-id').call(**kw), id='call'),
]


@pytest.fixture(params=[pytest.param(ApifyClient, id='sync'), pytest.param(ApifyClientAsync, id='async')])
def client(request: pytest.FixtureRequest, httpserver: HTTPServer) -> ApifyClient | ApifyClientAsync:
return request.param(token='test', api_url=httpserver.url_for('/').removesuffix('/'))


async def run(starter: Callable[..., Any], client: ApifyClient | ApifyClientAsync, **kwargs: Any) -> Any:
result = starter(client, **kwargs)
return await result if inspect.isawaitable(result) else result


@pytest.mark.parametrize('starter', STARTERS)
@pytest.mark.parametrize(
('max_total_charge_usd', 'expected_query'),
[
pytest.param(Decimal('1.5'), {'maxTotalChargeUsd': '1.5'}, id='set'),
pytest.param(None, {}, id='omitted'),
],
)
async def test_task_run_sends_max_total_charge_usd(
httpserver: HTTPServer,
client: ApifyClient | ApifyClientAsync,
starter: Callable[..., Any],
max_total_charge_usd: Decimal | None,
expected_query: dict[str, str],
) -> None:
"""`max_total_charge_usd` reaches the task run API as the `maxTotalChargeUsd` query parameter."""
httpserver.expect_request(
'/v2/actor-tasks/task-id/runs', method='POST', query_string=expected_query
).respond_with_json({'data': RUN}, status=201)
httpserver.expect_request('/v2/actor-runs/run-id').respond_with_json({'data': RUN})

await run(starter, client, max_total_charge_usd=max_total_charge_usd)

httpserver.check_assertions()
Loading