refactor: keep max_paid_dataset_items config field, remove only disable_outdated_warning and fact

Author: vdusek

docs/02_concepts/code/11_conditional_actor_charge.py

@@ -1,5 +1,4 @@
 import asyncio
-import os
 
 from apify import Actor
 
@@ -16,7 +15,7 @@ async def main() -> None:
         if Actor.get_charging_manager().get_pricing_info().is_pay_per_event:
             # highlight-end
             await Actor.push_data({'hello': 'world'}, charged_event_name='dataset-item')
-        elif charged_items < int(os.environ.get('ACTOR_MAX_PAID_DATASET_ITEMS') or 0):
+        elif charged_items < (Actor.configuration.max_paid_dataset_items or 0):
             await Actor.push_data({'hello': 'world'})
             charged_items += 1
 

docs/04_upgrading/upgrading_to_v4.md

@@ -73,21 +73,9 @@ The deprecated `latest_sdk_version`, `log_format`, and `standby_port` fields hav
 
 ### Unused Configuration fields
 
-The `disable_outdated_warning`, `fact`, and `max_paid_dataset_items` fields have been removed from `Configuration`. The SDK never read any of them, and `Actor.get_env()` no longer includes their keys. The corresponding `ActorEnvVars.MAX_PAID_DATASET_ITEMS`, `ApifyEnvVars.DISABLE_OUTDATED_WARNING`, and `ApifyEnvVars.FACT` enum entries remain available.
+The `disable_outdated_warning` and `fact` fields have been removed from `Configuration`. The SDK never read either of them, and `Actor.get_env()` no longer includes their keys. The corresponding `ApifyEnvVars.DISABLE_OUTDATED_WARNING` and `ApifyEnvVars.FACT` enum entries remain available.
 
-- `disable_outdated_warning` and `fact` have no replacement. SDK version checking isn't supported for the Python SDK, so there is no outdated-version warning to disable.
-- `max_paid_dataset_items` only mirrored the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable — read the environment variable directly instead:
-
-```python
-import os
-
-# Before (v3)
-max_paid_dataset_items = Actor.configuration.max_paid_dataset_items
-
-# After (v4)
-env_value = os.environ.get('ACTOR_MAX_PAID_DATASET_ITEMS')
-max_paid_dataset_items = int(env_value) if env_value else None
-```
+Neither has a replacement. SDK version checking isn't supported for the Python SDK, so there's no outdated-version warning to disable.
 
 ### wait_for_finish argument of Actor.start
 

src/apify/_configuration.py

@@ -300,6 +300,15 @@ class Configuration(CrawleeConfiguration):
         ),
     ] = False
 
+    max_paid_dataset_items: Annotated[
+        int | None,
+        Field(
+            validation_alias='actor_max_paid_dataset_items',
+            description='For paid-per-result Actors, the user-set limit on returned results. Do not exceed this limit',
+        ),
+        BeforeValidator(_default_if_empty(default=None)),
+    ] = None
+
     max_total_charge_usd: Annotated[
         Decimal | None,
         Field(

tests/unit/actor/test_actor_env_helpers.py

@@ -12,6 +12,7 @@
 from apify._consts import ActorEnvVars, ApifyEnvVars
 
 INTEGER_ENV_VARS: list[ActorEnvVars | ApifyEnvVars] = [
+    ActorEnvVars.MAX_PAID_DATASET_ITEMS,
     ActorEnvVars.MEMORY_MBYTES,
     ActorEnvVars.STANDBY_PORT,
     ActorEnvVars.WEB_SERVER_PORT,

tests/unit/actor/test_configuration.py

@@ -276,13 +276,27 @@ def test_default_values() -> None:
     assert config.test_pay_per_event is False
 
 
+def test_max_paid_dataset_items_zero_is_preserved(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test that max_paid_dataset_items=0 is not treated as falsy and converted to None."""
+    monkeypatch.setenv('ACTOR_MAX_PAID_DATASET_ITEMS', '0')
+    config = ApifyConfiguration()
+    assert config.max_paid_dataset_items == 0
+
+
 def test_max_total_charge_usd_zero_is_preserved(monkeypatch: pytest.MonkeyPatch) -> None:
     """Test that max_total_charge_usd=0 is not treated as falsy and converted to None."""
     monkeypatch.setenv('ACTOR_MAX_TOTAL_CHARGE_USD', '0')
     config = ApifyConfiguration()
     assert config.max_total_charge_usd == Decimal(0)
 
 
+def test_max_paid_dataset_items_empty_string_becomes_none(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test that an empty env var for max_paid_dataset_items is converted to None."""
+    monkeypatch.setenv('ACTOR_MAX_PAID_DATASET_ITEMS', '')
+    config = ApifyConfiguration()
+    assert config.max_paid_dataset_items is None
+
+
 def test_max_total_charge_usd_empty_string_becomes_none(monkeypatch: pytest.MonkeyPatch) -> None:
     """Test that an empty env var for max_total_charge_usd is converted to None."""
     monkeypatch.setenv('ACTOR_MAX_TOTAL_CHARGE_USD', '')
@@ -384,6 +398,7 @@ def test_actor_storage_json_env_var(monkeypatch: pytest.MonkeyPatch) -> None:
     ('env_var', 'attr', 'expected'),
     [
         ('APIFY_TIMEOUT_AT', 'timeout_at', None),
+        ('ACTOR_MAX_PAID_DATASET_ITEMS', 'max_paid_dataset_items', None),
         ('ACTOR_MAX_TOTAL_CHARGE_USD', 'max_total_charge_usd', None),
         ('APIFY_USER_IS_PAYING', 'user_is_paying', False),
     ],