From a90a3c5a25ae084e0933e3a3df8482dac4a99ac3 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 3 Jun 2026 12:16:43 +0200 Subject: [PATCH] docs: version docs for v3.4 Adds the 3.4 docs snapshot that the release pipeline failed to create for v3.4.0 and v3.4.1 (the Version docs job was broken until #928). The snapshot replaces the 3.3 one, mirroring what the workflow does (one minor per major), and was generated from the release-v3 branch (v3.4.1) so the API reference documents the released v3 API rather than the v4-dev code on master. --- .../01_introduction/code/01_introduction.py | 0 .../code/actor_structure/__init__.py | 0 .../code/actor_structure/__main__.py | 0 .../code/actor_structure/main.py | 0 .../code/actor_structure/py.typed | 0 .../01_introduction/images/apify-create.gif | Bin .../01_introduction/index.mdx | 0 .../01_introduction/quick-start.mdx | 0 .../02_concepts/01_actor_lifecycle.mdx | 0 .../02_concepts/02_actor_input.mdx | 0 .../02_concepts/03_storages.mdx | 0 .../02_concepts/04_actor_events.mdx | 0 .../02_concepts/05_proxy_management.mdx | 4 +- .../06_interacting_with_other_actors.mdx | 0 .../02_concepts/07_webhooks.mdx | 0 .../02_concepts/08_access_apify_api.mdx | 0 .../02_concepts/09_logging.mdx | 0 .../02_concepts/10_configuration.mdx | 0 .../02_concepts/11_pay_per_event.mdx | 0 .../02_concepts/code/01_class_context.py | 0 .../02_concepts/code/01_class_manual.py | 0 .../02_concepts/code/01_context_manager.py | 0 .../code/01_error_handling_context.py | 0 .../code/01_error_handling_manual.py | 0 .../02_concepts/code/01_init_exit.py | 0 .../02_concepts/code/01_instance_context.py | 0 .../02_concepts/code/01_instance_manual.py | 0 .../02_concepts/code/01_reboot.py | 0 .../02_concepts/code/01_status_message.py | 0 .../02_concepts/code/02_input.py | 0 .../02_concepts/code/02_request_list.py | 0 .../02_concepts/code/03_dataset_exports.py | 0 .../02_concepts/code/03_dataset_read_write.py | 0 .../02_concepts/code/03_deleting_storages.py | 0 .../02_concepts/code/03_kvs_iterating.py | 0 .../02_concepts/code/03_kvs_public_url.py | 0 .../02_concepts/code/03_kvs_read_write.py | 0 .../02_concepts/code/03_opening_storages.py | 0 .../code/03_opening_storages_alias.py | 0 .../02_concepts/code/03_rq.py | 0 .../02_concepts/code/04_actor_events.py | 0 .../02_concepts/code/04_use_state.py | 0 .../02_concepts/code/05_apify_proxy.py | 0 .../02_concepts/code/05_apify_proxy_config.py | 1 + .../02_concepts/code/05_custom_proxy.py | 0 .../code/05_custom_proxy_function.py | 0 .../02_concepts/code/05_proxy_actor_input.py | 0 .../02_concepts/code/05_proxy_httpx.py | 0 .../02_concepts/code/05_proxy_rotation.py | 0 .../02_concepts/code/05_tiered_proxy.py | 0 .../02_concepts/code/06_interacting_abort.py | 0 .../02_concepts/code/06_interacting_call.py | 0 .../code/06_interacting_call_task.py | 0 .../code/06_interacting_metamorph.py | 0 .../02_concepts/code/06_interacting_start.py | 0 .../02_concepts/code/07_webhook.py | 0 .../02_concepts/code/07_webhook_preventing.py | 0 .../02_concepts/code/08_actor_client.py | 0 .../02_concepts/code/08_actor_new_client.py | 0 .../02_concepts/code/09_log_config.py | 0 .../02_concepts/code/09_logger_usage.py | 0 .../02_concepts/code/09_redirect_log.py | 0 .../code/09_redirect_log_existing_run.py | 0 .../02_concepts/code/10_config.py | 0 .../02_concepts/code/10_get_env.py | 0 .../02_concepts/code/10_platform_detection.py | 0 .../02_concepts/code/11_actor_charge.py | 0 .../02_concepts/code/11_advanced_charging.py | 0 .../02_concepts/code/11_charge_limit_check.py | 0 .../code/11_conditional_actor_charge.py | 0 .../03_guides/01_beautifulsoup_httpx.mdx | 0 .../03_guides/02_parsel_impit.mdx | 0 .../03_guides/03_playwright.mdx | 0 .../03_guides/04_selenium.mdx | 0 .../03_guides/05_crawlee.mdx | 0 .../03_guides/06_scrapy.mdx | 0 .../03_guides/07_running_webserver.mdx | 0 .../03_guides/code/01_beautifulsoup_httpx.py | 0 .../03_guides/code/02_parsel_impit.py | 0 .../03_guides/code/03_playwright.py | 0 .../03_guides/code/04_selenium.py | 0 .../code/05_crawlee_beautifulsoup.py | 0 .../03_guides/code/05_crawlee_parsel.py | 0 .../03_guides/code/05_crawlee_playwright.py | 0 .../03_guides/code/07_webserver.py | 0 .../code/scrapy_project/src/__init__.py | 0 .../code/scrapy_project/src/__main__.py | 0 .../code/scrapy_project/src/items.py | 0 .../03_guides/code/scrapy_project/src/main.py | 0 .../code/scrapy_project/src/py.typed | 0 .../code/scrapy_project/src/settings.py | 0 .../scrapy_project/src/spiders/__init__.py | 0 .../code/scrapy_project/src/spiders/py.typed | 0 .../code/scrapy_project/src/spiders/title.py | 0 .../04_upgrading/upgrading_to_v2.md | 0 .../04_upgrading/upgrading_to_v3.md | 0 .../api-packages.json | 2 +- .../api-typedoc.json | 61471 ++++++++-------- .../version-3.3-sidebars.json | 45 - .../version-3.4-sidebars.json | 45 + website/versions.json | 2 +- 101 files changed, 31109 insertions(+), 30461 deletions(-) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/code/01_introduction.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/code/actor_structure/__init__.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/code/actor_structure/__main__.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/code/actor_structure/main.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/code/actor_structure/py.typed (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/images/apify-create.gif (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/index.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/01_introduction/quick-start.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/01_actor_lifecycle.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/02_actor_input.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/03_storages.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/04_actor_events.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/05_proxy_management.mdx (91%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/06_interacting_with_other_actors.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/07_webhooks.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/08_access_apify_api.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/09_logging.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/10_configuration.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/11_pay_per_event.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_class_context.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_class_manual.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_context_manager.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_error_handling_context.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_error_handling_manual.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_init_exit.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_instance_context.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_instance_manual.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_reboot.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/01_status_message.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/02_input.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/02_request_list.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_dataset_exports.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_dataset_read_write.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_deleting_storages.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_kvs_iterating.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_kvs_public_url.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_kvs_read_write.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_opening_storages.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_opening_storages_alias.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/03_rq.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/04_actor_events.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/04_use_state.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_apify_proxy.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_apify_proxy_config.py (93%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_custom_proxy.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_custom_proxy_function.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_proxy_actor_input.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_proxy_httpx.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_proxy_rotation.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/05_tiered_proxy.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/06_interacting_abort.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/06_interacting_call.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/06_interacting_call_task.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/06_interacting_metamorph.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/06_interacting_start.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/07_webhook.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/07_webhook_preventing.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/08_actor_client.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/08_actor_new_client.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/09_log_config.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/09_logger_usage.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/09_redirect_log.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/09_redirect_log_existing_run.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/10_config.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/10_get_env.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/10_platform_detection.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/11_actor_charge.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/11_advanced_charging.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/11_charge_limit_check.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/02_concepts/code/11_conditional_actor_charge.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/01_beautifulsoup_httpx.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/02_parsel_impit.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/03_playwright.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/04_selenium.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/05_crawlee.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/06_scrapy.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/07_running_webserver.mdx (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/01_beautifulsoup_httpx.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/02_parsel_impit.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/03_playwright.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/04_selenium.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/05_crawlee_beautifulsoup.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/05_crawlee_parsel.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/05_crawlee_playwright.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/07_webserver.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/__init__.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/__main__.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/items.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/main.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/py.typed (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/settings.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/spiders/__init__.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/spiders/py.typed (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/03_guides/code/scrapy_project/src/spiders/title.py (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/04_upgrading/upgrading_to_v2.md (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/04_upgrading/upgrading_to_v3.md (100%) rename website/versioned_docs/{version-3.3 => version-3.4}/api-packages.json (79%) rename website/versioned_docs/{version-3.3 => version-3.4}/api-typedoc.json (90%) delete mode 100644 website/versioned_sidebars/version-3.3-sidebars.json create mode 100644 website/versioned_sidebars/version-3.4-sidebars.json diff --git a/website/versioned_docs/version-3.3/01_introduction/code/01_introduction.py b/website/versioned_docs/version-3.4/01_introduction/code/01_introduction.py similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/code/01_introduction.py rename to website/versioned_docs/version-3.4/01_introduction/code/01_introduction.py diff --git a/website/versioned_docs/version-3.3/01_introduction/code/actor_structure/__init__.py b/website/versioned_docs/version-3.4/01_introduction/code/actor_structure/__init__.py similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/code/actor_structure/__init__.py rename to website/versioned_docs/version-3.4/01_introduction/code/actor_structure/__init__.py diff --git a/website/versioned_docs/version-3.3/01_introduction/code/actor_structure/__main__.py b/website/versioned_docs/version-3.4/01_introduction/code/actor_structure/__main__.py similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/code/actor_structure/__main__.py rename to website/versioned_docs/version-3.4/01_introduction/code/actor_structure/__main__.py diff --git a/website/versioned_docs/version-3.3/01_introduction/code/actor_structure/main.py b/website/versioned_docs/version-3.4/01_introduction/code/actor_structure/main.py similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/code/actor_structure/main.py rename to website/versioned_docs/version-3.4/01_introduction/code/actor_structure/main.py diff --git a/website/versioned_docs/version-3.3/01_introduction/code/actor_structure/py.typed b/website/versioned_docs/version-3.4/01_introduction/code/actor_structure/py.typed similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/code/actor_structure/py.typed rename to website/versioned_docs/version-3.4/01_introduction/code/actor_structure/py.typed diff --git a/website/versioned_docs/version-3.3/01_introduction/images/apify-create.gif b/website/versioned_docs/version-3.4/01_introduction/images/apify-create.gif similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/images/apify-create.gif rename to website/versioned_docs/version-3.4/01_introduction/images/apify-create.gif diff --git a/website/versioned_docs/version-3.3/01_introduction/index.mdx b/website/versioned_docs/version-3.4/01_introduction/index.mdx similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/index.mdx rename to website/versioned_docs/version-3.4/01_introduction/index.mdx diff --git a/website/versioned_docs/version-3.3/01_introduction/quick-start.mdx b/website/versioned_docs/version-3.4/01_introduction/quick-start.mdx similarity index 100% rename from website/versioned_docs/version-3.3/01_introduction/quick-start.mdx rename to website/versioned_docs/version-3.4/01_introduction/quick-start.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/01_actor_lifecycle.mdx b/website/versioned_docs/version-3.4/02_concepts/01_actor_lifecycle.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/01_actor_lifecycle.mdx rename to website/versioned_docs/version-3.4/02_concepts/01_actor_lifecycle.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/02_actor_input.mdx b/website/versioned_docs/version-3.4/02_concepts/02_actor_input.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/02_actor_input.mdx rename to website/versioned_docs/version-3.4/02_concepts/02_actor_input.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/03_storages.mdx b/website/versioned_docs/version-3.4/02_concepts/03_storages.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/03_storages.mdx rename to website/versioned_docs/version-3.4/02_concepts/03_storages.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/04_actor_events.mdx b/website/versioned_docs/version-3.4/02_concepts/04_actor_events.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/04_actor_events.mdx rename to website/versioned_docs/version-3.4/02_concepts/04_actor_events.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/05_proxy_management.mdx b/website/versioned_docs/version-3.4/02_concepts/05_proxy_management.mdx similarity index 91% rename from website/versioned_docs/version-3.3/02_concepts/05_proxy_management.mdx rename to website/versioned_docs/version-3.4/02_concepts/05_proxy_management.mdx index fef7ca8c..d60763b5 100644 --- a/website/versioned_docs/version-3.3/02_concepts/05_proxy_management.mdx +++ b/website/versioned_docs/version-3.4/02_concepts/05_proxy_management.mdx @@ -56,13 +56,13 @@ When no `session_id` is provided, your custom proxy URLs are rotated round-robin ### Apify proxy configuration -With Apify Proxy, you can select specific proxy groups to use, or countries to connect from. This allows you to get better proxy performance after some initial research. +With Apify Proxy, you can select specific proxy groups to use, or countries to connect from. For even finer control, you can also target a specific subdivision (e.g. a US state) using the `subdivision_code` parameter alongside `country_code`. This allows you to get better proxy performance after some initial research. {ApifyProxyConfig} -Now your connections using proxy_url will use only Residential proxies from the US. Note that you must first get access to a proxy group before you are able to use it. You can find your available proxy groups in the [proxy dashboard](https://console.apify.com/proxy). +Now your connections using proxy_url will use only Residential proxies from California, US. The `subdivision_code` accepts a 1–3 character ISO 3166-2 code (e.g. `CA` for California) and currently only works for the United States (`country_code='US'`). Note that you must first get access to a proxy group before you are able to use it. You can find your available proxy groups in the [proxy dashboard](https://console.apify.com/proxy). If you don't specify any proxy groups, automatic proxy selection will be used. diff --git a/website/versioned_docs/version-3.3/02_concepts/06_interacting_with_other_actors.mdx b/website/versioned_docs/version-3.4/02_concepts/06_interacting_with_other_actors.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/06_interacting_with_other_actors.mdx rename to website/versioned_docs/version-3.4/02_concepts/06_interacting_with_other_actors.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/07_webhooks.mdx b/website/versioned_docs/version-3.4/02_concepts/07_webhooks.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/07_webhooks.mdx rename to website/versioned_docs/version-3.4/02_concepts/07_webhooks.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/08_access_apify_api.mdx b/website/versioned_docs/version-3.4/02_concepts/08_access_apify_api.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/08_access_apify_api.mdx rename to website/versioned_docs/version-3.4/02_concepts/08_access_apify_api.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/09_logging.mdx b/website/versioned_docs/version-3.4/02_concepts/09_logging.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/09_logging.mdx rename to website/versioned_docs/version-3.4/02_concepts/09_logging.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/10_configuration.mdx b/website/versioned_docs/version-3.4/02_concepts/10_configuration.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/10_configuration.mdx rename to website/versioned_docs/version-3.4/02_concepts/10_configuration.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/11_pay_per_event.mdx b/website/versioned_docs/version-3.4/02_concepts/11_pay_per_event.mdx similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/11_pay_per_event.mdx rename to website/versioned_docs/version-3.4/02_concepts/11_pay_per_event.mdx diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_class_context.py b/website/versioned_docs/version-3.4/02_concepts/code/01_class_context.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_class_context.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_class_context.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_class_manual.py b/website/versioned_docs/version-3.4/02_concepts/code/01_class_manual.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_class_manual.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_class_manual.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_context_manager.py b/website/versioned_docs/version-3.4/02_concepts/code/01_context_manager.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_context_manager.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_context_manager.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_error_handling_context.py b/website/versioned_docs/version-3.4/02_concepts/code/01_error_handling_context.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_error_handling_context.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_error_handling_context.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_error_handling_manual.py b/website/versioned_docs/version-3.4/02_concepts/code/01_error_handling_manual.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_error_handling_manual.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_error_handling_manual.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_init_exit.py b/website/versioned_docs/version-3.4/02_concepts/code/01_init_exit.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_init_exit.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_init_exit.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_instance_context.py b/website/versioned_docs/version-3.4/02_concepts/code/01_instance_context.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_instance_context.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_instance_context.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_instance_manual.py b/website/versioned_docs/version-3.4/02_concepts/code/01_instance_manual.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_instance_manual.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_instance_manual.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_reboot.py b/website/versioned_docs/version-3.4/02_concepts/code/01_reboot.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_reboot.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_reboot.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/01_status_message.py b/website/versioned_docs/version-3.4/02_concepts/code/01_status_message.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/01_status_message.py rename to website/versioned_docs/version-3.4/02_concepts/code/01_status_message.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/02_input.py b/website/versioned_docs/version-3.4/02_concepts/code/02_input.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/02_input.py rename to website/versioned_docs/version-3.4/02_concepts/code/02_input.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/02_request_list.py b/website/versioned_docs/version-3.4/02_concepts/code/02_request_list.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/02_request_list.py rename to website/versioned_docs/version-3.4/02_concepts/code/02_request_list.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_dataset_exports.py b/website/versioned_docs/version-3.4/02_concepts/code/03_dataset_exports.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_dataset_exports.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_dataset_exports.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_dataset_read_write.py b/website/versioned_docs/version-3.4/02_concepts/code/03_dataset_read_write.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_dataset_read_write.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_dataset_read_write.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_deleting_storages.py b/website/versioned_docs/version-3.4/02_concepts/code/03_deleting_storages.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_deleting_storages.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_deleting_storages.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_kvs_iterating.py b/website/versioned_docs/version-3.4/02_concepts/code/03_kvs_iterating.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_kvs_iterating.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_kvs_iterating.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_kvs_public_url.py b/website/versioned_docs/version-3.4/02_concepts/code/03_kvs_public_url.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_kvs_public_url.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_kvs_public_url.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_kvs_read_write.py b/website/versioned_docs/version-3.4/02_concepts/code/03_kvs_read_write.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_kvs_read_write.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_kvs_read_write.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_opening_storages.py b/website/versioned_docs/version-3.4/02_concepts/code/03_opening_storages.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_opening_storages.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_opening_storages.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_opening_storages_alias.py b/website/versioned_docs/version-3.4/02_concepts/code/03_opening_storages_alias.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_opening_storages_alias.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_opening_storages_alias.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/03_rq.py b/website/versioned_docs/version-3.4/02_concepts/code/03_rq.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/03_rq.py rename to website/versioned_docs/version-3.4/02_concepts/code/03_rq.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/04_actor_events.py b/website/versioned_docs/version-3.4/02_concepts/code/04_actor_events.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/04_actor_events.py rename to website/versioned_docs/version-3.4/02_concepts/code/04_actor_events.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/04_use_state.py b/website/versioned_docs/version-3.4/02_concepts/code/04_use_state.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/04_use_state.py rename to website/versioned_docs/version-3.4/02_concepts/code/04_use_state.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_apify_proxy.py b/website/versioned_docs/version-3.4/02_concepts/code/05_apify_proxy.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_apify_proxy.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_apify_proxy.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_apify_proxy_config.py b/website/versioned_docs/version-3.4/02_concepts/code/05_apify_proxy_config.py similarity index 93% rename from website/versioned_docs/version-3.3/02_concepts/code/05_apify_proxy_config.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_apify_proxy_config.py index 68f39e09..40dac738 100644 --- a/website/versioned_docs/version-3.3/02_concepts/code/05_apify_proxy_config.py +++ b/website/versioned_docs/version-3.4/02_concepts/code/05_apify_proxy_config.py @@ -8,6 +8,7 @@ async def main() -> None: proxy_cfg = await Actor.create_proxy_configuration( groups=['RESIDENTIAL'], country_code='US', + subdivision_code='CA', ) if not proxy_cfg: diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_custom_proxy.py b/website/versioned_docs/version-3.4/02_concepts/code/05_custom_proxy.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_custom_proxy.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_custom_proxy.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_custom_proxy_function.py b/website/versioned_docs/version-3.4/02_concepts/code/05_custom_proxy_function.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_custom_proxy_function.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_custom_proxy_function.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_proxy_actor_input.py b/website/versioned_docs/version-3.4/02_concepts/code/05_proxy_actor_input.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_proxy_actor_input.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_proxy_actor_input.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_proxy_httpx.py b/website/versioned_docs/version-3.4/02_concepts/code/05_proxy_httpx.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_proxy_httpx.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_proxy_httpx.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_proxy_rotation.py b/website/versioned_docs/version-3.4/02_concepts/code/05_proxy_rotation.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_proxy_rotation.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_proxy_rotation.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/05_tiered_proxy.py b/website/versioned_docs/version-3.4/02_concepts/code/05_tiered_proxy.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/05_tiered_proxy.py rename to website/versioned_docs/version-3.4/02_concepts/code/05_tiered_proxy.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/06_interacting_abort.py b/website/versioned_docs/version-3.4/02_concepts/code/06_interacting_abort.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/06_interacting_abort.py rename to website/versioned_docs/version-3.4/02_concepts/code/06_interacting_abort.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/06_interacting_call.py b/website/versioned_docs/version-3.4/02_concepts/code/06_interacting_call.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/06_interacting_call.py rename to website/versioned_docs/version-3.4/02_concepts/code/06_interacting_call.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/06_interacting_call_task.py b/website/versioned_docs/version-3.4/02_concepts/code/06_interacting_call_task.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/06_interacting_call_task.py rename to website/versioned_docs/version-3.4/02_concepts/code/06_interacting_call_task.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/06_interacting_metamorph.py b/website/versioned_docs/version-3.4/02_concepts/code/06_interacting_metamorph.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/06_interacting_metamorph.py rename to website/versioned_docs/version-3.4/02_concepts/code/06_interacting_metamorph.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/06_interacting_start.py b/website/versioned_docs/version-3.4/02_concepts/code/06_interacting_start.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/06_interacting_start.py rename to website/versioned_docs/version-3.4/02_concepts/code/06_interacting_start.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/07_webhook.py b/website/versioned_docs/version-3.4/02_concepts/code/07_webhook.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/07_webhook.py rename to website/versioned_docs/version-3.4/02_concepts/code/07_webhook.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/07_webhook_preventing.py b/website/versioned_docs/version-3.4/02_concepts/code/07_webhook_preventing.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/07_webhook_preventing.py rename to website/versioned_docs/version-3.4/02_concepts/code/07_webhook_preventing.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/08_actor_client.py b/website/versioned_docs/version-3.4/02_concepts/code/08_actor_client.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/08_actor_client.py rename to website/versioned_docs/version-3.4/02_concepts/code/08_actor_client.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/08_actor_new_client.py b/website/versioned_docs/version-3.4/02_concepts/code/08_actor_new_client.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/08_actor_new_client.py rename to website/versioned_docs/version-3.4/02_concepts/code/08_actor_new_client.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/09_log_config.py b/website/versioned_docs/version-3.4/02_concepts/code/09_log_config.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/09_log_config.py rename to website/versioned_docs/version-3.4/02_concepts/code/09_log_config.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/09_logger_usage.py b/website/versioned_docs/version-3.4/02_concepts/code/09_logger_usage.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/09_logger_usage.py rename to website/versioned_docs/version-3.4/02_concepts/code/09_logger_usage.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/09_redirect_log.py b/website/versioned_docs/version-3.4/02_concepts/code/09_redirect_log.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/09_redirect_log.py rename to website/versioned_docs/version-3.4/02_concepts/code/09_redirect_log.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/09_redirect_log_existing_run.py b/website/versioned_docs/version-3.4/02_concepts/code/09_redirect_log_existing_run.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/09_redirect_log_existing_run.py rename to website/versioned_docs/version-3.4/02_concepts/code/09_redirect_log_existing_run.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/10_config.py b/website/versioned_docs/version-3.4/02_concepts/code/10_config.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/10_config.py rename to website/versioned_docs/version-3.4/02_concepts/code/10_config.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/10_get_env.py b/website/versioned_docs/version-3.4/02_concepts/code/10_get_env.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/10_get_env.py rename to website/versioned_docs/version-3.4/02_concepts/code/10_get_env.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/10_platform_detection.py b/website/versioned_docs/version-3.4/02_concepts/code/10_platform_detection.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/10_platform_detection.py rename to website/versioned_docs/version-3.4/02_concepts/code/10_platform_detection.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/11_actor_charge.py b/website/versioned_docs/version-3.4/02_concepts/code/11_actor_charge.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/11_actor_charge.py rename to website/versioned_docs/version-3.4/02_concepts/code/11_actor_charge.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/11_advanced_charging.py b/website/versioned_docs/version-3.4/02_concepts/code/11_advanced_charging.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/11_advanced_charging.py rename to website/versioned_docs/version-3.4/02_concepts/code/11_advanced_charging.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/11_charge_limit_check.py b/website/versioned_docs/version-3.4/02_concepts/code/11_charge_limit_check.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/11_charge_limit_check.py rename to website/versioned_docs/version-3.4/02_concepts/code/11_charge_limit_check.py diff --git a/website/versioned_docs/version-3.3/02_concepts/code/11_conditional_actor_charge.py b/website/versioned_docs/version-3.4/02_concepts/code/11_conditional_actor_charge.py similarity index 100% rename from website/versioned_docs/version-3.3/02_concepts/code/11_conditional_actor_charge.py rename to website/versioned_docs/version-3.4/02_concepts/code/11_conditional_actor_charge.py diff --git a/website/versioned_docs/version-3.3/03_guides/01_beautifulsoup_httpx.mdx b/website/versioned_docs/version-3.4/03_guides/01_beautifulsoup_httpx.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/01_beautifulsoup_httpx.mdx rename to website/versioned_docs/version-3.4/03_guides/01_beautifulsoup_httpx.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/02_parsel_impit.mdx b/website/versioned_docs/version-3.4/03_guides/02_parsel_impit.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/02_parsel_impit.mdx rename to website/versioned_docs/version-3.4/03_guides/02_parsel_impit.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/03_playwright.mdx b/website/versioned_docs/version-3.4/03_guides/03_playwright.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/03_playwright.mdx rename to website/versioned_docs/version-3.4/03_guides/03_playwright.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/04_selenium.mdx b/website/versioned_docs/version-3.4/03_guides/04_selenium.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/04_selenium.mdx rename to website/versioned_docs/version-3.4/03_guides/04_selenium.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/05_crawlee.mdx b/website/versioned_docs/version-3.4/03_guides/05_crawlee.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/05_crawlee.mdx rename to website/versioned_docs/version-3.4/03_guides/05_crawlee.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/06_scrapy.mdx b/website/versioned_docs/version-3.4/03_guides/06_scrapy.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/06_scrapy.mdx rename to website/versioned_docs/version-3.4/03_guides/06_scrapy.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/07_running_webserver.mdx b/website/versioned_docs/version-3.4/03_guides/07_running_webserver.mdx similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/07_running_webserver.mdx rename to website/versioned_docs/version-3.4/03_guides/07_running_webserver.mdx diff --git a/website/versioned_docs/version-3.3/03_guides/code/01_beautifulsoup_httpx.py b/website/versioned_docs/version-3.4/03_guides/code/01_beautifulsoup_httpx.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/01_beautifulsoup_httpx.py rename to website/versioned_docs/version-3.4/03_guides/code/01_beautifulsoup_httpx.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/02_parsel_impit.py b/website/versioned_docs/version-3.4/03_guides/code/02_parsel_impit.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/02_parsel_impit.py rename to website/versioned_docs/version-3.4/03_guides/code/02_parsel_impit.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/03_playwright.py b/website/versioned_docs/version-3.4/03_guides/code/03_playwright.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/03_playwright.py rename to website/versioned_docs/version-3.4/03_guides/code/03_playwright.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/04_selenium.py b/website/versioned_docs/version-3.4/03_guides/code/04_selenium.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/04_selenium.py rename to website/versioned_docs/version-3.4/03_guides/code/04_selenium.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/05_crawlee_beautifulsoup.py b/website/versioned_docs/version-3.4/03_guides/code/05_crawlee_beautifulsoup.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/05_crawlee_beautifulsoup.py rename to website/versioned_docs/version-3.4/03_guides/code/05_crawlee_beautifulsoup.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/05_crawlee_parsel.py b/website/versioned_docs/version-3.4/03_guides/code/05_crawlee_parsel.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/05_crawlee_parsel.py rename to website/versioned_docs/version-3.4/03_guides/code/05_crawlee_parsel.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/05_crawlee_playwright.py b/website/versioned_docs/version-3.4/03_guides/code/05_crawlee_playwright.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/05_crawlee_playwright.py rename to website/versioned_docs/version-3.4/03_guides/code/05_crawlee_playwright.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/07_webserver.py b/website/versioned_docs/version-3.4/03_guides/code/07_webserver.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/07_webserver.py rename to website/versioned_docs/version-3.4/03_guides/code/07_webserver.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/__init__.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/__init__.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/__init__.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/__init__.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/__main__.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/__main__.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/__main__.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/__main__.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/items.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/items.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/items.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/items.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/main.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/main.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/main.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/main.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/py.typed b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/py.typed similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/py.typed rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/py.typed diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/settings.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/settings.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/settings.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/settings.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/__init__.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/__init__.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/__init__.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/__init__.py diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/py.typed b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/py.typed similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/py.typed rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/py.typed diff --git a/website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/title.py b/website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/title.py similarity index 100% rename from website/versioned_docs/version-3.3/03_guides/code/scrapy_project/src/spiders/title.py rename to website/versioned_docs/version-3.4/03_guides/code/scrapy_project/src/spiders/title.py diff --git a/website/versioned_docs/version-3.3/04_upgrading/upgrading_to_v2.md b/website/versioned_docs/version-3.4/04_upgrading/upgrading_to_v2.md similarity index 100% rename from website/versioned_docs/version-3.3/04_upgrading/upgrading_to_v2.md rename to website/versioned_docs/version-3.4/04_upgrading/upgrading_to_v2.md diff --git a/website/versioned_docs/version-3.3/04_upgrading/upgrading_to_v3.md b/website/versioned_docs/version-3.4/04_upgrading/upgrading_to_v3.md similarity index 100% rename from website/versioned_docs/version-3.3/04_upgrading/upgrading_to_v3.md rename to website/versioned_docs/version-3.4/04_upgrading/upgrading_to_v3.md diff --git a/website/versioned_docs/version-3.3/api-packages.json b/website/versioned_docs/version-3.4/api-packages.json similarity index 79% rename from website/versioned_docs/version-3.3/api-packages.json rename to website/versioned_docs/version-3.4/api-packages.json index 4672c024..765ea7e7 100644 --- a/website/versioned_docs/version-3.3/api-packages.json +++ b/website/versioned_docs/version-3.4/api-packages.json @@ -1 +1 @@ -[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":".","packagePath":".","packageSlug":".","packageName":"apify-sdk-python"}] \ No newline at end of file +[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":".","packagePath":".","packageSlug":".","packageName":"apify-sdk-python-website"}] \ No newline at end of file diff --git a/website/versioned_docs/version-3.3/api-typedoc.json b/website/versioned_docs/version-3.4/api-typedoc.json similarity index 90% rename from website/versioned_docs/version-3.3/api-typedoc.json rename to website/versioned_docs/version-3.4/api-typedoc.json index b6e5c7f9..d8c92517 100644 --- a/website/versioned_docs/version-3.3/api-typedoc.json +++ b/website/versioned_docs/version-3.4/api-typedoc.json @@ -15,17 +15,17 @@ "flags": {}, "groups": [], "id": 1, - "module": "_consts", - "name": "EVENT_LISTENERS_TIMEOUT", + "module": "__init__", + "name": "__version__", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_consts.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 6 + "fileName": "/src/apify/__init__.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "type": { @@ -48,182 +48,17 @@ "flags": {}, "groups": [], "id": 2, - "module": "_consts", - "name": "BASE64_REGEXP", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_consts.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 8 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 3, - "module": "_consts", - "name": "ENCRYPTED_STRING_VALUE_PREFIX", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_consts.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 9 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4, - "module": "_consts", - "name": "ENCRYPTED_JSON_VALUE_PREFIX", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_consts.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 10 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 5, - "module": "_consts", - "name": "ENCRYPTED_INPUT_VALUE_REGEXP", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_consts.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 11 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 6, - "module": "_charging", - "name": "run_validator", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 7, - "module": "_charging", - "name": "DEFAULT_DATASET_ITEM_EVENT", + "module": "_actor", + "name": "MainReturnType", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 33 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 56 } ], "type": { @@ -231,93 +66,10 @@ "type": "reference" } }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 8, - "module": "_charging", - "name": "charging_manager_ctx", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ChargingManager", - "target": "9" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, { "kind": 128, "kindString": "Class", "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." - } - ] - }, - "flags": {}, - "groups": [], - "id": 10, - "module": "_charging", - "name": "charge_lock", - "parsedDocstring": { - "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55 - } - ], - "type": { - "name": "ReentrantLock", - "type": "reference", - "target": "392" - } - }, { "kind": 2048, "kindString": "Method", @@ -326,29 +78,34 @@ "summary": [ { "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + "text": "Initialize a new instance.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 11, - "module": "_charging", - "name": "charge", + "id": 4, + "module": "_actor", + "name": "__init__", "parsedDocstring": { - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", + "text": "Initialize a new instance.\n", "args": { - "event_name": "Name of the event to be charged for.", - "count": "Number of events to charge for." + "configuration": "The Actor configuration to use. If not provided, a default configuration is created.", + "configure_logging": "Whether to set up the default logging configuration.", + "exit_process": "Whether the Actor should call `sys.exit` when the context manager exits.\nDefaults to True, except in IPython, Pytest, and Scrapy environments.", + "exit_code": "The exit code the Actor should use when exiting.", + "status_message": "Final status message to display upon Actor termination.", + "event_listeners_timeout": "Maximum time to wait for Actor event listeners to complete before exiting.", + "cleanup_timeout": "Maximum time to wait for cleanup tasks to finish." } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 58 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 105 } ], "type": { @@ -361,38 +118,71 @@ "summary": [ { "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + "text": "Initialize a new instance.\n" } ] }, "flags": {}, - "id": 12, + "id": 5, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "charge", + "modifiers": [], + "name": "__init__", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Name of the event to be charged for." + "text": "The Actor configuration to use. If not provided, a default configuration is created." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": false }, - "id": 13, + "id": 6, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "configuration", "type": { - "name": "str", + "name": "Configuration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Configuration", + "target": "328" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to set up the default logging configuration." + } + ] + }, + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 7, + "kind": 32768, + "kindString": "Parameter", + "name": "configure_logging", + "type": { + "name": "bool", "type": "reference" } }, @@ -401,34 +191,151 @@ "summary": [ { "kind": "text", - "text": "Number of events to charge for." + "text": "Whether the Actor should call `sys.exit` when the context manager exits.\nDefaults to True, except in IPython, Pytest, and Scrapy environments." } ] }, - "defaultValue": "1", + "defaultValue": "None", "flags": { "isOptional": true, - "keyword-only": false + "keyword-only": true }, - "id": 14, + "id": 8, "kind": 32768, "kindString": "Parameter", - "name": "count", + "name": "exit_process", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exit code the Actor should use when exiting." + } + ] + }, + "defaultValue": "0", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 9, + "kind": 32768, + "kindString": "Parameter", + "name": "exit_code", "type": { "name": "int", "type": "reference" } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Final status message to display upon Actor termination." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 10, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum time to wait for Actor event listeners to complete before exiting." + } + ] + }, + "defaultValue": "EVENT_LISTENERS_TIMEOUT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 11, + "kind": 32768, + "kindString": "Parameter", + "name": "event_listeners_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum time to wait for cleanup tasks to finish." + } + ] + }, + "defaultValue": "timedelta(seconds=30)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 12, + "kind": 32768, + "kindString": "Parameter", + "name": "cleanup_timeout", + "type": { + "name": "timedelta", + "type": "reference" + } } ], "type": { - "name": "ChargeResult", - "type": "reference", - "target": "37" - }, - "overwrites": { - "name": "ChargingManager.charge", - "target": 11, - "type": "reference" + "name": "None", + "type": "literal", + "value": null } } ] @@ -441,25 +348,25 @@ "summary": [ { "kind": "text", - "text": "Calculate the total amount of money charged for pay-per-event events so far." + "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 15, - "module": "_charging", - "name": "calculate_total_charged_amount", + "id": 13, + "module": "_actor", + "name": "__aenter__", "parsedDocstring": { - "text": "Calculate the total amount of money charged for pay-per-event events so far." + "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 68 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 155 } ], "type": { @@ -472,24 +379,21 @@ "summary": [ { "kind": "text", - "text": "Calculate the total amount of money charged for pay-per-event events so far." + "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." } ] }, "flags": {}, - "id": 16, + "id": 14, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "calculate_total_charged_amount", + "modifiers": [ + "async" + ], + "name": "__aenter__", "parameters": [], "type": { - "name": "Decimal", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.calculate_total_charged_amount", - "target": 15, + "name": "Self", "type": "reference" } } @@ -503,28 +407,25 @@ "summary": [ { "kind": "text", - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" + "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 17, - "module": "_charging", - "name": "calculate_max_event_charge_count_within_limit", + "id": 15, + "module": "_actor", + "name": "__aexit__", "parsedDocstring": { - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n", - "args": { - "event_name": "Name of the inspected event." - } + "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 212 } ], "type": { @@ -537,26 +438,74 @@ "summary": [ { "kind": "text", - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" + "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." } ] }, "flags": {}, - "id": 18, + "id": 16, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "calculate_max_event_charge_count_within_limit", + "modifiers": [ + "async" + ], + "name": "__aexit__", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the inspected event." - } + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 17, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ] + }, + { + "type": "literal", + "value": null + } ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false }, + "id": 18, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_value", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { "flags": { "isOptional": false, "keyword-only": false @@ -564,31 +513,27 @@ "id": 19, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "exc_traceback", "type": { - "name": "str", - "type": "reference" + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - }, - "overwrites": { - "name": "ChargingManager.calculate_max_event_charge_count_within_limit", - "target": 17, - "type": "reference" + "name": "None", + "type": "literal", + "value": null } } ] @@ -601,7 +546,7 @@ "summary": [ { "kind": "text", - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." + "text": "" } ] }, @@ -609,17 +554,17 @@ "flags": {}, "groups": [], "id": 20, - "module": "_charging", - "name": "get_pricing_info", + "module": "_actor", + "name": "__repr__", "parsedDocstring": { - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 280 } ], "type": { @@ -628,29 +573,15 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." - } - ] - }, "flags": {}, "id": 21, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "get_pricing_info", + "name": "__repr__", "parameters": [], "type": { - "name": "ActorPricingInfo", - "type": "reference", - "target": "41" - }, - "overwrites": { - "name": "ChargingManager.get_pricing_info", - "target": 20, + "name": "str", "type": "reference" } } @@ -664,7 +595,7 @@ "summary": [ { "kind": "text", - "text": "Get the number of events with the given name that were charged so far.\n" + "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." } ] }, @@ -672,20 +603,17 @@ "flags": {}, "groups": [], "id": 22, - "module": "_charging", - "name": "get_charged_event_count", + "module": "_actor", + "name": "__call__", "parsedDocstring": { - "text": "Get the number of events with the given name that were charged so far.\n", - "args": { - "event_name": "Name of the inspected event." - } + "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 84 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 286 } ], "type": { @@ -698,7 +626,7 @@ "summary": [ { "kind": "text", - "text": "Get the number of events with the given name that were charged so far.\n" + "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." } ] }, @@ -707,250 +635,237 @@ "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "get_charged_event_count", + "name": "__call__", "parameters": [ { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 24, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "Name of the inspected event." + "type": "reference", + "name": "Configuration", + "target": "328" + }, + { + "type": "literal", + "value": null } ] + } + }, + { + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "configure_logging", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 24, + "id": 26, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "exit_process", "type": { - "name": "str", + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "0", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "exit_code", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "EVENT_LISTENERS_TIMEOUT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 28, + "kind": 32768, + "kindString": "Parameter", + "name": "event_listeners_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 29, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "timedelta(seconds=30)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 30, + "kind": 32768, + "kindString": "Parameter", + "name": "cleanup_timeout", + "type": { + "name": "timedelta", "type": "reference" } } ], "type": { - "name": "int", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.get_charged_event_count", - "target": 22, + "name": "Self", "type": "reference" } } ] }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get the configured maximum total charge for this Actor run." + "text": "Logger configured for this Actor." } ] }, - "decorations": [], + "decorations": [ + { + "name": "property" + } + ], "flags": {}, "groups": [], - "id": 25, - "module": "_charging", - "name": "get_max_total_charge_usd", + "id": 31, + "module": "_actor", + "name": "log", "parsedDocstring": { - "text": "Get the configured maximum total charge for this Actor run." + "text": "Logger configured for this Actor." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 312 } ], "type": { - "name": "Undefined", + "name": "logging.Logger", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the configured maximum total charge for this Actor run." - } - ] - }, - "flags": {}, - "id": 26, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_max_total_charge_usd", - "parameters": [], - "type": { - "name": "Decimal", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.get_max_total_charge_usd", - "target": 25, - "type": "reference" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" + "text": "The exit code the Actor will use when exiting." } ] }, - "decorations": [], + "decorations": [ + { + "name": "property" + } + ], "flags": {}, "groups": [], - "id": 27, - "module": "_charging", - "name": "compute_push_data_limit", + "id": 32, + "module": "_actor", + "name": "exit_code", "parsedDocstring": { - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n", - "args": { - "items_count": "The number of items to be pushed.", - "event_name": "The explicit event name to charge for each item.", - "is_default_dataset": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" - }, - "returns": "Max number of items that can be pushed within the budget." + "text": "The exit code the Actor will use when exiting." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 94 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 317 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Max number of items that can be pushed within the budget." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" - } - ] - }, - "flags": {}, - "id": 28, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "compute_push_data_limit", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to be pushed." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 29, - "kind": 32768, - "kindString": "Parameter", - "name": "items_count", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The explicit event name to charge for each item." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 30, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 31, - "kind": 32768, - "kindString": "Parameter", - "name": "is_default_dataset", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "int", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.compute_push_data_limit", - "target": 27, - "type": "reference" - } - } - ] + } }, { "kind": 2048, @@ -960,25 +875,30 @@ "summary": [ { "kind": "text", - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "args": ".setter", + "name": "exit_code" + } + ], "flags": {}, "groups": [], - "id": 32, - "module": "_charging", - "name": "is_event_charge_limit_reached", + "id": 33, + "module": "_actor", + "name": "exit_code", "parsedDocstring": { - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 116 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 322 } ], "type": { @@ -987,75 +907,116 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." - } - ] - }, "flags": {}, - "id": 33, + "id": 34, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "is_event_charge_limit_reached", + "name": "exit_code", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 34, + "id": 35, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "value", "type": { - "name": "str", + "name": "int", "type": "reference" } } ], "type": { - "name": "bool", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.is_event_charge_limit_reached", - "target": 32, - "type": "reference" + "name": "None", + "type": "literal", + "value": null } } ] }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Compute the maximum number of events of each type that can be charged within the current budget." + "text": "The final status message that the Actor will display upon termination." } ] }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 35, - "module": "_charging", - "name": "compute_chargeable", + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 36, + "module": "_actor", + "name": "status_message", "parsedDocstring": { - "text": "Compute the maximum number of events of each type that can be charged within the current budget." + "text": "The final status message that the Actor will display upon termination." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 119 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 326 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": ".setter", + "name": "status_message" + } + ], + "flags": {}, + "groups": [], + "id": 37, + "module": "_actor", + "name": "status_message", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 331 } ], "type": { @@ -1064,35 +1025,29 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Compute the maximum number of events of each type that can be charged within the current budget." - } - ] - }, "flags": {}, - "id": 36, + "id": 38, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "compute_chargeable", - "parameters": [], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "status_message", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false }, - { + "id": 39, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "str" }, { "type": "literal", @@ -1100,84 +1055,16 @@ } ] } - ] - }, - "overwrites": { - "name": "ChargingManager.compute_chargeable", - "target": 35, - "type": "reference" + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provides fine-grained access to pay-per-event functionality.\n\nThe ChargingManager allows you to charge for specific events in your Actor when using\nthe pay-per-event pricing model. This enables precise cost control and transparent\nbilling for different operations within your Actor.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors/publishing/monetize" - } - ] - }, - "decorations": [ - { - "args": "('Charging')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 17, - 15, - 11, - 35, - 27, - 22, - 25, - 20, - 32 - ], - "title": "Methods" }, - { - "children": [ - 10 - ], - "title": "Properties" - } - ], - "id": 9, - "module": "_charging", - "name": "ChargingManager", - "parsedDocstring": { - "text": "Provides fine-grained access to pay-per-event functionality.\n\nThe ChargingManager allows you to charge for specific events in your Actor when using\nthe pay-per-event pricing model. This enables precise cost control and transparent\nbilling for different operations within your Actor.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors/publishing/monetize" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "ChargingManagerImplementation", - "target": "46", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ { "kind": 1024, "kindString": "Property", @@ -1186,476 +1073,386 @@ "summary": [ { "kind": "text", - "text": "If true, no more events of this type can be charged within the limit." + "text": "Asynchronous Apify client for interacting with the Apify API." } ] }, - "flags": {}, - "groups": [], - "id": 38, - "module": "_charging", - "name": "event_charge_limit_reached", - "parsedDocstring": { - "text": "If true, no more events of this type can be charged within the limit." - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 128 + "name": "property" } ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total amount of charged events - may be lower than the requested amount." - } - ] - }, "flags": {}, "groups": [], - "id": 39, - "module": "_charging", - "name": "charged_count", + "id": 40, + "module": "_actor", + "name": "apify_client", "parsedDocstring": { - "text": "Total amount of charged events - may be lower than the requested amount." + "text": "Asynchronous Apify client for interacting with the Apify API." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 131 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 335 } ], "type": { - "name": "int", + "name": "ApifyClientAsync", "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "How many events of each known type can still be charged within the limit." + "text": "Actor configuration, uses the default instance if not explicitly set." } ] }, + "decorations": [ + { + "name": "cached_property" + } + ], "flags": {}, "groups": [], - "id": 40, - "module": "_charging", - "name": "chargeable_within_limit", + "id": 41, + "module": "_actor", + "name": "configuration", "parsedDocstring": { - "text": "How many events of each known type can still be charged within the limit." + "text": "Actor configuration, uses the default instance if not explicitly set." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 134 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 342 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Actor configuration, uses the default instance if not explicitly set." } ] + }, + "flags": {}, + "id": 42, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "configuration", + "parameters": [], + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of the `ChargingManager.charge` method." - } - ] - }, - "decorations": [ - { - "args": "('Charging')", - "name": "docs_group" + } + ] }, { - "args": "(frozen=True)", - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 40, - 39, - 38 - ], - "title": "Properties" - } - ], - "id": 37, - "module": "_charging", - "name": "ChargeResult", - "parsedDocstring": { - "text": "Result of the `ChargingManager.charge` method." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 125 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The currently effective pricing model." + "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." } ] }, - "flags": {}, - "groups": [], - "id": 42, - "module": "_charging", - "name": "pricing_model", - "parsedDocstring": { - "text": "The currently effective pricing model." - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 143 + "name": "cached_property" } ], - "type": { - "name": "PricingModel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "PricingModel", - "target": "95" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A configured limit for the total charged amount - if you exceed it, you won't receive more money than this." - } - ] - }, "flags": {}, "groups": [], "id": 43, - "module": "_charging", - "name": "max_total_charge_usd", + "module": "_actor", + "name": "event_manager", "parsedDocstring": { - "text": "A configured limit for the total charged amount - if you exceed it, you won't receive more money than this." + "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 146 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 363 } ], "type": { - "name": "Decimal", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." + } + ] + }, + "flags": {}, + "id": 44, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "event_manager", + "parameters": [], + "type": { + "name": "EventManager", + "type": "reference" + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "A shortcut - true if the Actor runs with the pay-per-event pricing model." + "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 44, - "module": "_charging", - "name": "is_pay_per_event", + "id": 45, + "module": "_actor", + "name": "init", "parsedDocstring": { - "text": "A shortcut - true if the Actor runs with the pay-per-event pricing model." + "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 149 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 428 } ], "type": { - "name": "bool", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." + } + ] + }, + "flags": {}, + "id": 46, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "init", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Price of every known event type." + "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 45, - "module": "_charging", - "name": "per_event_prices", + "id": 47, + "module": "_actor", + "name": "exit", "parsedDocstring": { - "text": "Price of every known event type." + "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n", + "args": { + "exit_code": "The exit code the Actor should use when exiting.", + "status_message": "Final status message to display upon Actor termination.", + "event_listeners_timeout": "Maximum time to wait for Actor event listeners to complete before exiting.", + "cleanup_timeout": "Maximum time to wait for cleanup tasks to finish." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 152 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 435 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n" + } + ] }, - { - "type": "reference", - "name": "Decimal" - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of the `ChargingManager.get_pricing_info` method." - } - ] - }, - "decorations": [ - { - "args": "('Charging')", - "name": "docs_group" - }, - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 44, - 43, - 45, - 42 - ], - "title": "Properties" - } - ], - "id": 41, - "module": "_charging", - "name": "ActorPricingInfo", - "parsedDocstring": { - "text": "Result of the `ChargingManager.get_pricing_info` method." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 47, - "module": "_charging", - "name": "LOCAL_CHARGING_LOG_DATASET_NAME", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 159 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 48, - "module": "_charging", - "name": "__init__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 161 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { "flags": {}, - "id": 49, + "id": 48, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "modifiers": [ + "async" + ], + "name": "exit", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exit code the Actor should use when exiting." + } + ] + }, + "defaultValue": "0", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true + }, + "id": 49, + "kind": 32768, + "kindString": "Parameter", + "name": "exit_code", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Final status message to display upon Actor termination." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true }, "id": 50, "kind": 32768, "kindString": "Parameter", - "name": "configuration", + "name": "status_message", "type": { - "name": "Configuration", - "type": "reference", - "target": "319" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum time to wait for Actor event listeners to complete before exiting." + } + ] + }, + "defaultValue": "EVENT_LISTENERS_TIMEOUT", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, "id": 51, "kind": 32768, "kindString": "Parameter", - "name": "client", + "name": "event_listeners_timeout", "type": { - "name": "ApifyClientAsync", + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum time to wait for cleanup tasks to finish." + } + ] + }, + "defaultValue": "timedelta(seconds=30)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 52, + "kind": 32768, + "kindString": "Parameter", + "name": "cleanup_timeout", + "type": { + "name": "timedelta", "type": "reference" } } @@ -1676,25 +1473,30 @@ "summary": [ { "kind": "text", - "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 52, - "module": "_charging", - "name": "__aenter__", + "id": 53, + "module": "_actor", + "name": "fail", "parsedDocstring": { - "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n", + "args": { + "exit_code": "The exit code with which the Actor should fail (defaults to `1`).", + "exception": "The exception with which the Actor failed.", + "status_message": "The final status message that the Actor should display." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 459 } ], "type": { @@ -1707,110 +1509,60 @@ "summary": [ { "kind": "text", - "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n" } ] }, "flags": {}, - "id": 53, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aenter__", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 54, - "module": "_charging", - "name": "__aexit__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 240 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 55, + "id": 54, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "__aexit__", + "name": "fail", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exit code with which the Actor should fail (defaults to `1`)." + } + ] + }, + "defaultValue": "1", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 56, + "id": 55, "kind": 32768, "kindString": "Parameter", - "name": "exc_type", + "name": "exit_code", "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ] - }, - { - "type": "literal", - "value": null - } - ] + "name": "int", + "type": "reference" } }, { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exception with which the Actor failed." + } + ] + }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 57, + "id": 56, "kind": 32768, "kindString": "Parameter", - "name": "exc_value", + "name": "exception", "type": { "name": "BaseException | None", "type": "union", @@ -1827,21 +1579,30 @@ } }, { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final status message that the Actor should display." + } + ] + }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 58, + "id": 57, "kind": 32768, "kindString": "Parameter", - "name": "exc_traceback", + "name": "status_message", "type": { - "name": "TracebackType | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "TracebackType" + "name": "str" }, { "type": "literal", @@ -1867,29 +1628,32 @@ "summary": [ { "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 59, - "module": "_charging", - "name": "charge", + "id": 58, + "module": "_actor", + "name": "new_client", "parsedDocstring": { - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", + "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n", "args": { - "event_name": "Name of the event to be charged for.", - "count": "Number of events to charge for." + "token": "The Apify API token.", + "api_url": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com.", + "max_retries": "How many times to retry a failed request at most.", + "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", + "timeout": "The socket timeout of the HTTP requests sent to the Apify API." } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 253 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 485 } ], "type": { @@ -1902,39 +1666,48 @@ "summary": [ { "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n" } ] }, "flags": {}, - "id": 12, + "id": 59, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "charge", + "modifiers": [], + "name": "new_client", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Name of the event to be charged for." + "text": "The Apify API token." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 13, + "id": 60, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "token", "type": { - "name": "str", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -1942,42 +1715,140 @@ "summary": [ { "kind": "text", - "text": "Number of events to charge for." + "text": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com." } ] }, - "defaultValue": "1", + "defaultValue": "None", "flags": { "isOptional": true, - "keyword-only": false + "keyword-only": true }, - "id": 14, + "id": 61, "kind": 32768, "kindString": "Parameter", - "name": "count", + "name": "api_url", "type": { - "name": "int", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many times to retry a failed request at most." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 62, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 63, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The socket timeout of the HTTP requests sent to the Apify API." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 64, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "ChargeResult", - "type": "reference", - "target": "37" - }, - "overwrites": { - "name": "ChargingManager.charge", - "target": 11, + "name": "ApifyClientAsync", "type": "reference" } } - ], - "overwrites": { - "name": "ChargingManager.charge", - "target": 11, - "type": "reference" - } + ] }, { "kind": 2048, @@ -1987,95 +1858,36 @@ "summary": [ { "kind": "text", - "text": "Calculate the total amount of money charged for pay-per-event events so far." + "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n" } ] }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 63, - "module": "_charging", - "name": "calculate_total_charged_amount", - "parsedDocstring": { - "text": "Calculate the total amount of money charged for pay-per-event events so far." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 342 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "decorations": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculate the total amount of money charged for pay-per-event events so far." - } - ] - }, - "flags": {}, - "id": 16, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "calculate_total_charged_amount", - "parameters": [], - "type": { - "name": "Decimal", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.calculate_total_charged_amount", - "target": 15, - "type": "reference" - } + "name": "_ensure_context" } ], - "overwrites": { - "name": "ChargingManager.calculate_total_charged_amount", - "target": 15, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" - } - ] - }, - "decorations": [], "flags": {}, "groups": [], "id": 65, - "module": "_charging", - "name": "calculate_max_event_charge_count_within_limit", + "module": "_actor", + "name": "open_dataset", "parsedDocstring": { - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n", + "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n", "args": { - "event_name": "Name of the inspected event." - } + "id": "The ID of the dataset to open. If provided, searches for existing dataset by ID.\nMutually exclusive with name and alias.", + "name": "The name of the dataset to open (global scope, persists across runs).\nMutually exclusive with id and alias.", + "alias": "The alias of the dataset to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", + "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" + }, + "returns": "An instance of the `Dataset` class for the given ID or name." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 349 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 524 } ], "type": { @@ -2085,230 +1897,162 @@ "signatures": [ { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "An instance of the `Dataset` class for the given ID or name." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" + "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n" } ] }, "flags": {}, - "id": 18, + "id": 66, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "calculate_max_event_charge_count_within_limit", + "modifiers": [ + "async" + ], + "name": "open_dataset", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Name of the inspected event." + "text": "The ID of the dataset to open. If provided, searches for existing dataset by ID.\nMutually exclusive with name and alias." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 19, + "id": 67, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "id", "type": { - "name": "str", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - } - ], - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The alias of the dataset to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." + } + ] }, - { - "type": "literal", - "value": null - } - ] - }, - "overwrites": { - "name": "ChargingManager.calculate_max_event_charge_count_within_limit", - "target": 17, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ChargingManager.calculate_max_event_charge_count_within_limit", - "target": 17, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 68, - "module": "_charging", - "name": "get_pricing_info", - "parsedDocstring": { - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 359 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 68, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "id": 21, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_pricing_info", - "parameters": [], - "type": { - "name": "ActorPricingInfo", - "type": "reference", - "target": "41" - }, - "overwrites": { - "name": "ChargingManager.get_pricing_info", - "target": 20, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ChargingManager.get_pricing_info", - "target": 20, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the number of events with the given name that were charged so far.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 70, - "module": "_charging", - "name": "get_charged_event_count", - "parsedDocstring": { - "text": "Get the number of events with the given name that were charged so far.\n", - "args": { - "event_name": "Name of the inspected event." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 372 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the number of events with the given name that were charged so far.\n" + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the dataset to open (global scope, persists across runs).\nMutually exclusive with id and alias." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 69, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "id": 23, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_charged_event_count", - "parameters": [ + }, { "comment": { "summary": [ { "kind": "text", - "text": "Name of the inspected event." + "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" } ] }, + "defaultValue": "False", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 24, + "id": 70, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "force_cloud", "type": { - "name": "str", + "name": "bool", "type": "reference" } } ], "type": { - "name": "int", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.get_charged_event_count", - "target": 22, + "name": "Dataset", "type": "reference" } } - ], - "overwrites": { - "name": "ChargingManager.get_charged_event_count", - "target": 22, - "type": "reference" - } + ] }, { "kind": 2048, @@ -2318,98 +2062,36 @@ "summary": [ { "kind": "text", - "text": "Get the configured maximum total charge for this Actor run." + "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n" } ] }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 73, - "module": "_charging", - "name": "get_max_total_charge_usd", - "parsedDocstring": { - "text": "Get the configured maximum total charge for this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 377 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "decorations": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the configured maximum total charge for this Actor run." - } - ] - }, - "flags": {}, - "id": 26, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_max_total_charge_usd", - "parameters": [], - "type": { - "name": "Decimal", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.get_max_total_charge_usd", - "target": 25, - "type": "reference" - } + "name": "_ensure_context" } ], - "overwrites": { - "name": "ChargingManager.get_max_total_charge_usd", - "target": 25, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" - } - ] - }, - "decorations": [], "flags": {}, "groups": [], - "id": 75, - "module": "_charging", - "name": "compute_push_data_limit", + "id": 71, + "module": "_actor", + "name": "open_key_value_store", "parsedDocstring": { - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n", + "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n", "args": { - "items_count": "The number of items to be pushed.", - "event_name": "The explicit event name to charge for each item.", - "is_default_dataset": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + "id": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias.", + "name": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias.", + "alias": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", + "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" }, - "returns": "Max number of items that can be pushed within the budget." + "returns": "An instance of the `KeyValueStore` class for the given ID or name." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 381 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 559 } ], "type": { @@ -2424,7 +2106,7 @@ "content": [ { "kind": "text", - "text": "Max number of items that can be pushed within the budget." + "text": "An instance of the `KeyValueStore` class for the given ID or name." } ], "tag": "@returns" @@ -2433,37 +2115,50 @@ "summary": [ { "kind": "text", - "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" + "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n" } ] }, "flags": {}, - "id": 28, + "id": 72, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "compute_push_data_limit", + "modifiers": [ + "async" + ], + "name": "open_key_value_store", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "The number of items to be pushed." + "text": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 29, + "id": 73, "kind": 32768, "kindString": "Parameter", - "name": "items_count", + "name": "id", "type": { - "name": "int", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -2471,21 +2166,32 @@ "summary": [ { "kind": "text", - "text": "The explicit event name to charge for each item." + "text": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 30, + "id": 74, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "alias", "type": { - "name": "str", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -2493,40 +2199,64 @@ "summary": [ { "kind": "text", - "text": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + "text": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": true }, - "id": 31, + "id": 75, "kind": 32768, "kindString": "Parameter", - "name": "is_default_dataset", + "name": "name", "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "int", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.compute_push_data_limit", - "target": 27, + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 76, + "kind": 32768, + "kindString": "Parameter", + "name": "force_cloud", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "KeyValueStore", "type": "reference" } } - ], - "overwrites": { - "name": "ChargingManager.compute_push_data_limit", - "target": 27, - "type": "reference" - } + ] }, { "kind": 2048, @@ -2536,25 +2266,36 @@ "summary": [ { "kind": "text", - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n" } ] }, - "decorations": [], + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 80, - "module": "_charging", - "name": "is_event_charge_limit_reached", + "id": 77, + "module": "_actor", + "name": "open_request_queue", "parsedDocstring": { - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n", + "args": { + "id": "The ID of the RQ to open. If provided, searches for existing RQ by ID.\nMutually exclusive with name and alias.", + "name": "The name of the RQ to open (global scope, persists across runs).\nMutually exclusive with id and alias.", + "alias": "The alias of the RQ to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", + "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" + }, + "returns": "An instance of the `RequestQueue` class for the given ID or name." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 400 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 593 } ], "type": { @@ -2564,51 +2305,162 @@ "signatures": [ { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "An instance of the `RequestQueue` class for the given ID or name." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n" } ] }, "flags": {}, - "id": 33, + "id": 78, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "is_event_charge_limit_reached", + "modifiers": [ + "async" + ], + "name": "open_request_queue", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the RQ to open. If provided, searches for existing RQ by ID.\nMutually exclusive with name and alias." + } + ] + }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 34, + "id": 79, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "id", "type": { - "name": "str", + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The alias of the RQ to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 80, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the RQ to open (global scope, persists across runs).\nMutually exclusive with id and alias." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 81, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 82, + "kind": 32768, + "kindString": "Parameter", + "name": "force_cloud", + "type": { + "name": "bool", "type": "reference" } } ], "type": { - "name": "bool", - "type": "reference" - }, - "overwrites": { - "name": "ChargingManager.is_event_charge_limit_reached", - "target": 32, + "name": "RequestQueue", "type": "reference" } } - ], - "overwrites": { - "name": "ChargingManager.is_event_charge_limit_reached", - "target": 32, - "type": "reference" - } + ] }, { "kind": 2048, @@ -2618,25 +2470,33 @@ "summary": [ { "kind": "text", - "text": "Compute the maximum number of events of each type that can be charged within the current budget." + "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n" } ] }, - "decorations": [], + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], "id": 83, - "module": "_charging", - "name": "compute_chargeable", + "module": "_actor", + "name": "push_data", "parsedDocstring": { - "text": "Compute the maximum number of events of each type that can be charged within the current budget." + "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n", + "args": { + "data": "The data to push to the default dataset.", + "charged_event_name": "If provided and if the Actor uses the pay-per-event pricing model,\nthe method will attempt to charge for the event for each pushed item." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 405 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 629 } ], "type": { @@ -2649,31 +2509,82 @@ "summary": [ { "kind": "text", - "text": "Compute the maximum number of events of each type that can be charged within the current budget." + "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n" } ] }, "flags": {}, - "id": 36, + "id": 84, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "compute_chargeable", - "parameters": [], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "modifiers": [ + "async" + ], + "name": "push_data", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to push to the default dataset." + } + ] }, - { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 85, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "dict | list[dict]", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "dict" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If provided and if the Actor uses the pay-per-event pricing model,\nthe method will attempt to charge for the event for each pushed item." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 86, + "kind": 32768, + "kindString": "Parameter", + "name": "charged_event_name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, { "type": "literal", @@ -2681,2122 +2592,4761 @@ } ] } - ] - }, - "overwrites": { - "name": "ChargingManager.compute_chargeable", - "target": 35, - "type": "reference" + } + ], + "type": { + "name": "ChargeResult", + "type": "reference", + "target": "265" } } - ], - "overwrites": { - "name": "ChargingManager.compute_chargeable", - "target": 35, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." + "text": "Get the Actor input value from the default key-value store associated with the current Actor run." } ] }, - "flags": {}, - "groups": [], - "id": 1195, - "module": "_charging", - "name": "charge_lock", - "parsedDocstring": { - "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55 + "name": "_ensure_context" } ], - "type": { - "name": "ReentrantLock", - "type": "reference", - "target": "392" - }, - "inheritedFrom": { - "name": "ChargingManager.charge_lock", - "target": 10, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implementation of the `ChargingManager` Protocol - this is only meant to be instantiated internally." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 52, - 54, - 48, - 65, - 63, - 59, - 83, - 75, - 70, - 73, - 68, - 80 - ], - "title": "Methods" - }, - { - "children": [ - 1195, - 47 - ], - "title": "Properties" - } - ], - "id": 46, - "module": "_charging", - "name": "ChargingManagerImplementation", - "parsedDocstring": { - "text": "Implementation of the `ChargingManager` Protocol - this is only meant to be instantiated internally." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 156 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ChargingManager", - "target": "9", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 86, - "module": "_charging", - "name": "charge_count", + "id": 87, + "module": "_actor", + "name": "get_input", "parsedDocstring": { - "text": "" + "text": "Get the Actor input value from the default key-value store associated with the current Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 461 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 690 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the Actor input value from the default key-value store associated with the current Actor run." + } + ] + }, + "flags": {}, + "id": 88, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_input", + "parameters": [], + "type": { + "name": "Any", + "type": "reference" + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get a value from the default key-value store associated with the current Actor run.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 87, - "module": "_charging", - "name": "total_charged_amount", + "id": 89, + "module": "_actor", + "name": "get_value", "parsedDocstring": { - "text": "" + "text": "Get a value from the default key-value store associated with the current Actor run.\n", + "args": { + "key": "The key of the record which to retrieve.", + "default_value": "Default value returned in case the record does not exist." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 462 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 705 } ], "type": { - "name": "Decimal", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 86, - 87 - ], - "title": "Properties" - } - ], - "id": 85, - "module": "_charging", - "name": "ChargingStateItem", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 460 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] }, - "flags": {}, - "groups": [], - "id": 89, - "module": "_charging", - "name": "price", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 467 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get a value from the default key-value store associated with the current Actor run.\n" + } + ] + }, + "flags": {}, + "id": 90, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_value", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record which to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 91, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default value returned in case the record does not exist." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 92, + "kind": 32768, + "kindString": "Parameter", + "name": "default_value", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "Any", + "type": "reference" + } } - ], - "type": { - "name": "Decimal", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 90, - "module": "_charging", - "name": "title", + "id": 93, + "module": "_actor", + "name": "set_value", "parsedDocstring": { - "text": "" + "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n", + "args": { + "key": "The key of the record which to set.", + "value": "The value of the record which to set, or None, if the record should be deleted.", + "content_type": "The content type which should be set to the value." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 468 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 716 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 89, - 90 - ], - "title": "Properties" - } - ], - "id": 88, - "module": "_charging", - "name": "PricingInfoItem", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 466 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n" + } + ] + }, + "flags": {}, + "id": 94, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "set_value", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record which to set." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 95, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the record which to set, or None, if the record should be deleted." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 96, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type which should be set to the value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 97, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the charging manager to access granular pricing information." } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 92, - "module": "_charging", - "name": "pricing_info", + "id": 98, + "module": "_actor", + "name": "get_charging_manager", "parsedDocstring": { - "text": "" + "text": "Retrieve the charging manager to access granular pricing information." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 472 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 734 } ], "type": { - "name": "( FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None )", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "204" - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "206" - } - ] - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "210" - } - ] - }, + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "222" + "kind": "text", + "text": "Retrieve the charging manager to access granular pricing information." } ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 99, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_charging_manager", + "parameters": [], + "type": { + "name": "ChargingManager", + "type": "reference", + "target": "237" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 93, - "module": "_charging", - "name": "charged_event_counts", + "id": 100, + "module": "_actor", + "name": "charge", "parsedDocstring": { - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", + "args": { + "event_name": "Name of the event to be charged for.", + "count": "Number of events to charge for." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 479 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 739 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + } + ] }, - { + "flags": {}, + "id": 101, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "charge", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the event to be charged for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 102, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of events to charge for." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 103, + "kind": 32768, + "kindString": "Parameter", + "name": "count", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "ChargeResult", "type": "reference", - "name": "int" + "target": "265" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 94, - "module": "_charging", - "name": "max_total_charge_usd", + "id": 104, + "module": "_actor", + "name": "on", "parsedDocstring": { - "text": "" + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n", + "args": { + "event_name": "The Actor event to listen for.", + "listener": "The function to be called when the event is emitted (can be async)." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 480 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 776 } ], "type": { - "name": "Decimal", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 93, - 94, - 92 - ], - "title": "Properties" - } - ], - "id": 91, - "module": "_charging", - "name": "_FetchedPricingInfoDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_charging.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 471 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing model for an Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 95, - "module": "_models", - "name": "PricingModel", - "parsedDocstring": { - "text": "Pricing model for an Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defines the general access level for the resource." - } - ] - }, - "flags": {}, - "groups": [], - "id": 96, - "module": "_models", - "name": "GeneralAccess", - "parsedDocstring": { - "text": "Defines the general access level for the resource." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 16 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] }, - "flags": {}, - "groups": [], - "id": 98, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 105, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 106, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Event", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 107, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + } + ], + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 99, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorId')]", - "type": "union", - "types": [ - { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 197, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 198, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.PERSIST_STATE" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 199, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventPersistStateData" + } + ] + } + } + ], + "type": { + "name": "EventListener", "type": "reference", - "name": "str" + "typeArguments": [ + { + "type": "reference", + "name": "EventPersistStateData" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 200, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 201, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.SYSTEM_INFO" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 202, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventSystemInfoData" + } + ] + } + } + ], + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventSystemInfoData" + } + ] } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 203, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 204, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.MIGRATING" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 205, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventMigratingData" + } + ] + } + } + ], + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventMigratingData" + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 100, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorTaskId')]", - "type": "union", - "types": [ - { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 206, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 207, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.ABORTING" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 208, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventAbortingData" + } + ] + } + } + ], + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventAbortingData" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 209, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 210, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.EXIT" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 211, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventExitData" + } + ] + } + } + ], + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventExitData" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + } + ] + }, + "flags": {}, + "id": 212, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "on", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event to listen for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 213, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Event", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to be called when the event is emitted (can be async)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 214, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "EventListener", "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Remove a listener, or all listeners, from an Actor event.\n" } ] }, - "flags": {}, - "groups": [], - "id": 101, - "module": "_models", - "name": "actor_run_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 27 + "name": "_ensure_context" } ], - "type": { - "name": "Annotated[str | None, Field(alias='actorRunId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Condition for triggering a webhook." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 99, - 101, - 100, - 98 - ], - "title": "Properties" - } - ], - "id": 97, - "module": "_models", - "name": "WebhookCondition", - "parsedDocstring": { - "text": "Condition for triggering a webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Status of a webhook dispatch." - } - ] - }, - "flags": {}, - "groups": [], - "id": 102, - "module": "_models", - "name": "WebhookDispatchStatus", - "parsedDocstring": { - "text": "Status of a webhook dispatch." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 30 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 104, - "module": "_models", - "name": "model_config", + "id": 108, + "module": "_actor", + "name": "off", "parsedDocstring": { - "text": "" + "text": "Remove a listener, or all listeners, from an Actor event.\n", + "args": { + "event_name": "The Actor event for which to remove listeners.", + "listener": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 817 } ], "type": { "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] }, - "flags": {}, - "groups": [], - "id": 105, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 39 - } - ], - "type": { - "name": "WebhookDispatchStatus", - "type": "reference", - "target": "102" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 109, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 110, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Event", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 111, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "Callable | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Callable" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 106, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 40 - } - ], - "type": { - "name": "datetime", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a webhook dispatch." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 106, - 104, - 105 - ], - "title": "Properties" - } - ], - "id": 103, - "module": "_models", - "name": "ExampleWebhookDispatch", - "parsedDocstring": { - "text": "Information about a webhook dispatch." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 215, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 216, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.PERSIST_STATE" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 217, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventPersistStateData" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 218, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 219, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.SYSTEM_INFO" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 220, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventSystemInfoData" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 221, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 222, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.MIGRATING" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 223, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventMigratingData" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 108, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 46 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 224, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 225, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.ABORTING" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 226, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventAbortingData" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 109, - "module": "_models", - "name": "total_dispatches", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 48 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about webhook dispatches." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 108, - 109 - ], - "title": "Properties" - } - ], - "id": 107, - "module": "_models", - "name": "WebhookStats", - "parsedDocstring": { - "text": "Statistics about webhook dispatches." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 227, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 228, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.EXIT" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 229, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EventExitData" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 111, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 53 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove a listener, or all listeners, from an Actor event.\n" + } + ] + }, + "flags": {}, + "id": 230, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "off", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor event for which to remove listeners." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 231, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "Event", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 232, + "kind": 32768, + "kindString": "Parameter", + "name": "listener", + "type": { + "name": "EventListener", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 112, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55 } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType" - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 113, - "module": "_models", - "name": "request_url", + "id": 112, + "module": "_actor", + "name": "is_at_home", "parsedDocstring": { - "text": "" + "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 827 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 114, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 64 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='id')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 113, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_at_home", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 115, - "module": "_models", - "name": "created_at", + "id": 114, + "module": "_actor", + "name": "get_env", "parsedDocstring": { - "text": "" + "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 65 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 832 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 115, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_env", + "parameters": [], + "type": { + "name": "dict", + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], "id": 116, - "module": "_models", - "name": "modified_at", + "module": "_actor", + "name": "start", "parsedDocstring": { - "text": "" + "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n", + "args": { + "actor_id": "The ID of the Actor to be run.", + "run_input": "The input to pass to the Actor run.", + "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", + "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", + "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 300.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\n" + }, + "returns": "Info about the started Actor run" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 66 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 860 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='modifiedAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Info about the started Actor run" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 117, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "start", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor to be run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 118, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 119, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 120, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 121, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 122, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 123, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 124, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 125, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 126, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "timedelta | None | Literal['inherit', 'RemainingTime']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "inherit" + }, + { + "type": "literal", + "value": "RemainingTime" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 127, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 300." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 128, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 129, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "list[Webhook] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Webhook", + "target": "431" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ActorRun", + "type": "reference", + "target": "547" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 117, - "module": "_models", - "name": "user_id", + "id": 130, + "module": "_actor", + "name": "abort", "parsedDocstring": { - "text": "" + "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n", + "args": { + "run_id": "The ID of the Actor run to be aborted.", + "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", + "status_message": "Status message of the Actor to be set on the platform.", + "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistState`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.\n" + }, + "returns": "Info about the aborted Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 948 } ], "type": { - "name": "Annotated[str | None, Field(alias='userId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Info about the aborted Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 131, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor run to be aborted." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 132, + "kind": 32768, + "kindString": "Parameter", + "name": "run_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 133, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Status message of the Actor to be set on the platform." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 134, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistState`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 135, + "kind": 32768, + "kindString": "Parameter", + "name": "gracefully", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ActorRun", + "type": "reference", + "target": "547" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 118, - "module": "_models", - "name": "is_ad_hoc", + "id": 136, + "module": "_actor", + "name": "call", "parsedDocstring": { - "text": "" + "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n", + "args": { + "actor_id": "The ID of the Actor to be run.", + "run_input": "The input to pass to the Actor run.", + "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", + "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", + "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", + "wait": "The maximum number of seconds the server waits for the run to finish. If not provided,\nwaits indefinitely.", + "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger.\n" + }, + "returns": "Info about the started Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 68 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 981 } ], "type": { - "name": "Annotated[bool | None, Field(alias='isAdHoc')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Info about the started Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": {}, + "id": 137, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor to be run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 138, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 139, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 140, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 141, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 142, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 143, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 144, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 145, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 146, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "timedelta | None | Literal['inherit', 'RemainingTime']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "inherit" + }, + { + "type": "literal", + "value": "RemainingTime" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 147, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 148, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "list[Webhook] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Webhook", + "target": "431" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. If not provided,\nwaits indefinitely." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 149, + "kind": 32768, + "kindString": "Parameter", + "name": "wait", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger.\n" + } + ] + }, + "defaultValue": "'default'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 150, + "kind": 32768, + "kindString": "Parameter", + "name": "logger", + "type": { + "name": "logging.Logger | None | Literal['default']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "logging.Logger" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "default" + } + ] + } + ] + } + } + ], + "type": { + "name": "ActorRun | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorRun", + "target": "547" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 119, - "module": "_models", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 69 } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n" } ] }, - "flags": {}, - "groups": [], - "id": 120, - "module": "_models", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 70 + "name": "_ensure_context" } ], - "type": { - "name": "Annotated[WebhookCondition | None, Field(alias='condition')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookCondition", - "target": "97" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 121, - "module": "_models", - "name": "ignore_ssl_errors", + "id": 151, + "module": "_actor", + "name": "call_task", "parsedDocstring": { - "text": "" + "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n", + "args": { + "task_id": "The ID of the Actor to be run.", + "task_input": "Overrides the input to pass to the Actor run.", + "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", + "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", + "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` will set timeout of the other Actor to the\ntime remaining from this Actor timeout.", + "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", + "wait": "The maximum number of seconds the server waits for the run to finish. If not provided, waits\nindefinitely.\n" + }, + "returns": "Info about the started Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1075 } ], "type": { - "name": "Annotated[bool | None, Field(alias='ignoreSslErrors')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 122, - "module": "_models", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" + "name": "Undefined", + "type": "reference" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 72 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='doNotRetry')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Info about the started Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": {}, + "id": 152, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call_task", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor to be run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 153, + "kind": 32768, + "kindString": "Parameter", + "name": "task_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides the input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 154, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 155, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 156, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 157, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` will set timeout of the other Actor to the\ntime remaining from this Actor timeout." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 158, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "timedelta | None | Literal['inherit']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "inherit" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 159, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "list[Webhook] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Webhook", + "target": "431" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. If not provided, waits\nindefinitely.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 160, + "kind": 32768, + "kindString": "Parameter", + "name": "wait", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 161, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ActorRun | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorRun", + "target": "547" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 123, - "module": "_models", - "name": "payload_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 73 } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='payloadTemplate', description='Template for the payload sent by the webhook'), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n" } ] }, - "flags": {}, - "groups": [], - "id": 124, - "module": "_models", - "name": "headers_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 77 + "name": "_ensure_context" } ], - "type": { - "name": "Annotated[str | None, Field(alias='headersTemplate')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 125, - "module": "_models", - "name": "description", + "id": 162, + "module": "_actor", + "name": "metamorph", "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n", + "args": { + "target_actor_id": "ID of the target Actor that the run should be transformed into", + "run_input": "The input to pass to the new run.", + "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", + "content_type": "The content type of the input.", + "custom_after_sleep": "How long to sleep for after the metamorph, to wait for the container to be stopped." } - ], - "type": { - "name": "Annotated[str | None, Field(alias='description')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 126, - "module": "_models", - "name": "last_dispatch", - "parsedDocstring": { - "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 79 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1149 } ], "type": { - "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ExampleWebhookDispatch", - "target": "103" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 127, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" + "name": "Undefined", + "type": "reference" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 80 - } - ], - "type": { - "name": "Annotated[WebhookStats | None, Field(alias='stats')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookStats", - "target": "107" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n" + } + ] }, - { + "flags": {}, + "id": 163, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "metamorph", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the target Actor that the run should be transformed into" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 164, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the new run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 165, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 166, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 167, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long to sleep for after the metamorph, to wait for the container to be stopped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 168, + "kind": 32768, + "kindString": "Parameter", + "name": "custom_after_sleep", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", "type": "literal", "value": null } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Actor')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 120, - 115, - 125, - 122, - 112, - 124, - 114, - 121, - 118, - 126, - 111, - 116, - 123, - 113, - 119, - 127, - 117 - ], - "title": "Properties" - } - ], - "id": 110, - "module": "_models", - "name": "Webhook", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 129, - "module": "_models", - "name": "model_config", + "id": 169, + "module": "_actor", + "name": "reboot", "parsedDocstring": { - "text": "" + "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n", + "args": { + "event_listeners_timeout": "How long should the Actor wait for Actor event listeners to finish before exiting.", + "custom_after_sleep": "How long to sleep for after the reboot, to wait for the container to be stopped." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 85 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1195 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n" + } + ] + }, + "flags": {}, + "id": 170, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "reboot", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long should the Actor wait for Actor event listeners to finish before exiting." + } + ] + }, + "defaultValue": "EVENT_LISTENERS_TIMEOUT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 171, + "kind": 32768, + "kindString": "Parameter", + "name": "event_listeners_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long to sleep for after the reboot, to wait for the container to be stopped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 172, + "kind": 32768, + "kindString": "Parameter", + "name": "custom_after_sleep", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 130, - "module": "_models", - "name": "origin", + "id": 173, + "module": "_actor", + "name": "add_webhook", "parsedDocstring": { - "text": "" + "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n", + "args": { + "webhook": "The webhook to be added", + "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url", + "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", + "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.\n" + }, + "returns": "The created webhook." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 87 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1261 } ], "type": { - "name": "MetaOrigin", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created webhook." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n" + } + ] + }, + "flags": {}, + "id": 174, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "add_webhook", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The webhook to be added" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 175, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook", + "type": { + "name": "Webhook", + "type": "reference", + "target": "431" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should ignore SSL errors returned by request_url" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 176, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon failure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 177, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 178, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set the status message for the current Actor run.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 131, - "module": "_models", - "name": "client_ip", + "id": 179, + "module": "_actor", + "name": "set_status_message", "parsedDocstring": { - "text": "" + "text": "Set the status message for the current Actor run.\n", + "args": { + "status_message": "The status message to set to the run.", + "is_terminal": "Set this flag to True if this is the final status message of the Actor run.\n" + }, + "returns": "The updated Actor run object." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 88 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1307 } ], "type": { - "name": "Annotated[str | None, Field(alias='clientIp')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Set the status message for the current Actor run.\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": {}, + "id": 180, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "set_status_message", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status message to set to the run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 181, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this flag to True if this is the final status message of the Actor run.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 182, + "kind": 32768, + "kindString": "Parameter", + "name": "is_terminal", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ActorRun | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorRun", + "target": "547" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 132, - "module": "_models", - "name": "user_agent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89 } - ], - "type": { - "name": "Annotated[str | None, Field(alias='userAgent')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 133, - "module": "_models", - "name": "schedule_id", + "id": 183, + "module": "_actor", + "name": "create_proxy_configuration", "parsedDocstring": { - "text": "" + "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n", + "args": { + "actor_proxy_input": "Proxy configuration field from the Actor input, if input has such input field. If you\npass this argument, all the other arguments will be inferred from it.", + "password": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available.", + "groups": "Proxy groups which the Apify Proxy should use, if provided.", + "country_code": "Country which the Apify Proxy should use, if provided.", + "subdivision_code": "Subdivision (e.g. US state) which the Apify Proxy should use, if provided.\nRequires `country_code` to be set. Two-letter ISO 3166-2 code (e.g. `CA` for California).", + "proxy_urls": "Custom proxy server URLs which should be rotated through.", + "new_url_function": "Function which returns a custom proxy URL to be used.\n" + }, + "returns": "ProxyConfiguration object with the passed configuration, or None, if no proxy should be used based\non the configuration." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 90 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1338 } ], "type": { - "name": "Annotated[str | None, Field(alias='scheduleId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ProxyConfiguration object with the passed configuration, or None, if no proxy should be used based\non the configuration." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 184, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create_proxy_configuration", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Proxy configuration field from the Actor input, if input has such input field. If you\npass this argument, all the other arguments will be inferred from it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 185, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_proxy_input", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 186, + "kind": 32768, + "kindString": "Parameter", + "name": "password", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Proxy groups which the Apify Proxy should use, if provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 187, + "kind": 32768, + "kindString": "Parameter", + "name": "groups", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Country which the Apify Proxy should use, if provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 188, + "kind": 32768, + "kindString": "Parameter", + "name": "country_code", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Subdivision (e.g. US state) which the Apify Proxy should use, if provided.\nRequires `country_code` to be set. Two-letter ISO 3166-2 code (e.g. `CA` for California)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 189, + "kind": 32768, + "kindString": "Parameter", + "name": "subdivision_code", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom proxy server URLs which should be rotated through." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 190, + "kind": 32768, + "kindString": "Parameter", + "name": "proxy_urls", + "type": { + "name": "list[str | None] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function which returns a custom proxy URL to be used.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 191, + "kind": 32768, + "kindString": "Parameter", + "name": "new_url_function", + "type": { + "name": "_NewUrlFunction | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "_NewUrlFunction" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ProxyConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProxyConfiguration", + "target": "588" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n" } ] }, + "decorations": [ + { + "name": "_ensure_context" + } + ], "flags": {}, "groups": [], - "id": 134, - "module": "_models", - "name": "scheduled_at", + "id": 192, + "module": "_actor", + "name": "use_state", "parsedDocstring": { - "text": "" + "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n", + "args": { + "default_value": "The default value to initialize the state if it is not already set.", + "key": "The key in the key-value store where the state is stored. If not provided, a default key is used.", + "kvs_name": "The name of the key-value store where the state is stored. If not provided, the default\nkey-value store associated with the Actor run is used.\n" + }, + "returns": "The state dictionary with automatic persistence." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1399 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='scheduledAt')]", - "type": "union", - "types": [ - { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The state dictionary with automatic persistence." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n" + } + ] + }, + "flags": {}, + "id": 193, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "use_state", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The default value to initialize the state if it is not already set." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 194, + "kind": 32768, + "kindString": "Parameter", + "name": "default_value", + "type": { + "name": "dict[str, JsonSerializable] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "JsonSerializable" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key in the key-value store where the state is stored. If not provided, a default key is used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 195, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the key-value store where the state is stored. If not provided, the default\nkey-value store associated with the Actor run is used.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 196, + "kind": 32768, + "kindString": "Parameter", + "name": "kvs_name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "MutableMapping", "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "JsonSerializable" + } + ] } - ] - } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The core class for building Actors on the Apify platform.\n\nActors are serverless programs running in the cloud that can perform anything from simple actions\n(such as filling out a web form or sending an email) to complex operations (such as crawling an\nentire website or removing duplicates from a large dataset). They are packaged as Docker containers\nwhich accept well-defined JSON input, perform an action, and optionally produce well-defined output.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors\n- Actor whitepaper: https://whitepaper.actor/\n\n### Usage\n\n```python\nimport asyncio\n\nimport httpx\nfrom apify import Actor\nfrom bs4 import BeautifulSoup\n\n\nasync def main() -> None:\n async with Actor:\n actor_input = await Actor.get_input()\n async with httpx.AsyncClient() as client:\n response = await client.get(actor_input['url'])\n soup = BeautifulSoup(response.content, 'html.parser')\n data = {\n 'url': actor_input['url'],\n 'title': soup.title.string if soup.title else None,\n }\n await Actor.push_data(data)\n\nif __name__ == '__main__':\n asyncio.run(main())\n```" } ] }, "decorations": [ + { + "args": "('Actor')", + "name": "docs_name" + }, { "args": "('Actor')", "name": "docs_group" @@ -4806,28 +7356,166 @@ "groups": [ { "children": [ - 131, - 129, + 13, + 15, + 22, + 4, + 20, 130, - 133, - 134, - 132 + 173, + 136, + 151, + 100, + 41, + 183, + 43, + 47, + 33, + 53, + 98, + 114, + 87, + 89, + 45, + 112, + 162, + 58, + 108, + 104, + 65, + 71, + 77, + 83, + 169, + 179, + 93, + 116, + 37, + 192 + ], + "title": "Methods" + }, + { + "children": [ + 40, + 32, + 31, + 36 ], "title": "Properties" } ], - "id": 128, - "module": "_models", - "name": "ActorRunMeta", + "id": 3, + "module": "_actor", + "name": "Actor", + "parsedDocstring": { + "text": "The core class for building Actors on the Apify platform.\n\nActors are serverless programs running in the cloud that can perform anything from simple actions\n(such as filling out a web form or sending an email) to complex operations (such as crawling an\nentire website or removing duplicates from a large dataset). They are packaged as Docker containers\nwhich accept well-defined JSON input, perform an action, and optionally produce well-defined output.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors\n- Actor whitepaper: https://whitepaper.actor/\n\n### Usage\n\n```python\nimport asyncio\n\nimport httpx\nfrom apify import Actor\nfrom bs4 import BeautifulSoup\n\n\nasync def main() -> None:\n async with Actor:\n actor_input = await Actor.get_input()\n async with httpx.AsyncClient() as client:\n response = await client.get(actor_input['url'])\n soup = BeautifulSoup(response.content, 'html.parser')\n data = {\n 'url': actor_input['url'],\n 'title': soup.title.string if soup.title else None,\n }\n await Actor.push_data(data)\n\nif __name__ == '__main__':\n asyncio.run(main())\n```" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 63 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The entry point of the SDK, through which all the Actor operations should be done." + } + ] + }, + "flags": {}, + "groups": [], + "id": 233, + "module": "_actor", + "name": "Actor", + "parsedDocstring": { + "text": "The entry point of the SDK, through which all the Actor operations should be done." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_actor.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 1455 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 234, + "module": "_charging", + "name": "run_validator", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 84 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 235, + "module": "_charging", + "name": "DEFAULT_DATASET_ITEM_EVENT", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 33 } ], "type": { @@ -4835,6 +7523,55 @@ "type": "reference" } }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 236, + "module": "_charging", + "name": "charging_manager_ctx", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ChargingManager", + "target": "237" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, { "kind": 128, "kindString": "Class", @@ -4847,441 +7584,892 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." } ] }, "flags": {}, "groups": [], - "id": 136, - "module": "_models", - "name": "model_config", + "id": 238, + "module": "_charging", + "name": "charge_lock", "parsedDocstring": { - "text": "" + "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 96 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "ReentrantLock", + "type": "reference", + "target": "625" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 137, - "module": "_models", - "name": "input_body_len", + "id": 239, + "module": "_charging", + "name": "charge", "parsedDocstring": { - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", + "args": { + "event_name": "Name of the event to be charged for.", + "count": "Number of events to charge for." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 98 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 58 } ], "type": { - "name": "Annotated[int | None, Field(alias='inputBodyLen')]", - "type": "union", - "types": [ - { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + } + ] + }, + "flags": {}, + "id": 240, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "charge", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the event to be charged for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 241, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of events to charge for." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 242, + "kind": 32768, + "kindString": "Parameter", + "name": "count", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "ChargeResult", "type": "reference", - "name": "int" + "target": "265" }, - { - "type": "literal", - "value": null + "overwrites": { + "name": "ChargingManager.charge", + "target": 239, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Calculate the total amount of money charged for pay-per-event events so far." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 138, - "module": "_models", - "name": "migration_count", + "id": 243, + "module": "_charging", + "name": "calculate_total_charged_amount", "parsedDocstring": { - "text": "" + "text": "Calculate the total amount of money charged for pay-per-event events so far." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 99 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 68 } ], "type": { - "name": "Annotated[int | None, Field(alias='migrationCount')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Calculate the total amount of money charged for pay-per-event events so far." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 244, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "calculate_total_charged_amount", + "parameters": [], + "type": { + "name": "Decimal", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.calculate_total_charged_amount", + "target": 243, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 139, - "module": "_models", - "name": "reboot_count", + "id": 245, + "module": "_charging", + "name": "calculate_max_event_charge_count_within_limit", "parsedDocstring": { - "text": "" + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n", + "args": { + "event_name": "Name of the inspected event." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 100 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 71 } ], "type": { - "name": "Annotated[int | None, Field(alias='rebootCount')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 140, - "module": "_models", - "name": "restart_count", - "parsedDocstring": { - "text": "" + "name": "Undefined", + "type": "reference" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 101 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" + } + ] + }, + "flags": {}, + "id": 246, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "calculate_max_event_charge_count_within_limit", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the inspected event." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 247, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + }, + "overwrites": { + "name": "ChargingManager.calculate_max_event_charge_count_within_limit", + "target": 245, + "type": "reference" + } } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 141, - "module": "_models", - "name": "resurrect_count", + "id": 248, + "module": "_charging", + "name": "get_pricing_info", "parsedDocstring": { - "text": "" + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 102 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 78 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." + } + ] + }, + "flags": {}, + "id": 249, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_pricing_info", + "parameters": [], + "type": { + "name": "ActorPricingInfo", + "type": "reference", + "target": "269" + }, + "overwrites": { + "name": "ChargingManager.get_pricing_info", + "target": 248, + "type": "reference" + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the number of events with the given name that were charged so far.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 142, - "module": "_models", - "name": "mem_avg_bytes", + "id": 250, + "module": "_charging", + "name": "get_charged_event_count", "parsedDocstring": { - "text": "" + "text": "Get the number of events with the given name that were charged so far.\n", + "args": { + "event_name": "Name of the inspected event." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84 } ], "type": { - "name": "Annotated[float | None, Field(alias='memAvgBytes')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the number of events with the given name that were charged so far.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 251, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_charged_event_count", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the inspected event." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 252, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "int", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.get_charged_event_count", + "target": 250, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the configured maximum total charge for this Actor run." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 143, - "module": "_models", - "name": "mem_max_bytes", + "id": 253, + "module": "_charging", + "name": "get_max_total_charge_usd", "parsedDocstring": { - "text": "" + "text": "Get the configured maximum total charge for this Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 104 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 91 } ], "type": { - "name": "Annotated[int | None, Field(alias='memMaxBytes')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the configured maximum total charge for this Actor run." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 254, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_max_total_charge_usd", + "parameters": [], + "type": { + "name": "Decimal", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.get_max_total_charge_usd", + "target": 253, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 144, - "module": "_models", - "name": "mem_current_bytes", + "id": 255, + "module": "_charging", + "name": "compute_push_data_limit", "parsedDocstring": { - "text": "" + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n", + "args": { + "items_count": "The number of items to be pushed.", + "event_name": "The explicit event name to charge for each item.", + "is_default_dataset": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + }, + "returns": "Max number of items that can be pushed within the budget." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 105 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 } ], "type": { - "name": "Annotated[int | None, Field(alias='memCurrentBytes')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Max number of items that can be pushed within the budget." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 256, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "compute_push_data_limit", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to be pushed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 257, + "kind": 32768, + "kindString": "Parameter", + "name": "items_count", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The explicit event name to charge for each item." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 258, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 259, + "kind": 32768, + "kindString": "Parameter", + "name": "is_default_dataset", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "int", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.compute_push_data_limit", + "target": 255, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 145, - "module": "_models", - "name": "cpu_avg_usage", + "id": 260, + "module": "_charging", + "name": "is_event_charge_limit_reached", "parsedDocstring": { - "text": "" + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 116 } ], "type": { - "name": "Annotated[float | None, Field(alias='cpuAvgUsage')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 261, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_event_charge_limit_reached", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 262, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.is_event_charge_limit_reached", + "target": 260, + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Compute the maximum number of events of each type that can be charged within the current budget." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 146, - "module": "_models", - "name": "cpu_max_usage", + "id": 263, + "module": "_charging", + "name": "compute_chargeable", "parsedDocstring": { - "text": "" + "text": "Compute the maximum number of events of each type that can be charged within the current budget." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 107 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 119 } ], "type": { - "name": "Annotated[float | None, Field(alias='cpuMaxUsage')]", - "type": "union", - "types": [ - { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Compute the maximum number of events of each type that can be charged within the current budget." + } + ] + }, + "flags": {}, + "id": 264, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "compute_chargeable", + "parameters": [], + "type": { + "name": "dict", "type": "reference", - "name": "float" + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + ] }, - { - "type": "literal", - "value": null + "overwrites": { + "name": "ChargingManager.compute_chargeable", + "target": 263, + "type": "reference" } - ] + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Provides fine-grained access to pay-per-event functionality.\n\nThe ChargingManager allows you to charge for specific events in your Actor when using\nthe pay-per-event pricing model. This enables precise cost control and transparent\nbilling for different operations within your Actor.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors/publishing/monetize" } + ] + }, + "decorations": [ + { + "args": "('Charging')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 245, + 243, + 239, + 263, + 255, + 250, + 253, + 248, + 260 + ], + "title": "Methods" }, + { + "children": [ + 238 + ], + "title": "Properties" + } + ], + "id": 237, + "module": "_charging", + "name": "ChargingManager", + "parsedDocstring": { + "text": "Provides fine-grained access to pay-per-event functionality.\n\nThe ChargingManager allows you to charge for specific events in your Actor when using\nthe pay-per-event pricing model. This enables precise cost control and transparent\nbilling for different operations within your Actor.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors/publishing/monetize" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ChargingManagerImplementation", + "target": "274", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -5290,39 +8478,29 @@ "summary": [ { "kind": "text", - "text": "" + "text": "If true, no more events of this type can be charged within the limit." } ] }, "flags": {}, "groups": [], - "id": 147, - "module": "_models", - "name": "cpu_current_usage", + "id": 266, + "module": "_charging", + "name": "event_charge_limit_reached", "parsedDocstring": { - "text": "" + "text": "If true, no more events of this type can be charged within the limit." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 108 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 128 } ], "type": { - "name": "Annotated[float | None, Field(alias='cpuCurrentUsage')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "bool", + "type": "reference" } }, { @@ -5333,39 +8511,29 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Total amount of charged events - may be lower than the requested amount." } ] }, "flags": {}, "groups": [], - "id": 148, - "module": "_models", - "name": "net_rx_bytes", + "id": 267, + "module": "_charging", + "name": "charged_count", "parsedDocstring": { - "text": "" + "text": "Total amount of charged events - may be lower than the requested amount." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 109 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 131 } ], "type": { - "name": "Annotated[int | None, Field(alias='netRxBytes')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + "name": "int", + "type": "reference" } }, { @@ -5376,41 +8544,103 @@ "summary": [ { "kind": "text", - "text": "" + "text": "How many events of each known type can still be charged within the limit." } ] }, "flags": {}, "groups": [], - "id": 149, - "module": "_models", - "name": "net_tx_bytes", + "id": 268, + "module": "_charging", + "name": "chargeable_within_limit", "parsedDocstring": { - "text": "" + "text": "How many events of each known type can still be charged within the limit." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 110 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 134 } ], "type": { - "name": "Annotated[int | None, Field(alias='netTxBytes')]", - "type": "union", - "types": [ + "name": "dict", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "int" + "name": "str" }, { - "type": "literal", - "value": null + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] } ] } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of the `ChargingManager.charge` method." + } + ] + }, + "decorations": [ + { + "args": "('Charging')", + "name": "docs_group" }, + { + "args": "(frozen=True)", + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 268, + 267, + 266 + ], + "title": "Properties" + } + ], + "id": 265, + "module": "_charging", + "name": "ChargeResult", + "parsedDocstring": { + "text": "Result of the `ChargingManager.charge` method." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 125 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -5419,33 +8649,34 @@ "summary": [ { "kind": "text", - "text": "" + "text": "The currently effective pricing model." } ] }, "flags": {}, "groups": [], - "id": 150, - "module": "_models", - "name": "duration_millis", + "id": 270, + "module": "_charging", + "name": "pricing_model", "parsedDocstring": { - "text": "" + "text": "The currently effective pricing model." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 111 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "type": { - "name": "Annotated[int | None, Field(alias='durationMillis')]", + "name": "PricingModel | None", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "PricingModel", + "target": "416" }, { "type": "literal", @@ -5462,39 +8693,29 @@ "summary": [ { "kind": "text", - "text": "" + "text": "A configured limit for the total charged amount - if you exceed it, you won't receive more money than this." } ] }, "flags": {}, "groups": [], - "id": 151, - "module": "_models", - "name": "run_time_secs", + "id": 271, + "module": "_charging", + "name": "max_total_charge_usd", "parsedDocstring": { - "text": "" + "text": "A configured limit for the total charged amount - if you exceed it, you won't receive more money than this." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 112 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 146 } ], "type": { - "name": "Annotated[float | None, Field(alias='runTimeSecs')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Decimal", + "type": "reference" } }, { @@ -5505,39 +8726,29 @@ "summary": [ { "kind": "text", - "text": "" + "text": "A shortcut - true if the Actor runs with the pay-per-event pricing model." } ] }, "flags": {}, "groups": [], - "id": 152, - "module": "_models", - "name": "metamorph", + "id": 272, + "module": "_charging", + "name": "is_pay_per_event", "parsedDocstring": { - "text": "" + "text": "A shortcut - true if the Actor runs with the pay-per-event pricing model." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 113 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 149 } ], "type": { - "name": "Annotated[int | None, Field(alias='metamorph')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + "name": "bool", + "type": "reference" } }, { @@ -5548,29 +8759,39 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Price of every known event type." } ] }, "flags": {}, "groups": [], - "id": 153, - "module": "_models", - "name": "compute_units", + "id": 273, + "module": "_charging", + "name": "per_event_prices", "parsedDocstring": { - "text": "" + "text": "Price of every known event type." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 114 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 152 } ], "type": { - "name": "float", - "type": "reference" + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Decimal" + } + ] } } ], @@ -5578,54 +8799,43 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Result of the `ChargingManager.get_pricing_info` method." } ] }, "decorations": [ { - "args": "('Actor')", + "args": "('Charging')", "name": "docs_group" + }, + { + "name": "dataclass" } ], "flags": {}, "groups": [ { "children": [ - 153, - 145, - 147, - 146, - 150, - 137, - 142, - 144, - 143, - 152, - 138, - 136, - 148, - 149, - 139, - 140, - 141, - 151 + 272, + 271, + 273, + 270 ], "title": "Properties" } ], - "id": 135, - "module": "_models", - "name": "ActorRunStats", + "id": 269, + "module": "_charging", + "name": "ActorPricingInfo", "parsedDocstring": { - "text": "" + "text": "Result of the `ChargingManager.get_pricing_info` method." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 95 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 140 } ], "type": { @@ -5651,18 +8861,18 @@ }, "flags": {}, "groups": [], - "id": 155, - "module": "_models", - "name": "model_config", + "id": 275, + "module": "_charging", + "name": "LOCAL_CHARGING_LOG_DATASET_NAME", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 119 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 159 } ], "type": { @@ -5671,8 +8881,8 @@ } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -5682,597 +8892,1100 @@ } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 156, - "module": "_models", - "name": "build", + "id": 276, + "module": "_charging", + "name": "__init__", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 121 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 161 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "flags": {}, + "id": 277, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 278, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 279, + "kind": 32768, + "kindString": "Parameter", + "name": "client", + "type": { + "name": "ApifyClientAsync", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 280, + "module": "_charging", + "name": "__aenter__", + "parsedDocstring": { + "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the charging manager - this is called by the `Actor` class and shouldn't be invoked manually." + } + ] + }, + "flags": {}, + "id": 281, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aenter__", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 282, + "module": "_charging", + "name": "__aexit__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 240 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 283, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aexit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 284, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 285, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_value", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 286, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_traceback", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 157, - "module": "_models", - "name": "timeout_secs", + "id": 287, + "module": "_charging", + "name": "charge", "parsedDocstring": { - "text": "" + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", + "args": { + "event_name": "Name of the event to be charged for.", + "count": "Number of events to charge for." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 122 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 253 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 158, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 123 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + } + ] + }, + "flags": {}, + "id": 240, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "charge", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the event to be charged for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 241, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of events to charge for." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 242, + "kind": 32768, + "kindString": "Parameter", + "name": "count", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "ChargeResult", + "type": "reference", + "target": "265" + }, + "overwrites": { + "name": "ChargingManager.charge", + "target": 239, + "type": "reference" + } } ], - "type": { - "name": "int", + "overwrites": { + "name": "ChargingManager.charge", + "target": 239, "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Calculate the total amount of money charged for pay-per-event events so far." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 159, - "module": "_models", - "name": "disk_mbytes", + "id": 291, + "module": "_charging", + "name": "calculate_total_charged_amount", "parsedDocstring": { - "text": "" + "text": "Calculate the total amount of money charged for pay-per-event events so far." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 124 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 342 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 160, - "module": "_models", - "name": "max_items", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 125 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='maxItems')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Calculate the total amount of money charged for pay-per-event events so far." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 244, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "calculate_total_charged_amount", + "parameters": [], + "type": { + "name": "Decimal", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.calculate_total_charged_amount", + "target": 243, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.calculate_total_charged_amount", + "target": 243, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 161, - "module": "_models", - "name": "max_total_charge_usd", + "id": 293, + "module": "_charging", + "name": "calculate_max_event_charge_count_within_limit", "parsedDocstring": { - "text": "" + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n", + "args": { + "event_name": "Name of the inspected event." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 126 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 349 } ], "type": { - "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Actor')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 156, - 159, - 160, - 161, - 158, - 155, - 157 - ], - "title": "Properties" - } - ], - "id": 154, - "module": "_models", - "name": "ActorRunOptions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 118 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 163, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "name": "Undefined", + "type": "reference" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 131 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Calculate how many instances of an event can be charged before we reach the configured limit.\n" + } + ] + }, + "flags": {}, + "id": 246, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "calculate_max_event_charge_count_within_limit", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the inspected event." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 247, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + }, + "overwrites": { + "name": "ChargingManager.calculate_max_event_charge_count_within_limit", + "target": 245, + "type": "reference" + } } ], - "type": { - "name": "Undefined", + "overwrites": { + "name": "ChargingManager.calculate_max_event_charge_count_within_limit", + "target": 245, "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 164, - "module": "_models", - "name": "actor_compute_units", + "id": 296, + "module": "_charging", + "name": "get_pricing_info", "parsedDocstring": { - "text": "" + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 133 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 359 } ], "type": { - "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS')]", - "type": "union", - "types": [ - { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve detailed information about the effective pricing of the current Actor run.\n\nThis can be used for instance when your code needs to support multiple pricing models in transition periods." + } + ] + }, + "flags": {}, + "id": 249, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_pricing_info", + "parameters": [], + "type": { + "name": "ActorPricingInfo", "type": "reference", - "name": "float" + "target": "269" }, - { - "type": "literal", - "value": null + "overwrites": { + "name": "ChargingManager.get_pricing_info", + "target": 248, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.get_pricing_info", + "target": 248, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the number of events with the given name that were charged so far.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 165, - "module": "_models", - "name": "dataset_reads", + "id": 298, + "module": "_charging", + "name": "get_charged_event_count", "parsedDocstring": { - "text": "" + "text": "Get the number of events with the given name that were charged so far.\n", + "args": { + "event_name": "Name of the inspected event." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 134 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 372 } ], "type": { - "name": "Annotated[int | None, Field(alias='DATASET_READS')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the number of events with the given name that were charged so far.\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": {}, + "id": 251, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_charged_event_count", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the inspected event." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 252, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "int", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.get_charged_event_count", + "target": 250, + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 166, - "module": "_models", - "name": "dataset_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 135 } ], - "type": { - "name": "Annotated[int | None, Field(alias='DATASET_WRITES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + "overwrites": { + "name": "ChargingManager.get_charged_event_count", + "target": 250, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the configured maximum total charge for this Actor run." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 167, - "module": "_models", - "name": "key_value_store_reads", + "id": 301, + "module": "_charging", + "name": "get_max_total_charge_usd", "parsedDocstring": { - "text": "" + "text": "Get the configured maximum total charge for this Actor run." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 136 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 377 } ], "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_READS')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the configured maximum total charge for this Actor run." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 254, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_max_total_charge_usd", + "parameters": [], + "type": { + "name": "Decimal", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.get_max_total_charge_usd", + "target": 253, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.get_max_total_charge_usd", + "target": 253, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 168, - "module": "_models", - "name": "key_value_store_writes", + "id": 303, + "module": "_charging", + "name": "compute_push_data_limit", "parsedDocstring": { - "text": "" + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n", + "args": { + "items_count": "The number of items to be pushed.", + "event_name": "The explicit event name to charge for each item.", + "is_default_dataset": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + }, + "returns": "Max number of items that can be pushed within the budget." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 137 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 381 } ], "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_WRITES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Max number of items that can be pushed within the budget." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Compute how many items can be pushed and charged within the current budget.\n\nAccounts for both the explicit event and the synthetic `DEFAULT_DATASET_ITEM_EVENT` event,\nso that the combined cost per item does not exceed the remaining budget.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 256, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "compute_push_data_limit", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to be pushed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 257, + "kind": 32768, + "kindString": "Parameter", + "name": "items_count", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The explicit event name to charge for each item." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 258, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the data is pushed to the default dataset.\nIf True, the synthetic event cost is included in the combined price.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 259, + "kind": 32768, + "kindString": "Parameter", + "name": "is_default_dataset", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "int", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.compute_push_data_limit", + "target": 255, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.compute_push_data_limit", + "target": 255, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 169, - "module": "_models", - "name": "key_value_store_lists", + "id": 308, + "module": "_charging", + "name": "is_event_charge_limit_reached", "parsedDocstring": { - "text": "" + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 138 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 400 } ], "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_LISTS')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return True if the remaining budget is insufficient to charge even a single event of the given type." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 261, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_event_charge_limit_reached", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 262, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "overwrites": { + "name": "ChargingManager.is_event_charge_limit_reached", + "target": 260, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.is_event_charge_limit_reached", + "target": 260, + "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Compute the maximum number of events of each type that can be charged within the current budget." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 170, - "module": "_models", - "name": "request_queue_reads", + "id": 311, + "module": "_charging", + "name": "compute_chargeable", "parsedDocstring": { - "text": "" + "text": "Compute the maximum number of events of each type that can be charged within the current budget." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 139 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 405 } ], "type": { - "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_READS')]", - "type": "union", - "types": [ - { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Compute the maximum number of events of each type that can be charged within the current budget." + } + ] + }, + "flags": {}, + "id": 264, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "compute_chargeable", + "parameters": [], + "type": { + "name": "dict", "type": "reference", - "name": "int" + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + ] }, - { - "type": "literal", - "value": null + "overwrites": { + "name": "ChargingManager.compute_chargeable", + "target": 263, + "type": "reference" } - ] + } + ], + "overwrites": { + "name": "ChargingManager.compute_chargeable", + "target": 263, + "type": "reference" } }, { @@ -6283,41 +9996,103 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." } ] }, "flags": {}, "groups": [], - "id": 171, - "module": "_models", - "name": "request_queue_writes", + "id": 1206, + "module": "_charging", + "name": "charge_lock", "parsedDocstring": { - "text": "" + "text": "Lock to synchronize charge operations. Prevents race conditions between `charge` and `push_data` calls." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "type": { - "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_WRITES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + "name": "ReentrantLock", + "type": "reference", + "target": "625" + }, + "inheritedFrom": { + "name": "ChargingManager.charge_lock", + "target": 238, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Implementation of the `ChargingManager` Protocol - this is only meant to be instantiated internally." } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 280, + 282, + 276, + 293, + 291, + 287, + 311, + 303, + 298, + 301, + 296, + 308 + ], + "title": "Methods" }, + { + "children": [ + 1206, + 275 + ], + "title": "Properties" + } + ], + "id": 274, + "module": "_charging", + "name": "ChargingManagerImplementation", + "parsedDocstring": { + "text": "Implementation of the `ChargingManager` Protocol - this is only meant to be instantiated internally." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 156 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ChargingManager", + "target": "237", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -6332,33 +10107,23 @@ }, "flags": {}, "groups": [], - "id": 172, - "module": "_models", - "name": "data_transfer_internal_gbytes", + "id": 314, + "module": "_charging", + "name": "charge_count", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 141 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 461 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "int", + "type": "reference" } }, { @@ -6375,35 +10140,72 @@ }, "flags": {}, "groups": [], - "id": 173, - "module": "_models", - "name": "data_transfer_external_gbytes", + "id": 315, + "module": "_charging", + "name": "total_charged_amount", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 142 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 462 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Decimal", + "type": "reference" } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 314, + 315 + ], + "title": "Properties" + } + ], + "id": 313, + "module": "_charging", + "name": "ChargingStateItem", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 460 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -6418,33 +10220,23 @@ }, "flags": {}, "groups": [], - "id": 174, - "module": "_models", - "name": "proxy_residential_transfer_gbytes", + "id": 317, + "module": "_charging", + "name": "price", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 143 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 467 } ], "type": { - "name": "Annotated[float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Decimal", + "type": "reference" } }, { @@ -6461,33 +10253,23 @@ }, "flags": {}, "groups": [], - "id": 175, - "module": "_models", - "name": "proxy_serps", + "id": 318, + "module": "_charging", + "name": "title", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 144 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 468 } ], "type": { - "name": "Annotated[int | None, Field(alias='PROXY_SERPS')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } } ], @@ -6501,43 +10283,31 @@ }, "decorations": [ { - "args": "('Actor')", - "name": "docs_group" + "name": "dataclass" } ], "flags": {}, "groups": [ { "children": [ - 164, - 173, - 172, - 165, - 166, - 169, - 167, - 168, - 163, - 174, - 175, - 170, - 171 + 317, + 318 ], "title": "Properties" } ], - "id": 162, - "module": "_models", - "name": "ActorRunUsage", + "id": 316, + "module": "_charging", + "name": "PricingInfoItem", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 130 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 466 } ], "type": { @@ -6563,23 +10333,64 @@ }, "flags": {}, "groups": [], - "id": 177, - "module": "_models", - "name": "model_config", + "id": 320, + "module": "_charging", + "name": "pricing_info", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 151 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 472 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "( FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None )", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "525" + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "527" + } + ] + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "531" + } + ] + }, + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "543" + } + ] + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -6596,31 +10407,31 @@ }, "flags": {}, "groups": [], - "id": 178, - "module": "_models", - "name": "actor_compute_units", + "id": 321, + "module": "_charging", + "name": "charged_event_counts", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 153 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 479 } ], "type": { - "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS')]", - "type": "union", - "types": [ + "name": "dict", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "float" + "name": "str" }, { - "type": "literal", - "value": null + "type": "reference", + "name": "int" } ] } @@ -6639,35 +10450,101 @@ }, "flags": {}, "groups": [], - "id": 179, - "module": "_models", - "name": "dataset_reads", + "id": 322, + "module": "_charging", + "name": "max_total_charge_usd", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 154 + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 480 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATASET_READS')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Decimal", + "type": "reference" } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 321, + 322, + 320 + ], + "title": "Properties" + } + ], + "id": 319, + "module": "_charging", + "name": "_FetchedPricingInfoDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_charging.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 471 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 323, + "module": "_configuration", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -6682,31 +10559,31 @@ }, "flags": {}, "groups": [], - "id": 180, - "module": "_models", - "name": "dataset_writes", + "id": 325, + "module": "_configuration", + "name": "key_value_stores", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 155 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATASET_WRITES')]", - "type": "union", - "types": [ + "name": "dict", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "float" + "name": "str" }, { - "type": "literal", - "value": null + "type": "reference", + "name": "str" } ] } @@ -6725,31 +10602,31 @@ }, "flags": {}, "groups": [], - "id": 181, - "module": "_models", - "name": "key_value_store_reads", + "id": 326, + "module": "_configuration", + "name": "datasets", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 156 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 46 } ], "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_READS')]", - "type": "union", - "types": [ + "name": "dict", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "float" + "name": "str" }, { - "type": "literal", - "value": null + "type": "reference", + "name": "str" } ] } @@ -6768,35 +10645,78 @@ }, "flags": {}, "groups": [], - "id": 182, - "module": "_models", - "name": "key_value_store_writes", + "id": 327, + "module": "_configuration", + "name": "request_queues", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 47 } ], "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_WRITES')]", - "type": "union", - "types": [ + "name": "dict", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "float" + "name": "str" }, { - "type": "literal", - "value": null + "type": "reference", + "name": "str" } ] } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mapping of storage aliases to their IDs, grouped by storage type.\n\nPopulated from the `ACTOR_STORAGES_JSON` env var that the Apify platform sets when an Actor declares\nnamed storages in its `actor.json` schema. Each key maps a user-defined alias (e.g. `'custom'`)\nto the platform-assigned storage ID." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 326, + 325, + 327 + ], + "title": "Properties" + } + ], + "id": 324, + "module": "_configuration", + "name": "ActorStorages", + "parsedDocstring": { + "text": "Mapping of storage aliases to their IDs, grouped by storage type.\n\nPopulated from the `ACTOR_STORAGES_JSON` env var that the Apify platform sets when an Actor declares\nnamed storages in its `actor.json` schema. Each key maps a user-defined alias (e.g. `'custom'`)\nto the platform-assigned storage ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -6811,27 +10731,27 @@ }, "flags": {}, "groups": [], - "id": 183, - "module": "_models", - "name": "key_value_store_lists", + "id": 329, + "module": "_configuration", + "name": "actor_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 158 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 82 } ], "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_LISTS')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_id', 'apify_actor_id', 'apify_act_id', ), description='ID of the Actor', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -6854,27 +10774,27 @@ }, "flags": {}, "groups": [], - "id": 184, - "module": "_models", - "name": "request_queue_reads", + "id": 330, + "module": "_configuration", + "name": "actor_full_name", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 159 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 } ], "type": { - "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_READS')]", + "name": "Annotated[ str | None, Field( description='Full name of the Actor', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -6897,27 +10817,27 @@ }, "flags": {}, "groups": [], - "id": 185, - "module": "_models", - "name": "request_queue_writes", + "id": 331, + "module": "_configuration", + "name": "actor_permission_level", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 160 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 101 } ], "type": { - "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_WRITES')]", + "name": "Annotated[ str | None, Field( description='Permission level the Actor is run under.', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -6940,27 +10860,27 @@ }, "flags": {}, "groups": [], - "id": 186, - "module": "_models", - "name": "data_transfer_internal_gbytes", + "id": 332, + "module": "_configuration", + "name": "actor_run_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 161 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_run_id', 'apify_actor_run_id', 'apify_act_run_id', ), description='ID of the Actor run', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -6983,27 +10903,27 @@ }, "flags": {}, "groups": [], - "id": 187, - "module": "_models", - "name": "data_transfer_external_gbytes", + "id": 333, + "module": "_configuration", + "name": "actor_build_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 162 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 120 } ], "type": { - "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_build_id', 'apify_actor_build_id', ), description='ID of the Actor build used in the run', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -7026,27 +10946,27 @@ }, "flags": {}, "groups": [], - "id": 188, - "module": "_models", - "name": "proxy_residential_transfer_gbytes", + "id": 334, + "module": "_configuration", + "name": "actor_build_number", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 163 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 131 } ], "type": { - "name": "Annotated[float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_build_number', 'apify_actor_build_number', ), description='Build number of the Actor build used in the run', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -7069,94 +10989,41 @@ }, "flags": {}, "groups": [], - "id": 189, - "module": "_models", - "name": "proxy_serps", + "id": 335, + "module": "_configuration", + "name": "actor_build_tags", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 164 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 142 } ], "type": { - "name": "Annotated[float | None, Field(alias='PROXY_SERPS')]", + "name": "Annotated[ list[str] | None, Field( description='Build tags of the Actor build used in the run', ), BeforeValidator(_transform_to_list), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource usage costs in USD." - } - ] - }, - "decorations": [ - { - "args": "('Actor')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 178, - 187, - 186, - 179, - 180, - 183, - 181, - 182, - 177, - 188, - 189, - 184, - 185 - ], - "title": "Properties" - } - ], - "id": 176, - "module": "_models", - "name": "ActorRunUsageUsd", - "parsedDocstring": { - "text": "Resource usage costs in USD." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 148 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, { "kind": 1024, "kindString": "Property", @@ -7171,23 +11038,33 @@ }, "flags": {}, "groups": [], - "id": 191, - "module": "_models", - "name": "model_config", + "id": 336, + "module": "_configuration", + "name": "actor_task_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 170 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 150 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_task_id', 'apify_actor_task_id', ), description='ID of the Actor task. Empty if Actor is run outside of any task, e.g. directly using the API', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -7204,23 +11081,33 @@ }, "flags": {}, "groups": [], - "id": 192, - "module": "_models", - "name": "created_at", + "id": 337, + "module": "_configuration", + "name": "actor_events_ws_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 172 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 161 } ], "type": { - "name": "datetime", - "type": "reference" + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_events_websocket_url', 'apify_actor_events_ws_url', ), description='Websocket URL where Actor may listen for events from Actor platform', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -7237,18 +11124,18 @@ }, "flags": {}, "groups": [], - "id": 193, - "module": "_models", - "name": "actor_id", + "id": 338, + "module": "_configuration", + "name": "api_base_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 173 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 172 } ], "type": { @@ -7270,18 +11157,18 @@ }, "flags": {}, "groups": [], - "id": 194, - "module": "_models", - "name": "build_id", + "id": 339, + "module": "_configuration", + "name": "api_public_base_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 174 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 180 } ], "type": { @@ -7303,27 +11190,27 @@ }, "flags": {}, "groups": [], - "id": 195, - "module": "_models", - "name": "input_key", + "id": 340, + "module": "_configuration", + "name": "dedicated_cpus", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 175 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 188 } ], "type": { - "name": "Annotated[str | None, Field(alias='inputKey')]", + "name": "Annotated[ float | None, Field( alias='apify_dedicated_cpus', description='Number of CPU cores reserved for the actor, based on allocated memory', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -7331,52 +11218,7 @@ } ] } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a metamorph event that occurred during the run." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 193, - 194, - 192, - 195, - 191 - ], - "title": "Properties" - } - ], - "id": 190, - "module": "_models", - "name": "Metamorph", - "parsedDocstring": { - "text": "Information about a metamorph event that occurred during the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 167 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { "kind": 1024, "kindString": "Property", @@ -7391,23 +11233,33 @@ }, "flags": {}, "groups": [], - "id": 197, - "module": "_models", - "name": "model_config", + "id": 341, + "module": "_configuration", + "name": "default_dataset_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 196 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_dataset_id', 'apify_default_dataset_id', ), description='Default dataset ID used by the Apify storage client when no ID or name is provided.', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -7424,27 +11276,27 @@ }, "flags": {}, "groups": [], - "id": 198, - "module": "_models", - "name": "apify_margin_percentage", + "id": 342, + "module": "_configuration", + "name": "default_key_value_store_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 207 } ], "type": { - "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_key_value_store_id', 'apify_default_key_value_store_id', ), description='Default key-value store ID for the Apify storage client when no ID or name is provided.', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", @@ -7467,27 +11319,27 @@ }, "flags": {}, "groups": [], - "id": 199, - "module": "_models", - "name": "created_at", + "id": 343, + "module": "_configuration", + "name": "default_request_queue_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 218 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_request_queue_id', 'apify_default_request_queue_id', ), description='Default request queue ID for the Apify storage client when no ID or name is provided.', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "str" }, { "type": "literal", @@ -7510,33 +11362,23 @@ }, "flags": {}, "groups": [], - "id": 200, - "module": "_models", - "name": "started_at", + "id": 344, + "module": "_configuration", + "name": "disable_outdated_warning", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 229 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='startedAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] + "name": "bool", + "type": "reference" } }, { @@ -7553,27 +11395,27 @@ }, "flags": {}, "groups": [], - "id": 201, - "module": "_models", - "name": "notified_about_future_change_at", + "id": 345, + "module": "_configuration", + "name": "fact", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 184 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 238 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "name": "Annotated[str | None, Field(alias='apify_fact')]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "str" }, { "type": "literal", @@ -7596,33 +11438,23 @@ }, "flags": {}, "groups": [], - "id": 202, - "module": "_models", - "name": "notified_about_change_at", + "id": 346, + "module": "_configuration", + "name": "input_key", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 240 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } }, { @@ -7639,22 +11471,22 @@ }, "flags": {}, "groups": [], - "id": 203, - "module": "_models", - "name": "reason_for_change", + "id": 347, + "module": "_configuration", + "name": "input_secrets_private_key_file", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 186 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252 } ], "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "name": "Annotated[ str | None, Field( alias='apify_input_secrets_private_key_file', description='Path to the secret key used to decrypt Secret inputs.', ), ]", "type": "union", "types": [ { @@ -7667,76 +11499,7 @@ } ] } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 198, - 199, - 197, - 202, - 201, - 203, - 200 - ], - "title": "Properties" - } - ], - "id": 196, - "module": "_models", - "name": "CommonActorPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 178 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "FreeActorPricingInfo", - "target": "204", - "type": "reference" }, - { - "name": "FlatPricePerMonthActorPricingInfo", - "target": "206", - "type": "reference" - }, - { - "name": "PricePerDatasetItemActorPricingInfo", - "target": "210", - "type": "reference" - }, - { - "name": "PayPerEventActorPricingInfo", - "target": "222", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ { "kind": 1024, "kindString": "Property", @@ -7751,27 +11514,31 @@ }, "flags": {}, "groups": [], - "id": 205, - "module": "_models", - "name": "pricing_model", + "id": 348, + "module": "_configuration", + "name": "input_secrets_private_key_passphrase", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 190 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 260 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "name": "Annotated[ str | None, Field( alias='apify_input_secrets_private_key_passphrase', description='Passphrase for the input secret key', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, { "type": "literal", - "value": "FREE" + "value": null } ] } @@ -7790,27 +11557,22 @@ }, "flags": {}, "groups": [], - "id": 1167, - "module": "_models", - "name": "model_config", + "id": 349, + "module": "_configuration", + "name": "is_at_home", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 268 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.model_config", - "target": 197, + "name": "bool", "type": "reference" } }, @@ -7828,38 +11590,33 @@ }, "flags": {}, "groups": [], - "id": 1168, - "module": "_models", - "name": "apify_margin_percentage", + "id": 350, + "module": "_configuration", + "name": "latest_sdk_version", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 276 } ], "type": { - "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "name": "Annotated[ str | None, Field( alias='apify_sdk_latest_version', description='Specifies the most recent release version of the Apify SDK for Javascript. Used for ' 'checking for updates.', ), deprecated('SDK version checking is not supported for the Python SDK'), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "str" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 198, - "type": "reference" } }, { @@ -7876,38 +11633,33 @@ }, "flags": {}, "groups": [], - "id": 1169, - "module": "_models", - "name": "created_at", + "id": 351, + "module": "_configuration", + "name": "log_format", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 286 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "name": "Annotated[ str | None, Field(alias='apify_log_format'), deprecated('Adjust the log format in code instead'), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "str" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 199, - "type": "reference" } }, { @@ -7924,38 +11676,33 @@ }, "flags": {}, "groups": [], - "id": 1170, - "module": "_models", - "name": "started_at", + "id": 352, + "module": "_configuration", + "name": "max_paid_dataset_items", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 292 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "name": "Annotated[ int | None, Field( 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(lambda val: val if val != '' else None), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "int" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 200, - "type": "reference" } }, { @@ -7972,38 +11719,33 @@ }, "flags": {}, "groups": [], - "id": 1171, - "module": "_models", - "name": "notified_about_future_change_at", + "id": 353, + "module": "_configuration", + "name": "max_total_charge_usd", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 184 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 301 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "name": "Annotated[ Decimal | None, Field( alias='actor_max_total_charge_usd', description='For pay-per-event Actors, the user-set limit on total charges. Do not exceed this limit', ), BeforeValidator(lambda val: val if val != '' else None), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "Decimal" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 201, - "type": "reference" } }, { @@ -8020,37 +11762,22 @@ }, "flags": {}, "groups": [], - "id": 1172, - "module": "_models", - "name": "notified_about_change_at", + "id": 354, + "module": "_configuration", + "name": "test_pay_per_event", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 310 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 202, + "name": "bool", "type": "reference" } }, @@ -8068,22 +11795,22 @@ }, "flags": {}, "groups": [], - "id": 1173, - "module": "_models", - "name": "reason_for_change", + "id": 355, + "module": "_configuration", + "name": "meta_origin", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 186 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 318 } ], "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "name": "Annotated[ str | None, Field( alias='apify_meta_origin', description='Specifies how an Actor run was started', ), ]", "type": "union", "types": [ { @@ -8095,68 +11822,41 @@ "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 203, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1168, - 1169, - 1167, - 1172, - 1171, - 205, - 1173, - 1170 - ], - "title": "Properties" - } - ], - "id": 204, - "module": "_models", - "name": "FreeActorPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 189 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ + }, { - "name": "CommonActorPricingInfo", - "target": "196", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 356, + "module": "_configuration", + "name": "metamorph_after_sleep", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 326 + } + ], + "type": { + "name": "timedelta_ms", + "type": "reference" + } + }, { "kind": 1024, "kindString": "Property", @@ -8171,29 +11871,23 @@ }, "flags": {}, "groups": [], - "id": 207, - "module": "_models", - "name": "pricing_model", + "id": 357, + "module": "_configuration", + "name": "proxy_hostname", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 194 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 334 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "FLAT_PRICE_PER_MONTH" - } - ] + "name": "str", + "type": "reference" } }, { @@ -8210,23 +11904,33 @@ }, "flags": {}, "groups": [], - "id": 208, - "module": "_models", - "name": "trial_minutes", + "id": 358, + "module": "_configuration", + "name": "proxy_password", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 195 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 342 } ], "type": { - "name": "int", - "type": "reference" + "name": "Annotated[ str | None, Field( alias='apify_proxy_password', description='Password to the Apify proxy', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -8243,22 +11947,22 @@ }, "flags": {}, "groups": [], - "id": 209, - "module": "_models", - "name": "price_per_unit_usd", + "id": 359, + "module": "_configuration", + "name": "proxy_port", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 196 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 350 } ], "type": { - "name": "float", + "name": "int", "type": "reference" } }, @@ -8276,27 +11980,22 @@ }, "flags": {}, "groups": [], - "id": 1174, - "module": "_models", - "name": "model_config", + "id": 360, + "module": "_configuration", + "name": "proxy_status_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 358 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.model_config", - "target": 197, + "name": "str", "type": "reference" } }, @@ -8314,38 +12013,33 @@ }, "flags": {}, "groups": [], - "id": 1175, - "module": "_models", - "name": "apify_margin_percentage", + "id": 361, + "module": "_configuration", + "name": "started_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 366 } ], "type": { - "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "name": "Annotated[ datetime | None, Field( validation_alias=AliasChoices( 'actor_started_at', 'apify_started_at', ), description='Date when the Actor was started', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "datetime" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 198, - "type": "reference" } }, { @@ -8362,22 +12056,22 @@ }, "flags": {}, "groups": [], - "id": 1176, - "module": "_models", - "name": "created_at", + "id": 362, + "module": "_configuration", + "name": "timeout_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 377 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "name": "Annotated[ datetime | None, Field( validation_alias=AliasChoices( 'actor_timeout_at', 'apify_timeout_at', ), description='Date when the Actor will time out', ), BeforeValidator(lambda val: val if val != '' else None), ]", "type": "union", "types": [ { @@ -8389,11 +12083,6 @@ "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 199, - "type": "reference" } }, { @@ -8410,37 +12099,22 @@ }, "flags": {}, "groups": [], - "id": 1177, - "module": "_models", - "name": "started_at", + "id": 363, + "module": "_configuration", + "name": "standby_port", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 389 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='startedAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 200, + "name": "int", "type": "reference" } }, @@ -8458,37 +12132,22 @@ }, "flags": {}, "groups": [], - "id": 1178, - "module": "_models", - "name": "notified_about_future_change_at", + "id": 364, + "module": "_configuration", + "name": "standby_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 184 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 398 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 201, + "name": "str", "type": "reference" } }, @@ -8506,38 +12165,33 @@ }, "flags": {}, "groups": [], - "id": 1179, - "module": "_models", - "name": "notified_about_change_at", + "id": 365, + "module": "_configuration", + "name": "token", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 407 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "name": "Annotated[ str | None, Field( alias='apify_token', description='API token of the user who started the Actor', ), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "str" }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 202, - "type": "reference" } }, { @@ -8554,22 +12208,22 @@ }, "flags": {}, "groups": [], - "id": 1180, - "module": "_models", - "name": "reason_for_change", + "id": 366, + "module": "_configuration", + "name": "user_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 186 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 415 } ], "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "name": "Annotated[ str | None, Field( alias='apify_user_id', description='ID of the user who started the Actor. May differ from the Actor owner', ), ]", "type": "union", "types": [ { @@ -8581,70 +12235,8 @@ "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 203, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1175, - 1176, - 1174, - 1179, - 1178, - 209, - 207, - 1180, - 1177, - 208 - ], - "title": "Properties" - } - ], - "id": 206, - "module": "_models", - "name": "FlatPricePerMonthActorPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 193 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "196", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { "kind": 1024, "kindString": "Property", @@ -8659,29 +12251,23 @@ }, "flags": {}, "groups": [], - "id": 211, - "module": "_models", - "name": "pricing_model", + "id": 367, + "module": "_configuration", + "name": "user_is_paying", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 200 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 423 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "PRICE_PER_DATASET_ITEM" - } - ] + "name": "bool", + "type": "reference" } }, { @@ -8698,22 +12284,22 @@ }, "flags": {}, "groups": [], - "id": 212, - "module": "_models", - "name": "unit_name", + "id": 368, + "module": "_configuration", + "name": "web_server_port", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 201 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 432 } ], "type": { - "name": "str", + "name": "int", "type": "reference" } }, @@ -8731,22 +12317,22 @@ }, "flags": {}, "groups": [], - "id": 213, - "module": "_models", - "name": "price_per_unit_usd", + "id": 369, + "module": "_configuration", + "name": "web_server_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 202 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 444 } ], "type": { - "name": "float", + "name": "str", "type": "reference" } }, @@ -8764,28 +12350,33 @@ }, "flags": {}, "groups": [], - "id": 1181, - "module": "_models", - "name": "model_config", + "id": 370, + "module": "_configuration", + "name": "workflow_key", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 455 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.model_config", - "target": 197, - "type": "reference" + "name": "Annotated[ str | None, Field( alias='apify_workflow_key', description='Identifier used for grouping related runs and API calls together', ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -8802,38 +12393,64 @@ }, "flags": {}, "groups": [], - "id": 1182, - "module": "_models", - "name": "apify_margin_percentage", + "id": 371, + "module": "_configuration", + "name": "actor_pricing_info", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 463 } ], "type": { - "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "name": "Annotated[ FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None, Field( alias='apify_actor_pricing_info', description='JSON string with prising info of the actor', discriminator='pricing_model', ), BeforeValidator(lambda data: json.loads(data) if isinstance(data, str) else data or None), ]", "type": "union", "types": [ { - "type": "reference", - "name": "float" + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "525" + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "527" + } + ] + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "531" + } + ] + }, + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "543" + } + ] }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 198, - "type": "reference" } }, { @@ -8850,38 +12467,43 @@ }, "flags": {}, "groups": [], - "id": 1183, - "module": "_models", - "name": "created_at", + "id": 372, + "module": "_configuration", + "name": "charged_event_counts", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 477 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "name": "Annotated[ dict[str, int] | None, Field( alias='apify_charged_actor_event_counts', description='Counts of events that were charged for the actor', ), BeforeValidator(lambda data: json.loads(data) if isinstance(data, str) else data or None), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "int" + } + ] }, { "type": "literal", "value": null } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 199, - "type": "reference" } }, { @@ -8898,37 +12520,133 @@ }, "flags": {}, "groups": [], - "id": 1184, - "module": "_models", - "name": "started_at", + "id": 373, + "module": "_configuration", + "name": "actor_storages", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 486 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "name": "Annotated[ ActorStorages | None, Field( alias='actor_storages_json', description='Mapping of storage aliases to their platform-assigned IDs.', ), BeforeValidator(_load_storage_keys), ]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "ActorStorages", + "target": "324" }, { "type": "literal", "value": null } ] + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." + } + ] }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 200, + "decorations": [ + { + "args": "(mode='after')", + "name": "model_validator" + } + ], + "flags": {}, + "groups": [], + "id": 374, + "module": "_configuration", + "name": "disable_browser_sandbox_on_platform", + "parsedDocstring": { + "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 496 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." + } + ] + }, + "flags": {}, + "id": 375, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "disable_browser_sandbox_on_platform", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 376, + "module": "_configuration", + "name": "canonical_input_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 509 + } + ], + "type": { + "name": "str", "type": "reference" } }, @@ -8944,338 +12662,466 @@ } ] }, + "decorations": [ + { + "name": "property" + } + ], "flags": {}, "groups": [], - "id": 1185, - "module": "_models", - "name": "notified_about_future_change_at", + "id": 377, + "module": "_configuration", + "name": "input_key_candidates", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 184 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 513 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ + "name": "set", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null + "name": "str" } ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 201, - "type": "reference" } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." } ] }, + "decorations": [ + { + "name": "classmethod" + } + ], "flags": {}, "groups": [], - "id": 1186, - "module": "_models", - "name": "notified_about_change_at", + "id": 378, + "module": "_configuration", + "name": "get_global_configuration", "parsedDocstring": { - "text": "" + "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 517 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 379, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_global_configuration", + "parameters": [], + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 202, - "type": "reference" - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create Apify Configuration from existing Crawlee Configuration.\n" } ] }, + "decorations": [ + { + "name": "classmethod" + } + ], "flags": {}, "groups": [], - "id": 1187, - "module": "_models", - "name": "reason_for_change", + "id": 380, + "module": "_configuration", + "name": "from_configuration", "parsedDocstring": { - "text": "" + "text": "Create Apify Configuration from existing Crawlee Configuration.\n", + "args": { + "configuration": "The existing Crawlee Configuration.\n" + }, + "returns": "The created Apify Configuration." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 186 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 538 } ], "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Apify Configuration." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create Apify Configuration from existing Crawlee Configuration.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 381, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "from_configuration", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The existing Crawlee Configuration.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 382, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration", + "type": "reference" + } + } + ], + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 203, - "type": "reference" - } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "A class for specifying the configuration of an Actor.\n\nCan be used either globally via `Configuration.get_global_configuration()`,\nor it can be specific to each `Actor` instance on the `actor.config` property." } ] }, + "decorations": [ + { + "args": "('Configuration')", + "name": "docs_group" + } + ], "flags": {}, "groups": [ { "children": [ - 1182, - 1183, - 1181, - 1186, - 1185, - 213, - 211, - 1187, - 1184, - 212 + 374, + 380, + 378 + ], + "title": "Methods" + }, + { + "children": [ + 333, + 334, + 335, + 337, + 330, + 329, + 331, + 371, + 332, + 373, + 336, + 338, + 339, + 376, + 372, + 340, + 341, + 342, + 343, + 344, + 345, + 346, + 377, + 347, + 348, + 349, + 350, + 351, + 352, + 353, + 355, + 356, + 357, + 358, + 359, + 360, + 363, + 364, + 361, + 354, + 362, + 365, + 366, + 367, + 368, + 369, + 370 ], "title": "Properties" } ], - "id": 210, - "module": "_models", - "name": "PricePerDatasetItemActorPricingInfo", + "id": 328, + "module": "_configuration", + "name": "Configuration", "parsedDocstring": { - "text": "" + "text": "A class for specifying the configuration of an Actor.\n\nCan be used either globally via `Configuration.get_global_configuration()`,\nor it can be specific to each `Actor` instance on the `actor.config` property." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 199 + "fileName": "/src/apify/_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 75 } ], "type": { "name": "Undefined", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "extendedTypes": [ + "flags": {}, + "groups": [], + "id": 383, + "module": "_consts", + "name": "EVENT_LISTENERS_TIMEOUT", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "CommonActorPricingInfo", - "target": "196", - "type": "reference" + "character": 1, + "fileName": "/src/apify/_consts.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 6 } - ] + ], + "type": { + "name": "Undefined", + "type": "reference" + } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 215, - "module": "_models", - "name": "model_config", - "parsedDocstring": { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 206 - } - ], - "type": { - "name": "Undefined", - "type": "reference" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 384, + "module": "_consts", + "name": "BASE64_REGEXP", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 216, - "module": "_models", - "name": "event_price_usd", - "parsedDocstring": { + "character": 1, + "fileName": "/src/apify/_consts.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 208 - } - ], - "type": { - "name": "float", - "type": "reference" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 385, + "module": "_consts", + "name": "ENCRYPTED_STRING_VALUE_PREFIX", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 217, - "module": "_models", - "name": "event_title", - "parsedDocstring": { + "character": 1, + "fileName": "/src/apify/_consts.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 209 - } - ], - "type": { - "name": "str", - "type": "reference" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 386, + "module": "_consts", + "name": "ENCRYPTED_JSON_VALUE_PREFIX", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 218, - "module": "_models", - "name": "event_description", - "parsedDocstring": { + "character": 1, + "fileName": "/src/apify/_consts.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 210 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='eventDescription')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] } + ] + }, + "flags": {}, + "groups": [], + "id": 387, + "module": "_consts", + "name": "ENCRYPTED_INPUT_VALUE_REGEXP", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_consts.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 11 } ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { @@ -9285,29 +13131,19 @@ ] }, "flags": {}, - "groups": [ - { - "children": [ - 218, - 216, - 217, - 215 - ], - "title": "Properties" - } - ], - "id": 214, - "module": "_models", - "name": "ActorChargeEvent", + "groups": [], + "id": 388, + "module": "_crypto", + "name": "ENCRYPTION_KEY_LENGTH", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 205 + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 19 } ], "type": { @@ -9316,97 +13152,42 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 220, - "module": "_models", - "name": "model_config", - "parsedDocstring": { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 214 - } - ], - "type": { - "name": "Undefined", - "type": "reference" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 389, + "module": "_crypto", + "name": "ENCRYPTION_IV_LENGTH", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 221, - "module": "_models", - "name": "actor_charge_events", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 216 - } - ], - "type": { - "name": "Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "ActorChargeEvent", - "target": "214" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { @@ -9416,27 +13197,19 @@ ] }, "flags": {}, - "groups": [ - { - "children": [ - 221, - 220 - ], - "title": "Properties" - } - ], - "id": 219, - "module": "_models", - "name": "PricingPerEvent", + "groups": [], + "id": 390, + "module": "_crypto", + "name": "ENCRYPTION_AUTH_TAG_LENGTH", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 213 + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 } ], "type": { @@ -9445,503 +13218,692 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 223, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 220 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "PAY_PER_EVENT" - } - ] + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value." } - }, + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 391, + "module": "_crypto", + "name": "public_encrypt", + "parsedDocstring": { + "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value.", + "args": { + "value": "The value which should be encrypted.", + "public_key": "Public key to use for encryption.\n" + } + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 224, - "module": "_models", - "name": "pricing_per_event", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 221 - } - ], - "type": { - "name": "PricingPerEvent", - "type": "reference", - "target": "219" - } - }, + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value." } ] }, "flags": {}, - "groups": [], - "id": 225, - "module": "_models", - "name": "minimal_max_total_charge_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 392, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "public_encrypt", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 222 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value which should be encrypted." + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 393, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str", + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 1188, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public key to use for encryption.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 394, + "kind": 32768, + "kindString": "Parameter", + "name": "public_key", + "type": { + "name": "rsa.RSAPublicKey", + "type": "reference" + } } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.model_config", - "target": 197, + "name": "dict", "type": "reference" } - }, + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 395, + "module": "_crypto", + "name": "private_decrypt", + "parsedDocstring": { + "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value.", + "args": { + "encrypted_password": "Password used to encrypt the private key encoded as base64 string.", + "encrypted_value": "Encrypted value to decrypt as base64 string.", + "private_key": "Private key to use for decryption.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value." } ] }, "flags": {}, - "groups": [], - "id": 1189, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "private_decrypt", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Password used to encrypt the private key encoded as base64 string." + } + ] }, - { - "type": "literal", - "value": null + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 397, + "kind": 32768, + "kindString": "Parameter", + "name": "encrypted_password", + "type": { + "name": "str", + "type": "reference" } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 198, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encrypted value to decrypt as base64 string." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 398, + "kind": 32768, + "kindString": "Parameter", + "name": "encrypted_value", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Private key to use for decryption.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 399, + "kind": 32768, + "kindString": "Parameter", + "name": "private_key", + "type": { + "name": "rsa.RSAPrivateKey", + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 1190, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 182 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='createdAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 199, + "name": "str", "type": "reference" } - }, + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 400, + "module": "_crypto", + "name": "load_private_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, - "groups": [], - "id": 1191, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 401, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "load_private_key", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 402, + "kind": 32768, + "kindString": "Parameter", + "name": "private_key_file_base64", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 403, + "kind": 32768, + "kindString": "Parameter", + "name": "private_key_password", + "type": { + "name": "str", + "type": "reference" + } } ], "type": { - "name": "Annotated[datetime | None, Field(alias='startedAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 200, + "name": "rsa.RSAPrivateKey", "type": "reference" } - }, + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Decrypt input secrets." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 404, + "module": "_crypto", + "name": "decrypt_input_secrets", + "parsedDocstring": { + "text": "Decrypt input secrets." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 137 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Decrypt input secrets." } ] }, "flags": {}, - "groups": [], - "id": 1192, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 405, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "decrypt_input_secrets", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 184 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 406, + "kind": 32768, + "kindString": "Parameter", + "name": "private_key", + "type": { + "name": "rsa.RSAPrivateKey", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 407, + "kind": 32768, + "kindString": "Parameter", + "name": "input_data", + "type": { + "name": "Any", + "type": "reference" + } } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 201, + "name": "Any", "type": "reference" } - }, + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 408, + "module": "_crypto", + "name": "CHARSET", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 163 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode the given number to base62." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 409, + "module": "_crypto", + "name": "encode_base62", + "parsedDocstring": { + "text": "Encode the given number to base62." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 166 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Encode the given number to base62." } ] }, "flags": {}, - "groups": [], - "id": 1193, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 410, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "encode_base62", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 411, + "kind": 32768, + "kindString": "Parameter", + "name": "num", + "type": { + "name": "int", + "type": "reference" + } } ], "type": { - "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 202, + "name": "str", "type": "reference" } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 412, + "module": "_crypto", + "name": "create_hmac_signature", + "parsedDocstring": { + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n", + "args": { + "secret_key": "Secret key used for signing signatures.", + "message": "Message to be signed.\n" }, + "returns": "Base62 encoded signature." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_crypto.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 178 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Base62 encoded signature." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "" + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n" } ] }, "flags": {}, - "groups": [], - "id": 1194, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 413, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_hmac_signature", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 186 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Secret key used for signing signatures." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 414, + "kind": 32768, + "kindString": "Parameter", + "name": "secret_key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Message to be signed.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 415, + "kind": 32768, + "kindString": "Parameter", + "name": "message", + "type": { + "name": "str", + "type": "reference" + } } ], "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 203, + "name": "str", "type": "reference" } } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pricing model for an Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 416, + "module": "_models", + "name": "PricingModel", + "parsedDocstring": { + "text": "Pricing model for an Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 13 + } ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Defines the general access level for the resource." } ] }, "flags": {}, - "groups": [ - { - "children": [ - 1189, - 1190, - 225, - 1188, - 1193, - 1192, - 223, - 224, - 1194, - 1191 - ], - "title": "Properties" - } - ], - "id": 222, + "groups": [], + "id": 417, "module": "_models", - "name": "PayPerEventActorPricingInfo", + "name": "GeneralAccess", "parsedDocstring": { - "text": "" + "text": "Defines the general access level for the resource." }, "sources": [ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 219 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "type": { "name": "Undefined", "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "196", - "type": "reference" - } - ] + } }, { "kind": 128, @@ -9961,7 +13923,7 @@ }, "flags": {}, "groups": [], - "id": 227, + "id": 419, "module": "_models", "name": "model_config", "parsedDocstring": { @@ -9971,8 +13933,8 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 227 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { @@ -9994,108 +13956,9 @@ }, "flags": {}, "groups": [], - "id": 228, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 229 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 229, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 230 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 230, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 231 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 231, + "id": 420, "module": "_models", - "name": "actor_task_id", + "name": "actor_id", "parsedDocstring": { "text": "" }, @@ -10103,12 +13966,12 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 232 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "type": { - "name": "Annotated[str | None, Field(alias='actorTaskId')]", + "name": "Annotated[str | None, Field(alias='actorId')]", "type": "union", "types": [ { @@ -10136,42 +13999,9 @@ }, "flags": {}, "groups": [], - "id": 232, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 233 - } - ], - "type": { - "name": "datetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 233, + "id": 421, "module": "_models", - "name": "finished_at", + "name": "actor_task_id", "parsedDocstring": { "text": "" }, @@ -10179,17 +14009,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 234 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { - "name": "Annotated[datetime | None, Field(alias='finishedAt')]", + "name": "Annotated[str | None, Field(alias='actorTaskId')]", "type": "union", "types": [ { "type": "reference", - "name": "datetime" + "name": "str" }, { "type": "literal", @@ -10212,42 +14042,9 @@ }, "flags": {}, "groups": [], - "id": 234, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 235 - } - ], - "type": { - "name": "ActorJobStatus", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 235, + "id": 422, "module": "_models", - "name": "status_message", + "name": "actor_run_id", "parsedDocstring": { "text": "" }, @@ -10255,12 +14052,12 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 236 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 27 } ], "type": { - "name": "Annotated[str | None, Field(alias='statusMessage')]", + "name": "Annotated[str | None, Field(alias='actorRunId')]", "type": "union", "types": [ { @@ -10273,84 +14070,84 @@ } ] } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 236, - "module": "_models", - "name": "is_status_message_terminal", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 237 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Condition for triggering a webhook." } - }, + ] + }, + "flags": {}, + "groups": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 237, - "module": "_models", - "name": "meta", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 238 - } + "children": [ + 420, + 422, + 421, + 419 ], - "type": { - "name": "ActorRunMeta", - "type": "reference", - "target": "128" + "title": "Properties" + } + ], + "id": 418, + "module": "_models", + "name": "WebhookCondition", + "parsedDocstring": { + "text": "Condition for triggering a webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Status of a webhook dispatch." } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 423, + "module": "_models", + "name": "WebhookDispatchStatus", + "parsedDocstring": { + "text": "Status of a webhook dispatch." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 30 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -10365,9 +14162,9 @@ }, "flags": {}, "groups": [], - "id": 238, + "id": 425, "module": "_models", - "name": "stats", + "name": "model_config", "parsedDocstring": { "text": "" }, @@ -10375,14 +14172,13 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "type": { - "name": "ActorRunStats", - "type": "reference", - "target": "135" + "name": "Undefined", + "type": "reference" } }, { @@ -10399,9 +14195,9 @@ }, "flags": {}, "groups": [], - "id": 239, + "id": 426, "module": "_models", - "name": "options", + "name": "status", "parsedDocstring": { "text": "" }, @@ -10409,14 +14205,14 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 240 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 39 } ], "type": { - "name": "ActorRunOptions", + "name": "WebhookDispatchStatus", "type": "reference", - "target": "154" + "target": "423" } }, { @@ -10433,9 +14229,9 @@ }, "flags": {}, "groups": [], - "id": 240, + "id": 427, "module": "_models", - "name": "build_id", + "name": "finished_at", "parsedDocstring": { "text": "" }, @@ -10443,134 +14239,58 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 241 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40 } ], "type": { - "name": "str", + "name": "datetime", "type": "reference" } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 241, - "module": "_models", - "name": "exit_code", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 242 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='exitCode')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a webhook dispatch." } - }, + ] + }, + "flags": {}, + "groups": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 242, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 243 - } + "children": [ + 427, + 425, + 426 ], - "type": { - "name": "Annotated[str | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, + "title": "Properties" + } + ], + "id": 424, + "module": "_models", + "name": "ExampleWebhookDispatch", + "parsedDocstring": { + "text": "Information about a webhook dispatch." + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 243, - "module": "_models", - "name": "default_key_value_store_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 244 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -10585,9 +14305,9 @@ }, "flags": {}, "groups": [], - "id": 244, + "id": 429, "module": "_models", - "name": "default_dataset_id", + "name": "model_config", "parsedDocstring": { "text": "" }, @@ -10595,12 +14315,12 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 245 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 46 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" } }, @@ -10618,9 +14338,9 @@ }, "flags": {}, "groups": [], - "id": 245, + "id": 430, "module": "_models", - "name": "default_request_queue_id", + "name": "total_dispatches", "parsedDocstring": { "text": "" }, @@ -10628,15 +14348,57 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 246 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 48 } ], "type": { - "name": "str", + "name": "int", "type": "reference" } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics about webhook dispatches." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 429, + 430 + ], + "title": "Properties" + } + ], + "id": 428, + "module": "_models", + "name": "WebhookStats", + "parsedDocstring": { + "text": "Statistics about webhook dispatches." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -10651,9 +14413,9 @@ }, "flags": {}, "groups": [], - "id": 246, + "id": 432, "module": "_models", - "name": "build_number", + "name": "model_config", "parsedDocstring": { "text": "" }, @@ -10661,23 +14423,13 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 247 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 53 } ], "type": { - "name": "Annotated[str | None, Field(alias='buildNumber')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Undefined", + "type": "reference" } }, { @@ -10694,9 +14446,9 @@ }, "flags": {}, "groups": [], - "id": 247, + "id": 433, "module": "_models", - "name": "container_url", + "name": "event_types", "parsedDocstring": { "text": "" }, @@ -10704,21 +14456,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 248 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "type": { - "name": "Annotated[str | None, Field(alias='containerUrl')]", - "type": "union", - "types": [ + "name": "list", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null + "name": "WebhookEventType" } ] } @@ -10737,9 +14485,9 @@ }, "flags": {}, "groups": [], - "id": 248, + "id": 434, "module": "_models", - "name": "is_container_server_ready", + "name": "request_url", "parsedDocstring": { "text": "" }, @@ -10747,23 +14495,13 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 249 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 59 } ], "type": { - "name": "Annotated[bool | None, Field(alias='isContainerServerReady')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } }, { @@ -10780,9 +14518,9 @@ }, "flags": {}, "groups": [], - "id": 249, + "id": 435, "module": "_models", - "name": "git_branch_name", + "name": "id", "parsedDocstring": { "text": "" }, @@ -10790,12 +14528,12 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 250 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 64 } ], "type": { - "name": "Annotated[str | None, Field(alias='gitBranchName')]", + "name": "Annotated[str | None, Field(alias='id')]", "type": "union", "types": [ { @@ -10823,9 +14561,9 @@ }, "flags": {}, "groups": [], - "id": 250, + "id": 436, "module": "_models", - "name": "usage", + "name": "created_at", "parsedDocstring": { "text": "" }, @@ -10833,18 +14571,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 251 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 65 } ], "type": { - "name": "Annotated[ActorRunUsage | None, Field(alias='usage')]", + "name": "Annotated[datetime | None, Field(alias='createdAt')]", "type": "union", "types": [ { "type": "reference", - "name": "ActorRunUsage", - "target": "162" + "name": "datetime" }, { "type": "literal", @@ -10867,9 +14604,9 @@ }, "flags": {}, "groups": [], - "id": 251, + "id": 437, "module": "_models", - "name": "usage_total_usd", + "name": "modified_at", "parsedDocstring": { "text": "" }, @@ -10877,17 +14614,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 252 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 66 } ], "type": { - "name": "Annotated[float | None, Field(alias='usageTotalUsd')]", + "name": "Annotated[datetime | None, Field(alias='modifiedAt')]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "datetime" }, { "type": "literal", @@ -10910,9 +14647,9 @@ }, "flags": {}, "groups": [], - "id": 252, + "id": 438, "module": "_models", - "name": "usage_usd", + "name": "user_id", "parsedDocstring": { "text": "" }, @@ -10920,18 +14657,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 253 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67 } ], "type": { - "name": "Annotated[ActorRunUsageUsd | None, Field(alias='usageUsd')]", + "name": "Annotated[str | None, Field(alias='userId')]", "type": "union", "types": [ { "type": "reference", - "name": "ActorRunUsageUsd", - "target": "176" + "name": "str" }, { "type": "literal", @@ -10954,9 +14690,9 @@ }, "flags": {}, "groups": [], - "id": 253, + "id": 439, "module": "_models", - "name": "pricing_info", + "name": "is_ad_hoc", "parsedDocstring": { "text": "" }, @@ -10964,48 +14700,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 254 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 68 } ], "type": { - "name": "Annotated[ FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None, Field(alias='pricingInfo', discriminator='pricing_model'), ]", + "name": "Annotated[bool | None, Field(alias='isAdHoc')]", "type": "union", "types": [ { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "204" - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "206" - } - ] - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "210" - } - ] - }, - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "222" - } - ] + "type": "reference", + "name": "bool" }, { "type": "literal", @@ -11028,9 +14733,9 @@ }, "flags": {}, "groups": [], - "id": 254, + "id": 440, "module": "_models", - "name": "charged_event_counts", + "name": "should_interpolate_strings", "parsedDocstring": { "text": "" }, @@ -11038,27 +14743,17 @@ { "character": 1, "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 262 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 69 } ], "type": { - "name": "Annotated[ dict[str, int] | None, Field(alias='chargedEventCounts'), ]", + "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings')]", "type": "union", "types": [ { "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "int" - } - ] + "name": "bool" }, { "type": "literal", @@ -11081,838 +14776,340 @@ }, "flags": {}, "groups": [], - "id": 255, + "id": 441, "module": "_models", - "name": "metamorphs", + "name": "condition", "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 266 - } - ], - "type": { - "name": "Annotated[list[Metamorph] | None, Field(alias='metamorphs')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Metamorph", - "target": "190" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Actor')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 229, - 231, - 240, - 246, - 254, - 247, - 244, - 243, - 245, - 241, - 233, - 242, - 249, - 228, - 248, - 236, - 237, - 255, - 227, - 239, - 253, - 232, - 238, - 234, - 235, - 250, - 251, - 252, - 230 - ], - "title": "Properties" - } - ], - "id": 226, - "module": "_models", - "name": "ActorRun", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 226 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 256, - "module": "_crypto", - "name": "ENCRYPTION_KEY_LENGTH", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 19 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 257, - "module": "_crypto", - "name": "ENCRYPTION_IV_LENGTH", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 258, - "module": "_crypto", - "name": "ENCRYPTION_AUTH_TAG_LENGTH", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 259, - "module": "_crypto", - "name": "public_encrypt", - "parsedDocstring": { - "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value.", - "args": { - "value": "The value which should be encrypted.", - "public_key": "Public key to use for encryption.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encrypts the given value using AES cipher and the password for encryption using the public key.\n\nThe encryption password is a string of encryption key and initial vector used for cipher.\nIt returns the encrypted password and encrypted value in BASE64 format.\n\n\nReturns: Encrypted password and value." - } - ] - }, - "flags": {}, - "id": 260, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "public_encrypt", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value which should be encrypted." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 261, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public key to use for encryption.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 262, - "kind": 32768, - "kindString": "Parameter", - "name": "public_key", - "type": { - "name": "rsa.RSAPublicKey", - "type": "reference" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 263, - "module": "_crypto", - "name": "private_decrypt", - "parsedDocstring": { - "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value.", - "args": { - "encrypted_password": "Password used to encrypt the private key encoded as base64 string.", - "encrypted_value": "Encrypted value to decrypt as base64 string.", - "private_key": "Private key to use for decryption.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 70 + } + ], + "type": { + "name": "Annotated[WebhookCondition | None, Field(alias='condition')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookCondition", + "target": "418" + }, + { + "type": "literal", + "value": null + } + ] + } + }, { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Decrypts the given encrypted value using the private key and password.\n\n\nReturns: Decrypted value." + "text": "" } ] }, "flags": {}, - "id": 264, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "private_decrypt", - "parameters": [ + "groups": [], + "id": 442, + "module": "_models", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Password used to encrypt the private key encoded as base64 string." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 71 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='ignoreSslErrors')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" }, - "id": 265, - "kind": 32768, - "kindString": "Parameter", - "name": "encrypted_password", - "type": { - "name": "str", - "type": "reference" + { + "type": "literal", + "value": null } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encrypted value to decrypt as base64 string." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 266, - "kind": 32768, - "kindString": "Parameter", - "name": "encrypted_value", - "type": { - "name": "str", - "type": "reference" + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 443, + "module": "_models", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Private key to use for decryption.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 267, - "kind": 32768, - "kindString": "Parameter", - "name": "private_key", - "type": { - "name": "rsa.RSAPrivateKey", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 72 } ], "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "name": "Annotated[bool | None, Field(alias='doNotRetry')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 268, - "module": "_crypto", - "name": "load_private_key", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 118 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + }, { - "flags": {}, - "id": 269, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "load_private_key", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 270, - "kind": 32768, - "kindString": "Parameter", - "name": "private_key_file_base64", - "type": { - "name": "str", - "type": "reference" + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 444, + "module": "_models", + "name": "payload_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 271, - "kind": 32768, - "kindString": "Parameter", - "name": "private_key_password", - "type": { - "name": "str", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 73 } ], "type": { - "name": "rsa.RSAPrivateKey", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Decrypt input secrets." + "name": "Annotated[ str | None, Field(alias='payloadTemplate', description='Template for the payload sent by the webhook'), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 272, - "module": "_crypto", - "name": "decrypt_input_secrets", - "parsedDocstring": { - "text": "Decrypt input secrets." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 137 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + }, { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Decrypt input secrets." + "text": "" } ] }, "flags": {}, - "id": 273, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "decrypt_input_secrets", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 274, - "kind": 32768, - "kindString": "Parameter", - "name": "private_key", - "type": { - "name": "rsa.RSAPrivateKey", - "type": "reference" - } - }, + "groups": [], + "id": 445, + "module": "_models", + "name": "headers_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 275, - "kind": 32768, - "kindString": "Parameter", - "name": "input_data", - "type": { - "name": "Any", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "type": { - "name": "Any", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 276, - "module": "_crypto", - "name": "CHARSET", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 163 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encode the given number to base62." + "name": "Annotated[str | None, Field(alias='headersTemplate')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 277, - "module": "_crypto", - "name": "encode_base62", - "parsedDocstring": { - "text": "Encode the given number to base62." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 166 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + }, { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Encode the given number to base62." + "text": "" } ] }, "flags": {}, - "id": 278, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "encode_base62", - "parameters": [ + "groups": [], + "id": 446, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 279, - "kind": 32768, - "kindString": "Parameter", - "name": "num", - "type": { - "name": "int", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 78 } ], "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n" + "name": "Annotated[str | None, Field(alias='description')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 280, - "module": "_crypto", - "name": "create_hmac_signature", - "parsedDocstring": { - "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n", - "args": { - "secret_key": "Secret key used for signing signatures.", - "message": "Message to be signed.\n" }, - "returns": "Base62 encoded signature." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_crypto.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 178 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Base62 encoded signature." - } - ], - "tag": "@returns" - } - ], + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { "summary": [ { "kind": "text", - "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n" + "text": "" } ] }, "flags": {}, - "id": 281, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_hmac_signature", - "parameters": [ + "groups": [], + "id": 447, + "module": "_models", + "name": "last_dispatch", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Secret key used for signing signatures." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 79 + } + ], + "type": { + "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleWebhookDispatch", + "target": "424" }, - "id": 282, - "kind": 32768, - "kindString": "Parameter", - "name": "secret_key", - "type": { - "name": "str", - "type": "reference" + { + "type": "literal", + "value": null } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Message to be signed.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 283, - "kind": 32768, - "kindString": "Parameter", - "name": "message", - "type": { - "name": "str", - "type": "reference" + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 448, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 80 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[WebhookStats | None, Field(alias='stats')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookStats", + "target": "428" + }, + { + "type": "literal", + "value": null + } + ] } } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + ], "comment": { "summary": [ { @@ -11921,53 +15118,49 @@ } ] }, - "flags": {}, - "groups": [], - "id": 284, - "module": "log", - "name": "logger_name", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/log.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 8 + "args": "('Actor')", + "name": "docs_group" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, - "groups": [], - "id": 285, - "module": "log", - "name": "logger", + "groups": [ + { + "children": [ + 441, + 436, + 446, + 443, + 433, + 445, + 435, + 442, + 439, + 447, + 432, + 437, + 444, + 434, + 440, + 448, + 438 + ], + "title": "Properties" + } + ], + "id": 431, + "module": "_models", + "name": "Webhook", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/log.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 11 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 52 } ], "type": { @@ -11978,106 +15171,246 @@ { "kind": 128, "kindString": "Class", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 450, + "module": "_models", + "name": "model_config", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 85 + } + ], + "type": { + "name": "Undefined", + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 286, - "module": "log", - "name": "ActorLogFormatter", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/log.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 451, + "module": "_models", + "name": "origin", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 87 + } + ], + "type": { + "name": "MetaOrigin", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 452, + "module": "_models", + "name": "client_ip", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 88 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='clientIp')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 287, - "module": "_proxy_configuration", - "name": "APIFY_PROXY_VALUE_REGEX", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 453, + "module": "_models", + "name": "user_agent", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 89 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='userAgent')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 288, - "module": "_proxy_configuration", - "name": "COUNTRY_CODE_REGEX", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 454, + "module": "_models", + "name": "schedule_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 90 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='scheduleId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 455, + "module": "_models", + "name": "scheduled_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 91 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='scheduledAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + } } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { @@ -12086,103 +15419,82 @@ } ] }, - "flags": {}, - "groups": [], - "id": 289, - "module": "_proxy_configuration", - "name": "SESSION_ID_MAX_LENGTH", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 30 + "args": "('Actor')", + "name": "docs_group" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if the given string is a valid URL." - } - ] - }, - "decorations": [], "flags": {}, - "groups": [], - "id": 290, - "module": "_proxy_configuration", - "name": "is_url", + "groups": [ + { + "children": [ + 452, + 450, + 451, + 454, + 455, + 453 + ], + "title": "Properties" + } + ], + "id": 449, + "module": "_models", + "name": "ActorRunMeta", "parsedDocstring": { - "text": "Check if the given string is a valid URL." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 33 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Check if the given string is a valid URL." + "text": "" } ] }, "flags": {}, - "id": 291, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "is_url", - "parameters": [ + "groups": [], + "id": 457, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 292, - "kind": 32768, - "kindString": "Parameter", - "name": "url", - "type": { - "name": "str", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 96 } ], "type": { - "name": "bool", + "name": "Undefined", "type": "reference" } - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { "kind": 1024, "kindString": "Property", @@ -12191,33 +15503,37 @@ "summary": [ { "kind": "text", - "text": "An array of proxy groups to be used by the [Apify Proxy](https://docs.apify.com/proxy). If not provided,\nthe proxy will select the groups automatically." + "text": "" } ] }, "flags": {}, "groups": [], - "id": 294, - "module": "_proxy_configuration", - "name": "groups", + "id": 458, + "module": "_models", + "name": "input_body_len", "parsedDocstring": { - "text": "An array of proxy groups to be used by the [Apify Proxy](https://docs.apify.com/proxy). If not provided,\nthe proxy will select the groups automatically." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98 } ], "type": { - "name": "list", - "type": "reference", - "typeArguments": [ + "name": "Annotated[int | None, Field(alias='inputBodyLen')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "int" + }, + { + "type": "literal", + "value": null } ] } @@ -12230,33 +15546,33 @@ "summary": [ { "kind": "text", - "text": "If set and relevant proxies are available in your Apify account, all proxied requests will use IP addresses\nthat are geolocated to the specified country. For example `GB` for IPs from Great Britain. Note that online\nservices often have their own rules for handling geolocation and thus the country selection is a best attempt\nat geolocation, rather than a guaranteed hit. This parameter is optional, by default, each proxied request is\nassigned an IP address from a random country. The country code needs to be a two letter ISO country code.\nSee the [full list of available country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).\nThis parameter is optional, by default, the proxy uses all available proxy servers from all countries." + "text": "" } ] }, "flags": {}, "groups": [], - "id": 295, - "module": "_proxy_configuration", - "name": "country_code", + "id": 459, + "module": "_models", + "name": "migration_count", "parsedDocstring": { - "text": "If set and relevant proxies are available in your Apify account, all proxied requests will use IP addresses\nthat are geolocated to the specified country. For example `GB` for IPs from Great Britain. Note that online\nservices often have their own rules for handling geolocation and thus the country selection is a best attempt\nat geolocation, rather than a guaranteed hit. This parameter is optional, by default, each proxied request is\nassigned an IP address from a random country. The country code needs to be a two letter ISO country code.\nSee the [full list of available country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).\nThis parameter is optional, by default, the proxy uses all available proxy servers from all countries." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 82 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 99 } ], "type": { - "name": "str | None", + "name": "Annotated[int | None, Field(alias='migrationCount')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -12264,745 +15580,417 @@ } ] } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provides information about a proxy connection that is used for requests." - } - ] - }, - "decorations": [ - { - "args": "('Configuration')", - "name": "docs_group" }, { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 295, - 294 - ], - "title": "Properties" - } - ], - "id": 293, - "module": "_proxy_configuration", - "name": "ProxyInfo", - "parsedDocstring": { - "text": "Provides information about a proxy connection that is used for requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 75 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 297, - "module": "_proxy_configuration", - "name": "__init__", + "id": 460, + "module": "_models", + "name": "reboot_count", "parsedDocstring": { - "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n", - "args": { - "password": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available.", - "groups": "Proxy groups which the Apify Proxy should use, if provided.", - "country_code": "Country which the Apify Proxy should use, if provided.", - "proxy_urls": "Custom proxy server URLs which should be rotated through.", - "new_url_function": "Function which returns a custom proxy URL to be used.", - "tiered_proxy_urls": "Proxy URLs arranged into tiers" - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 108 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 100 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n" - } - ] + "name": "Annotated[int | None, Field(alias='rebootCount')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" }, - "flags": {}, - "id": 298, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 299, - "kind": 32768, - "kindString": "Parameter", - "name": "password", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Proxy groups which the Apify Proxy should use, if provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 300, - "kind": 32768, - "kindString": "Parameter", - "name": "groups", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Country which the Apify Proxy should use, if provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 301, - "kind": 32768, - "kindString": "Parameter", - "name": "country_code", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom proxy server URLs which should be rotated through." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 302, - "kind": 32768, - "kindString": "Parameter", - "name": "proxy_urls", - "type": { - "name": "list[str | None] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function which returns a custom proxy URL to be used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 303, - "kind": 32768, - "kindString": "Parameter", - "name": "new_url_function", - "type": { - "name": "_NewUrlFunction | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "_NewUrlFunction" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Proxy URLs arranged into tiers" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 304, - "kind": 32768, - "kindString": "Parameter", - "name": "tiered_proxy_urls", - "type": { - "name": "list[list[str | None]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 305, - "kind": 32768, - "kindString": "Parameter", - "name": "_actor_config", - "type": { - "name": "Configuration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Configuration", - "target": "319" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 306, - "kind": 32768, - "kindString": "Parameter", - "name": "_apify_client", - "type": { - "name": "ApifyClientAsync | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ApifyClientAsync" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", + { "type": "literal", "value": null } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 461, + "module": "_models", + "name": "restart_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 101 } - ] + ], + "type": { + "name": "int", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 307, - "module": "_proxy_configuration", - "name": "initialize", + "id": 462, + "module": "_models", + "name": "resurrect_count", "parsedDocstring": { - "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 180 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 102 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 463, + "module": "_models", + "name": "mem_avg_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." - } - ] + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='memAvgBytes')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" }, - "flags": {}, - "id": 308, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "initialize", - "parameters": [], - "type": { - "name": "None", + { "type": "literal", "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 309, - "module": "_proxy_configuration", - "name": "new_proxy_info", + "id": 464, + "module": "_models", + "name": "mem_max_bytes", "parsedDocstring": { - "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n", - "args": { - "session_id": "Represents the identifier of a proxy session (https://docs.apify.com/proxy#sessions).\nAll the HTTP requests going through the proxy with the same session identifier will use the same\ntarget proxy server (i.e. the same IP address). The identifier must not be longer than 50 characters\nand include only the following: `0-9`, `a-z`, `A-Z`, `\".\"`, `\"_\"` and `\"~\"`.", - "request": "request for which the proxy info is being issued, used in proxy tier handling.", - "proxy_tier": "allows forcing the proxy tier to be used.\n" - }, - "returns": "Dictionary that represents information about the proxy and its configuration." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 205 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 104 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "Annotated[int | None, Field(alias='memMaxBytes')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 465, + "module": "_models", + "name": "mem_current_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Dictionary that represents information about the proxy and its configuration." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n" - } - ] + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 105 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memCurrentBytes')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" }, - "flags": {}, - "id": 310, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "new_proxy_info", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents the identifier of a proxy session (https://docs.apify.com/proxy#sessions).\nAll the HTTP requests going through the proxy with the same session identifier will use the same\ntarget proxy server (i.e. the same IP address). The identifier must not be longer than 50 characters\nand include only the following: `0-9`, `a-z`, `A-Z`, `\".\"`, `\"_\"` and `\"~\"`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 311, - "kind": 32768, - "kindString": "Parameter", - "name": "session_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "request for which the proxy info is being issued, used in proxy tier handling." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 312, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "allows forcing the proxy tier to be used.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 313, - "kind": 32768, - "kindString": "Parameter", - "name": "proxy_tier", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ProxyInfo | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProxyInfo", - "target": "293" - }, - { - "type": "literal", - "value": null - } - ] + { + "type": "literal", + "value": null } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configures a connection to a proxy server with the provided options.\n\nProxy servers are used to prevent target websites from blocking your crawlers based on IP address rate limits or\nblacklists. The default servers used by this class are managed by [Apify Proxy](https://docs.apify.com/proxy).\nTo be able to use Apify Proxy, you need an Apify account and access to the selected proxies. If you provide\nno configuration option, the proxies will be managed automatically using a smart algorithm.\n\nIf you want to use your own proxies, use the `proxy_urls` or `new_url_function` constructor options. Your list\nof proxy URLs will be rotated by the configuration, if this option is provided." + ] } - ] - }, - "decorations": [ + }, { - "args": "('Configuration')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 466, + "module": "_models", + "name": "cpu_avg_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='cpuAvgUsage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, { - "children": [ - 297, - 307, - 309 + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 467, + "module": "_models", + "name": "cpu_max_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 107 + } ], - "title": "Methods" - } - ], - "id": 296, - "module": "_proxy_configuration", - "name": "ProxyConfiguration", - "parsedDocstring": { - "text": "Configures a connection to a proxy server with the provided options.\n\nProxy servers are used to prevent target websites from blocking your crawlers based on IP address rate limits or\nblacklists. The default servers used by this class are managed by [Apify Proxy](https://docs.apify.com/proxy).\nTo be able to use Apify Proxy, you need an Apify account and access to the selected proxies. If you provide\nno configuration option, the proxies will be managed automatically using a smart algorithm.\n\nIf you want to use your own proxies, use the `proxy_urls` or `new_url_function` constructor options. Your list\nof proxy URLs will be rotated by the configuration, if this option is provided." - }, - "sources": [ + "type": { + "name": "Annotated[float | None, Field(alias='cpuMaxUsage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, { - "character": 1, - "fileName": "/src/apify/_proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 94 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 468, + "module": "_models", + "name": "cpu_current_usage", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='cpuCurrentUsage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 314, - "module": "_configuration", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 469, + "module": "_models", + "name": "net_rx_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 109 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='netRxBytes')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, { "kind": 1024, "kindString": "Property", @@ -13017,31 +16005,31 @@ }, "flags": {}, "groups": [], - "id": 316, - "module": "_configuration", - "name": "key_value_stores", + "id": 470, + "module": "_models", + "name": "net_tx_bytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 45 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 110 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ + "name": "Annotated[int | None, Field(alias='netTxBytes')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { - "type": "reference", - "name": "str" + "type": "literal", + "value": null } ] } @@ -13060,31 +16048,31 @@ }, "flags": {}, "groups": [], - "id": 317, - "module": "_configuration", - "name": "datasets", + "id": 471, + "module": "_models", + "name": "duration_millis", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 46 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 111 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ + "name": "Annotated[int | None, Field(alias='durationMillis')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { - "type": "reference", - "name": "str" + "type": "literal", + "value": null } ] } @@ -13103,33 +16091,109 @@ }, "flags": {}, "groups": [], - "id": 318, - "module": "_configuration", - "name": "request_queues", + "id": 472, + "module": "_models", + "name": "run_time_secs", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 47 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 112 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ + "name": "Annotated[float | None, Field(alias='runTimeSecs')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "float" }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 473, + "module": "_models", + "name": "metamorph", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='metamorph')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } ] + }, + "flags": {}, + "groups": [], + "id": 474, + "module": "_models", + "name": "compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 114 + } + ], + "type": { + "name": "float", + "type": "reference" } } ], @@ -13137,33 +16201,54 @@ "summary": [ { "kind": "text", - "text": "Mapping of storage aliases to their IDs, grouped by storage type.\n\nPopulated from the `ACTOR_STORAGES_JSON` env var that the Apify platform sets when an Actor declares\nnamed storages in its `actor.json` schema. Each key maps a user-defined alias (e.g. `'custom'`)\nto the platform-assigned storage ID." + "text": "" } ] }, + "decorations": [ + { + "args": "('Actor')", + "name": "docs_group" + } + ], "flags": {}, "groups": [ { "children": [ - 317, - 316, - 318 + 474, + 466, + 468, + 467, + 471, + 458, + 463, + 465, + 464, + 473, + 459, + 457, + 469, + 470, + 460, + 461, + 462, + 472 ], "title": "Properties" } ], - "id": 315, - "module": "_configuration", - "name": "ActorStorages", + "id": 456, + "module": "_models", + "name": "ActorRunStats", "parsedDocstring": { - "text": "Mapping of storage aliases to their IDs, grouped by storage type.\n\nPopulated from the `ACTOR_STORAGES_JSON` env var that the Apify platform sets when an Actor declares\nnamed storages in its `actor.json` schema. Each key maps a user-defined alias (e.g. `'custom'`)\nto the platform-assigned storage ID." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 95 } ], "type": { @@ -13189,33 +16274,23 @@ }, "flags": {}, "groups": [], - "id": 320, - "module": "_configuration", - "name": "actor_id", + "id": 476, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 82 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 119 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_id', 'apify_actor_id', 'apify_act_id', ), description='ID of the Actor', ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Undefined", + "type": "reference" } }, { @@ -13232,33 +16307,56 @@ }, "flags": {}, "groups": [], - "id": 321, - "module": "_configuration", - "name": "actor_full_name", + "id": 477, + "module": "_models", + "name": "build", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 94 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 121 } ], "type": { - "name": "Annotated[ str | None, Field( description='Full name of the Actor', ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "" } ] + }, + "flags": {}, + "groups": [], + "id": 478, + "module": "_models", + "name": "timeout_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 122 + } + ], + "type": { + "name": "int", + "type": "reference" } }, { @@ -13275,33 +16373,56 @@ }, "flags": {}, "groups": [], - "id": 322, - "module": "_configuration", - "name": "actor_permission_level", + "id": 479, + "module": "_models", + "name": "memory_mbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 101 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 123 } ], "type": { - "name": "Annotated[ str | None, Field( description='Permission level the Actor is run under.', ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "" } ] + }, + "flags": {}, + "groups": [], + "id": 480, + "module": "_models", + "name": "disk_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 124 + } + ], + "type": { + "name": "int", + "type": "reference" } }, { @@ -13318,27 +16439,27 @@ }, "flags": {}, "groups": [], - "id": 323, - "module": "_configuration", - "name": "actor_run_id", + "id": 481, + "module": "_models", + "name": "max_items", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 108 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 125 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_run_id', 'apify_actor_run_id', 'apify_act_run_id', ), description='ID of the Actor run', ), ]", + "name": "Annotated[int | None, Field(alias='maxItems')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -13361,27 +16482,27 @@ }, "flags": {}, "groups": [], - "id": 324, - "module": "_configuration", - "name": "actor_build_id", + "id": 482, + "module": "_models", + "name": "max_total_charge_usd", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 120 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 126 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_build_id', 'apify_actor_build_id', ), description='ID of the Actor build used in the run', ), ]", + "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -13389,7 +16510,60 @@ } ] } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Actor')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 477, + 480, + 481, + 482, + 479, + 476, + 478 + ], + "title": "Properties" + } + ], + "id": 475, + "module": "_models", + "name": "ActorRunOptions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -13404,27 +16578,60 @@ }, "flags": {}, "groups": [], - "id": 325, - "module": "_configuration", - "name": "actor_build_number", + "id": 484, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 131 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_build_number', 'apify_actor_build_number', ), description='Build number of the Actor build used in the run', ), ]", + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 485, + "module": "_models", + "name": "actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 133 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -13447,33 +16654,27 @@ }, "flags": {}, "groups": [], - "id": 326, - "module": "_configuration", - "name": "actor_build_tags", + "id": 486, + "module": "_models", + "name": "dataset_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 142 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 134 } ], "type": { - "name": "Annotated[ list[str] | None, Field( description='Build tags of the Actor build used in the run', ), BeforeValidator(_transform_to_list), ]", + "name": "Annotated[int | None, Field(alias='DATASET_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] + "name": "int" }, { "type": "literal", @@ -13496,27 +16697,27 @@ }, "flags": {}, "groups": [], - "id": 327, - "module": "_configuration", - "name": "actor_task_id", + "id": 487, + "module": "_models", + "name": "dataset_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 150 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 135 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_task_id', 'apify_actor_task_id', ), description='ID of the Actor task. Empty if Actor is run outside of any task, e.g. directly using the API', ), ]", + "name": "Annotated[int | None, Field(alias='DATASET_WRITES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -13539,27 +16740,27 @@ }, "flags": {}, "groups": [], - "id": 328, - "module": "_configuration", - "name": "actor_events_ws_url", + "id": 488, + "module": "_models", + "name": "key_value_store_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 161 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 136 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_events_websocket_url', 'apify_actor_events_ws_url', ), description='Websocket URL where Actor may listen for events from Actor platform', ), ]", + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -13582,23 +16783,33 @@ }, "flags": {}, "groups": [], - "id": 329, - "module": "_configuration", - "name": "api_base_url", + "id": 489, + "module": "_models", + "name": "key_value_store_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 172 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 137 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_WRITES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -13615,23 +16826,33 @@ }, "flags": {}, "groups": [], - "id": 330, - "module": "_configuration", - "name": "api_public_base_url", + "id": 490, + "module": "_models", + "name": "key_value_store_lists", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 180 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 138 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_LISTS')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -13648,27 +16869,27 @@ }, "flags": {}, "groups": [], - "id": 331, - "module": "_configuration", - "name": "dedicated_cpus", + "id": 491, + "module": "_models", + "name": "request_queue_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 188 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 139 } ], "type": { - "name": "Annotated[ float | None, Field( alias='apify_dedicated_cpus', description='Number of CPU cores reserved for the actor, based on allocated memory', ), ]", + "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "float" + "name": "int" }, { "type": "literal", @@ -13691,27 +16912,27 @@ }, "flags": {}, "groups": [], - "id": 332, - "module": "_configuration", - "name": "default_dataset_id", + "id": 492, + "module": "_models", + "name": "request_queue_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 196 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 140 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_dataset_id', 'apify_default_dataset_id', ), description='Default dataset ID used by the Apify storage client when no ID or name is provided.', ), ]", + "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_WRITES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -13734,27 +16955,27 @@ }, "flags": {}, "groups": [], - "id": 333, - "module": "_configuration", - "name": "default_key_value_store_id", + "id": 493, + "module": "_models", + "name": "data_transfer_internal_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 207 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 141 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_key_value_store_id', 'apify_default_key_value_store_id', ), description='Default key-value store ID for the Apify storage client when no ID or name is provided.', ), ]", + "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -13777,27 +16998,27 @@ }, "flags": {}, "groups": [], - "id": 334, - "module": "_configuration", - "name": "default_request_queue_id", + "id": 494, + "module": "_models", + "name": "data_transfer_external_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 218 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 142 } ], "type": { - "name": "Annotated[ str | None, Field( validation_alias=AliasChoices( 'actor_default_request_queue_id', 'apify_default_request_queue_id', ), description='Default request queue ID for the Apify storage client when no ID or name is provided.', ), ]", + "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -13820,23 +17041,33 @@ }, "flags": {}, "groups": [], - "id": 335, - "module": "_configuration", - "name": "disable_outdated_warning", + "id": 495, + "module": "_models", + "name": "proxy_residential_transfer_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 229 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "type": { - "name": "bool", - "type": "reference" + "name": "Annotated[float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -13853,27 +17084,27 @@ }, "flags": {}, "groups": [], - "id": 336, - "module": "_configuration", - "name": "fact", + "id": 496, + "module": "_models", + "name": "proxy_serps", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 238 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 144 } ], "type": { - "name": "Annotated[str | None, Field(alias='apify_fact')]", + "name": "Annotated[int | None, Field(alias='PROXY_SERPS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "int" }, { "type": "literal", @@ -13881,7 +17112,66 @@ } ] } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Actor')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 485, + 494, + 493, + 486, + 487, + 490, + 488, + 489, + 484, + 495, + 496, + 491, + 492 + ], + "title": "Properties" + } + ], + "id": 483, + "module": "_models", + "name": "ActorRunUsage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 130 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -13896,22 +17186,22 @@ }, "flags": {}, "groups": [], - "id": 337, - "module": "_configuration", - "name": "input_key", + "id": 498, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 240 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 151 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" } }, @@ -13929,27 +17219,27 @@ }, "flags": {}, "groups": [], - "id": 338, - "module": "_configuration", - "name": "input_secrets_private_key_file", + "id": 499, + "module": "_models", + "name": "actor_compute_units", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 252 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 153 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_input_secrets_private_key_file', description='Path to the secret key used to decrypt Secret inputs.', ), ]", + "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -13972,27 +17262,27 @@ }, "flags": {}, "groups": [], - "id": 339, - "module": "_configuration", - "name": "input_secrets_private_key_passphrase", + "id": 500, + "module": "_models", + "name": "dataset_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 260 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 154 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_input_secrets_private_key_passphrase', description='Passphrase for the input secret key', ), ]", + "name": "Annotated[float | None, Field(alias='DATASET_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14015,23 +17305,33 @@ }, "flags": {}, "groups": [], - "id": 340, - "module": "_configuration", - "name": "is_at_home", + "id": 501, + "module": "_models", + "name": "dataset_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 268 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 155 } ], "type": { - "name": "bool", - "type": "reference" + "name": "Annotated[float | None, Field(alias='DATASET_WRITES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14048,27 +17348,27 @@ }, "flags": {}, "groups": [], - "id": 341, - "module": "_configuration", - "name": "latest_sdk_version", + "id": 502, + "module": "_models", + "name": "key_value_store_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 276 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 156 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_sdk_latest_version', description='Specifies the most recent release version of the Apify SDK for Javascript. Used for ' 'checking for updates.', ), deprecated('SDK version checking is not supported for the Python SDK'), ]", + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14091,27 +17391,27 @@ }, "flags": {}, "groups": [], - "id": 342, - "module": "_configuration", - "name": "log_format", + "id": 503, + "module": "_models", + "name": "key_value_store_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 286 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 157 } ], "type": { - "name": "Annotated[ str | None, Field(alias='apify_log_format'), deprecated('Adjust the log format in code instead'), ]", + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_WRITES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14134,27 +17434,27 @@ }, "flags": {}, "groups": [], - "id": 343, - "module": "_configuration", - "name": "max_paid_dataset_items", + "id": 504, + "module": "_models", + "name": "key_value_store_lists", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 292 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 158 } ], "type": { - "name": "Annotated[ int | None, Field( 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(lambda val: val if val != '' else None), ]", + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_LISTS')]", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "float" }, { "type": "literal", @@ -14177,27 +17477,27 @@ }, "flags": {}, "groups": [], - "id": 344, - "module": "_configuration", - "name": "max_total_charge_usd", + "id": 505, + "module": "_models", + "name": "request_queue_reads", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 301 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 159 } ], "type": { - "name": "Annotated[ Decimal | None, Field( alias='actor_max_total_charge_usd', description='For pay-per-event Actors, the user-set limit on total charges. Do not exceed this limit', ), BeforeValidator(lambda val: val if val != '' else None), ]", + "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_READS')]", "type": "union", "types": [ { "type": "reference", - "name": "Decimal" + "name": "float" }, { "type": "literal", @@ -14220,23 +17520,33 @@ }, "flags": {}, "groups": [], - "id": 345, - "module": "_configuration", - "name": "test_pay_per_event", + "id": 506, + "module": "_models", + "name": "request_queue_writes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 310 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "type": { - "name": "bool", - "type": "reference" + "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_WRITES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14253,27 +17563,27 @@ }, "flags": {}, "groups": [], - "id": 346, - "module": "_configuration", - "name": "meta_origin", + "id": 507, + "module": "_models", + "name": "data_transfer_internal_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 318 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 161 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_meta_origin', description='Specifies how an Actor run was started', ), ]", + "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14296,23 +17606,33 @@ }, "flags": {}, "groups": [], - "id": 347, - "module": "_configuration", - "name": "metamorph_after_sleep", + "id": 508, + "module": "_models", + "name": "data_transfer_external_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 326 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 162 } ], "type": { - "name": "timedelta_ms", - "type": "reference" + "name": "Annotated[float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14329,23 +17649,33 @@ }, "flags": {}, "groups": [], - "id": 348, - "module": "_configuration", - "name": "proxy_hostname", + "id": 509, + "module": "_models", + "name": "proxy_residential_transfer_gbytes", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 334 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 163 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14362,27 +17692,27 @@ }, "flags": {}, "groups": [], - "id": 349, - "module": "_configuration", - "name": "proxy_password", + "id": 510, + "module": "_models", + "name": "proxy_serps", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 342 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 164 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_proxy_password', description='Password to the Apify proxy', ), ]", + "name": "Annotated[float | None, Field(alias='PROXY_SERPS')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14390,7 +17720,66 @@ } ] } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource usage costs in USD." + } + ] + }, + "decorations": [ + { + "args": "('Actor')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 499, + 508, + 507, + 500, + 501, + 504, + 502, + 503, + 498, + 509, + 510, + 505, + 506 + ], + "title": "Properties" + } + ], + "id": 497, + "module": "_models", + "name": "ActorRunUsageUsd", + "parsedDocstring": { + "text": "Resource usage costs in USD." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 148 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -14405,22 +17794,22 @@ }, "flags": {}, "groups": [], - "id": 350, - "module": "_configuration", - "name": "proxy_port", + "id": 512, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 350 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 170 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" } }, @@ -14438,22 +17827,22 @@ }, "flags": {}, "groups": [], - "id": 351, - "module": "_configuration", - "name": "proxy_status_url", + "id": 513, + "module": "_models", + "name": "created_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 358 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 172 } ], "type": { - "name": "str", + "name": "datetime", "type": "reference" } }, @@ -14471,33 +17860,23 @@ }, "flags": {}, "groups": [], - "id": 352, - "module": "_configuration", - "name": "started_at", + "id": 514, + "module": "_models", + "name": "actor_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 366 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 173 } ], "type": { - "name": "Annotated[ datetime | None, Field( validation_alias=AliasChoices( 'actor_started_at', 'apify_started_at', ), description='Date when the Actor was started', ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } }, { @@ -14514,33 +17893,23 @@ }, "flags": {}, "groups": [], - "id": 353, - "module": "_configuration", - "name": "timeout_at", + "id": 515, + "module": "_models", + "name": "build_id", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 377 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 174 } ], "type": { - "name": "Annotated[ datetime | None, Field( validation_alias=AliasChoices( 'actor_timeout_at', 'apify_timeout_at', ), description='Date when the Actor will time out', ), BeforeValidator(lambda val: val if val != '' else None), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } }, { @@ -14557,25 +17926,80 @@ }, "flags": {}, "groups": [], - "id": 354, - "module": "_configuration", - "name": "standby_port", + "id": 516, + "module": "_models", + "name": "input_key", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 389 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 175 } ], "type": { - "name": "int", - "type": "reference" + "name": "Annotated[str | None, Field(alias='inputKey')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a metamorph event that occurred during the run." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 514, + 515, + 513, + 516, + 512 + ], + "title": "Properties" + } + ], + "id": 511, + "module": "_models", + "name": "Metamorph", + "parsedDocstring": { + "text": "Information about a metamorph event that occurred during the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 167 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -14590,22 +18014,22 @@ }, "flags": {}, "groups": [], - "id": 355, - "module": "_configuration", - "name": "standby_url", + "id": 518, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 398 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" } }, @@ -14623,27 +18047,27 @@ }, "flags": {}, "groups": [], - "id": 356, - "module": "_configuration", - "name": "token", + "id": 519, + "module": "_models", + "name": "apify_margin_percentage", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 407 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_token', description='API token of the user who started the Actor', ), ]", + "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", @@ -14666,27 +18090,27 @@ }, "flags": {}, "groups": [], - "id": 357, - "module": "_configuration", - "name": "user_id", + "id": 520, + "module": "_models", + "name": "created_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 415 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_user_id', description='ID of the user who started the Actor. May differ from the Actor owner', ), ]", + "name": "Annotated[datetime | None, Field(alias='createdAt')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "datetime" }, { "type": "literal", @@ -14709,23 +18133,33 @@ }, "flags": {}, "groups": [], - "id": 358, - "module": "_configuration", - "name": "user_is_paying", + "id": 521, + "module": "_models", + "name": "started_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 423 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 } ], "type": { - "name": "bool", - "type": "reference" + "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14742,23 +18176,33 @@ }, "flags": {}, "groups": [], - "id": 359, - "module": "_configuration", - "name": "web_server_port", + "id": 522, + "module": "_models", + "name": "notified_about_future_change_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 432 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 184 } ], "type": { - "name": "int", - "type": "reference" + "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14775,23 +18219,33 @@ }, "flags": {}, "groups": [], - "id": 360, - "module": "_configuration", - "name": "web_server_url", + "id": 523, + "module": "_models", + "name": "notified_about_change_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 444 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -14808,22 +18262,22 @@ }, "flags": {}, "groups": [], - "id": 361, - "module": "_configuration", - "name": "workflow_key", + "id": 524, + "module": "_models", + "name": "reason_for_change", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 455 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186 } ], "type": { - "name": "Annotated[ str | None, Field( alias='apify_workflow_key', description='Identifier used for grouping related runs and API calls together', ), ]", + "name": "Annotated[str | None, Field(alias='reasonForChange')]", "type": "union", "types": [ { @@ -14836,7 +18290,76 @@ } ] } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 519, + 520, + 518, + 523, + 522, + 524, + 521 + ], + "title": "Properties" + } + ], + "id": 517, + "module": "_models", + "name": "CommonActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 178 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "FreeActorPricingInfo", + "target": "525", + "type": "reference" + }, + { + "name": "FlatPricePerMonthActorPricingInfo", + "target": "527", + "type": "reference" + }, + { + "name": "PricePerDatasetItemActorPricingInfo", + "target": "531", + "type": "reference" }, + { + "name": "PayPerEventActorPricingInfo", + "target": "543", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -14851,62 +18374,27 @@ }, "flags": {}, "groups": [], - "id": 362, - "module": "_configuration", - "name": "actor_pricing_info", + "id": 526, + "module": "_models", + "name": "pricing_model", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 463 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 190 } ], "type": { - "name": "Annotated[ FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None, Field( alias='apify_actor_pricing_info', description='JSON string with prising info of the actor', discriminator='pricing_model', ), BeforeValidator(lambda data: json.loads(data) if isinstance(data, str) else data or None), ]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "204" - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "206" - } - ] - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "210" - } - ] - }, - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "222" - } - ] - }, + "name": "Literal", + "type": "reference", + "typeArguments": [ { "type": "literal", - "value": null + "value": "FREE" } ] } @@ -14925,43 +18413,28 @@ }, "flags": {}, "groups": [], - "id": 363, - "module": "_configuration", - "name": "charged_event_counts", + "id": 1178, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 477 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 } ], "type": { - "name": "Annotated[ dict[str, int] | None, Field( alias='apify_charged_actor_event_counts', description='Counts of events that were charged for the actor', ), BeforeValidator(lambda data: json.loads(data) if isinstance(data, str) else data or None), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "int" - } - ] - }, - { - "type": "literal", - "value": null - } - ] + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.model_config", + "target": 518, + "type": "reference" } }, { @@ -14978,97 +18451,87 @@ }, "flags": {}, "groups": [], - "id": 364, - "module": "_configuration", - "name": "actor_storages", + "id": 1179, + "module": "_models", + "name": "apify_margin_percentage", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 486 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 } ], "type": { - "name": "Annotated[ ActorStorages | None, Field( alias='actor_storages_json', description='Mapping of storage aliases to their platform-assigned IDs.', ), BeforeValidator(_load_storage_keys), ]", + "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", "type": "union", "types": [ { "type": "reference", - "name": "ActorStorages", - "target": "315" + "name": "float" }, { "type": "literal", "value": null } ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 519, + "type": "reference" } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." + "text": "" } ] }, - "decorations": [ - { - "args": "(mode='after')", - "name": "model_validator" - } - ], "flags": {}, "groups": [], - "id": 365, - "module": "_configuration", - "name": "disable_browser_sandbox_on_platform", + "id": 1180, + "module": "_models", + "name": "created_at", "parsedDocstring": { - "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 496 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disable the browser sandbox mode when running on the Apify platform.\n\nRunning in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running\nin a container. It can be on the contrary undesired as the process in the container might be running as root and\nthis will crash chromium that was started with browser sandbox mode." - } - ] + "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "flags": {}, - "id": 366, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "disable_browser_sandbox_on_platform", - "parameters": [], - "type": { - "name": "Self", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 520, + "type": "reference" + } }, { "kind": 1024, @@ -15082,29 +18545,39 @@ } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 367, - "module": "_configuration", - "name": "canonical_input_key", + "id": 1181, + "module": "_models", + "name": "started_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 509 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 } ], "type": { - "name": "str", + "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 521, "type": "reference" } }, @@ -15120,440 +18593,139 @@ } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 368, - "module": "_configuration", - "name": "input_key_candidates", + "id": 1182, + "module": "_models", + "name": "notified_about_future_change_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 513 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 184 } ], "type": { - "name": "set", - "type": "reference", - "typeArguments": [ + "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ { "type": "reference", - "name": "str" + "name": "datetime" + }, + { + "type": "literal", + "value": null } ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 522, + "type": "reference" } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." + "text": "" } ] }, - "decorations": [ - { - "name": "classmethod" - } - ], "flags": {}, "groups": [], - "id": 369, - "module": "_configuration", - "name": "get_global_configuration", + "id": 1183, + "module": "_models", + "name": "notified_about_change_at", "parsedDocstring": { - "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 517 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the global instance of the configuration.\n\nThis method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the\nservice locator." - } - ] - }, - "flags": {}, - "id": 370, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_global_configuration", - "parameters": [], - "type": { - "name": "Configuration", + "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { "type": "reference", - "target": "319" + "name": "datetime" + }, + { + "type": "literal", + "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 523, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Create Apify Configuration from existing Crawlee Configuration.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "classmethod" - } - ], "flags": {}, "groups": [], - "id": 371, - "module": "_configuration", - "name": "from_configuration", + "id": 1184, + "module": "_models", + "name": "reason_for_change", "parsedDocstring": { - "text": "Create Apify Configuration from existing Crawlee Configuration.\n", - "args": { - "configuration": "The existing Crawlee Configuration.\n" - }, - "returns": "The created Apify Configuration." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 538 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Apify Configuration." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create Apify Configuration from existing Crawlee Configuration.\n" - } - ] - }, - "flags": {}, - "id": 372, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "from_configuration", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The existing Crawlee Configuration.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 373, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration", - "type": "reference" - } - } - ], - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A class for specifying the configuration of an Actor.\n\nCan be used either globally via `Configuration.get_global_configuration()`,\nor it can be specific to each `Actor` instance on the `actor.config` property." - } - ] - }, - "decorations": [ - { - "args": "('Configuration')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 365, - 371, - 369 - ], - "title": "Methods" - }, - { - "children": [ - 324, - 325, - 326, - 328, - 321, - 320, - 322, - 362, - 323, - 364, - 327, - 329, - 330, - 367, - 363, - 331, - 332, - 333, - 334, - 335, - 336, - 337, - 368, - 338, - 339, - 340, - 341, - 342, - 343, - 344, - 346, - 347, - 348, - 349, - 350, - 351, - 354, - 355, - 352, - 345, - 353, - 356, - 357, - 358, - 359, - 360, - 361 - ], - "title": "Properties" - } - ], - "id": 319, - "module": "_configuration", - "name": "Configuration", - "parsedDocstring": { - "text": "A class for specifying the configuration of an Actor.\n\nCan be used either globally via `Configuration.get_global_configuration()`,\nor it can be specific to each `Actor` instance on the `actor.config` property." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 75 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 374, - "module": "_utils", - "name": "T", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 375, - "module": "_utils", - "name": "ensure_context", - "parsedDocstring": { - "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n", - "args": { - "attribute_name": "The name of the boolean attribute to check on the instance.\n" - }, - "returns": "A decorator that wraps methods with context checking." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A decorator that wraps methods with context checking." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n" - } - ] - }, - "flags": {}, - "id": 376, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "ensure_context", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the boolean attribute to check on the instance.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 377, - "kind": 32768, - "kindString": "Parameter", - "name": "attribute_name", - "type": { - "name": "str", - "type": "reference" - } + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186 } ], "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ { "type": "reference", - "name": "[T]" + "name": "str" }, { - "type": "reference", - "name": "T", - "target": "374" + "type": "literal", + "value": null } ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 524, + "type": "reference" } } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], + ], "comment": { "summary": [ { @@ -15562,395 +18734,648 @@ } ] }, - "decorations": [], "flags": {}, - "groups": [], - "id": 378, - "module": "_utils", - "name": "get_system_info", + "groups": [ + { + "children": [ + 1179, + 1180, + 1178, + 1183, + 1182, + 526, + 1184, + 1181 + ], + "title": "Properties" + } + ], + "id": 525, + "module": "_models", + "name": "FreeActorPricingInfo", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 53 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 189 } ], "type": { "name": "Undefined", "type": "reference" }, - "signatures": [ + "extendedTypes": [ { - "flags": {}, - "id": 379, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_system_info", - "parameters": [], - "type": { - "name": "dict", - "type": "reference" - } + "name": "CommonActorPricingInfo", + "target": "517", + "type": "reference" } ] }, { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 528, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 194 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "FLAT_PRICE_PER_MONTH" + } + ] } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 380, - "module": "_utils", - "name": "is_running_in_ipython", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 69 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + }, { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, - "id": 381, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "is_running_in_ipython", - "parameters": [], + "groups": [], + "id": 529, + "module": "_models", + "name": "trial_minutes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 195 + } + ], "type": { - "name": "bool", + "name": "int", "type": "reference" } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 530, + "module": "_models", + "name": "price_per_unit_usd", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 196 + } + ], + "type": { + "name": "float", + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 382, - "module": "_utils", - "name": "GroupName", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 74 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1185, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.model_config", + "target": 518, + "type": "reference" } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 383, - "module": "_utils", - "name": "docs_group", - "parsedDocstring": { - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n", - "args": { - "group_name": "The documentation group to which the symbol belongs.\n" }, - "returns": "The original callable without modification." - }, - "sources": [ { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 88 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1186, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 519, + "type": "reference" + } + }, { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { - "blockTags": [ + "summary": [ { - "content": [ - { - "kind": "text", - "text": "The original callable without modification." - } - ], - "tag": "@returns" + "kind": "text", + "text": "" } - ], + ] + }, + "flags": {}, + "groups": [], + "id": 1187, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 520, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { "summary": [ { "kind": "text", - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + "text": "" } ] }, "flags": {}, - "id": 384, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "docs_group", - "parameters": [ + "groups": [], + "id": 1188, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The documentation group to which the symbol belongs.\n" - } - ] + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "flags": { - "isOptional": false, - "keyword-only": false + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 521, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1189, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 184 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "id": 385, - "kind": 32768, - "kindString": "Parameter", - "name": "group_name", - "type": { - "name": "GroupName", + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 522, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1190, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { "type": "reference", - "target": "382" + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 523, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 1191, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186 } ], "type": { - "name": "Callable", + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 524, "type": "reference" } } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], + ], "comment": { "summary": [ { "kind": "text", - "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, - "groups": [], - "id": 386, - "module": "_utils", - "name": "docs_name", + "groups": [ + { + "children": [ + 1186, + 1187, + 1185, + 1190, + 1189, + 530, + 528, + 1191, + 1188, + 529 + ], + "title": "Properties" + } + ], + "id": 527, + "module": "_models", + "name": "FlatPricePerMonthActorPricingInfo", "parsedDocstring": { - "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n", - "args": { - "symbol_name": "The name to be used in the documentation.\n" - }, - "returns": "The original callable without modification." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 107 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 193 } ], "type": { "name": "Undefined", "type": "reference" }, - "signatures": [ + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "517", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { - "blockTags": [ + "summary": [ { - "content": [ - { - "kind": "text", - "text": "The original callable without modification." - } - ], - "tag": "@returns" + "kind": "text", + "text": "" } - ], + ] + }, + "flags": {}, + "groups": [], + "id": 532, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 200 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "PRICE_PER_DATASET_ITEM" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { "summary": [ { "kind": "text", - "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n" + "text": "" } ] }, "flags": {}, - "id": 387, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "docs_name", - "parameters": [ + "groups": [], + "id": 533, + "module": "_models", + "name": "unit_name", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name to be used in the documentation.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 388, - "kind": 32768, - "kindString": "Parameter", - "name": "symbol_name", - "type": { - "name": "str", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 201 } ], "type": { - "name": "Callable", + "name": "str", "type": "reference" } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 389, - "module": "_utils", - "name": "maybe_extract_enum_member_value", - "parsedDocstring": { - "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 126 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + }, { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + "text": "" } ] }, "flags": {}, - "id": 390, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "maybe_extract_enum_member_value", - "parameters": [ + "groups": [], + "id": 534, + "module": "_models", + "name": "price_per_unit_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 391, - "kind": 32768, - "kindString": "Parameter", - "name": "maybe_enum_member", - "type": { - "name": "Any", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 202 } ], "type": { - "name": "Any", + "name": "float", "type": "reference" } - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -15960,659 +19385,446 @@ } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 393, - "module": "_utils", - "name": "__init__", + "id": 1192, + "module": "_models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 136 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 } ], "type": { "name": "Undefined", "type": "reference" }, - "signatures": [ + "inheritedFrom": { + "name": "CommonActorPricingInfo.model_config", + "target": 518, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1193, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": {}, - "id": 394, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [], - "type": { - "name": "None", + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { "type": "literal", "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 519, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." + "text": "" } ] }, - "decorations": [ - { - "name": "asynccontextmanager" - } - ], "flags": {}, "groups": [], - "id": 395, - "module": "_utils", - "name": "__call__", + "id": 1194, + "module": "_models", + "name": "created_at", "parsedDocstring": { - "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 141 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 } ], "type": { - "name": "Undefined", + "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 520, "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 1195, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." - } - ] - }, - "flags": {}, - "id": 396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__call__", - "parameters": [], - "type": { - "name": "AsyncIterator", + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "type": "union", + "types": [ + { "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": null - } - ] + "name": "datetime" + }, + { + "type": "literal", + "value": null } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A reentrant lock implementation for asyncio using asyncio.Lock." + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 521, + "type": "reference" } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 395, - 393 - ], - "title": "Methods" - } - ], - "id": 392, - "module": "_utils", - "name": "ReentrantLock", - "parsedDocstring": { - "text": "A reentrant lock implementation for asyncio using asyncio.Lock." - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 133 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1196, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 184 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 522, + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 397, - "module": "_actor", - "name": "MainReturnType", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 54 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 399, - "module": "_actor", - "name": "__init__", + "id": 1197, + "module": "_models", + "name": "notified_about_change_at", "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "configuration": "The Actor configuration to use. If not provided, a default configuration is created.", - "configure_logging": "Whether to set up the default logging configuration.", - "exit_process": "Whether the Actor should call `sys.exit` when the context manager exits.\nDefaults to True, except in IPython, Pytest, and Scrapy environments.", - "exit_code": "The exit code the Actor should use when exiting.", - "status_message": "Final status message to display upon Actor termination.", - "event_listeners_timeout": "Maximum time to wait for Actor event listeners to complete before exiting.", - "cleanup_timeout": "Maximum time to wait for cleanup tasks to finish." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] + "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "flags": {}, - "id": 400, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor configuration to use. If not provided, a default configuration is created." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 401, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Configuration", - "target": "319" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to set up the default logging configuration." - } - ] - }, - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 402, - "kind": 32768, - "kindString": "Parameter", - "name": "configure_logging", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor should call `sys.exit` when the context manager exits.\nDefaults to True, except in IPython, Pytest, and Scrapy environments." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 403, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_process", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The exit code the Actor should use when exiting." - } - ] - }, - "defaultValue": "0", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 404, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_code", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Final status message to display upon Actor termination." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 405, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for Actor event listeners to complete before exiting." - } - ] - }, - "defaultValue": "EVENT_LISTENERS_TIMEOUT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 406, - "kind": 32768, - "kindString": "Parameter", - "name": "event_listeners_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for cleanup tasks to finish." - } - ] - }, - "defaultValue": "timedelta(seconds=30)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 407, - "kind": 32768, - "kindString": "Parameter", - "name": "cleanup_timeout", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "None", + { "type": "literal", "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 523, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 408, - "module": "_actor", - "name": "__aenter__", + "id": 1198, + "module": "_models", + "name": "reason_for_change", "parsedDocstring": { - "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 153 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enter the Actor context.\n\nInitializes the Actor when used in an `async with` block. This method:\n\n- Sets up local or cloud storage clients depending on whether the Actor runs locally or on the Apify platform.\n- Configures the event manager and starts periodic state persistence.\n- Initializes the charging manager for handling charging events.\n- Configures logging after all core services are registered.\n\nThis method must be called exactly once per Actor instance. Re-initializing an Actor or having multiple\nactive Actor instances is not standard usage and may lead to warnings or unexpected behavior." - } - ] + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 409, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aenter__", - "parameters": [], - "type": { - "name": "Self", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] - }, + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 524, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ { - "kind": 2048, - "kindString": "Method", + "children": [ + 1193, + 1194, + 1192, + 1197, + 1196, + 534, + 532, + 1198, + 1195, + 533 + ], + "title": "Properties" + } + ], + "id": 531, + "module": "_models", + "name": "PricePerDatasetItemActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 199 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "517", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 410, - "module": "_actor", - "name": "__aexit__", + "id": 536, + "module": "_models", + "name": "model_config", "parsedDocstring": { - "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 210 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 206 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exit the Actor context.\n\nIf the block exits with an exception, the Actor fails with a non-zero exit code.\nOtherwise, it exits cleanly. In both cases the Actor:\n\n- Cancels periodic `PERSIST_STATE` events.\n- Sends a final `PERSIST_STATE` event.\n- Waits for all event listeners to finish.\n- Stops the event manager and the charging manager.\n- Optionally terminates the process with the selected exit code." - } - ] - }, - "flags": {}, - "id": 411, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aexit__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 412, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_type", - "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 413, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_value", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 414, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_traceback", - "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 537, + "module": "_models", + "name": "event_price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 208 } - ] + ], + "type": { + "name": "float", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -16622,247 +19834,243 @@ } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 415, - "module": "_actor", - "name": "__repr__", + "id": 538, + "module": "_models", + "name": "event_title", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 278 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 209 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 539, + "module": "_models", + "name": "event_description", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": {}, - "id": 416, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__repr__", - "parameters": [], - "type": { - "name": "str", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210 } - ] - }, + ], + "type": { + "name": "Annotated[str | None, Field(alias='eventDescription')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ { - "kind": 2048, - "kindString": "Method", + "children": [ + 539, + 537, + 538, + 536 + ], + "title": "Properties" + } + ], + "id": 535, + "module": "_models", + "name": "ActorChargeEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 205 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 417, - "module": "_actor", - "name": "__call__", + "id": 541, + "module": "_models", + "name": "model_config", "parsedDocstring": { - "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 284 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 214 } ], "type": { "name": "Undefined", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 542, + "module": "_models", + "name": "actor_charge_events", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 216 + } + ], + "type": { + "name": "Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ { - "kind": "text", - "text": "Make a new Actor instance with a non-default configuration.\n\nThis is necessary due to the lazy object proxying of the global `Actor` instance." + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "ActorChargeEvent", + "target": "535" } ] }, - "flags": {}, - "id": 418, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__call__", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 419, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Configuration", - "target": "319" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 420, - "kind": 32768, - "kindString": "Parameter", - "name": "configure_logging", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 421, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_process", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "0", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 422, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_code", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "EVENT_LISTENERS_TIMEOUT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 423, - "kind": 32768, - "kindString": "Parameter", - "name": "event_listeners_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 424, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "timedelta(seconds=30)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 425, - "kind": 32768, - "kindString": "Parameter", - "name": "cleanup_timeout", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "Self", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] - }, + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 542, + 541 + ], + "title": "Properties" + } + ], + "id": 540, + "module": "_models", + "name": "PricingPerEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 213 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 1024, "kindString": "Property", @@ -16871,34 +20079,35 @@ "summary": [ { "kind": "text", - "text": "Logger configured for this Actor." + "text": "" } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 426, - "module": "_actor", - "name": "log", + "id": 544, + "module": "_models", + "name": "pricing_model", "parsedDocstring": { - "text": "Logger configured for this Actor." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 310 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 220 } ], "type": { - "name": "logging.Logger", - "type": "reference" + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "PAY_PER_EVENT" + } + ] } }, { @@ -16909,39 +20118,35 @@ "summary": [ { "kind": "text", - "text": "The exit code the Actor will use when exiting." + "text": "" } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 427, - "module": "_actor", - "name": "exit_code", + "id": 545, + "module": "_models", + "name": "pricing_per_event", "parsedDocstring": { - "text": "The exit code the Actor will use when exiting." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 315 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 221 } ], "type": { - "name": "int", - "type": "reference" + "name": "PricingPerEvent", + "type": "reference", + "target": "540" } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -16951,63 +20156,74 @@ } ] }, - "decorations": [ - { - "args": ".setter", - "name": "exit_code" - } - ], "flags": {}, "groups": [], - "id": 428, - "module": "_actor", - "name": "exit_code", + "id": 546, + "module": "_models", + "name": "minimal_max_total_charge_usd", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 320 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 222 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 429, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "exit_code", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 430, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "int", - "type": "reference" - } - } - ], - "type": { - "name": "None", + "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { "type": "literal", "value": null } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1199, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 } - ] + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.model_config", + "target": 518, + "type": "reference" + } }, { "kind": 1024, @@ -17017,49 +20233,49 @@ "summary": [ { "kind": "text", - "text": "The final status message that the Actor will display upon termination." + "text": "" } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 431, - "module": "_actor", - "name": "status_message", + "id": 1200, + "module": "_models", + "name": "apify_margin_percentage", "parsedDocstring": { - "text": "The final status message that the Actor will display upon termination." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 324 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 } ], "type": { - "name": "str | None", + "name": "Annotated[float | None, Field(alias='apifyMarginPercentage')]", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "float" }, { "type": "literal", "value": null } ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 519, + "type": "reference" } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -17069,73 +20285,41 @@ } ] }, - "decorations": [ - { - "args": ".setter", - "name": "status_message" - } - ], "flags": {}, "groups": [], - "id": 432, - "module": "_actor", - "name": "status_message", + "id": 1201, + "module": "_models", + "name": "created_at", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 329 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 433, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "status_message", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 434, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", + "name": "Annotated[datetime | None, Field(alias='createdAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { "type": "literal", "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 520, + "type": "reference" + } }, { "kind": 1024, @@ -17145,2689 +20329,1909 @@ "summary": [ { "kind": "text", - "text": "Asynchronous Apify client for interacting with the Apify API." + "text": "" } ] }, - "decorations": [ - { - "name": "property" - } - ], "flags": {}, "groups": [], - "id": 435, - "module": "_actor", - "name": "apify_client", + "id": 1202, + "module": "_models", + "name": "started_at", "parsedDocstring": { - "text": "Asynchronous Apify client for interacting with the Apify API." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 333 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 } ], "type": { - "name": "ApifyClientAsync", + "name": "Annotated[datetime | None, Field(alias='startedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 521, "type": "reference" } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Actor configuration, uses the default instance if not explicitly set." + "text": "" } ] }, - "decorations": [ - { - "name": "cached_property" - } - ], "flags": {}, "groups": [], - "id": 436, - "module": "_actor", - "name": "configuration", + "id": 1203, + "module": "_models", + "name": "notified_about_future_change_at", "parsedDocstring": { - "text": "Actor configuration, uses the default instance if not explicitly set." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 340 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 184 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor configuration, uses the default instance if not explicitly set." - } - ] - }, - "flags": {}, - "id": 437, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "configuration", - "parameters": [], - "type": { - "name": "Configuration", + "name": "Annotated[datetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { "type": "reference", - "target": "319" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ + "name": "datetime" + }, { - "kind": "text", - "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." + "type": "literal", + "value": null } ] }, - "decorations": [ - { - "name": "cached_property" - } - ], - "flags": {}, - "groups": [], - "id": 438, - "module": "_actor", - "name": "event_manager", - "parsedDocstring": { - "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 361 - } - ], - "type": { - "name": "Undefined", + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 522, "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Manages Apify platform events.\n\nIt uses `ApifyEventManager` on the Apify platform and `LocalEventManager` otherwise." - } - ] - }, - "flags": {}, - "id": 439, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "event_manager", - "parameters": [], - "type": { - "name": "EventManager", - "type": "reference" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 440, - "module": "_actor", - "name": "init", + "id": 1204, + "module": "_models", + "name": "notified_about_change_at", "parsedDocstring": { - "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 426 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aenter__()`." - } - ] + "name": "Annotated[datetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "flags": {}, - "id": 441, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "init", - "parameters": [], - "type": { - "name": "None", + { "type": "literal", "value": null } - } - ] + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 523, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 442, - "module": "_actor", - "name": "exit", + "id": 1205, + "module": "_models", + "name": "reason_for_change", "parsedDocstring": { - "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n", - "args": { - "exit_code": "The exit code the Actor should use when exiting.", - "status_message": "Final status message to display upon Actor termination.", - "event_listeners_timeout": "Maximum time to wait for Actor event listeners to complete before exiting.", - "cleanup_timeout": "Maximum time to wait for cleanup tasks to finish." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 433 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exit the Actor without using context-manager syntax.\n\nEquivalent to `await Actor.__aexit__()`.\n" - } - ] + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 443, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "exit", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The exit code the Actor should use when exiting." - } - ] - }, - "defaultValue": "0", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 444, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_code", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Final status message to display upon Actor termination." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 445, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for Actor event listeners to complete before exiting." - } - ] - }, - "defaultValue": "EVENT_LISTENERS_TIMEOUT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 446, - "kind": 32768, - "kindString": "Parameter", - "name": "event_listeners_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for cleanup tasks to finish." - } - ] - }, - "defaultValue": "timedelta(seconds=30)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 447, - "kind": 32768, - "kindString": "Parameter", - "name": "cleanup_timeout", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "None", + { "type": "literal", "value": null } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 524, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1200, + 1201, + 546, + 1199, + 1204, + 1203, + 544, + 545, + 1205, + 1202 + ], + "title": "Properties" + } + ], + "id": 543, + "module": "_models", + "name": "PayPerEventActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 219 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "517", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 548, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 227 } - ] + ], + "type": { + "name": "Undefined", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 448, - "module": "_actor", - "name": "fail", + "id": 549, + "module": "_models", + "name": "id", "parsedDocstring": { - "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n", - "args": { - "exit_code": "The exit code with which the Actor should fail (defaults to `1`).", - "exception": "The exception with which the Actor failed.", - "status_message": "The final status message that the Actor should display." + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 229 } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 550, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 457 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 230 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 551, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fail the Actor instance without using context-manager syntax.\n\nEquivalent to setting the `self.exit_code` and `self.status_message` properties and using\n`await Actor.__aexit__()`.\n" - } - ] + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 231 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 552, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 232 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorTaskId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 449, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "fail", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The exit code with which the Actor should fail (defaults to `1`)." - } - ] - }, - "defaultValue": "1", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 450, - "kind": 32768, - "kindString": "Parameter", - "name": "exit_code", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The exception with which the Actor failed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 451, - "kind": 32768, - "kindString": "Parameter", - "name": "exception", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final status message that the Actor should display." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 452, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", + { "type": "literal", "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 453, - "module": "_actor", - "name": "new_client", + "id": 553, + "module": "_models", + "name": "started_at", "parsedDocstring": { - "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n", - "args": { - "token": "The Apify API token.", - "api_url": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com.", - "max_retries": "How many times to retry a failed request at most.", - "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", - "timeout": "The socket timeout of the HTTP requests sent to the Apify API." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 483 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 233 } ], "type": { - "name": "Undefined", + "name": "datetime", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 554, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return a new instance of the Apify API client.\n\nThe `ApifyClientAsync` class is provided by the [apify-client](https://github.com/apify/apify-client-python)\npackage, and it is automatically configured using the `APIFY_API_BASE_URL` and `APIFY_TOKEN` environment\nvariables.\n\nYou can override the token via the available options. That's useful if you want to use the client\nas a different Apify user than the SDK internals are using.\n" - } - ] + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 234 + } + ], + "type": { + "name": "Annotated[datetime | None, Field(alias='finishedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" }, - "flags": {}, - "id": 454, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "new_client", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 455, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 456, - "kind": 32768, - "kindString": "Parameter", - "name": "api_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many times to retry a failed request at most." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 457, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 458, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The socket timeout of the HTTP requests sent to the Apify API." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 459, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ApifyClientAsync", - "type": "reference" + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 555, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 235 } - ] + ], + "type": { + "name": "ActorJobStatus", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n" + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 556, + "module": "_models", + "name": "status_message", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 236 } ], + "type": { + "name": "Annotated[str | None, Field(alias='statusMessage')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 460, - "module": "_actor", - "name": "open_dataset", + "id": 557, + "module": "_models", + "name": "is_status_message_terminal", "parsedDocstring": { - "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n", - "args": { - "id": "The ID of the dataset to open. If provided, searches for existing dataset by ID.\nMutually exclusive with name and alias.", - "name": "The name of the dataset to open (global scope, persists across runs).\nMutually exclusive with id and alias.", - "alias": "The alias of the dataset to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", - "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - }, - "returns": "An instance of the `Dataset` class for the given ID or name." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 522 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 237 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "An instance of the `Dataset` class for the given ID or name." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Open a dataset.\n\nDatasets are used to store structured data where each object stored has the same attributes, such as online\nstore products or real estate offers. The actual data is stored either on the local filesystem or in\nthe Apify cloud.\n" - } - ] + "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" }, - "flags": {}, - "id": 461, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open_dataset", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the dataset to open. If provided, searches for existing dataset by ID.\nMutually exclusive with name and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 462, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The alias of the dataset to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 463, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the dataset to open (global scope, persists across runs).\nMutually exclusive with id and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 464, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 465, - "kind": 32768, - "kindString": "Parameter", - "name": "force_cloud", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "Dataset", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n" + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 558, + "module": "_models", + "name": "meta", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 238 } ], + "type": { + "name": "ActorRunMeta", + "type": "reference", + "target": "449" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 466, - "module": "_actor", - "name": "open_key_value_store", + "id": 559, + "module": "_models", + "name": "stats", "parsedDocstring": { - "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n", - "args": { - "id": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias.", - "name": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias.", - "alias": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", - "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - }, - "returns": "An instance of the `KeyValueStore` class for the given ID or name." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 557 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 239 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "ActorRunStats", + "type": "reference", + "target": "456" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 560, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "An instance of the `KeyValueStore` class for the given ID or name." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Open a key-value store.\n\nKey-value stores are used to store records or files, along with their MIME content type. The records are stored\nand retrieved using a unique key. The actual data is stored either on a local filesystem or in the Apify cloud.\n" - } - ] - }, - "flags": {}, - "id": 467, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open_key_value_store", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 468, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 469, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 470, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 471, - "kind": 32768, - "kindString": "Parameter", - "name": "force_cloud", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "KeyValueStore", - "type": "reference" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 240 + } + ], + "type": { + "name": "ActorRunOptions", + "type": "reference", + "target": "475" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 561, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 241 } - ] + ], + "type": { + "name": "str", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n" + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 562, + "module": "_models", + "name": "exit_code", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], + "type": { + "name": "Annotated[int | None, Field(alias='exitCode')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 472, - "module": "_actor", - "name": "open_request_queue", + "id": 563, + "module": "_models", + "name": "general_access", "parsedDocstring": { - "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n", - "args": { - "id": "The ID of the RQ to open. If provided, searches for existing RQ by ID.\nMutually exclusive with name and alias.", - "name": "The name of the RQ to open (global scope, persists across runs).\nMutually exclusive with id and alias.", - "alias": "The alias of the RQ to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", - "force_cloud": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - }, - "returns": "An instance of the `RequestQueue` class for the given ID or name." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 591 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 243 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "An instance of the `RequestQueue` class for the given ID or name." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Open a request queue.\n\nRequest queue represents a queue of URLs to crawl, which is stored either on local filesystem or in\nthe Apify cloud. The queue is used for deep crawling of websites, where you start with several URLs and then\nrecursively follow links to other pages. The data structure supports both breadth-first and depth-first\ncrawling orders.\n" - } - ] + "name": "Annotated[str | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 473, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open_request_queue", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the RQ to open. If provided, searches for existing RQ by ID.\nMutually exclusive with name and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 474, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The alias of the RQ to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 475, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the RQ to open (global scope, persists across runs).\nMutually exclusive with id and alias." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 476, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `True` then the Apify cloud storage is always used. This way it is possible\nto combine local and cloud storage.\n" - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 477, - "kind": 32768, - "kindString": "Parameter", - "name": "force_cloud", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "RequestQueue", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n" + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 564, + "module": "_models", + "name": "default_key_value_store_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 244 } ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 478, - "module": "_actor", - "name": "push_data", + "id": 565, + "module": "_models", + "name": "default_dataset_id", "parsedDocstring": { - "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n", - "args": { - "data": "The data to push to the default dataset.", - "charged_event_name": "If provided and if the Actor uses the pay-per-event pricing model,\nthe method will attempt to charge for the event for each pushed item." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 627 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 245 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 566, + "module": "_models", + "name": "default_request_queue_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Store an object or a list of objects to the default dataset of the current Actor run.\n" - } - ] - }, - "flags": {}, - "id": 479, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "push_data", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to push to the default dataset." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 480, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "dict | list[dict]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If provided and if the Actor uses the pay-per-event pricing model,\nthe method will attempt to charge for the event for each pushed item." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 481, - "kind": 32768, - "kindString": "Parameter", - "name": "charged_event_name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ChargeResult", - "type": "reference", - "target": "37" - } + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 246 } - ] + ], + "type": { + "name": "str", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get the Actor input value from the default key-value store associated with the current Actor run." + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 567, + "module": "_models", + "name": "build_number", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 247 } ], + "type": { + "name": "Annotated[str | None, Field(alias='buildNumber')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 482, - "module": "_actor", - "name": "get_input", + "id": 568, + "module": "_models", + "name": "container_url", "parsedDocstring": { - "text": "Get the Actor input value from the default key-value store associated with the current Actor run." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 688 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 248 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the Actor input value from the default key-value store associated with the current Actor run." - } - ] + "name": "Annotated[str | None, Field(alias='containerUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 483, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_input", - "parameters": [], - "type": { - "name": "Any", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get a value from the default key-value store associated with the current Actor run.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 484, - "module": "_actor", - "name": "get_value", + "id": 569, + "module": "_models", + "name": "is_container_server_ready", "parsedDocstring": { - "text": "Get a value from the default key-value store associated with the current Actor run.\n", - "args": { - "key": "The key of the record which to retrieve.", - "default_value": "Default value returned in case the record does not exist." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 703 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 249 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a value from the default key-value store associated with the current Actor run.\n" - } - ] + "name": "Annotated[bool | None, Field(alias='isContainerServerReady')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" }, - "flags": {}, - "id": 485, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_value", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record which to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 486, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default value returned in case the record does not exist." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 487, - "kind": 32768, - "kindString": "Parameter", - "name": "default_value", - "type": { - "name": "Any", - "type": "reference" - } - } - ], - "type": { - "name": "Any", - "type": "reference" + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 488, - "module": "_actor", - "name": "set_value", + "id": 570, + "module": "_models", + "name": "git_branch_name", "parsedDocstring": { - "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n", - "args": { - "key": "The key of the record which to set.", - "value": "The value of the record which to set, or None, if the record should be deleted.", - "content_type": "The content type which should be set to the value." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 714 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 250 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set or delete a value in the default key-value store associated with the current Actor run.\n" - } - ] + "name": "Annotated[str | None, Field(alias='gitBranchName')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 489, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "set_value", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record which to set." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 490, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the record which to set, or None, if the record should be deleted." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 491, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type which should be set to the value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 492, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", + { "type": "literal", "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Retrieve the charging manager to access granular pricing information." + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 493, - "module": "_actor", - "name": "get_charging_manager", + "id": 571, + "module": "_models", + "name": "usage", "parsedDocstring": { - "text": "Retrieve the charging manager to access granular pricing information." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 732 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 251 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the charging manager to access granular pricing information." - } - ] - }, - "flags": {}, - "id": 494, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_charging_manager", - "parameters": [], - "type": { - "name": "ChargingManager", + "name": "Annotated[ActorRunUsage | None, Field(alias='usage')]", + "type": "union", + "types": [ + { "type": "reference", - "target": "9" + "name": "ActorRunUsage", + "target": "483" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 495, - "module": "_actor", - "name": "charge", + "id": 572, + "module": "_models", + "name": "usage_total_usd", "parsedDocstring": { - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n", - "args": { - "event_name": "Name of the event to be charged for.", - "count": "Number of events to charge for." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 737 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge for a specified number of events - sub-operations of the Actor.\n\nThis is relevant only for the pay-per-event pricing model.\n" - } - ] - }, - "flags": {}, - "id": 496, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "charge", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the event to be charged for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 497, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of events to charge for." - } - ] - }, - "defaultValue": "1", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 498, - "kind": 32768, - "kindString": "Parameter", - "name": "count", - "type": { - "name": "int", - "type": "reference" - } - } - ], - "type": { - "name": "ChargeResult", + "name": "Annotated[float | None, Field(alias='usageTotalUsd')]", + "type": "union", + "types": [ + { "type": "reference", - "target": "37" + "name": "float" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 499, - "module": "_actor", - "name": "on", + "id": 573, + "module": "_models", + "name": "usage_usd", "parsedDocstring": { - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n", - "args": { - "event_name": "The Actor event to listen for.", - "listener": "The function to be called when the event is emitted (can be async)." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 774 + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 253 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 500, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 501, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Event", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 502, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Any" - } - ] - } - } - ], - "type": { - "name": "EventListener", + "name": "Annotated[ActorRunUsageUsd | None, Field(alias='usageUsd')]", + "type": "union", + "types": [ + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Any" - } - ] + "name": "ActorRunUsageUsd", + "target": "497" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } - }, + ] + }, + "flags": {}, + "groups": [], + "id": 574, + "module": "_models", + "name": "pricing_info", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 254 + } + ], + "type": { + "name": "Annotated[ FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo | PricePerDatasetItemActorPricingInfo | PayPerEventActorPricingInfo | None, Field(alias='pricingInfo', discriminator='pricing_model'), ]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 584, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ + "type": "union", + "types": [ { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 585, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "525" + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "527" + } + ] + }, { "type": "reference", - "name": "Event.PERSIST_STATE" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." + "name": "PricePerDatasetItemActorPricingInfo", + "target": "531" } ] }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 586, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventPersistStateData" - } - ] - } - } - ], - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ { "type": "reference", - "name": "EventPersistStateData" + "name": "PayPerEventActorPricingInfo", + "target": "543" } ] + }, + { + "type": "literal", + "value": null } - }, + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 575, + "module": "_models", + "name": "charged_event_counts", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 262 + } + ], + "type": { + "name": "Annotated[ dict[str, int] | None, Field(alias='chargedEventCounts'), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 587, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 588, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.SYSTEM_INFO" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false + "name": "str" }, - "id": 589, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventSystemInfoData" - } - ] - } - } - ], - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ { "type": "reference", - "name": "EventSystemInfoData" + "name": "int" } ] + }, + { + "type": "literal", + "value": null } - }, + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 576, + "module": "_models", + "name": "metamorphs", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 590, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 591, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.MIGRATING" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 592, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventMigratingData" - } - ] - } - } - ], - "type": { - "name": "EventListener", + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 266 + } + ], + "type": { + "name": "Annotated[list[Metamorph] | None, Field(alias='metamorphs')]", + "type": "union", + "types": [ + { "type": "reference", + "name": "list", "typeArguments": [ { "type": "reference", - "name": "EventMigratingData" + "name": "Metamorph", + "target": "511" } ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Actor')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 550, + 552, + 561, + 567, + 575, + 568, + 565, + 564, + 566, + 562, + 554, + 563, + 570, + 549, + 569, + 557, + 558, + 576, + 548, + 560, + 574, + 553, + 559, + 555, + 556, + 571, + 572, + 573, + 551 + ], + "title": "Properties" + } + ], + "id": 547, + "module": "_models", + "name": "ActorRun", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 226 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 577, + "module": "_proxy_configuration", + "name": "APIFY_PROXY_VALUE_REGEX", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 578, + "module": "_proxy_configuration", + "name": "COUNTRY_CODE_REGEX", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 579, + "module": "_proxy_configuration", + "name": "SUBDIVISION_CODE_REGEX", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 580, + "module": "_proxy_configuration", + "name": "SESSION_ID_MAX_LENGTH", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given string is a valid URL." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 581, + "module": "_proxy_configuration", + "name": "is_url", + "parsedDocstring": { + "text": "Check if the given string is a valid URL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given string is a valid URL." } - }, + ] + }, + "flags": {}, + "id": 582, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_url", + "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] + "flags": { + "isOptional": false, + "keyword-only": false }, - "flags": {}, - "id": 593, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 594, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.ABORTING" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 595, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventAbortingData" - } - ] - } - } - ], + "id": 583, + "kind": 32768, + "kindString": "Parameter", + "name": "url", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventAbortingData" - } - ] + "name": "str", + "type": "reference" } - }, + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of proxy groups to be used by the [Apify Proxy](https://docs.apify.com/proxy). If not provided,\nthe proxy will select the groups automatically." + } + ] + }, + "flags": {}, + "groups": [], + "id": 585, + "module": "_proxy_configuration", + "name": "groups", + "parsedDocstring": { + "text": "An array of proxy groups to be used by the [Apify Proxy](https://docs.apify.com/proxy). If not provided,\nthe proxy will select the groups automatically." + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 596, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 597, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.EXIT" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 598, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventExitData" - } - ] - } - } - ], - "type": { - "name": "EventListener", + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 80 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventExitData" - } - ] + "name": "str" } - }, + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set and relevant proxies are available in your Apify account, all proxied requests will use IP addresses\nthat are geolocated to the specified country. For example `GB` for IPs from Great Britain. Note that online\nservices often have their own rules for handling geolocation and thus the country selection is a best attempt\nat geolocation, rather than a guaranteed hit. This parameter is optional, by default, each proxied request is\nassigned an IP address from a random country. The country code needs to be a two letter ISO country code.\nSee the [full list of available country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).\nThis parameter is optional, by default, the proxy uses all available proxy servers from all countries." + } + ] + }, + "flags": {}, + "groups": [], + "id": 586, + "module": "_proxy_configuration", + "name": "country_code", + "parsedDocstring": { + "text": "If set and relevant proxies are available in your Apify account, all proxied requests will use IP addresses\nthat are geolocated to the specified country. For example `GB` for IPs from Great Britain. Note that online\nservices often have their own rules for handling geolocation and thus the country selection is a best attempt\nat geolocation, rather than a guaranteed hit. This parameter is optional, by default, each proxied request is\nassigned an IP address from a random country. The country code needs to be a two letter ISO country code.\nSee the [full list of available country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).\nThis parameter is optional, by default, the proxy uses all available proxy servers from all countries." + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add an event listener to the Actor's event manager.\n\nThe following events can be emitted:\n\n- `Event.SYSTEM_INFO`: Emitted every minute; the event data contains information about the Actor's resource\nusage.\n\n- `Event.MIGRATING`: Emitted when the Actor on the Apify platform is about to be migrated to another worker\nserver. Use this event to persist the Actor's state and gracefully stop in-progress tasks, preventing\ndisruption.\n\n- `Event.PERSIST_STATE`: Emitted regularly (default: 60 seconds) to notify the Actor to persist its state,\npreventing work repetition after a restart. This event is emitted together with the `MIGRATING` event, where\nthe `isMigrating` flag in the event data is `True`; otherwise, the flag is `False`. This event is for\nconvenience; the same effect can be achieved by setting an interval and listening for the `MIGRATING` event.\n\n- `Event.ABORTING`: Emitted when a user aborts an Actor run on the Apify platform, allowing the Actor time\nto clean up its state if the abort is graceful.\n" - } - ] - }, - "flags": {}, - "id": 599, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "on", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event to listen for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 600, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Event", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to be called when the event is emitted (can be async)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 601, - "kind": 32768, - "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "EventListener", + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Any" - } - ] + "name": "str" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" + "text": "If set, the proxy will use IP addresses geolocated to the specified subdivision (e.g. US state).\nRequires `country_code` to be set. The subdivision code must be a 1-3 character ISO 3166-2 code\nconsisting of uppercase letters and digits (e.g. `CA` for California). Currently only supported for\nthe United States (`country_code='US'`)." } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 587, + "module": "_proxy_configuration", + "name": "subdivision_code", + "parsedDocstring": { + "text": "If set, the proxy will use IP addresses geolocated to the specified subdivision (e.g. US state).\nRequires `country_code` to be set. The subdivision code must be a 1-3 character ISO 3166-2 code\nconsisting of uppercase letters and digits (e.g. `CA` for California). Currently only supported for\nthe United States (`country_code='US'`)." + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 } ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Provides information about a proxy connection that is used for requests." + } + ] + }, + "decorations": [ + { + "args": "('Configuration')", + "name": "docs_group" + }, + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 586, + 585, + 587 + ], + "title": "Properties" + } + ], + "id": 584, + "module": "_proxy_configuration", + "name": "ProxyInfo", + "parsedDocstring": { + "text": "Provides information about a proxy connection that is used for requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n" + } + ] + }, + "decorations": [], "flags": {}, "groups": [], - "id": 503, - "module": "_actor", - "name": "off", + "id": 589, + "module": "_proxy_configuration", + "name": "__init__", "parsedDocstring": { - "text": "Remove a listener, or all listeners, from an Actor event.\n", + "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n", "args": { - "event_name": "The Actor event for which to remove listeners.", - "listener": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "password": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available.", + "groups": "Proxy groups which the Apify Proxy should use, if provided.", + "country_code": "Country which the Apify Proxy should use, if provided.", + "subdivision_code": "Subdivision (e.g. US state) which the Apify Proxy should use, if provided.\nRequires `country_code` to be set. 1-3 character ISO 3166-2 code of uppercase letters/digits\n(e.g. `CA` for California).", + "proxy_urls": "Custom proxy server URLs which should be rotated through.", + "new_url_function": "Function which returns a custom proxy URL to be used.", + "tiered_proxy_urls": "Proxy URLs arranged into tiers" } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 815 + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 117 } ], "type": { @@ -19840,64 +22244,42 @@ "summary": [ { "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" + "text": "Create a ProxyConfiguration instance.\n\nIt is highly recommended to use `Actor.create_proxy_configuration()` instead of this.\n" } ] - }, - "flags": {}, - "id": 504, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event for which to remove listeners." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 505, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Event", - "type": "reference" - } - }, + }, + "flags": {}, + "id": 590, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available." } ] }, "defaultValue": "None", "flags": { "isOptional": true, - "keyword-only": false + "keyword-only": true }, - "id": 506, + "id": 591, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "password", "type": { - "name": "Callable | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "Callable" + "name": "str" }, { "type": "literal", @@ -19905,54 +22287,42 @@ } ] } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" - } - ] - }, - "flags": {}, - "id": 602, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ + }, { "comment": { "summary": [ { "kind": "text", - "text": "The Actor event for which to remove listeners." + "text": "Proxy groups which the Apify Proxy should use, if provided." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 603, + "id": 592, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "groups", "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "name": "list[str] | None", + "type": "union", + "types": [ { "type": "reference", - "name": "Event.PERSIST_STATE" + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null } ] } @@ -19962,76 +22332,63 @@ "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "Country which the Apify Proxy should use, if provided." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 604, + "id": 593, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "country_code", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ + "name": "str | None", + "type": "union", + "types": [ { "type": "reference", - "name": "EventPersistStateData" + "name": "str" + }, + { + "type": "literal", + "value": null } ] } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" - } - ] - }, - "flags": {}, - "id": 605, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ + }, { "comment": { "summary": [ { "kind": "text", - "text": "The Actor event for which to remove listeners." + "text": "Subdivision (e.g. US state) which the Apify Proxy should use, if provided.\nRequires `country_code` to be set. 1-3 character ISO 3166-2 code of uppercase letters/digits\n(e.g. `CA` for California)." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 606, + "id": 594, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "subdivision_code", "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "name": "str | None", + "type": "union", + "types": [ { "type": "reference", - "name": "Event.SYSTEM_INFO" + "name": "str" + }, + { + "type": "literal", + "value": null } ] } @@ -20041,76 +22398,78 @@ "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "Custom proxy server URLs which should be rotated through." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 607, + "id": 595, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "proxy_urls", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ + "name": "list[str | None] | None", + "type": "union", + "types": [ { "type": "reference", - "name": "EventSystemInfoData" + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + }, + { + "type": "literal", + "value": null } ] } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" - } - ] - }, - "flags": {}, - "id": 608, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ + }, { "comment": { "summary": [ { "kind": "text", - "text": "The Actor event for which to remove listeners." + "text": "Function which returns a custom proxy URL to be used." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 609, + "id": 596, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "new_url_function", "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "name": "_NewUrlFunction | None", + "type": "union", + "types": [ { "type": "reference", - "name": "Event.MIGRATING" + "name": "_NewUrlFunction" + }, + { + "type": "literal", + "value": null } ] } @@ -20120,104 +22479,102 @@ "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "Proxy URLs arranged into tiers" } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 610, + "id": 597, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "tiered_proxy_urls", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ + "name": "list[list[str | None]] | None", + "type": "union", + "types": [ { "type": "reference", - "name": "EventMigratingData" + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + ] + }, + { + "type": "literal", + "value": null } ] } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" - } - ] - }, - "flags": {}, - "id": 611, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ + }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor event for which to remove listeners." - } - ] - }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 612, + "id": 598, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "_actor_config", "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + "name": "Configuration | None", + "type": "union", + "types": [ { "type": "reference", - "name": "Event.ABORTING" + "name": "Configuration", + "target": "328" + }, + { + "type": "literal", + "value": null } ] } }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." - } - ] - }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 613, + "id": 599, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "_apify_client", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ + "name": "ApifyClientAsync | None", + "type": "union", + "types": [ { "type": "reference", - "name": "EventAbortingData" + "name": "ApifyClientAsync" + }, + { + "type": "literal", + "value": null } ] } @@ -20228,122 +22585,202 @@ "type": "literal", "value": null } - }, + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 600, + "module": "_proxy_configuration", + "name": "initialize", + "parsedDocstring": { + "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 200 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { "comment": { "summary": [ { "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" + "text": "Check if using proxy, if so, check the access.\n\nLoad the Apify Proxy password from API (only if not passed to constructor or through env var).\n\nOnly called if Apify Proxy configuration is used. Also checks if country has access to Apify Proxy groups\nif the country code is provided.\n\nYou should use the Actor.create_proxy_configuration function to create a pre-initialized\n`ProxyConfiguration` instance instead of calling this manually." } ] }, "flags": {}, - "id": 614, + "id": 601, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ - { - "comment": { - "summary": [ + "modifiers": [ + "async" + ], + "name": "initialize", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 602, + "module": "_proxy_configuration", + "name": "new_proxy_info", + "parsedDocstring": { + "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n", + "args": { + "session_id": "Represents the identifier of a proxy session (https://docs.apify.com/proxy#sessions).\nAll the HTTP requests going through the proxy with the same session identifier will use the same\ntarget proxy server (i.e. the same IP address). The identifier must not be longer than 50 characters\nand include only the following: `0-9`, `a-z`, `A-Z`, `\".\"`, `\"_\"` and `\"~\"`.", + "request": "request for which the proxy info is being issued, used in proxy tier handling.", + "proxy_tier": "allows forcing the proxy tier to be used.\n" + }, + "returns": "Dictionary that represents information about the proxy and its configuration." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 225 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ { "kind": "text", - "text": "The Actor event for which to remove listeners." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 615, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.EXIT" + "text": "Dictionary that represents information about the proxy and its configuration." } - ] + ], + "tag": "@returns" } - }, + ], + "summary": [ + { + "kind": "text", + "text": "Create a new ProxyInfo object.\n\nUse it if you want to work with a rich representation of a proxy URL. If you need the URL string only,\nuse `ProxyConfiguration.new_url`.\n" + } + ] + }, + "flags": {}, + "id": 603, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "new_proxy_info", + "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "Represents the identifier of a proxy session (https://docs.apify.com/proxy#sessions).\nAll the HTTP requests going through the proxy with the same session identifier will use the same\ntarget proxy server (i.e. the same IP address). The identifier must not be longer than 50 characters\nand include only the following: `0-9`, `a-z`, `A-Z`, `\".\"`, `\"_\"` and `\"~\"`." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": false }, - "id": 616, + "id": 604, "kind": 32768, "kindString": "Parameter", - "name": "listener", - "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EventExitData" - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove a listener, or all listeners, from an Actor event.\n" + "name": "session_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "id": 617, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "off", - "parameters": [ + }, { "comment": { "summary": [ { "kind": "text", - "text": "The Actor event for which to remove listeners." + "text": "request for which the proxy info is being issued, used in proxy tier handling." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": false }, - "id": 618, + "id": 605, "kind": 32768, "kindString": "Parameter", - "name": "event_name", + "name": "request", "type": { - "name": "Event", - "type": "reference" + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -20351,22 +22788,27 @@ "summary": [ { "kind": "text", - "text": "The listener which is supposed to be removed. If not passed, all listeners of this event\nare removed." + "text": "allows forcing the proxy tier to be used.\n" } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": false }, - "id": 619, + "id": 606, "kind": 32768, "kindString": "Parameter", - "name": "listener", + "name": "proxy_tier", "type": { - "name": "EventListener", - "type": "reference", - "typeArguments": [ + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, { "type": "literal", "value": null @@ -20376,131 +22818,605 @@ } ], "type": { - "name": "None", - "type": "literal", - "value": null + "name": "ProxyInfo | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProxyInfo", + "target": "584" + }, + { + "type": "literal", + "value": null + } + ] } } ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configures a connection to a proxy server with the provided options.\n\nProxy servers are used to prevent target websites from blocking your crawlers based on IP address rate limits or\nblacklists. The default servers used by this class are managed by [Apify Proxy](https://docs.apify.com/proxy).\nTo be able to use Apify Proxy, you need an Apify account and access to the selected proxies. If you provide\nno configuration option, the proxies will be managed automatically using a smart algorithm.\n\nIf you want to use your own proxies, use the `proxy_urls` or `new_url_function` constructor options. Your list\nof proxy URLs will be rotated by the configuration, if this option is provided." + } + ] + }, + "decorations": [ + { + "args": "('Configuration')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 589, + 600, + 602 + ], + "title": "Methods" + } + ], + "id": 588, + "module": "_proxy_configuration", + "name": "ProxyConfiguration", + "parsedDocstring": { + "text": "Configures a connection to a proxy server with the provided options.\n\nProxy servers are used to prevent target websites from blocking your crawlers based on IP address rate limits or\nblacklists. The default servers used by this class are managed by [Apify Proxy](https://docs.apify.com/proxy).\nTo be able to use Apify Proxy, you need an Apify account and access to the selected proxies. If you provide\nno configuration option, the proxies will be managed automatically using a smart algorithm.\n\nIf you want to use your own proxies, use the `proxy_urls` or `new_url_function` constructor options. Your list\nof proxy URLs will be rotated by the configuration, if this option is provided." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_proxy_configuration.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 607, + "module": "_utils", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 608, + "module": "_utils", + "name": "ensure_context", + "parsedDocstring": { + "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n", + "args": { + "attribute_name": "The name of the boolean attribute to check on the instance.\n" }, + "returns": "A decorator that wraps methods with context checking." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 2048, - "kindString": "Method", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A decorator that wraps methods with context checking." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." + "text": "Create a decorator that ensures the context manager is initialized before executing the method.\n\nThe decorator checks if the calling instance has the specified attribute and verifies that it is set to `True`.\nIf the instance is inactive, it raises a `RuntimeError`. Works for both synchronous and asynchronous methods.\n" + } + ] + }, + "flags": {}, + "id": 609, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "ensure_context", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the boolean attribute to check on the instance.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 610, + "kind": 32768, + "kindString": "Parameter", + "name": "attribute_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "[T]" + }, + { + "type": "reference", + "name": "T", + "target": "607" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 611, + "module": "_utils", + "name": "get_system_info", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 53 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 612, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_system_info", + "parameters": [], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 613, + "module": "_utils", + "name": "is_running_in_ipython", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 69 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 614, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_running_in_ipython", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 615, + "module": "_utils", + "name": "GroupName", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 74 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 616, + "module": "_utils", + "name": "docs_group", + "parsedDocstring": { + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n", + "args": { + "group_name": "The documentation group to which the symbol belongs.\n" + }, + "returns": "The original callable without modification." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 88 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The original callable without modification." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + } + ] + }, + "flags": {}, + "id": 617, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "docs_group", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The documentation group to which the symbol belongs.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 618, + "kind": 32768, + "kindString": "Parameter", + "name": "group_name", + "type": { + "name": "GroupName", + "type": "reference", + "target": "615" + } + } + ], + "type": { + "name": "Callable", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 619, + "module": "_utils", + "name": "docs_name", + "parsedDocstring": { + "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n", + "args": { + "symbol_name": "The name to be used in the documentation.\n" + }, + "returns": "The original callable without modification." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 107 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The original callable without modification." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Rename a symbol for documentation rendering.\n\nThis decorator modifies only the displayed name of the symbol in the generated documentation\nand does not affect its runtime behavior.\n" } ] }, - "decorations": [], "flags": {}, - "groups": [], - "id": 507, - "module": "_actor", - "name": "is_at_home", - "parsedDocstring": { - "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 825 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "id": 620, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "docs_name", + "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Return `True` when the Actor is running on the Apify platform, and `False` otherwise (e.g. local run)." + "text": "The name to be used in the documentation.\n" } ] }, - "flags": {}, - "id": 508, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "is_at_home", - "parameters": [], + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 621, + "kind": 32768, + "kindString": "Parameter", + "name": "symbol_name", "type": { - "name": "bool", + "name": "str", "type": "reference" } } - ] - }, + ], + "type": { + "name": "Callable", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 622, + "module": "_utils", + "name": "maybe_extract_enum_member_value", + "parsedDocstring": { + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 126 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 2048, - "kindString": "Method", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, - "groups": [], - "id": 509, - "module": "_actor", - "name": "get_env", - "parsedDocstring": { - "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 830 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "id": 623, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "maybe_extract_enum_member_value", + "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return a dictionary with information parsed from all the `APIFY_XXX` environment variables.\n\nFor a list of all the environment variables, see the\n[Actor documentation](https://docs.apify.com/actors/development/environment-variables). If some variables\nare not defined or are invalid, the corresponding value in the resulting dictionary will be None." - } - ] + "flags": { + "isOptional": false, + "keyword-only": false }, - "flags": {}, - "id": 510, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_env", - "parameters": [], + "id": 624, + "kind": 32768, + "kindString": "Parameter", + "name": "maybe_enum_member", "type": { - "name": "dict", + "name": "Any", "type": "reference" } } - ] - }, + ], + "type": { + "name": "Any", + "type": "reference" + } + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 2048, "kindString": "Method", @@ -20509,41 +23425,25 @@ "summary": [ { "kind": "text", - "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 511, - "module": "_actor", - "name": "start", + "id": 626, + "module": "_utils", + "name": "__init__", "parsedDocstring": { - "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n", - "args": { - "actor_id": "The ID of the Actor to be run.", - "run_input": "The input to pass to the Actor run.", - "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", - "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", - "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout.", - "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 300.", - "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\n" - }, - "returns": "Info about the started Actor run" + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 858 + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 136 } ], "type": { @@ -20552,341 +23452,17 @@ }, "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Info about the started Actor run" - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Run an Actor on the Apify platform.\n\nUnlike `Actor.call`, this method just starts the run without waiting for finish.\n" - } - ] - }, "flags": {}, - "id": 512, + "id": 627, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "start", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor to be run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 513, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 514, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 515, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 516, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 517, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 518, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 519, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "timedelta | None | Literal['inherit', 'RemainingTime']", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "inherit" - }, - { - "type": "literal", - "value": "RemainingTime" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 300." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 520, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 521, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "list[Webhook] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Webhook", - "target": "110" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], + "modifiers": [], + "name": "__init__", + "parameters": [], "type": { - "name": "ActorRun", - "type": "reference", - "target": "226" + "name": "None", + "type": "literal", + "value": null } } ] @@ -20899,36 +23475,29 @@ "summary": [ { "kind": "text", - "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n" + "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." } ] }, "decorations": [ { - "name": "_ensure_context" + "name": "asynccontextmanager" } ], "flags": {}, "groups": [], - "id": 522, - "module": "_actor", - "name": "abort", + "id": 628, + "module": "_utils", + "name": "__call__", "parsedDocstring": { - "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n", - "args": { - "run_id": "The ID of the Actor run to be aborted.", - "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", - "status_message": "Status message of the Actor to be set on the platform.", - "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistState`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.\n" - }, - "returns": "Info about the aborted Actor run." + "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 935 + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 141 } ], "type": { @@ -20938,163 +23507,110 @@ "signatures": [ { "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Info about the aborted Actor run." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Abort given Actor run on the Apify platform using the current user account.\n\nThe user account is determined by the `APIFY_TOKEN` environment variable.\n" + "text": "Acquire the lock if it's not already owned by the current task, otherwise proceed without acquiring." } ] }, "flags": {}, - "id": 523, + "id": 629, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "abort", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor run to be aborted." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 524, - "kind": 32768, - "kindString": "Parameter", - "name": "run_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 525, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Status message of the Actor to be set on the platform." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 526, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistState`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 527, - "kind": 32768, - "kindString": "Parameter", - "name": "gracefully", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], + "name": "__call__", + "parameters": [], "type": { - "name": "ActorRun", + "name": "AsyncIterator", "type": "reference", - "target": "226" + "typeArguments": [ + { + "type": "literal", + "value": null + } + ] } } ] - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A reentrant lock implementation for asyncio using asyncio.Lock." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 628, + 626 + ], + "title": "Methods" + } + ], + "id": 625, + "module": "_utils", + "name": "ReentrantLock", + "parsedDocstring": { + "text": "A reentrant lock implementation for asyncio using asyncio.Lock." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 133 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 630, + "module": "events._apify_event_manager", + "name": "event_data_adapter", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_apify_event_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 2048, "kindString": "Method", @@ -21103,42 +23619,29 @@ "summary": [ { "kind": "text", - "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n" + "text": "Initialize a new instance.\n" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 528, - "module": "_actor", - "name": "call", + "id": 632, + "module": "events._apify_event_manager", + "name": "__init__", "parsedDocstring": { - "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n", + "text": "Initialize a new instance.\n", "args": { - "actor_id": "The ID of the Actor to be run.", - "run_input": "The input to pass to the Actor run.", - "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", - "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", - "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout.", - "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", - "wait": "The maximum number of seconds the server waits for the run to finish. If not provided,\nwaits indefinitely.", - "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger.\n" - }, - "returns": "Info about the started Actor run." + "configuration": "The Actor configuration for the event manager.", + "**kwargs": "Additional event manager options passed to the parent class." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 968 + "fileName": "/src/apify/events/_apify_event_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 48 } ], "type": { @@ -21148,292 +23651,175 @@ "signatures": [ { "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Info about the started Actor run." - } - ], - "tag": "@returns" - } - ], "summary": [ - { - "kind": "text", - "text": "Start an Actor on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n" - } - ] - }, - "flags": {}, - "id": 529, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor to be run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 530, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 531, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 532, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 533, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 534, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 535, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` or `RemainingTime` will set timeout of the\nother Actor to the time remaining from this Actor timeout." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 536, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "timedelta | None | Literal['inherit', 'RemainingTime']", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "inherit" - }, - { - "type": "literal", - "value": "RemainingTime" - } - ] - } - ] + { + "kind": "text", + "text": "Initialize a new instance.\n" } - }, + ] + }, + "flags": {}, + "id": 633, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." + "text": "The Actor configuration for the event manager." } ] }, - "defaultValue": "None", "flags": { - "isOptional": true, - "keyword-only": true + "isOptional": false, + "keyword-only": false }, - "id": 537, + "id": 634, "kind": 32768, "kindString": "Parameter", - "name": "webhooks", + "name": "configuration", "type": { - "name": "list[Webhook] | None", + "name": "Configuration", + "type": "reference", + "target": "328" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 636, + "module": "events._apify_event_manager", + "name": "__aenter__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_apify_event_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 70 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 637, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aenter__", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 638, + "module": "events._apify_event_manager", + "name": "__aexit__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_apify_event_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 88 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 639, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aexit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 640, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", "type": "union", "types": [ { "type": "reference", - "name": "list", + "name": "type", "typeArguments": [ { "type": "reference", - "name": "Webhook", - "target": "110" + "name": "BaseException" } ] }, @@ -21445,30 +23831,21 @@ } }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. If not provided,\nwaits indefinitely." - } - ] - }, - "defaultValue": "None", "flags": { - "isOptional": true, - "keyword-only": true + "isOptional": false, + "keyword-only": false }, - "id": 538, + "id": 641, "kind": 32768, "kindString": "Parameter", - "name": "wait", + "name": "exc_value", "type": { - "name": "timedelta | None", + "name": "BaseException | None", "type": "union", "types": [ { "type": "reference", - "name": "timedelta" + "name": "BaseException" }, { "type": "literal", @@ -21478,71 +23855,350 @@ } }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger.\n" - } - ] - }, - "defaultValue": "'default'", "flags": { - "isOptional": true, - "keyword-only": true + "isOptional": false, + "keyword-only": false }, - "id": 539, + "id": 642, "kind": 32768, "kindString": "Parameter", - "name": "logger", + "name": "exc_traceback", "type": { - "name": "logging.Logger | None | Literal['default']", + "name": "TracebackType | None", "type": "union", "types": [ { - "type": "union", - "types": [ - { - "type": "reference", - "name": "logging.Logger" - }, - { - "type": "literal", - "value": null - } - ] + "type": "reference", + "name": "TracebackType" }, { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "default" - } - ] + "type": "literal", + "value": null } ] } } ], "type": { - "name": "ActorRun | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorRun", - "target": "226" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event manager for the Apify platform.\n\nThis class extends Crawlee's `EventManager` to provide Apify-specific functionality, including websocket\nconnectivity to the Apify platform for receiving platform events.\n\nThe event manager handles:\n- Registration and emission of events and their listeners.\n- Websocket connection to Apify platform events.\n- Processing and validation of platform messages.\n- Automatic event forwarding from the platform to local event listeners.\n\nThis class should not be used directly. Use the `Actor.on` and `Actor.off` methods to interact\nwith the event system." + } + ] + }, + "decorations": [ + { + "args": "('Event managers')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 636, + 638, + 632 + ], + "title": "Methods" + } + ], + "id": 631, + "module": "events._apify_event_manager", + "name": "ApifyEventManager", + "parsedDocstring": { + "text": "Event manager for the Apify platform.\n\nThis class extends Crawlee's `EventManager` to provide Apify-specific functionality, including websocket\nconnectivity to the Apify platform for receiving platform events.\n\nThe event manager handles:\n- Registration and emission of events and their listeners.\n- Websocket connection to Apify platform events.\n- Processing and validation of platform messages.\n- Automatic event forwarding from the platform to local event listeners.\n\nThis class should not be used directly. Use the `Actor.on` and `Actor.off` methods to interact\nwith the event system." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_apify_event_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 644, + "module": "events._types", + "name": "mem_avg_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 22 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 645, + "module": "events._types", + "name": "mem_current_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 646, + "module": "events._types", + "name": "mem_max_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 647, + "module": "events._types", + "name": "cpu_avg_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 648, + "module": "events._types", + "name": "cpu_max_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 649, + "module": "events._types", + "name": "cpu_current_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 27 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 650, + "module": "events._types", + "name": "is_cpu_overloaded", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 651, + "module": "events._types", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 } - ] + ], + "type": { + "name": "datetime", + "type": "reference" + } }, { "kind": 2048, @@ -21552,41 +24208,25 @@ "summary": [ { "kind": "text", - "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 540, - "module": "_actor", - "name": "call_task", + "id": 652, + "module": "events._types", + "name": "to_crawlee_format", "parsedDocstring": { - "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n", - "args": { - "task_id": "The ID of the Actor to be run.", - "task_input": "Overrides the input to pass to the Actor run.", - "token": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).", - "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,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor.", - "timeout": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` will set timeout of the other Actor to the\ntime remaining from this Actor timeout.", - "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", - "wait": "The maximum number of seconds the server waits for the run to finish. If not provided, waits\nindefinitely.\n" - }, - "returns": "Info about the started Actor run." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1051 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 } ], "type": { @@ -21595,1560 +24235,930 @@ }, "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Info about the started Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start an Actor task on the Apify Platform and wait for it to finish before returning.\n\nIt waits indefinitely, unless the wait argument is provided.\n\nNote that an Actor task is a saved input configuration and options for an Actor. If you want to run an Actor\ndirectly rather than an Actor task, please use the `Actor.call`\n" - } - ] - }, "flags": {}, - "id": 541, + "id": 653, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call_task", + "modifiers": [], + "name": "to_crawlee_format", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor to be run." - } - ] - }, "flags": { "isOptional": false, "keyword-only": false }, - "id": 542, + "id": 654, "kind": 32768, "kindString": "Parameter", - "name": "task_id", + "name": "dedicated_cpus", "type": { - "name": "str", + "name": "float", "type": "reference" } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides the input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 543, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 544, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 545, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in\nthe default run configuration for the Actor. Using `inherit` will set timeout of the other Actor to the\ntime remaining from this Actor timeout." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 546, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "timedelta | None | Literal['inherit']", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "inherit" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 547, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "list[Webhook] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Webhook", - "target": "110" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. If not provided, waits\nindefinitely.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 548, - "kind": 32768, - "kindString": "Parameter", - "name": "wait", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 549, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } } ], "type": { - "name": "ActorRun | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorRun", - "target": "226" - }, - { - "type": "literal", - "value": null - } - ] + "name": "EventSystemInfoData", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Event data')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 652 + ], + "title": "Methods" + }, + { + "children": [ + 647, + 649, + 648, + 651, + 650, + 644, + 645, + 646 + ], + "title": "Properties" + } + ], + "id": 643, + "module": "events._types", + "name": "SystemInfoEventData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 656, + "module": "events._types", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.PERSIST_STATE" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 657, + "module": "events._types", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 50 + } + ], + "type": { + "name": "EventPersistStateData", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 657, + 656 + ], + "title": "Properties" + } + ], + "id": 655, + "module": "events._types", + "name": "PersistStateEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 48 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 659, + "module": "events._types", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } - ] + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.SYSTEM_INFO" + } + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n" + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 660, + "module": "events._types", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "_ensure_context" + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 56 } ], + "type": { + "name": "SystemInfoEventData", + "type": "reference", + "target": "643" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 660, + 659 + ], + "title": "Properties" + } + ], + "id": 658, + "module": "events._types", + "name": "SystemInfoEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 550, - "module": "_actor", - "name": "metamorph", + "id": 662, + "module": "events._types", + "name": "name", "parsedDocstring": { - "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n", - "args": { - "target_actor_id": "ID of the target Actor that the run should be transformed into", - "run_input": "The input to pass to the new run.", - "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", - "content_type": "The content type of the input.", - "custom_after_sleep": "How long to sleep for after the metamorph, to wait for the container to be stopped." + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 61 } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.MIGRATING" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 663, + "module": "events._types", + "name": "data", + "parsedDocstring": { + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1121 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "type": { - "name": "Undefined", + "name": "EventMigratingData", "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 663, + 662 + ], + "title": "Properties" + } + ], + "id": 661, + "module": "events._types", + "name": "MigratingEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 60 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 665, + "module": "events._types", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform this Actor run to an Actor run of a different Actor.\n\nThe platform stops the current Actor container and starts a new container with the new Actor instead. All\nthe default storages are preserved, and the new input is stored under the `INPUT-METAMORPH-1` key in the same\ndefault key-value store.\n" - } - ] - }, - "flags": {}, - "id": 551, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "metamorph", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the target Actor that the run should be transformed into" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 552, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the new run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 553, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 554, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 555, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long to sleep for after the metamorph, to wait for the container to be stopped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 556, - "kind": 32768, - "kindString": "Parameter", - "name": "custom_after_sleep", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.ABORTING" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 666, + "module": "events._types", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 68 } - ] + ], + "type": { + "name": "EventAbortingData", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 666, + 665 + ], + "title": "Properties" + } + ], + "id": 664, + "module": "events._types", + "name": "AbortingEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 668, + "module": "events._types", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 73 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.EXIT" + } + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 557, - "module": "_actor", - "name": "reboot", + "id": 669, + "module": "events._types", + "name": "data", "parsedDocstring": { - "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n", - "args": { - "event_listeners_timeout": "How long should the Actor wait for Actor event listeners to finish before exiting.", - "custom_after_sleep": "How long to sleep for after the reboot, to wait for the container to be stopped." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1167 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 74 } ], "type": { - "name": "Undefined", + "name": "EventExitData", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internally reboot this Actor.\n\nThe system stops the current container and starts a new one, with the same run ID and default storages.\n" - } - ] - }, - "flags": {}, - "id": 558, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "reboot", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long should the Actor wait for Actor event listeners to finish before exiting." - } - ] - }, - "defaultValue": "EVENT_LISTENERS_TIMEOUT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 559, - "kind": 32768, - "kindString": "Parameter", - "name": "event_listeners_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long to sleep for after the reboot, to wait for the container to be stopped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 560, - "kind": 32768, - "kindString": "Parameter", - "name": "custom_after_sleep", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ { - "kind": 2048, - "kindString": "Method", + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 669, + 668 + ], + "title": "Properties" + } + ], + "id": 667, + "module": "events._types", + "name": "ExitEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 561, - "module": "_actor", - "name": "add_webhook", + "id": 671, + "module": "events._types", + "name": "name", "parsedDocstring": { - "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n", - "args": { - "webhook": "The webhook to be added", - "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url", - "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", - "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.\n" - }, - "returns": "The created webhook." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1233 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 79 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created webhook." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create an ad-hoc webhook for the current Actor run.\n\nThis webhook lets you receive a notification when the Actor run finished or failed.\n\nNote that webhooks are only supported for Actors running on the Apify platform. When running the Actor locally,\nthe function will print a warning and have no effect.\n\nFor more information about Apify Actor webhooks, please see the [documentation](https://docs.apify.com/webhooks).\n" - } - ] + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Event.SESSION_RETIRED" }, - "flags": {}, - "id": 562, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "add_webhook", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The webhook to be added" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 563, - "kind": 32768, - "kindString": "Parameter", - "name": "webhook", - "type": { - "name": "Webhook", - "type": "reference", - "target": "110" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should ignore SSL errors returned by request_url" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 564, - "kind": 32768, - "kindString": "Parameter", - "name": "ignore_ssl_errors", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should retry sending the payload to request_url upon failure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 565, - "kind": 32768, - "kindString": "Parameter", - "name": "do_not_retry", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 566, - "kind": 32768, - "kindString": "Parameter", - "name": "idempotency_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null + { + "type": "reference", + "name": "Event.BROWSER_LAUNCHED" + }, + { + "type": "reference", + "name": "Event.BROWSER_RETIRED" + }, + { + "type": "reference", + "name": "Event.BROWSER_CLOSED" + }, + { + "type": "reference", + "name": "Event.PAGE_CREATED" + }, + { + "type": "reference", + "name": "Event.PAGE_CLOSED" } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Set the status message for the current Actor run.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 567, - "module": "_actor", - "name": "set_status_message", + "id": 672, + "module": "events._types", + "name": "data", "parsedDocstring": { - "text": "Set the status message for the current Actor run.\n", - "args": { - "status_message": "The status message to set to the run.", - "is_terminal": "Set this flag to True if this is the final status message of the Actor run.\n" - }, - "returns": "The updated Actor run object." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1279 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 87 } ], "type": { - "name": "Undefined", + "name": "Any", "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Set the status message for the current Actor run.\n" - } - ] - }, - "flags": {}, - "id": 568, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "set_status_message", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status message to set to the run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 569, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this flag to True if this is the final status message of the Actor run.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 570, - "kind": 32768, - "kindString": "Parameter", - "name": "is_terminal", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ActorRun | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorRun", - "target": "226" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ { - "kind": 2048, - "kindString": "Method", + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 672, + 671 + ], + "title": "Properties" + } + ], + "id": 670, + "module": "events._types", + "name": "EventWithoutData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 78 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 571, - "module": "_actor", - "name": "create_proxy_configuration", + "id": 674, + "module": "events._types", + "name": "name", "parsedDocstring": { - "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n", - "args": { - "actor_proxy_input": "Proxy configuration field from the Actor input, if input has such input field. If you\npass this argument, all the other arguments will be inferred from it.", - "password": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available.", - "groups": "Proxy groups which the Apify Proxy should use, if provided.", - "country_code": "Country which the Apify Proxy should use, if provided.", - "proxy_urls": "Custom proxy server URLs which should be rotated through.", - "new_url_function": "Function which returns a custom proxy URL to be used.\n" - }, - "returns": "ProxyConfiguration object with the passed configuration, or None, if no proxy should be used based\non the configuration." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1310 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 92 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "ProxyConfiguration object with the passed configuration, or None, if no proxy should be used based\non the configuration." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a ProxyConfiguration object with the passed proxy configuration.\n\nConfigures connection to a proxy server with the provided options. Proxy servers are used to prevent target\nwebsites from blocking your crawlers based on IP address rate limits or blacklists.\n\nFor more details and code examples, see the `ProxyConfiguration` class.\n" - } - ] - }, - "flags": {}, - "id": 572, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_proxy_configuration", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Proxy configuration field from the Actor input, if input has such input field. If you\npass this argument, all the other arguments will be inferred from it." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 573, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_proxy_input", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Password for the Apify Proxy. If not provided, will use os.environ['APIFY_PROXY_PASSWORD'],\nif available." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 574, - "kind": 32768, - "kindString": "Parameter", - "name": "password", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Proxy groups which the Apify Proxy should use, if provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 575, - "kind": 32768, - "kindString": "Parameter", - "name": "groups", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Country which the Apify Proxy should use, if provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 576, - "kind": 32768, - "kindString": "Parameter", - "name": "country_code", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom proxy server URLs which should be rotated through." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 577, - "kind": 32768, - "kindString": "Parameter", - "name": "proxy_urls", - "type": { - "name": "list[str | None] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function which returns a custom proxy URL to be used.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 578, - "kind": 32768, - "kindString": "Parameter", - "name": "new_url_function", - "type": { - "name": "_NewUrlFunction | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "_NewUrlFunction" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ProxyConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProxyConfiguration", - "target": "296" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "cpuInfo" } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "_ensure_context" - } - ], "flags": {}, "groups": [], - "id": 579, - "module": "_actor", - "name": "use_state", + "id": 675, + "module": "events._types", + "name": "data", "parsedDocstring": { - "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n", - "args": { - "default_value": "The default value to initialize the state if it is not already set.", - "key": "The key in the key-value store where the state is stored. If not provided, a default key is used.", - "kvs_name": "The name of the key-value store where the state is stored. If not provided, the default\nkey-value store associated with the Actor run is used.\n" - }, - "returns": "The state dictionary with automatic persistence." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1366 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 93 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The state dictionary with automatic persistence." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Easily create and manage state values. All state values are automatically persisted.\n\nValues can be modified by simply using the assignment operator.\n" - } - ] - }, - "flags": {}, - "id": 580, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "use_state", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The default value to initialize the state if it is not already set." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 581, - "kind": 32768, - "kindString": "Parameter", - "name": "default_value", - "type": { - "name": "dict[str, JsonSerializable] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "JsonSerializable" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key in the key-value store where the state is stored. If not provided, a default key is used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 582, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the key-value store where the state is stored. If not provided, the default\nkey-value store associated with the Actor run is used.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 583, - "kind": 32768, - "kindString": "Parameter", - "name": "kvs_name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "JsonSerializable" - } - ] + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" } - } - ] + ] + } } ], "comment": { "summary": [ { "kind": "text", - "text": "The core class for building Actors on the Apify platform.\n\nActors are serverless programs running in the cloud that can perform anything from simple actions\n(such as filling out a web form or sending an email) to complex operations (such as crawling an\nentire website or removing duplicates from a large dataset). They are packaged as Docker containers\nwhich accept well-defined JSON input, perform an action, and optionally produce well-defined output.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors\n- Actor whitepaper: https://whitepaper.actor/\n\n### Usage\n\n```python\nimport asyncio\n\nimport httpx\nfrom apify import Actor\nfrom bs4 import BeautifulSoup\n\n\nasync def main() -> None:\n async with Actor:\n actor_input = await Actor.get_input()\n async with httpx.AsyncClient() as client:\n response = await client.get(actor_input['url'])\n soup = BeautifulSoup(response.content, 'html.parser')\n data = {\n 'url': actor_input['url'],\n 'title': soup.title.string if soup.title else None,\n }\n await Actor.push_data(data)\n\nif __name__ == '__main__':\n asyncio.run(main())\n```" + "text": "" } ] }, "decorations": [ { - "args": "('Actor')", - "name": "docs_name" - }, - { - "args": "('Actor')", + "args": "('Events')", "name": "docs_group" } ], @@ -23156,67 +25166,148 @@ "groups": [ { "children": [ - 408, - 410, - 417, - 399, - 415, - 522, - 561, - 528, - 540, - 495, - 436, - 571, - 438, - 442, - 428, - 448, - 493, - 509, - 482, - 484, - 440, - 507, - 550, - 453, - 503, - 499, - 460, - 466, - 472, - 478, - 557, - 567, - 488, - 511, - 432, - 579 + 675, + 674 ], - "title": "Methods" + "title": "Properties" + } + ], + "id": 673, + "module": "events._types", + "name": "DeprecatedEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 677, + "module": "events._types", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98 + } + ], + "type": { + "name": "str", + "type": "reference" + } }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 678, + "module": "events._types", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 99 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Events')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ { "children": [ - 435, - 427, - 426, - 431 + 678, + 677 ], "title": "Properties" } ], - "id": 398, - "module": "_actor", - "name": "Actor", + "id": 676, + "module": "events._types", + "name": "UnknownEvent", "parsedDocstring": { - "text": "The core class for building Actors on the Apify platform.\n\nActors are serverless programs running in the cloud that can perform anything from simple actions\n(such as filling out a web form or sending an email) to complex operations (such as crawling an\nentire website or removing duplicates from a large dataset). They are packaged as Docker containers\nwhich accept well-defined JSON input, perform an action, and optionally produce well-defined output.\n\n### References\n\n- Apify platform documentation: https://docs.apify.com/platform/actors\n- Actor whitepaper: https://whitepaper.actor/\n\n### Usage\n\n```python\nimport asyncio\n\nimport httpx\nfrom apify import Actor\nfrom bs4 import BeautifulSoup\n\n\nasync def main() -> None:\n async with Actor:\n actor_input = await Actor.get_input()\n async with httpx.AsyncClient() as client:\n response = await client.get(actor_input['url'])\n soup = BeautifulSoup(response.content, 'html.parser')\n data = {\n 'url': actor_input['url'],\n 'title': soup.title.string if soup.title else None,\n }\n await Actor.push_data(data)\n\nif __name__ == '__main__':\n asyncio.run(main())\n```" + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 97 } ], "type": { @@ -23232,24 +25323,24 @@ "summary": [ { "kind": "text", - "text": "The entry point of the SDK, through which all the Actor operations should be done." + "text": "" } ] }, "flags": {}, "groups": [], - "id": 620, - "module": "_actor", - "name": "Actor", + "id": 679, + "module": "events._types", + "name": "EventMessage", "parsedDocstring": { - "text": "The entry point of the SDK, through which all the Actor operations should be done." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/_actor.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 1422 + "fileName": "/src/apify/events/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 102 } ], "type": { @@ -23271,18 +25362,18 @@ }, "flags": {}, "groups": [], - "id": 621, - "module": "__init__", - "name": "__version__", + "id": 680, + "module": "log", + "name": "logger_name", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/__init__.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 + "fileName": "/src/apify/log.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 8 } ], "type": { @@ -23291,180 +25382,111 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 623, - "module": "storage_clients._ppe_dataset_mixin", - "name": "__init__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 15 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 624, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "DatasetClientPpeMixin.__init__", - "target": 623, - "type": "reference" - } - } - ] - } - ], + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "A mixin for dataset clients to add support for PPE pricing model and tracking synthetic events." + "text": "" } ] }, "flags": {}, - "groups": [ + "groups": [], + "id": 681, + "module": "log", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "children": [ - 623 - ], - "title": "Methods" + "character": 1, + "fileName": "/src/apify/log.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 11 } ], - "id": 622, - "module": "storage_clients._ppe_dataset_mixin", - "name": "DatasetClientPpeMixin", + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 682, + "module": "log", + "name": "ActorLogFormatter", "parsedDocstring": { - "text": "A mixin for dataset clients to add support for PPE pricing model and tracking synthetic events." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 12 + "fileName": "/src/apify/log.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 14 } ], "type": { "name": "Undefined", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "extendedBy": [ - { - "name": "ApifyFileSystemDatasetClient", - "target": "625", - "type": "reference" - }, + "flags": {}, + "groups": [], + "id": 683, + "module": "request_loaders._apify_request_list", + "name": "URL_NO_COMMAS_REGEX", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "ApifyDatasetClient", - "target": "804", - "type": "reference" + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 17 } - ] + ], + "type": { + "name": "Undefined", + "type": "reference" + } }, { "kind": 128, "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 626, - "module": "storage_clients._ppe_dataset_mixin", - "name": "__init__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 624, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "DatasetClientPpeMixin.__init__", - "target": 623, - "type": "reference" - } - } - ], - "overwrites": { - "name": "DatasetClientPpeMixin.__init__", - "target": 623, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -23474,143 +25496,30 @@ } ] }, - "decorations": [ - { - "name": "override" - }, - { - "name": "classmethod" - } - ], "flags": {}, "groups": [], - "id": 630, - "module": "storage_clients._file_system._dataset_client", - "name": "open", + "id": 685, + "module": "request_loaders._apify_request_list", + "name": "method", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 631, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 632, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 633, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 634, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 635, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - } - ], - "type": { - "name": "Self", - "type": "reference" - } + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } - ] + ], + "type": { + "name": "HttpMethod", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -23620,107 +25529,119 @@ } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 686, + "module": "request_loaders._apify_request_list", + "name": "payload", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "override" + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 } ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 636, - "module": "storage_clients._file_system._dataset_client", - "name": "push_data", + "id": 687, + "module": "request_loaders._apify_request_list", + "name": "headers", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 50 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 688, + "module": "request_loaders._apify_request_list", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": {}, - "id": 637, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "push_data", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 638, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "list[dict[str, Any]] | dict[str, Any]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } - ] + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } } ], "comment": { "summary": [ { "kind": "text", - "text": "Apify-specific implementation of the `FileSystemDatasetClient`.\n\nIt extends the functionality of `FileSystemDatasetClient` using `DatasetClientPpeMixin` and updates `push_data` to\nlimit and charge for the synthetic `apify-default-dataset-item` event. This is necessary for consistent behavior\nwhen locally testing the `PAY_PER_EVENT` pricing model." + "text": "" } ] }, @@ -23728,79 +25649,52 @@ "groups": [ { "children": [ - 626, - 630, - 636 + 687, + 685, + 686, + 688 ], - "title": "Methods" + "title": "Properties" } ], - "id": 625, - "module": "storage_clients._file_system._dataset_client", - "name": "ApifyFileSystemDatasetClient", + "id": 684, + "module": "request_loaders._apify_request_list", + "name": "_RequestDetails", "parsedDocstring": { - "text": "Apify-specific implementation of the `FileSystemDatasetClient`.\n\nIt extends the functionality of `FileSystemDatasetClient` using `DatasetClientPpeMixin` and updates `push_data` to\nlimit and charge for the synthetic `apify-default-dataset-item` event. This is necessary for consistent behavior\nwhen locally testing the `PAY_PER_EVENT` pricing model." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 15 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 22 } ], "type": { "name": "Undefined", "type": "reference" }, - "extendedTypes": [ + "extendedBy": [ { - "name": "DatasetClientPpeMixin", - "target": "622", + "name": "_RequestsFromUrlInput", + "target": "689", "type": "reference" - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 639, - "module": "storage_clients._file_system._key_value_store_client", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 + "name": "_SimpleUrlInput", + "target": "691", + "type": "reference" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { "kind": 128, "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -23810,90 +25704,30 @@ } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 641, - "module": "storage_clients._file_system._key_value_store_client", - "name": "__init__", + "id": 690, + "module": "request_loaders._apify_request_list", + "name": "requests_from_url", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 27 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 30 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 642, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 643, - "kind": 32768, - "kindString": "Parameter", - "name": "metadata", - "type": { - "name": "KeyValueStoreMetadata", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 644, - "kind": 32768, - "kindString": "Parameter", - "name": "path_to_kvs", - "type": { - "name": "Path", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 645, - "kind": 32768, - "kindString": "Parameter", - "name": "lock", - "type": { - "name": "asyncio.Lock", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -23903,206 +25737,121 @@ } ] }, - "decorations": [ - { - "name": "override" - }, - { - "name": "classmethod" - } - ], "flags": {}, "groups": [], - "id": 646, - "module": "storage_clients._file_system._key_value_store_client", - "name": "open", + "id": 1170, + "module": "request_loaders._apify_request_list", + "name": "method", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 41 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { - "name": "Undefined", + "name": "HttpMethod", "type": "reference" }, - "signatures": [ - { - "flags": {}, - "id": 647, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 648, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 649, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 650, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 651, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration", - "type": "reference" - } - } - ], - "type": { - "name": "Self", - "type": "reference" - } - } - ] + "inheritedFrom": { + "name": "_RequestDetails.method", + "target": 685, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." + "text": "" } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 652, - "module": "storage_clients._file_system._key_value_store_client", - "name": "purge", + "id": 1171, + "module": "request_loaders._apify_request_list", + "name": "payload", "parsedDocstring": { - "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" }, - "signatures": [ + "inheritedFrom": { + "name": "_RequestDetails.payload", + "target": 686, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1172, + "module": "request_loaders._apify_request_list", + "name": "headers", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." - } - ] + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" }, - "flags": {}, - "id": 653, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "purge", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null + { + "type": "reference", + "name": "str" } - } - ] + ] + }, + "inheritedFrom": { + "name": "_RequestDetails.headers", + "target": 687, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -24112,80 +25861,48 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 654, - "module": "storage_clients._file_system._key_value_store_client", - "name": "get_value", + "id": 1173, + "module": "request_loaders._apify_request_list", + "name": "user_data", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 655, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_value", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 656, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "KeyValueStoreRecord | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreRecord" - }, - { - "type": "literal", - "value": null - } - ] + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" } - } - ] + ] + }, + "inheritedFrom": { + "name": "_RequestDetails.user_data", + "target": 688, + "type": "reference" + } } ], "comment": { "summary": [ { "kind": "text", - "text": "Apify-specific implementation of the `FileSystemKeyValueStoreClient`.\n\nThe only difference is that it overrides the `purge` method to delete all files in the key-value store\ndirectory, except for the metadata file and the `INPUT.json` file." + "text": "" } ] }, @@ -24193,40 +25910,48 @@ "groups": [ { "children": [ - 641, - 654, - 646, - 652 + 1172, + 1170, + 1171, + 690, + 1173 ], - "title": "Methods" + "title": "Properties" } ], - "id": 640, - "module": "storage_clients._file_system._key_value_store_client", - "name": "ApifyFileSystemKeyValueStoreClient", + "id": 689, + "module": "request_loaders._apify_request_list", + "name": "_RequestsFromUrlInput", "parsedDocstring": { - "text": "Apify-specific implementation of the `FileSystemKeyValueStoreClient`.\n\nThe only difference is that it overrides the `purge` method to delete all files in the key-value store\ndirectory, except for the metadata file and the `INPUT.json` file." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "extendedTypes": [ + { + "name": "_RequestDetails", + "target": "684", + "type": "reference" + } + ] }, { "kind": 128, "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -24236,66 +25961,68 @@ } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 692, + "module": "request_loaders._apify_request_list", + "name": "url", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "name": "override" + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [], - "id": 658, - "module": "storage_clients._file_system._storage_client", - "name": "get_storage_client_cache_key", + "id": 1174, + "module": "request_loaders._apify_request_list", + "name": "method", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { - "name": "Undefined", + "name": "HttpMethod", "type": "reference" }, - "signatures": [ - { - "flags": {}, - "id": 659, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_storage_client_cache_key", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 660, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - } - ], - "type": { - "name": "Hashable", - "type": "reference" - } - } - ] + "inheritedFrom": { + "name": "_RequestDetails.method", + "target": 685, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -24305,154 +26032,35 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 661, - "module": "storage_clients._file_system._storage_client", - "name": "create_kvs_client", + "id": 1175, + "module": "request_loaders._apify_request_list", + "name": "payload", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 35 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" }, - "signatures": [ - { - "flags": {}, - "id": 662, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_kvs_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 663, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 664, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 665, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 666, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Configuration", - "target": "319" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "FileSystemKeyValueStoreClient", - "type": "reference" - } - } - ] + "inheritedFrom": { + "name": "_RequestDetails.payload", + "target": 686, + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -24462,158 +26070,96 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 667, - "module": "storage_clients._file_system._storage_client", - "name": "create_dataset_client", + "id": 1176, + "module": "request_loaders._apify_request_list", + "name": "headers", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 54 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "type": { - "name": "Undefined", + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + "inheritedFrom": { + "name": "_RequestDetails.headers", + "target": 687, "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 1177, + "module": "request_loaders._apify_request_list", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": {}, - "id": 668, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_dataset_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 669, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 670, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 671, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 672, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Configuration", - "target": "319" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ApifyFileSystemDatasetClient", + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { "type": "reference", - "target": "625" + "name": "str" } - } - ] + ] + }, + "inheritedFrom": { + "name": "_RequestDetails.user_data", + "target": 688, + "type": "reference" + } } ], "comment": { "summary": [ { "kind": "text", - "text": "Apify-specific implementation of the file system storage client.\n\nThe only difference is that it uses `ApifyFileSystemKeyValueStoreClient` for key-value stores,\nwhich overrides the `purge` method to delete all files in the key-value store directory\nexcept for the metadata file and the `INPUT.json` file." + "text": "" } ] }, @@ -24621,31 +26167,40 @@ "groups": [ { "children": [ - 667, - 661, - 658 + 1176, + 1174, + 1175, + 692, + 1177 ], - "title": "Methods" + "title": "Properties" } ], - "id": 657, - "module": "storage_clients._file_system._storage_client", - "name": "ApifyFileSystemStorageClient", + "id": 691, + "module": "request_loaders._apify_request_list", + "name": "_SimpleUrlInput", "parsedDocstring": { - "text": "Apify-specific implementation of the file system storage client.\n\nThe only difference is that it uses `ApifyFileSystemKeyValueStoreClient` for key-value stores,\nwhich overrides the `purge` method to delete all files in the key-value store directory\nexcept for the metadata file and the `INPUT.json` file." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 19 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 33 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "extendedTypes": [ + { + "name": "_RequestDetails", + "target": "684", + "type": "reference" + } + ] }, { "kind": 1024, @@ -24661,18 +26216,18 @@ }, "flags": {}, "groups": [], - "id": 673, - "module": "storage_clients._apify._request_queue_client", - "name": "logger", + "id": 693, + "module": "request_loaders._apify_request_list", + "name": "url_input_adapter", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "type": { @@ -24692,195 +26247,7 @@ "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 675, - "module": "storage_clients._apify._request_queue_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 38 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." - } - ] - }, - "flags": {}, - "id": 676, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 677, - "kind": 32768, - "kindString": "Parameter", - "name": "api_client", - "type": { - "name": "RequestQueueClientAsync", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 678, - "kind": 32768, - "kindString": "Parameter", - "name": "metadata", - "type": { - "name": "RequestQueueMetadata", - "type": "reference" - } - }, - { - "defaultValue": "'single'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 679, - "kind": 32768, - "kindString": "Parameter", - "name": "access", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "single" - }, - { - "type": "literal", - "value": "shared" - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n" - } - ] - }, - "decorations": [ - { - "name": "override" - } - ], - "flags": {}, - "groups": [], - "id": 680, - "module": "storage_clients._apify._request_queue_client", - "name": "get_metadata", - "parsedDocstring": { - "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n", - "returns": "Request queue metadata with accurate counts and timestamps, combining API data with local estimates." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 70 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Request queue metadata with accurate counts and timestamps, combining API data with local estimates." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n" - } - ] - }, - "flags": {}, - "id": 681, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_metadata", - "parameters": [], - "type": { - "name": "ApifyRequestQueueMetadata", - "type": "reference", - "target": "775" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n" + "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n" } ] }, @@ -24891,26 +26258,24 @@ ], "flags": {}, "groups": [], - "id": 682, - "module": "storage_clients._apify._request_queue_client", + "id": 695, + "module": "request_loaders._apify_request_list", "name": "open", "parsedDocstring": { - "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n", + "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n", "args": { - "id": "ID of an existing request queue to open. Mutually exclusive with `name` and `alias`.", - "name": "Name of the request queue to open or create (persists across Actor runs).\nMutually exclusive with `id` and `alias`.", - "alias": "Alias for the request queue (scoped to current Actor run, creates unnamed storage).\nMutually exclusive with `id` and `name`.", - "configuration": "Configuration object containing API credentials (`token`, `api_base_url`) and\noptionally a `default_request_queue_id` for fallback when no identifier is provided.", - "access": "Access mode controlling the client's behavior:\n- `single`: Optimized for single-consumer scenarios (lower API usage, better performance).\n- `shared`: Optimized for multi-consumer scenarios (more API calls, guaranteed consistency).\n" + "name": "An optional name for the request list, used for state persistence.", + "request_list_sources_input": "A list of request source dicts in the standard Apify format. Each dict must\ncontain either a `url` key or a `requestsFromUrl` key. If `None` or empty, an empty request list\nis returned.", + "http_client": "HTTP client used to fetch remote URL lists (entries with `requestsFromUrl`). Defaults to\n`ImpitHttpClient` if not provided.\n" }, - "returns": "An instance for the opened or created storage client." + "returns": "A new `ApifyRequestList` populated with the resolved requests." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103 + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 69 } ], "type": { @@ -24925,7 +26290,7 @@ "content": [ { "kind": "text", - "text": "An instance for the opened or created storage client." + "text": "A new `ApifyRequestList` populated with the resolved requests." } ], "tag": "@returns" @@ -24934,12 +26299,12 @@ "summary": [ { "kind": "text", - "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n" + "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n" } ] }, "flags": {}, - "id": 683, + "id": 696, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -24952,47 +26317,16 @@ "summary": [ { "kind": "text", - "text": "ID of an existing request queue to open. Mutually exclusive with `name` and `alias`." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 684, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the request queue to open or create (persists across Actor runs).\nMutually exclusive with `id` and `alias`." + "text": "An optional name for the request list, used for state persistence." } ] }, + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": true }, - "id": 685, + "id": 697, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -25016,366 +26350,245 @@ "summary": [ { "kind": "text", - "text": "Alias for the request queue (scoped to current Actor run, creates unnamed storage).\nMutually exclusive with `id` and `name`." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 686, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration object containing API credentials (`token`, `api_base_url`) and\noptionally a `default_request_queue_id` for fallback when no identifier is provided." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 687, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access mode controlling the client's behavior:\n- `single`: Optimized for single-consumer scenarios (lower API usage, better performance).\n- `shared`: Optimized for multi-consumer scenarios (more API calls, guaranteed consistency).\n" + "text": "A list of request source dicts in the standard Apify format. Each dict must\ncontain either a `url` key or a `requestsFromUrl` key. If `None` or empty, an empty request list\nis returned." } ] }, - "defaultValue": "'single'", + "defaultValue": "None", "flags": { "isOptional": true, "keyword-only": true }, - "id": 688, - "kind": 32768, - "kindString": "Parameter", - "name": "access", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "single" - }, - { - "type": "literal", - "value": "shared" - } - ] - } - } - ], - "type": { - "name": "ApifyRequestQueueClient", - "type": "reference", - "target": "674" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "override" - } - ], - "flags": {}, - "groups": [], - "id": 689, - "module": "storage_clients._apify._request_queue_client", - "name": "purge", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 690, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "purge", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "override" - } - ], - "flags": {}, - "groups": [], - "id": 691, - "module": "storage_clients._apify._request_queue_client", - "name": "drop", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 164 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 692, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "drop", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "override" - } - ], - "flags": {}, - "groups": [], - "id": 693, - "module": "storage_clients._apify._request_queue_client", - "name": "add_batch_of_requests", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 168 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 694, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "add_batch_of_requests", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 695, + "id": 698, "kind": 32768, "kindString": "Parameter", - "name": "requests", + "name": "request_list_sources_input", "type": { - "name": "Sequence", - "type": "reference", - "typeArguments": [ + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ { "type": "reference", - "name": "Request" + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + }, + { + "type": "literal", + "value": null } ] } }, { - "defaultValue": "False", + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client used to fetch remote URL lists (entries with `requestsFromUrl`). Defaults to\n`ImpitHttpClient` if not provided.\n" + } + ] + }, + "defaultValue": "None", "flags": { "isOptional": true, "keyword-only": true }, - "id": 696, + "id": 699, "kind": 32768, "kindString": "Parameter", - "name": "forefront", + "name": "http_client", "type": { - "name": "bool", - "type": "reference" + "name": "HttpClient | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpClient" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "AddRequestsResponse", - "type": "reference" + "name": "ApifyRequestList", + "type": "reference", + "target": "694" } } ] - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request list that can be constructed from the standard Apify `requestListSources` Actor input format.\n\nThis extends the Crawlee `RequestList` with the ability to parse the request list sources input commonly\nused in Apify Actors. It supports two kinds of entries:\n\n- **Direct URLs** - entries with a `url` key are converted to requests directly.\n- **Remote URL lists** - entries with a `requestsFromUrl` key point to a remote resource (e.g. a plain-text\nfile). The resource is fetched and all URLs found in the response body are extracted and converted to requests.\n\nBoth kinds of entries can optionally specify `method`, `payload`, `headers`, and `userData` fields that will be\napplied to every request created from that entry.\n\n### Usage\n\n```python\nfrom apify import Actor\nfrom apify.request_loaders import ApifyRequestList\n\nasync with Actor:\n actor_input = await Actor.get_input() or {}\n request_list = await ApifyRequestList.open(\n request_list_sources_input=actor_input.get('requestListSources', []),\n )\n```" + } + ] + }, + "decorations": [ + { + "args": "('Request loaders')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 695 + ], + "title": "Methods" + } + ], + "id": 694, + "module": "request_loaders._apify_request_list", + "name": "ApifyRequestList", + "parsedDocstring": { + "text": "A request list that can be constructed from the standard Apify `requestListSources` Actor input format.\n\nThis extends the Crawlee `RequestList` with the ability to parse the request list sources input commonly\nused in Apify Actors. It supports two kinds of entries:\n\n- **Direct URLs** - entries with a `url` key are converted to requests directly.\n- **Remote URL lists** - entries with a `requestsFromUrl` key point to a remote resource (e.g. a plain-text\nfile). The resource is fetched and all URLs found in the response body are extracted and converted to requests.\n\nBoth kinds of entries can optionally specify `method`, `payload`, `headers`, and `userData` fields that will be\napplied to every request created from that entry.\n\n### Usage\n\n```python\nfrom apify import Actor\nfrom apify.request_loaders import ApifyRequestList\n\nasync with Actor:\n actor_input = await Actor.get_input() or {}\n request_list = await ApifyRequestList.open(\n request_list_sources_input=actor_input.get('requestListSources', []),\n )\n```" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/request_loaders/_apify_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 41 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 700, + "module": "scrapy._actor_runner", + "name": "run_scrapy_actor", + "parsedDocstring": { + "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/_actor_runner.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 2048, - "kindString": "Method", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, - "groups": [], - "id": 697, - "module": "storage_clients._apify._request_queue_client", - "name": "fetch_next_request", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 177 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "id": 701, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "run_scrapy_actor", + "parameters": [ { - "flags": {}, - "id": 698, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "fetch_next_request", - "parameters": [], + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 702, + "kind": 32768, + "kindString": "Parameter", + "name": "coro", "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Coroutine", + "type": "reference" } } - ] - }, + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 703, + "module": "scrapy._async_thread", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/_async_thread.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 13 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 2048, "kindString": "Method", @@ -25388,25 +26601,21 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 699, - "module": "storage_clients._apify._request_queue_client", - "name": "mark_request_as_handled", + "id": 705, + "module": "scrapy._async_thread", + "name": "__init__", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 181 + "fileName": "/src/apify/scrapy/_async_thread.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { @@ -25416,42 +26625,16 @@ "signatures": [ { "flags": {}, - "id": 700, + "id": 706, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "mark_request_as_handled", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 701, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "Request", - "type": "reference" - } - } - ], + "modifiers": [], + "name": "__init__", + "parameters": [], "type": { - "name": "ProcessedRequest | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProcessedRequest" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null } } ] @@ -25464,29 +26647,30 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n" } ] }, - "decorations": [ - { - "name": "override" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 702, - "module": "storage_clients._apify._request_queue_client", - "name": "get_request", + "id": 707, + "module": "scrapy._async_thread", + "name": "run_coro", "parsedDocstring": { - "text": "" + "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n", + "args": { + "coro": "The coroutine to run.", + "timeout": "The maximum number of seconds to wait for the coroutine to finish.\n" + }, + "returns": "The result returned by the coroutine." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 185 + "fileName": "/src/apify/scrapy/_async_thread.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 33 } ], "type": { @@ -25495,138 +26679,81 @@ }, "signatures": [ { - "flags": {}, - "id": 703, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_request", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 704, - "kind": 32768, - "kindString": "Parameter", - "name": "unique_key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "Request | None", - "type": "union", - "types": [ + "comment": { + "blockTags": [ { - "type": "reference", - "name": "Request" - }, + "content": [ + { + "kind": "text", + "text": "The result returned by the coroutine." + } + ], + "tag": "@returns" + } + ], + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n" } ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "name": "override" - } - ], - "flags": {}, - "groups": [], - "id": 705, - "module": "storage_clients._apify._request_queue_client", - "name": "reclaim_request", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 189 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { + }, "flags": {}, - "id": 706, + "id": 708, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "reclaim_request", + "modifiers": [], + "name": "run_coro", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The coroutine to run." + } + ] + }, "flags": { "isOptional": false, "keyword-only": false }, - "id": 707, + "id": 709, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "coro", "type": { - "name": "Request", + "name": "Coroutine", "type": "reference" } }, { - "defaultValue": "False", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds to wait for the coroutine to finish.\n" + } + ] + }, + "defaultValue": "timedelta(seconds=60)", "flags": { "isOptional": true, - "keyword-only": true + "keyword-only": false }, - "id": 708, + "id": 710, "kind": 32768, "kindString": "Parameter", - "name": "forefront", + "name": "timeout", "type": { - "name": "bool", + "name": "timedelta", "type": "reference" } } ], "type": { - "name": "ProcessedRequest | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProcessedRequest" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Any", + "type": "reference" } } ] @@ -25639,29 +26766,28 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n" } ] }, - "decorations": [ - { - "name": "override" - } - ], + "decorations": [], "flags": {}, "groups": [], - "id": 709, - "module": "storage_clients._apify._request_queue_client", - "name": "is_empty", + "id": 711, + "module": "scrapy._async_thread", + "name": "close", "parsedDocstring": { - "text": "" + "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n", + "args": { + "timeout": "The maximum number of seconds to wait for the event loop thread to exit." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 198 + "fileName": "/src/apify/scrapy/_async_thread.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 70 } ], "type": { @@ -25670,18 +26796,49 @@ }, "signatures": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n" + } + ] + }, "flags": {}, - "id": 710, + "id": 712, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" + "modifiers": [], + "name": "close", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds to wait for the event loop thread to exit." + } + ] + }, + "defaultValue": "timedelta(seconds=60)", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 713, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "timedelta", + "type": "reference" + } + } ], - "name": "is_empty", - "parameters": [], "type": { - "name": "bool", - "type": "reference" + "name": "None", + "type": "literal", + "value": null } } ] @@ -25691,7 +26848,7 @@ "summary": [ { "kind": "text", - "text": "Request queue client for the Apify platform.\n\nThis client provides access to request queues stored on the Apify platform, supporting both single-consumer\nand multi-consumer scenarios. It manages local caching, request fetching, and state synchronization with the\nplatform's API." + "text": "Class for running an asyncio event loop in a separate thread.\n\nThis allows running asynchronous coroutines from synchronous code by executingthem on an event loop\nthat runs in its own dedicated thread." } ] }, @@ -25699,33 +26856,25 @@ "groups": [ { "children": [ - 675, - 693, - 691, - 697, - 680, - 702, - 709, - 699, - 682, - 689, - 705 + 705, + 711, + 707 ], "title": "Methods" } ], - "id": 674, - "module": "storage_clients._apify._request_queue_client", - "name": "ApifyRequestQueueClient", + "id": 704, + "module": "scrapy._async_thread", + "name": "AsyncThread", "parsedDocstring": { - "text": "Request queue client for the Apify platform.\n\nThis client provides access to request queues stored on the Apify platform, supporting both single-consumer\nand multi-consumer scenarios. It manages local caching, request fetching, and state synchronization with the\nplatform's API." + "text": "Class for running an asyncio event loop in a separate thread.\n\nThis allows running asynchronous coroutines from synchronous code by executingthem on an event loop\nthat runs in its own dedicated thread." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 27 + "fileName": "/src/apify/scrapy/_async_thread.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "type": { @@ -25734,351 +26883,100 @@ } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 711, - "module": "storage_clients._apify._alias_resolving", - "name": "logger", + "id": 714, + "module": "scrapy._logging_config", + "name": "initialize_logging", "parsedDocstring": { - "text": "" + "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "fileName": "/src/apify/scrapy/_logging_config.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." + } + ] + }, + "flags": {}, + "id": 715, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "initialize_logging", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 712, - "module": "storage_clients._apify._alias_resolving", - "name": "open_by_alias", + "id": 716, + "module": "scrapy.extensions._httpcache", + "name": "logger", "parsedDocstring": { - "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n", - "args": { - "alias": "The alias name for the storage (e.g., 'my-storage').", - "storage_type": "The type of storage to open.", - "collection_client": "The Apify API collection client for the storage type.", - "get_resource_client_by_id": "A callable that takes a storage ID and returns the resource client.", - "configuration": "Configuration object containing API credentials and settings.\n" - }, - "returns": "The storage client for the opened or created storage." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 64 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The storage client for the opened or created storage." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n" - } - ] - }, - "flags": {}, - "id": 713, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open_by_alias", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The alias name for the storage (e.g., 'my-storage')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 714, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of storage to open." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 715, - "kind": 32768, - "kindString": "Parameter", - "name": "storage_type", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "Dataset" - }, - { - "type": "literal", - "value": "KeyValueStore" - }, - { - "type": "literal", - "value": "RequestQueue" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API collection client for the storage type." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 716, - "kind": 32768, - "kindString": "Parameter", - "name": "collection_client", - "type": { - "name": "( KeyValueStoreCollectionClientAsync | RequestQueueCollectionClientAsync | DatasetCollectionClientAsync )", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreCollectionClientAsync" - }, - { - "type": "reference", - "name": "RequestQueueCollectionClientAsync" - } - ] - }, - { - "type": "reference", - "name": "DatasetCollectionClientAsync" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callable that takes a storage ID and returns the resource client." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 717, - "kind": 32768, - "kindString": "Parameter", - "name": "get_resource_client_by_id", - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "[str]" - }, - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreClientAsync" - }, - { - "type": "reference", - "name": "RequestQueueClientAsync" - } - ] - }, - { - "type": "reference", - "name": "DatasetClientAsync" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration object containing API credentials and settings.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 718, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - } - ], - "type": { - "name": "KeyValueStoreClientAsync | RequestQueueClientAsync | DatasetClientAsync", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreClientAsync" - }, - { - "type": "reference", - "name": "RequestQueueClientAsync" - } - ] - }, - { - "type": "reference", - "name": "DatasetClientAsync" - } - ] - } - } - ] + } }, { "kind": 128, "kindString": "Class", "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 720, - "module": "storage_clients._apify._alias_resolving", - "name": "default_storage_key", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 138 - } - ], - "type": { - "name": "ClassVar", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - }, { "kind": 2048, "kindString": "Method", @@ -26094,8 +26992,8 @@ "decorations": [], "flags": {}, "groups": [], - "id": 721, - "module": "storage_clients._apify._alias_resolving", + "id": 718, + "module": "scrapy.extensions._httpcache", "name": "__init__", "parsedDocstring": { "text": "" @@ -26103,9 +27001,9 @@ "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 38 } ], "type": { @@ -26115,7 +27013,7 @@ "signatures": [ { "flags": {}, - "id": 722, + "id": 719, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -26126,57 +27024,14 @@ "isOptional": false, "keyword-only": false }, - "id": 723, - "kind": 32768, - "kindString": "Parameter", - "name": "storage_type", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "Dataset" - }, - { - "type": "literal", - "value": "KeyValueStore" - }, - { - "type": "literal", - "value": "RequestQueue" - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 724, + "id": 720, "kind": 32768, "kindString": "Parameter", - "name": "alias", + "name": "settings", "type": { - "name": "str", + "name": "BaseSettings", "type": "reference" } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 725, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } } ], "type": { @@ -26195,25 +27050,25 @@ "summary": [ { "kind": "text", - "text": "Context manager to prevent race condition in alias creation." + "text": "Open the cache storage for a spider." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 726, - "module": "storage_clients._apify._alias_resolving", - "name": "__aenter__", + "id": 721, + "module": "scrapy.extensions._httpcache", + "name": "open_spider", "parsedDocstring": { - "text": "Context manager to prevent race condition in alias creation." + "text": "Open the cache storage for a spider." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 150 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 46 } ], "type": { @@ -26226,23 +27081,36 @@ "summary": [ { "kind": "text", - "text": "Context manager to prevent race condition in alias creation." + "text": "Open the cache storage for a spider." } ] }, "flags": {}, - "id": 727, + "id": 722, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" + "modifiers": [], + "name": "open_spider", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 723, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } + } ], - "name": "__aenter__", - "parameters": [], "type": { - "name": "AliasResolver", - "type": "reference", - "target": "719" + "name": "None", + "type": "literal", + "value": null } } ] @@ -26255,25 +27123,25 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Close the cache storage for a spider." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 728, - "module": "storage_clients._apify._alias_resolving", - "name": "__aexit__", + "id": 724, + "module": "scrapy.extensions._httpcache", + "name": "close_spider", "parsedDocstring": { - "text": "" + "text": "Close the cache storage for a spider." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 156 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 69 } ], "type": { @@ -26282,85 +27150,52 @@ }, "signatures": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the cache storage for a spider." + } + ] + }, "flags": {}, - "id": 729, + "id": 725, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aexit__", + "modifiers": [], + "name": "close_spider", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 730, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_type", - "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 731, + "id": 726, "kind": 32768, "kindString": "Parameter", - "name": "exc_value", + "name": "_", "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Spider", + "type": "reference" } }, { + "defaultValue": "None", "flags": { - "isOptional": false, + "isOptional": true, "keyword-only": false }, - "id": 732, + "id": 727, "kind": 32768, "kindString": "Parameter", - "name": "exc_traceback", + "name": "current_time", "type": { - "name": "TracebackType | None", + "name": "int | None", "type": "union", "types": [ { "type": "reference", - "name": "TracebackType" + "name": "int" }, { "type": "literal", @@ -26386,26 +27221,25 @@ "summary": [ { "kind": "text", - "text": "Get id of the aliased storage.\n" + "text": "Retrieve a response from the cache storage." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 733, - "module": "storage_clients._apify._alias_resolving", - "name": "resolve_id", + "id": 728, + "module": "scrapy.extensions._httpcache", + "name": "retrieve_response", "parsedDocstring": { - "text": "Get id of the aliased storage.\n", - "returns": "Storage id if it exists, None otherwise." + "text": "Retrieve a response from the cache storage." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 197 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 112 } ], "type": { @@ -26415,40 +27249,81 @@ "signatures": [ { "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Storage id if it exists, None otherwise." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Get id of the aliased storage.\n" + "text": "Retrieve a response from the cache storage." } ] }, "flags": {}, - "id": 734, + "id": 729, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" + "modifiers": [], + "name": "retrieve_response", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 730, + "kind": 32768, + "kindString": "Parameter", + "name": "_", + "type": { + "name": "Spider", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 731, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 732, + "kind": 32768, + "kindString": "Parameter", + "name": "current_time", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } ], - "name": "resolve_id", - "parameters": [], "type": { - "name": "str | None", + "name": "Response | None", "type": "union", "types": [ { "type": "reference", - "name": "str" + "name": "Response" }, { "type": "literal", @@ -26467,25 +27342,25 @@ "summary": [ { "kind": "text", - "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." + "text": "Store a response in the cache storage." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 735, - "module": "storage_clients._apify._alias_resolving", - "name": "store_mapping", + "id": 733, + "module": "scrapy.extensions._httpcache", + "name": "store_response", "parsedDocstring": { - "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." + "text": "Store a response in the cache storage." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 217 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 144 } ], "type": { @@ -26498,19 +27373,45 @@ "summary": [ { "kind": "text", - "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." + "text": "Store a response in the cache storage." } ] }, "flags": {}, - "id": 736, + "id": 734, "kind": 4096, "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "store_mapping", + "modifiers": [], + "name": "store_response", "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 735, + "kind": 32768, + "kindString": "Parameter", + "name": "_", + "type": { + "name": "Spider", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 736, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, { "flags": { "isOptional": false, @@ -26519,9 +27420,9 @@ "id": 737, "kind": 32768, "kindString": "Parameter", - "name": "storage_id", + "name": "response", "type": { - "name": "str", + "name": "Response", "type": "reference" } } @@ -26539,7 +27440,7 @@ "summary": [ { "kind": "text", - "text": "Class for handling aliases.\n\nThe purpose of this is class is to ensure that alias storages are created with correct id. This is achieved by using\ndefault kvs as a storage for global mapping of aliases to storage ids. Same mapping is also kept in memory to avoid\nunnecessary calls to API and also have limited support of alias storages when not running on Apify platform. When on\nApify platform, the storages created with alias are accessible by the same alias even after migration or reboot." + "text": "A Scrapy cache storage that uses the Apify `KeyValueStore` to store responses.\n\nIt can be set as a storage for Scrapy's built-in `HttpCacheMiddleware`, which caches\nresponses to requests. See HTTPCache middleware settings (prefixed with `HTTPCACHE_`)\nin the Scrapy documentation for more information. Requires the asyncio Twisted reactor\nto be installed." } ] }, @@ -26547,33 +27448,27 @@ "groups": [ { "children": [ - 726, - 728, + 718, + 724, 721, - 733, - 735 + 728, + 733 ], "title": "Methods" - }, - { - "children": [ - 720 - ], - "title": "Properties" } ], - "id": 719, - "module": "storage_clients._apify._alias_resolving", - "name": "AliasResolver", + "id": 717, + "module": "scrapy.extensions._httpcache", + "name": "ApifyCacheStorage", "parsedDocstring": { - "text": "Class for handling aliases.\n\nThe purpose of this is class is to ensure that alias storages are created with correct id. This is achieved by using\ndefault kvs as a storage for global mapping of aliases to storage ids. Same mapping is also kept in memory to avoid\nunnecessary calls to API and also have limited support of alias storages when not running on Apify platform. When on\nApify platform, the storages created with alias are accessible by the same alias even after migration or reboot." + "text": "A Scrapy cache storage that uses the Apify `KeyValueStore` to store responses.\n\nIt can be set as a storage for Scrapy's built-in `HttpCacheMiddleware`, which caches\nresponses to requests. See HTTPCache middleware settings (prefixed with `HTTPCACHE_`)\nin the Scrapy documentation for more information. Requires the asyncio Twisted reactor\nto be installed." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 114 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 } ], "type": { @@ -26582,522 +27477,847 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dump a dictionary to a gzip-compressed byte stream." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 738, + "module": "scrapy.extensions._httpcache", + "name": "to_gzip", + "parsedDocstring": { + "text": "Dump a dictionary to a gzip-compressed byte stream." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 164 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The secret key used for signing URLs for secure access to key-value store records." + "text": "Dump a dictionary to a gzip-compressed byte stream." } ] }, "flags": {}, - "groups": [], "id": 739, - "module": "storage_clients._apify._models", - "name": "url_signing_secret_key", - "parsedDocstring": { - "text": "The secret key used for signing URLs for secure access to key-value store records." - }, - "sources": [ + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "to_gzip", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 740, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "dict", + "type": "reference" + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 741, + "kind": 32768, + "kindString": "Parameter", + "name": "mtime", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } } ], "type": { - "name": "Annotated[str | None, Field(alias='urlSigningSecretKey', default=None)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + "name": "bytes", + "type": "reference" } } - ], + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Extended key-value store metadata model for Apify platform.\n\nIncludes additional Apify-specific fields." + "text": "Load a dictionary from a gzip-compressed byte stream." } ] }, - "decorations": [ - { - "args": "('Storage data')", - "name": "docs_group" - } - ], + "decorations": [], "flags": {}, - "groups": [ - { - "children": [ - 739 - ], - "title": "Properties" - } - ], - "id": 738, - "module": "storage_clients._apify._models", - "name": "ApifyKeyValueStoreMetadata", + "groups": [], + "id": 742, + "module": "scrapy.extensions._httpcache", + "name": "from_gzip", "parsedDocstring": { - "text": "Extended key-value store metadata model for Apify platform.\n\nIncludes additional Apify-specific fields." + "text": "Load a dictionary from a gzip-compressed byte stream." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 15 + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 172 } ], "type": { "name": "Undefined", "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Load a dictionary from a gzip-compressed byte stream." } ] }, "flags": {}, - "groups": [], - "id": 741, - "module": "storage_clients._apify._models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 743, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "from_gzip", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 744, + "kind": 32768, + "kindString": "Parameter", + "name": "gzip_bytes", + "type": { + "name": "bytes", + "type": "reference" + } } ], "type": { - "name": "Undefined", + "name": "dict", "type": "reference" } - }, + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 745, + "module": "scrapy.extensions._httpcache", + "name": "read_gzip_time", + "parsedDocstring": { + "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." } ] }, "flags": {}, - "groups": [], - "id": 742, - "module": "storage_clients._apify._models", - "name": "lock_expires_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 746, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "read_gzip_time", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 747, + "kind": 32768, + "kindString": "Parameter", + "name": "gzip_bytes", + "type": { + "name": "bytes", + "type": "reference" + } } ], "type": { - "name": "datetime", + "name": "int", "type": "reference" } } - ], + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Response to prolong request lock calls." + "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n" } ] }, - "decorations": [ + "decorations": [], + "flags": {}, + "groups": [], + "id": 748, + "module": "scrapy.extensions._httpcache", + "name": "get_kvs_name", + "parsedDocstring": { + "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n", + "args": { + "spider_name": "Value of the Spider instance's name attribute.", + "max_length": "Maximum length of the key value store name.\n" + } + }, + "sources": [ { - "args": "('Storage data')", - "name": "docs_group" + "character": 1, + "fileName": "/src/apify/scrapy/extensions/_httpcache.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 187 } ], - "flags": {}, - "groups": [ + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "children": [ - 742, - 741 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n" + } + ] + }, + "flags": {}, + "id": 749, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_kvs_name", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Value of the Spider instance's name attribute." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 750, + "kind": 32768, + "kindString": "Parameter", + "name": "spider_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum length of the key value store name.\n" + } + ] + }, + "defaultValue": "60", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 751, + "kind": 32768, + "kindString": "Parameter", + "name": "max_length", + "type": { + "name": "int", + "type": "reference" + } + } ], - "title": "Properties" - } - ], - "id": 740, - "module": "storage_clients._apify._models", - "name": "ProlongRequestLockResponse", - "parsedDocstring": { - "text": "Response to prolong request lock calls." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "type": { + "name": "str", + "type": "reference" + } } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { "kind": 128, "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new instance.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 744, - "module": "storage_clients._apify._models", - "name": "model_config", + "id": 753, + "module": "scrapy.middlewares.apify_proxy", + "name": "__init__", "parsedDocstring": { - "text": "" + "text": "Create a new instance.\n", + "args": { + "proxy_settings": "Dictionary containing proxy settings, provided by the Actor input.", + "auth_encoding": "Encoding for basic authentication (default is 'latin-1')." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 } ], "type": { "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of requests that were requested from the queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 745, - "module": "storage_clients._apify._models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of requests that were requested from the queue." }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 44 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='limit', default=None)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new instance.\n" + } + ] }, - { + "flags": {}, + "id": 754, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dictionary containing proxy settings, provided by the Actor input." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 755, + "kind": 32768, + "kindString": "Parameter", + "name": "proxy_settings", + "type": { + "name": "dict", + "type": "reference" + } + } + ], + "type": { + "name": "None", "type": "literal", "value": null } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether the queue has been accessed by multiple clients (consumers)." + "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class." } ] }, - "flags": {}, - "groups": [], - "id": 746, - "module": "storage_clients._apify._models", - "name": "had_multiple_clients", - "parsedDocstring": { - "text": "Indicates whether the queue has been accessed by multiple clients (consumers)." - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 47 + "name": "classmethod" } ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the queue was last modified." - } - ] - }, "flags": {}, "groups": [], - "id": 747, - "module": "storage_clients._apify._models", - "name": "queue_modified_at", + "id": 756, + "module": "scrapy.middlewares.apify_proxy", + "name": "from_crawler", "parsedDocstring": { - "text": "The timestamp when the queue was last modified." + "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class.", + "args": { + "crawler": "Scrapy Crawler object.\n" + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 50 + "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 39 } ], "type": { - "name": "datetime", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class." + } + ] + }, + "flags": {}, + "id": 757, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "from_crawler", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy Crawler object.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 758, + "kind": 32768, + "kindString": "Parameter", + "name": "crawler", + "type": { + "name": "Crawler", + "type": "reference" + } + } + ], + "type": { + "name": "ApifyHttpProxyMiddleware", + "type": "reference", + "target": "752" + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The duration for which the returned requests are locked and cannot be processed by other clients." + "text": "Process a Scrapy request by assigning a new proxy.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 748, - "module": "storage_clients._apify._models", - "name": "lock_time", + "id": 759, + "module": "scrapy.middlewares.apify_proxy", + "name": "process_request", "parsedDocstring": { - "text": "The duration for which the returned requests are locked and cannot be processed by other clients." + "text": "Process a Scrapy request by assigning a new proxy.\n", + "args": { + "request": "Scrapy Request object.", + "spider": "Scrapy Spider object.\n" + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 53 + "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67 } ], "type": { - "name": "Annotated[timedelta | None, Field(alias='lockSecs', default=None)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Process a Scrapy request by assigning a new proxy.\n" + } + ] }, - { + "flags": {}, + "id": 760, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "process_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy Request object." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 761, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy Spider object.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 762, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } + } + ], + "type": { + "name": "None", "type": "literal", "value": null } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether the queue contains any locked requests." + "text": "Process an exception that occurs during request processing.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 749, - "module": "storage_clients._apify._models", - "name": "queue_has_locked_requests", + "id": 763, + "module": "scrapy.middlewares.apify_proxy", + "name": "process_exception", "parsedDocstring": { - "text": "Indicates whether the queue contains any locked requests." + "text": "Process an exception that occurs during request processing.\n", + "args": { + "request": "Scrapy Request object.", + "exception": "Exception object.", + "spider": "Scrapy Spider object.\n" + }, + "returns": "Returning None, meaning Scrapy will continue processing this exception, executing any other\nprocess_exception() methods of installed middleware, until no middleware is left and the default\nexception handling kicks in." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 56 + "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 89 } ], "type": { - "name": "Annotated[bool | None, Field(alias='queueHasLockedRequests', default=False)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Returning None, meaning Scrapy will continue processing this exception, executing any other\nprocess_exception() methods of installed middleware, until no middleware is left and the default\nexception handling kicks in." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Process an exception that occurs during request processing.\n" + } + ] }, - { + "flags": {}, + "id": 764, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "process_exception", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy Request object." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 765, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Exception object." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 766, + "kind": 32768, + "kindString": "Parameter", + "name": "exception", + "type": { + "name": "Exception", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy Spider object.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 767, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } + } + ], + "type": { + "name": "None", "type": "literal", "value": null } - ] + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify HTTP proxy middleware for Scrapy.\n\nThis middleware enhances request processing by adding a 'proxy' field to the request's meta and an authentication\nheader. It draws inspiration from the `HttpProxyMiddleware` included by default in Scrapy projects. The proxy URL\nis sourced from the settings under the `APIFY_PROXY_SETTINGS` key. The value of this key, a dictionary, should be\nprovided by the Actor input. An example of the proxy settings:\n\nproxy_settings = {'useApifyProxy': true, 'apifyProxyGroups': []}" } - }, + ] + }, + "flags": {}, + "groups": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of request objects retrieved from the beginning of the queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 750, - "module": "storage_clients._apify._models", - "name": "items", - "parsedDocstring": { - "text": "The list of request objects retrieved from the beginning of the queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 - } + "children": [ + 753, + 756, + 763, + 759 ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request" - } - ] - } + "title": "Methods" + } + ], + "id": 752, + "module": "scrapy.middlewares.apify_proxy", + "name": "ApifyHttpProxyMiddleware", + "parsedDocstring": { + "text": "Apify HTTP proxy middleware for Scrapy.\n\nThis middleware enhances request processing by adding a 'proxy' field to the request's meta and an authentication\nheader. It draws inspiration from the `HttpProxyMiddleware` included by default in Scrapy projects. The proxy URL\nis sourced from the settings under the `APIFY_PROXY_SETTINGS` key. The value of this key, a dictionary, should be\nprovided by the Actor input. An example of the proxy settings:\n\nproxy_settings = {'useApifyProxy': true, 'apifyProxyGroups': []}" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 17 } ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Model for request queue head.\n\nRepresents a collection of requests retrieved from the beginning of a queue,\nincluding metadata about the queue's state and lock information for the requests." + "text": "" } ] }, - "decorations": [ - { - "args": "('Storage data')", - "name": "docs_group" - } - ], "flags": {}, - "groups": [ - { - "children": [ - 746, - 750, - 745, - 748, - 744, - 749, - 747 - ], - "title": "Properties" - } - ], - "id": 743, - "module": "storage_clients._apify._models", - "name": "RequestQueueHead", + "groups": [], + "id": 768, + "module": "scrapy.pipelines.actor_dataset_push", + "name": "logger", "parsedDocstring": { - "text": "Model for request queue head.\n\nRepresents a collection of requests retrieved from the beginning of a queue,\nincluding metadata about the queue's state and lock information for the requests." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 35 + "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 13 } ], "type": { @@ -27110,110 +28330,85 @@ "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Pushes the provided Scrapy item to the Actor's default dataset." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 752, - "module": "storage_clients._apify._models", - "name": "model_config", + "id": 770, + "module": "scrapy.pipelines.actor_dataset_push", + "name": "process_item", "parsedDocstring": { - "text": "" + "text": "Pushes the provided Scrapy item to the Actor's default dataset." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 69 + "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 22 } ], "type": { "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 753, - "module": "storage_clients._apify._models", - "name": "key", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pushes the provided Scrapy item to the Actor's default dataset." + } + ] + }, + "flags": {}, + "id": 771, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "process_item", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 772, + "kind": 32768, + "kindString": "Parameter", + "name": "item", + "type": { + "name": "Item", + "type": "reference" + } + } + ], + "type": { + "name": "Item", + "type": "reference" } - ] - }, - "flags": {}, - "groups": [], - "id": 754, - "module": "storage_clients._apify._models", - "name": "size", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 72 } - ], - "type": { - "name": "int", - "type": "reference" - } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "Model for a key-value store key info.\n\nOnly internal structure." + "text": "A Scrapy pipeline for pushing items to an Actor's default dataset.\n\nThis pipeline is designed to be enabled only when the Scrapy project is run as an Actor." } ] }, @@ -27221,25 +28416,23 @@ "groups": [ { "children": [ - 753, - 752, - 754 + 770 ], - "title": "Properties" + "title": "Methods" } ], - "id": 751, - "module": "storage_clients._apify._models", - "name": "KeyValueStoreKeyInfo", + "id": 769, + "module": "scrapy.pipelines.actor_dataset_push", + "name": "ActorDatasetPushPipeline", "parsedDocstring": { - "text": "Model for a key-value store key info.\n\nOnly internal structure." + "text": "A Scrapy pipeline for pushing items to an Actor's default dataset.\n\nThis pipeline is designed to be enabled only when the Scrapy project is run as an Actor." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 63 + "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "type": { @@ -27248,144 +28441,324 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 756, - "module": "storage_clients._apify._models", - "name": "model_config", - "parsedDocstring": { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 81 - } - ], - "type": { - "name": "Undefined", - "type": "reference" } + ] + }, + "flags": {}, + "groups": [], + "id": 773, + "module": "scrapy.requests", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/requests.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Convert a Scrapy request to an Apify request.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 774, + "module": "scrapy.requests", + "name": "to_apify_request", + "parsedDocstring": { + "text": "Convert a Scrapy request to an Apify request.\n", + "args": { + "scrapy_request": "The Scrapy request to be converted.", + "spider": "The Scrapy spider that the request is associated with.\n" }, + "returns": "The converted Apify request if the conversion was successful, otherwise None." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/requests.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The converted Apify request if the conversion was successful, otherwise None." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "" + "text": "Convert a Scrapy request to an Apify request.\n" } ] }, "flags": {}, - "groups": [], - "id": 757, - "module": "storage_clients._apify._models", - "name": "count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 775, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "to_apify_request", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 83 + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Scrapy request to be converted." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 776, + "kind": 32768, + "kindString": "Parameter", + "name": "scrapy_request", + "type": { + "name": "ScrapyRequest", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Scrapy spider that the request is associated with.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 777, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } } ], "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ + "name": "ApifyRequest | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "" + "type": "reference", + "name": "ApifyRequest" + }, + { + "type": "literal", + "value": null } ] - }, - "flags": {}, - "groups": [], - "id": 758, - "module": "storage_clients._apify._models", - "name": "limit", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 84 - } - ], - "type": { - "name": "int", - "type": "reference" } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Convert an Apify request to a Scrapy request.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 778, + "module": "scrapy.requests", + "name": "to_scrapy_request", + "parsedDocstring": { + "text": "Convert an Apify request to a Scrapy request.\n", + "args": { + "apify_request": "The Apify request to be converted.", + "spider": "The Scrapy spider that the request is associated with.\n" }, + "returns": "The converted Scrapy request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/requests.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 96 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The converted Scrapy request." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "" + "text": "Convert an Apify request to a Scrapy request.\n" } ] }, "flags": {}, - "groups": [], - "id": 759, - "module": "storage_clients._apify._models", - "name": "is_truncated", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 779, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "to_scrapy_request", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 85 + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify request to be converted." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 780, + "kind": 32768, + "kindString": "Parameter", + "name": "apify_request", + "type": { + "name": "ApifyRequest", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Scrapy spider that the request is associated with.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 781, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } } ], "type": { - "name": "bool", + "name": "ScrapyRequest", "type": "reference" } - }, + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 782, + "module": "scrapy.scheduler", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "kind": 1024, - "kindString": "Property", + "character": 1, + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -27395,325 +28768,476 @@ } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 760, - "module": "storage_clients._apify._models", - "name": "items", + "id": 784, + "module": "scrapy.scheduler", + "name": "__init__", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 86 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 30 } ], "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKeyInfo", - "target": "751" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 785, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Open the scheduler.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 761, - "module": "storage_clients._apify._models", - "name": "exclusive_start_key", + "id": 786, + "module": "scrapy.scheduler", + "name": "open", "parsedDocstring": { - "text": "" + "text": "Open the scheduler.\n", + "args": { + "spider": "The spider that the scheduler is associated with." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 87 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 43 } ], "type": { - "name": "Annotated[str | None, Field(alias='exclusiveStartKey', default=None)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Open the scheduler.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 787, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "open", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The spider that the scheduler is associated with." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 788, + "kind": 32768, + "kindString": "Parameter", + "name": "spider", + "type": { + "name": "Spider", + "type": "reference" + } + } + ], + "type": { + "name": "Deferred[None] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Deferred", + "typeArguments": [ + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 762, - "module": "storage_clients._apify._models", - "name": "next_exclusive_start_key", + "id": 789, + "module": "scrapy.scheduler", + "name": "close", "parsedDocstring": { - "text": "" + "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n", + "args": { + "reason": "The reason for closing the spider." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 88 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 70 } ], "type": { - "name": "Annotated[str | None, Field(alias='nextExclusiveStartKey', default=None)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n" + } + ] }, - { + "flags": {}, + "id": 790, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "close", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for closing the spider." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 791, + "kind": 32768, + "kindString": "Parameter", + "name": "reason", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", "type": "literal", "value": null } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Model for listing keys in the key-value store.\n\nOnly internal structure." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 757, - 761, - 759, - 760, - 758, - 756, - 762 - ], - "title": "Properties" - } - ], - "id": 755, - "module": "storage_clients._apify._models", - "name": "KeyValueStoreListKeysPage", - "parsedDocstring": { - "text": "Model for listing keys in the key-value store.\n\nOnly internal structure." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 75 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Id of the request." + "text": "Check if the scheduler has any pending requests.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 764, - "module": "storage_clients._apify._models", - "name": "id", + "id": 792, + "module": "scrapy.scheduler", + "name": "has_pending_requests", "parsedDocstring": { - "text": "Id of the request." + "text": "Check if the scheduler has any pending requests.\n", + "returns": "True if the scheduler has any pending requests, False otherwise." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 97 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 91 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request was already handled." - } - ] - }, - "flags": {}, - "groups": [], - "id": 765, - "module": "storage_clients._apify._models", - "name": "was_already_handled", - "parsedDocstring": { - "text": "Whether the request was already handled." }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 100 + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the scheduler has any pending requests, False otherwise." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Check if the scheduler has any pending requests.\n" + } + ] + }, + "flags": {}, + "id": 793, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "has_pending_requests", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" + } } - ], - "type": { - "name": "bool", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The hydrated request object (the original one)." + "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 766, - "module": "storage_clients._apify._models", - "name": "hydrated", + "id": 794, + "module": "scrapy.scheduler", + "name": "enqueue_request", "parsedDocstring": { - "text": "The hydrated request object (the original one)." + "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n", + "args": { + "request": "The request to add to the scheduler.\n" + }, + "returns": "True if the request was successfully enqueued, False otherwise." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108 } ], "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the request was successfully enqueued, False otherwise." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 795, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "enqueue_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request to add to the scheduler.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 796, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + } + ], + "type": { + "name": "bool", + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The expiration time of the lock on the request." + "text": "Fetch the next request from the scheduler.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 767, - "module": "storage_clients._apify._models", - "name": "lock_expires_at", + "id": 797, + "module": "scrapy.scheduler", + "name": "next_request", "parsedDocstring": { - "text": "The expiration time of the lock on the request." + "text": "Fetch the next request from the scheduler.\n", + "returns": "The next request, or None if there are no more requests." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 142 } ], "type": { - "name": "datetime | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "datetime" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The next request, or None if there are no more requests." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Fetch the next request from the scheduler.\n" + } + ] }, - { - "type": "literal", - "value": null + "flags": {}, + "id": 798, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "next_request", + "parameters": [], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "Pydantic model for cached request information.\n\nOnly internal structure." + "text": "A Scrapy scheduler that uses the Apify `RequestQueue` to manage requests.\n\nThis scheduler requires the asyncio Twisted reactor to be installed." } ] }, @@ -27721,26 +29245,28 @@ "groups": [ { "children": [ - 766, - 764, - 767, - 765 + 784, + 789, + 794, + 792, + 797, + 786 ], - "title": "Properties" + "title": "Methods" } ], - "id": 763, - "module": "storage_clients._apify._models", - "name": "CachedRequest", + "id": 783, + "module": "scrapy.scheduler", + "name": "ApifyScheduler", "parsedDocstring": { - "text": "Pydantic model for cached request information.\n\nOnly internal structure." + "text": "A Scrapy scheduler that uses the Apify `RequestQueue` to manage requests.\n\nThis scheduler requires the asyncio Twisted reactor to be installed." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 + "fileName": "/src/apify/scrapy/scheduler.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 } ], "type": { @@ -27749,248 +29275,548 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a basic authentication header for the given username and password." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 799, + "module": "scrapy.utils", + "name": "get_basic_auth_header", + "parsedDocstring": { + "text": "Generate a basic authentication header for the given username and password." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Generate a basic authentication header for the given username and password." } ] }, "flags": {}, - "groups": [], - "id": 769, - "module": "storage_clients._apify._models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 800, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_basic_auth_header", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 111 + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 801, + "kind": 32768, + "kindString": "Parameter", + "name": "username", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 802, + "kind": 32768, + "kindString": "Parameter", + "name": "password", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "defaultValue": "'latin-1'", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 803, + "kind": 32768, + "kindString": "Parameter", + "name": "auth_encoding", + "type": { + "name": "str", + "type": "reference" + } } ], "type": { - "name": "Undefined", + "name": "bytes", "type": "reference" } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 804, + "module": "scrapy.utils", + "name": "apply_apify_settings", + "parsedDocstring": { + "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n", + "args": { + "settings": "Scrapy project settings to be modified.", + "proxy_config": "Proxy configuration to be stored in the settings.\n" }, + "returns": "Scrapy project settings with custom configurations." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/scrapy/utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Scrapy project settings with custom configurations." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "\"The number of request queue deletes." + "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n" } ] }, "flags": {}, - "groups": [], - "id": 770, - "module": "storage_clients._apify._models", - "name": "delete_count", - "parsedDocstring": { - "text": "\"The number of request queue deletes." - }, - "sources": [ + "id": 805, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "apply_apify_settings", + "parameters": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 113 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Scrapy project settings to be modified." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 806, + "kind": 32768, + "kindString": "Parameter", + "name": "settings", + "type": { + "name": "Settings | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Settings" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Proxy configuration to be stored in the settings.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 807, + "kind": 32768, + "kindString": "Parameter", + "name": "proxy_config", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } } ], "type": { - "name": "int", + "name": "Settings", "type": "reference" } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 808, + "module": "storage_clients._apify._alias_resolving", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 809, + "module": "storage_clients._apify._alias_resolving", + "name": "open_by_alias", + "parsedDocstring": { + "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n", + "args": { + "alias": "The alias name for the storage (e.g., 'my-storage').", + "storage_type": "The type of storage to open.", + "collection_client": "The Apify API collection client for the storage type.", + "get_resource_client_by_id": "A callable that takes a storage ID and returns the resource client.", + "configuration": "Configuration object containing API credentials and settings.\n" }, + "returns": "The storage client for the opened or created storage." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 64 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The storage client for the opened or created storage." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "The number of request queue head reads." + "text": "Open storage by alias, creating it if necessary.\n\nThis function resolves storage aliases to their IDs, creating new unnamed storage if needed.\nThe alias mapping is stored in the default key-value store for persistence across Actor runs.\n" } ] }, "flags": {}, - "groups": [], - "id": 771, - "module": "storage_clients._apify._models", - "name": "head_item_read_count", - "parsedDocstring": { - "text": "The number of request queue head reads." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 116 - } + "id": 810, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of request queue reads." + "name": "open_by_alias", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The alias name for the storage (e.g., 'my-storage')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 811, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of storage to open." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 812, + "kind": 32768, + "kindString": "Parameter", + "name": "storage_type", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Dataset" + }, + { + "type": "literal", + "value": "KeyValueStore" + }, + { + "type": "literal", + "value": "RequestQueue" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API collection client for the storage type." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 813, + "kind": 32768, + "kindString": "Parameter", + "name": "collection_client", + "type": { + "name": "( KeyValueStoreCollectionClientAsync | RequestQueueCollectionClientAsync | DatasetCollectionClientAsync )", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreCollectionClientAsync" + }, + { + "type": "reference", + "name": "RequestQueueCollectionClientAsync" + } + ] + }, + { + "type": "reference", + "name": "DatasetCollectionClientAsync" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A callable that takes a storage ID and returns the resource client." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 814, + "kind": 32768, + "kindString": "Parameter", + "name": "get_resource_client_by_id", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "[str]" + }, + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreClientAsync" + }, + { + "type": "reference", + "name": "RequestQueueClientAsync" + } + ] + }, + { + "type": "reference", + "name": "DatasetClientAsync" + } + ] + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 772, - "module": "storage_clients._apify._models", - "name": "read_count", - "parsedDocstring": { - "text": "The number of request queue reads." - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 119 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage size in bytes." + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configuration object containing API credentials and settings.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 815, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" } - ] - }, - "flags": {}, - "groups": [], - "id": 773, - "module": "storage_clients._apify._models", - "name": "storage_bytes", - "parsedDocstring": { - "text": "Storage size in bytes." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 122 } ], "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ + "name": "KeyValueStoreClientAsync | RequestQueueClientAsync | DatasetClientAsync", + "type": "union", + "types": [ { - "kind": "text", - "text": "The number of request queue writes." + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreClientAsync" + }, + { + "type": "reference", + "name": "RequestQueueClientAsync" + } + ] + }, + { + "type": "reference", + "name": "DatasetClientAsync" } ] - }, - "flags": {}, - "groups": [], - "id": 774, - "module": "storage_clients._apify._models", - "name": "write_count", - "parsedDocstring": { - "text": "The number of request queue writes." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 125 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 770, - 771, - 769, - 772, - 773, - 774 - ], - "title": "Properties" - } - ], - "id": 768, - "module": "storage_clients._apify._models", - "name": "RequestQueueStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 110 } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { "kind": 128, @@ -28004,106 +29830,37 @@ "summary": [ { "kind": "text", - "text": "Additional statistics about the request queue." + "text": "" } ] }, "flags": {}, "groups": [], - "id": 776, - "module": "storage_clients._apify._models", - "name": "stats", + "id": 817, + "module": "storage_clients._apify._alias_resolving", + "name": "default_storage_key", "parsedDocstring": { - "text": "Additional statistics about the request queue." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 130 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 138 } ], "type": { - "name": "RequestQueueStats", + "name": "ClassVar", "type": "reference", - "target": "768" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 776 - ], - "title": "Properties" - } - ], - "id": 775, - "module": "storage_clients._apify._models", - "name": "ApifyRequestQueueMetadata", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 129 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 777, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 22 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { "kind": 2048, "kindString": "Method", @@ -28112,31 +29869,25 @@ "summary": [ { "kind": "text", - "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n" + "text": "" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 779, - "module": "storage_clients._apify._request_queue_shared_client", + "id": 818, + "module": "storage_clients._apify._alias_resolving", "name": "__init__", "parsedDocstring": { - "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n", - "args": { - "api_client": "The Apify API client for request queue operations.", - "metadata": "Initial metadata for the request queue.", - "cache_size": "Maximum number of requests to cache locally.", - "metadata_getter": "Async function to fetch current metadata from the API." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 40 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 140 } ], "type": { @@ -28145,132 +29896,68 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n" - } - ] - }, "flags": {}, - "id": 780, + "id": 819, "kind": 4096, "kindString": "Call signature", "modifiers": [], "name": "__init__", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API client for request queue operations." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": true + "keyword-only": false }, - "id": 781, + "id": 820, "kind": 32768, "kindString": "Parameter", - "name": "api_client", + "name": "storage_type", "type": { - "name": "RequestQueueClientAsync", - "type": "reference" - } - }, - { - "comment": { - "summary": [ + "name": "Literal", + "type": "reference", + "typeArguments": [ { - "kind": "text", - "text": "Initial metadata for the request queue." + "type": "literal", + "value": "Dataset" + }, + { + "type": "literal", + "value": "KeyValueStore" + }, + { + "type": "literal", + "value": "RequestQueue" } ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 782, - "kind": 32768, - "kindString": "Parameter", - "name": "metadata", - "type": { - "name": "RequestQueueMetadata", - "type": "reference" } }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of requests to cache locally." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": true + "keyword-only": false }, - "id": 783, + "id": 821, "kind": 32768, "kindString": "Parameter", - "name": "cache_size", + "name": "alias", "type": { - "name": "int", + "name": "str", "type": "reference" } }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Async function to fetch current metadata from the API." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": true + "keyword-only": false }, - "id": 784, + "id": 822, "kind": 32768, "kindString": "Parameter", - "name": "metadata_getter", + "name": "configuration", "type": { - "name": "Callable", + "name": "Configuration", "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "[]" - }, - { - "type": "reference", - "name": "Coroutine", - "typeArguments": [ - { - "type": "reference", - "name": "Any" - }, - { - "type": "reference", - "name": "Any" - }, - { - "type": "reference", - "name": "ApifyRequestQueueMetadata", - "target": "775" - } - ] - } - ] + "target": "328" } } ], @@ -28290,25 +29977,25 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Context manager to prevent race condition in alias creation." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 785, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "add_batch_of_requests", + "id": 823, + "module": "storage_clients._apify._alias_resolving", + "name": "__aenter__", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Context manager to prevent race condition in alias creation." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 82 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 150 } ], "type": { @@ -28321,58 +30008,23 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Context manager to prevent race condition in alias creation." } ] }, "flags": {}, - "id": 786, + "id": 824, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "add_batch_of_requests", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 787, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "Sequence", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request" - } - ] - } - }, - { - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 788, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool", - "type": "reference" - } - } - ], + "name": "__aenter__", + "parameters": [], "type": { - "name": "AddRequestsResponse", - "type": "reference" + "name": "AliasResolver", + "type": "reference", + "target": "816" } } ] @@ -28385,25 +30037,25 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 789, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "get_request", + "id": 825, + "module": "storage_clients._apify._alias_resolving", + "name": "__aexit__", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 166 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 156 } ], "type": { @@ -28412,51 +30064,98 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." - } - ] - }, "flags": {}, - "id": 790, + "id": 826, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "get_request", + "name": "__aexit__", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 791, + "id": 827, "kind": 32768, "kindString": "Parameter", - "name": "unique_key", + "name": "exc_type", "type": { - "name": "str", - "type": "reference" + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 828, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_value", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 829, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_traceback", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null } } ] @@ -28469,25 +30168,26 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Get id of the aliased storage.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 792, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "fetch_next_request", + "id": 830, + "module": "storage_clients._apify._alias_resolving", + "name": "resolve_id", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Get id of the aliased storage.\n", + "returns": "Storage id if it exists, None otherwise." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 170 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 197 } ], "type": { @@ -28497,29 +30197,40 @@ "signatures": [ { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Storage id if it exists, None otherwise." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Get id of the aliased storage.\n" } ] }, "flags": {}, - "id": 793, + "id": 831, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "fetch_next_request", + "name": "resolve_id", "parameters": [], "type": { - "name": "Request | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "Request" + "name": "str" }, { "type": "literal", @@ -28538,25 +30249,25 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 794, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "mark_request_as_handled", + "id": 832, + "module": "storage_clients._apify._alias_resolving", + "name": "store_mapping", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 212 + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 217 } ], "type": { @@ -28569,140 +30280,244 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Add alias and related storage id to the mapping in default kvs and local in-memory mapping." } ] }, "flags": {}, - "id": 795, + "id": 833, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "mark_request_as_handled", + "name": "store_mapping", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 796, + "id": 834, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "storage_id", "type": { - "name": "Request", + "name": "str", "type": "reference" } } ], "type": { - "name": "ProcessedRequest | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProcessedRequest" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null } } ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Class for handling aliases.\n\nThe purpose of this is class is to ensure that alias storages are created with correct id. This is achieved by using\ndefault kvs as a storage for global mapping of aliases to storage ids. Same mapping is also kept in memory to avoid\nunnecessary calls to API and also have limited support of alias storages when not running on Apify platform. When on\nApify platform, the storages created with alias are accessible by the same alias even after migration or reboot." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 823, + 825, + 818, + 830, + 832 + ], + "title": "Methods" }, { - "kind": 2048, - "kindString": "Method", - "children": [], + "children": [ + 817 + ], + "title": "Properties" + } + ], + "id": 816, + "module": "storage_clients._apify._alias_resolving", + "name": "AliasResolver", + "parsedDocstring": { + "text": "Class for handling aliases.\n\nThe purpose of this is class is to ensure that alias storages are created with correct id. This is achieved by using\ndefault kvs as a storage for global mapping of aliases to storage ids. Same mapping is also kept in memory to avoid\nunnecessary calls to API and also have limited support of alias storages when not running on Apify platform. When on\nApify platform, the storages created with alias are accessible by the same alias even after migration or reboot." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_alias_resolving.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 114 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 835, + "module": "storage_clients._apify._api_client_creation", + "name": "create_storage_api_client", + "parsedDocstring": { + "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n", + "args": { + "storage_type": "The type of storage to open.", + "configuration": "Configuration object containing API credentials.", + "id": "Storage ID to open. Mutually exclusive with name and alias.", + "name": "Storage name (global scope, persists across runs). Mutually exclusive with id and alias.", + "alias": "Storage alias (run scope, creates unnamed storage). Mutually exclusive with id and name.\n" + }, + "returns": "The storage client for the opened or created storage." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_api_client_creation.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The storage client for the opened or created storage." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n" } ] }, - "decorations": [], "flags": {}, - "groups": [], - "id": 797, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "reclaim_request", - "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 244 - } + "id": 836, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "name": "create_storage_api_client", + "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "The type of storage to open." } ] }, - "flags": {}, - "id": 798, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "reclaim_request", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 837, + "kind": 32768, + "kindString": "Parameter", + "name": "storage_type", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Dataset" }, - "id": 799, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "Request", - "type": "reference" - } - }, - { - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true + { + "type": "literal", + "value": "KeyValueStore" }, - "id": 800, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool", - "type": "reference" + { + "type": "literal", + "value": "RequestQueue" } - } - ], + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configuration object containing API credentials." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 838, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", "type": { - "name": "ProcessedRequest | None", + "name": "Configuration", + "type": "reference", + "target": "328" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage ID to open. Mutually exclusive with name and alias." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 839, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "ProcessedRequest" + "name": "str" }, { "type": "literal", @@ -28710,110 +30525,99 @@ } ] } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 801, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "is_empty", - "parsedDocstring": { - "text": "Specific implementation of this method for the RQ shared access mode." - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 288 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage name (global scope, persists across runs). Mutually exclusive with id and alias." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 840, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, { "comment": { "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ shared access mode." + "text": "Storage alias (run scope, creates unnamed storage). Mutually exclusive with id and name.\n" } ] }, - "flags": {}, - "id": 802, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "is_empty", - "parameters": [], + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 841, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", "type": { - "name": "bool", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internal request queue client implementation for multi-consumer scenarios on the Apify platform.\n\nThis implementation is optimized for scenarios where multiple clients concurrently fetch and process requests\nfrom the same queue. It makes more frequent API calls to ensure consistency across all consumers and uses\nrequest locking to prevent duplicate processing.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='shared'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 779, - 785, - 792, - 789, - 801, - 794, - 797 ], - "title": "Methods" - } - ], - "id": 778, - "module": "storage_clients._apify._request_queue_shared_client", - "name": "ApifyRequestQueueSharedClient", - "parsedDocstring": { - "text": "Internal request queue client implementation for multi-consumer scenarios on the Apify platform.\n\nThis implementation is optimized for scenarios where multiple clients concurrently fetch and process requests\nfrom the same queue. It makes more frequent API calls to ensure consistency across all consumers and uses\nrequest locking to prevent duplicate processing.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='shared'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "type": { + "name": "KeyValueStoreClientAsync | RequestQueueClientAsync | DatasetClientAsync", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreClientAsync" + }, + { + "type": "reference", + "name": "RequestQueueClientAsync" + } + ] + }, + { + "type": "reference", + "name": "DatasetClientAsync" + } + ] + } } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { "kind": 1024, @@ -28829,7 +30633,7 @@ }, "flags": {}, "groups": [], - "id": 803, + "id": 842, "module": "storage_clients._apify._dataset_client", "name": "logger", "parsedDocstring": { @@ -28839,7 +30643,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26 } ], @@ -28867,7 +30671,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 805, + "id": 844, "module": "storage_clients._apify._dataset_client", "name": "__init__", "parsedDocstring": { @@ -28877,7 +30681,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -28896,7 +30700,7 @@ ] }, "flags": {}, - "id": 806, + "id": 845, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -28907,7 +30711,7 @@ "isOptional": false, "keyword-only": true }, - "id": 807, + "id": 846, "kind": 32768, "kindString": "Parameter", "name": "api_client", @@ -28921,7 +30725,7 @@ "isOptional": false, "keyword-only": true }, - "id": 808, + "id": 847, "kind": 32768, "kindString": "Parameter", "name": "api_public_base_url", @@ -28935,7 +30739,7 @@ "isOptional": false, "keyword-only": true }, - "id": 809, + "id": 848, "kind": 32768, "kindString": "Parameter", "name": "lock", @@ -28952,14 +30756,14 @@ }, "overwrites": { "name": "DatasetClientPpeMixin.__init__", - "target": 623, + "target": 1137, "type": "reference" } } ], "overwrites": { "name": "DatasetClientPpeMixin.__init__", - "target": 623, + "target": 1137, "type": "reference" } }, @@ -28982,7 +30786,7 @@ ], "flags": {}, "groups": [], - "id": 810, + "id": 849, "module": "storage_clients._apify._dataset_client", "name": "get_metadata", "parsedDocstring": { @@ -28992,7 +30796,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 70 } ], @@ -29003,7 +30807,7 @@ "signatures": [ { "flags": {}, - "id": 811, + "id": 850, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29037,7 +30841,7 @@ ], "flags": {}, "groups": [], - "id": 812, + "id": 851, "module": "storage_clients._apify._dataset_client", "name": "open", "parsedDocstring": { @@ -29054,7 +30858,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 75 } ], @@ -29084,7 +30888,7 @@ ] }, "flags": {}, - "id": 813, + "id": 852, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29105,7 +30909,7 @@ "isOptional": false, "keyword-only": true }, - "id": 814, + "id": 853, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -29137,7 +30941,7 @@ "isOptional": false, "keyword-only": true }, - "id": 815, + "id": 854, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -29169,7 +30973,7 @@ "isOptional": false, "keyword-only": true }, - "id": 816, + "id": 855, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -29201,21 +31005,21 @@ "isOptional": false, "keyword-only": true }, - "id": 817, + "id": 856, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "319" + "target": "328" } } ], "type": { "name": "ApifyDatasetClient", "type": "reference", - "target": "804" + "target": "843" } } ] @@ -29239,7 +31043,7 @@ ], "flags": {}, "groups": [], - "id": 818, + "id": 857, "module": "storage_clients._apify._dataset_client", "name": "purge", "parsedDocstring": { @@ -29249,7 +31053,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 128 } ], @@ -29260,7 +31064,7 @@ "signatures": [ { "flags": {}, - "id": 819, + "id": 858, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29295,7 +31099,7 @@ ], "flags": {}, "groups": [], - "id": 820, + "id": 859, "module": "storage_clients._apify._dataset_client", "name": "drop", "parsedDocstring": { @@ -29305,7 +31109,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 135 } ], @@ -29316,7 +31120,7 @@ "signatures": [ { "flags": {}, - "id": 821, + "id": 860, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29351,7 +31155,7 @@ ], "flags": {}, "groups": [], - "id": 822, + "id": 861, "module": "storage_clients._apify._dataset_client", "name": "push_data", "parsedDocstring": { @@ -29361,7 +31165,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 140 } ], @@ -29372,7 +31176,7 @@ "signatures": [ { "flags": {}, - "id": 823, + "id": 862, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29385,27 +31189,37 @@ "isOptional": false, "keyword-only": false }, - "id": 824, + "id": 863, "kind": 32768, "kindString": "Parameter", "name": "data", "type": { - "name": "list[Any] | dict[str, Any]", + "name": "Sequence[Mapping[str, JsonSerializable]] | Mapping[str, JsonSerializable]", "type": "union", "types": [ { "type": "reference", - "name": "list", + "name": "Sequence", "typeArguments": [ { "type": "reference", - "name": "Any" + "name": "Mapping", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "JsonSerializable" + } + ] } ] }, { "type": "reference", - "name": "dict", + "name": "Mapping", "typeArguments": [ { "type": "reference", @@ -29413,7 +31227,7 @@ }, { "type": "reference", - "name": "Any" + "name": "JsonSerializable" } ] } @@ -29448,7 +31262,7 @@ ], "flags": {}, "groups": [], - "id": 825, + "id": 864, "module": "storage_clients._apify._dataset_client", "name": "get_data", "parsedDocstring": { @@ -29458,7 +31272,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 156 } ], @@ -29469,7 +31283,7 @@ "signatures": [ { "flags": {}, - "id": 826, + "id": 865, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29483,7 +31297,7 @@ "isOptional": true, "keyword-only": true }, - "id": 827, + "id": 866, "kind": 32768, "kindString": "Parameter", "name": "offset", @@ -29498,7 +31312,7 @@ "isOptional": true, "keyword-only": true }, - "id": 828, + "id": 867, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -29523,7 +31337,7 @@ "isOptional": true, "keyword-only": true }, - "id": 829, + "id": 868, "kind": 32768, "kindString": "Parameter", "name": "clean", @@ -29538,7 +31352,7 @@ "isOptional": true, "keyword-only": true }, - "id": 830, + "id": 869, "kind": 32768, "kindString": "Parameter", "name": "desc", @@ -29553,7 +31367,7 @@ "isOptional": true, "keyword-only": true }, - "id": 831, + "id": 870, "kind": 32768, "kindString": "Parameter", "name": "fields", @@ -29584,7 +31398,7 @@ "isOptional": true, "keyword-only": true }, - "id": 832, + "id": 871, "kind": 32768, "kindString": "Parameter", "name": "omit", @@ -29615,7 +31429,7 @@ "isOptional": true, "keyword-only": true }, - "id": 833, + "id": 872, "kind": 32768, "kindString": "Parameter", "name": "unwind", @@ -29646,7 +31460,7 @@ "isOptional": true, "keyword-only": true }, - "id": 834, + "id": 873, "kind": 32768, "kindString": "Parameter", "name": "skip_empty", @@ -29661,7 +31475,7 @@ "isOptional": true, "keyword-only": true }, - "id": 835, + "id": 874, "kind": 32768, "kindString": "Parameter", "name": "skip_hidden", @@ -29676,7 +31490,7 @@ "isOptional": true, "keyword-only": true }, - "id": 836, + "id": 875, "kind": 32768, "kindString": "Parameter", "name": "flatten", @@ -29707,7 +31521,7 @@ "isOptional": true, "keyword-only": true }, - "id": 837, + "id": 876, "kind": 32768, "kindString": "Parameter", "name": "view", @@ -29753,7 +31567,7 @@ ], "flags": {}, "groups": [], - "id": 838, + "id": 877, "module": "storage_clients._apify._dataset_client", "name": "iterate_items", "parsedDocstring": { @@ -29763,7 +31577,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 187 } ], @@ -29774,7 +31588,7 @@ "signatures": [ { "flags": {}, - "id": 839, + "id": 878, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -29788,7 +31602,7 @@ "isOptional": true, "keyword-only": true }, - "id": 840, + "id": 879, "kind": 32768, "kindString": "Parameter", "name": "offset", @@ -29803,7 +31617,7 @@ "isOptional": true, "keyword-only": true }, - "id": 841, + "id": 880, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -29828,7 +31642,7 @@ "isOptional": true, "keyword-only": true }, - "id": 842, + "id": 881, "kind": 32768, "kindString": "Parameter", "name": "clean", @@ -29843,7 +31657,7 @@ "isOptional": true, "keyword-only": true }, - "id": 843, + "id": 882, "kind": 32768, "kindString": "Parameter", "name": "desc", @@ -29858,7 +31672,7 @@ "isOptional": true, "keyword-only": true }, - "id": 844, + "id": 883, "kind": 32768, "kindString": "Parameter", "name": "fields", @@ -29889,7 +31703,7 @@ "isOptional": true, "keyword-only": true }, - "id": 845, + "id": 884, "kind": 32768, "kindString": "Parameter", "name": "omit", @@ -29920,7 +31734,7 @@ "isOptional": true, "keyword-only": true }, - "id": 846, + "id": 885, "kind": 32768, "kindString": "Parameter", "name": "unwind", @@ -29951,7 +31765,7 @@ "isOptional": true, "keyword-only": true }, - "id": 847, + "id": 886, "kind": 32768, "kindString": "Parameter", "name": "skip_empty", @@ -29966,7 +31780,7 @@ "isOptional": true, "keyword-only": true }, - "id": 848, + "id": 887, "kind": 32768, "kindString": "Parameter", "name": "skip_hidden", @@ -30002,19 +31816,19 @@ "groups": [ { "children": [ - 805, - 820, - 825, - 810, - 838, - 812, - 818, - 822 + 844, + 859, + 864, + 849, + 877, + 851, + 857, + 861 ], "title": "Methods" } ], - "id": 804, + "id": 843, "module": "storage_clients._apify._dataset_client", "name": "ApifyDatasetClient", "parsedDocstring": { @@ -30024,7 +31838,7 @@ { "character": 1, "fileName": "/src/apify/storage_clients/_apify/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -30035,304 +31849,205 @@ "extendedTypes": [ { "name": "DatasetClientPpeMixin", - "target": "622", + "target": "1136", "type": "reference" } ] }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 849, - "module": "storage_clients._apify._api_client_creation", - "name": "create_storage_api_client", + "id": 888, + "module": "storage_clients._apify._key_value_store_client", + "name": "logger", "parsedDocstring": { - "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n", - "args": { - "storage_type": "The type of storage to open.", - "configuration": "Configuration object containing API credentials.", - "id": "Storage ID to open. Mutually exclusive with name and alias.", - "name": "Storage name (global scope, persists across runs). Mutually exclusive with id and alias.", - "alias": "Storage alias (run scope, creates unnamed storage). Mutually exclusive with id and name.\n" - }, - "returns": "The storage client for the opened or created storage." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_api_client_creation.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 49 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 2048, + "kindString": "Method", + "children": [], "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The storage client for the opened or created storage." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Get an Apify API client for a specific storage type.\n\nThis function handles the creation and initialization of Apify storage clients (KVS, RQ, or Dataset).\nIt manages authentication, storage lookup/creation, and client instantiation.\n" + "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." } ] }, + "decorations": [], "flags": {}, - "id": 850, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" + "groups": [], + "id": 890, + "module": "storage_clients._apify._key_value_store_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 + } ], - "name": "create_storage_api_client", - "parameters": [ + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ { "comment": { "summary": [ { "kind": "text", - "text": "The type of storage to open." + "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." } ] }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 851, - "kind": 32768, - "kindString": "Parameter", - "name": "storage_type", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "Dataset" - }, - { - "type": "literal", - "value": "KeyValueStore" + "flags": {}, + "id": 891, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true }, - { - "type": "literal", - "value": "RequestQueue" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration object containing API credentials." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 852, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage ID to open. Mutually exclusive with name and alias." + "id": 892, + "kind": 32768, + "kindString": "Parameter", + "name": "api_client", + "type": { + "name": "KeyValueStoreClientAsync", + "type": "reference" } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 853, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + }, + { + "flags": { + "isOptional": false, + "keyword-only": true }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage name (global scope, persists across runs). Mutually exclusive with id and alias." + "id": 893, + "kind": 32768, + "kindString": "Parameter", + "name": "api_public_base_url", + "type": { + "name": "str", + "type": "reference" } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 854, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + }, + { + "flags": { + "isOptional": false, + "keyword-only": true }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage alias (run scope, creates unnamed storage). Mutually exclusive with id and name.\n" + "id": 894, + "kind": 32768, + "kindString": "Parameter", + "name": "lock", + "type": { + "name": "asyncio.Lock", + "type": "reference" } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 855, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", + } + ], "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null } } - ], - "type": { - "name": "KeyValueStoreClientAsync | RequestQueueClientAsync | DatasetClientAsync", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreClientAsync" - }, - { - "type": "reference", - "name": "RequestQueueClientAsync" - } - ] - }, + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 895, + "module": "storage_clients._apify._key_value_store_client", + "name": "get_metadata", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 896, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_metadata", + "parameters": [], + "type": { + "name": "ApifyKeyValueStoreMetadata", "type": "reference", - "name": "DatasetClientAsync" + "target": "928" } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 856, - "module": "storage_clients._apify._request_queue_single_client", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + } + ] + }, { "kind": 2048, "kindString": "Method", @@ -30341,30 +32056,36 @@ "summary": [ { "kind": "text", - "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n" + "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n" } ] }, - "decorations": [], + "decorations": [ + { + "name": "classmethod" + } + ], "flags": {}, "groups": [], - "id": 858, - "module": "storage_clients._apify._request_queue_single_client", - "name": "__init__", + "id": 897, + "module": "storage_clients._apify._key_value_store_client", + "name": "open", "parsedDocstring": { - "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n", + "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n", "args": { - "api_client": "The Apify API client for request queue operations.", - "metadata": "Initial metadata for the request queue.", - "cache_size": "Maximum number of requests to cache locally." - } + "id": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias.", + "name": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias.", + "alias": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", + "configuration": "The configuration object containing API credentials and settings. Must include a valid\n`token` and `api_base_url`. May also contain a `default_key_value_store_id` for fallback when\nneither `id`, `name`, nor `alias` is provided.\n" + }, + "returns": "An instance for the opened or created storage client." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 60 } ], "type": { @@ -30374,26 +32095,39 @@ "signatures": [ { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "An instance for the opened or created storage client." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n" + "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n" } ] }, "flags": {}, - "id": 859, + "id": 898, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "modifiers": [ + "async" + ], + "name": "open", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "The Apify API client for request queue operations." + "text": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias." } ] }, @@ -30401,13 +32135,23 @@ "isOptional": false, "keyword-only": true }, - "id": 860, + "id": 899, "kind": 32768, "kindString": "Parameter", - "name": "api_client", + "name": "id", "type": { - "name": "RequestQueueClientAsync", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -30415,7 +32159,7 @@ "summary": [ { "kind": "text", - "text": "Initial metadata for the request queue." + "text": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias." } ] }, @@ -30423,13 +32167,23 @@ "isOptional": false, "keyword-only": true }, - "id": 861, + "id": 900, "kind": 32768, "kindString": "Parameter", - "name": "metadata", + "name": "name", "type": { - "name": "RequestQueueMetadata", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { @@ -30437,7 +32191,7 @@ "summary": [ { "kind": "text", - "text": "Maximum number of requests to cache locally." + "text": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." } ] }, @@ -30445,16 +32199,105 @@ "isOptional": false, "keyword-only": true }, - "id": 862, + "id": 901, "kind": 32768, "kindString": "Parameter", - "name": "cache_size", + "name": "alias", "type": { - "name": "int", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The configuration object containing API credentials and settings. Must include a valid\n`token` and `api_base_url`. May also contain a `default_key_value_store_id` for fallback when\nneither `id`, `name`, nor `alias` is provided.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 902, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" } } ], + "type": { + "name": "ApifyKeyValueStoreClient", + "type": "reference", + "target": "889" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 903, + "module": "storage_clients._apify._key_value_store_client", + "name": "purge", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 904, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "purge", + "parameters": [], "type": { "name": "None", "type": "literal", @@ -30471,25 +32314,29 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 863, - "module": "storage_clients._apify._request_queue_single_client", - "name": "add_batch_of_requests", + "id": 905, + "module": "storage_clients._apify._key_value_store_client", + "name": "drop", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 98 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 } ], "type": { @@ -30498,62 +32345,99 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." - } - ] - }, "flags": {}, - "id": 864, + "id": 906, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "add_batch_of_requests", + "name": "drop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 907, + "module": "storage_clients._apify._key_value_store_client", + "name": "get_value", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 908, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_value", "parameters": [ { "flags": { "isOptional": false, - "keyword-only": false - }, - "id": 865, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "Sequence", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request" - } - ] - } - }, - { - "defaultValue": "False", - "flags": { - "isOptional": true, "keyword-only": true }, - "id": 866, + "id": 909, "kind": 32768, "kindString": "Parameter", - "name": "forefront", + "name": "key", "type": { - "name": "bool", + "name": "str", "type": "reference" } } ], "type": { - "name": "AddRequestsResponse", - "type": "reference" + "name": "KeyValueStoreRecord | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreRecord" + }, + { + "type": "literal", + "value": null + } + ] } } ] @@ -30566,25 +32450,29 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 867, - "module": "storage_clients._apify._request_queue_single_client", - "name": "get_request", + "id": 910, + "module": "storage_clients._apify._key_value_store_client", + "name": "set_value", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 183 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 123 } ], "type": { @@ -30593,51 +32481,73 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." - } - ] - }, "flags": {}, - "id": 868, + "id": 911, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "get_request", + "name": "set_value", "parameters": [ { "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 869, + "id": 912, "kind": 32768, "kindString": "Parameter", - "name": "unique_key", + "name": "key", "type": { "name": "str", "type": "reference" } + }, + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 913, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 914, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } } ], "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" - }, - { - "type": "literal", - "value": null - } - ] + "name": "None", + "type": "literal", + "value": null } } ] @@ -30650,25 +32560,29 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 870, - "module": "storage_clients._apify._request_queue_single_client", - "name": "fetch_next_request", + "id": 915, + "module": "storage_clients._apify._key_value_store_client", + "name": "delete_value", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 187 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 132 } ], "type": { @@ -30677,36 +32591,34 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." - } - ] - }, "flags": {}, - "id": 871, + "id": 916, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "fetch_next_request", - "parameters": [], - "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" + "name": "delete_value", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true }, - { - "type": "literal", - "value": null + "id": 917, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" } - ] + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } } ] @@ -30719,25 +32631,29 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 872, - "module": "storage_clients._apify._request_queue_single_client", - "name": "mark_request_as_handled", + "id": 918, + "module": "storage_clients._apify._key_value_store_client", + "name": "iterate_keys", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 206 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 137 } ], "type": { @@ -30746,49 +32662,73 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." - } - ] - }, "flags": {}, - "id": 873, + "id": 919, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "mark_request_as_handled", + "name": "iterate_keys", "parameters": [ { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 874, + "id": 920, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "exclusive_start_key", "type": { - "name": "Request", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 921, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "ProcessedRequest | None", - "type": "union", - "types": [ + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ { "type": "reference", - "name": "ProcessedRequest" - }, - { - "type": "literal", - "value": null + "name": "KeyValueStoreRecordMetadata" } ] } @@ -30803,25 +32743,29 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 875, - "module": "storage_clients._apify._request_queue_single_client", - "name": "reclaim_request", + "id": 922, + "module": "storage_clients._apify._key_value_store_client", + "name": "record_exists", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 236 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 170 } ], "type": { @@ -30830,66 +32774,33 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." - } - ] - }, "flags": {}, - "id": 876, + "id": 923, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "reclaim_request", + "name": "record_exists", "parameters": [ { "flags": { "isOptional": false, - "keyword-only": false - }, - "id": 877, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "Request", - "type": "reference" - } - }, - { - "defaultValue": "False", - "flags": { - "isOptional": true, "keyword-only": true }, - "id": 878, + "id": 924, "kind": 32768, "kindString": "Parameter", - "name": "forefront", + "name": "key", "type": { - "name": "bool", + "name": "str", "type": "reference" } } ], "type": { - "name": "ProcessedRequest | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ProcessedRequest" - }, - { - "type": "literal", - "value": null - } - ] + "name": "bool", + "type": "reference" } } ] @@ -30902,25 +32813,33 @@ "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 879, - "module": "storage_clients._apify._request_queue_single_client", - "name": "is_empty", + "id": 925, + "module": "storage_clients._apify._key_value_store_client", + "name": "get_public_url", "parsedDocstring": { - "text": "Specific implementation of this method for the RQ single access mode." + "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n", + "args": { + "key": "The key for which the URL should be generated.\n" + }, + "returns": "A public URL that can be used to access the value of the given key in the KVS." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 279 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 174 } ], "type": { @@ -30930,24 +32849,58 @@ "signatures": [ { "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A public URL that can be used to access the value of the given key in the KVS." + } + ], + "tag": "@returns" + } + ], "summary": [ { "kind": "text", - "text": "Specific implementation of this method for the RQ single access mode." + "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n" } ] }, "flags": {}, - "id": 880, + "id": 926, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "is_empty", - "parameters": [], + "name": "get_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key for which the URL should be generated.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 927, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + } + ], "type": { - "name": "bool", + "name": "str", "type": "reference" } } @@ -30958,7 +32911,7 @@ "summary": [ { "kind": "text", - "text": "Internal request queue client implementation for single-consumer scenarios on the Apify platform.\n\nThis implementation minimizes API calls and resource usage by leveraging local caching and head estimation.\nIt is designed for scenarios where only one client consumes requests from the queue at a time, though multiple\nproducers may add requests concurrently.\n\n### Usage constraints\n\nThis client must operate within the following constraints to function correctly:\n\n- **Single consumer**: Only one client should be consuming (fetching) requests from the queue at any given time.\n- **Multiple producers allowed**: Multiple clients can add requests concurrently, but their forefront requests\nmay not be prioritized immediately since this client relies on local head estimation.\n- **Append-only queue**: Requests should only be added to the queue, never deleted by other clients.\nMarking requests as handled is permitted.\n- **No external modifications**: Other producers can add new requests but should not modify existing ones,\nas modifications won't be reflected in the local cache.\n\nIf these constraints are not met, the client may exhibit unpredictable behavior.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='single'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." + "text": "An Apify platform implementation of the key-value store client." } ] }, @@ -30966,29 +32919,33 @@ "groups": [ { "children": [ - 858, - 863, - 870, - 867, - 879, - 872, - 875 + 890, + 915, + 905, + 895, + 925, + 907, + 918, + 897, + 903, + 922, + 910 ], "title": "Methods" } ], - "id": 857, - "module": "storage_clients._apify._request_queue_single_client", - "name": "ApifyRequestQueueSingleClient", + "id": 889, + "module": "storage_clients._apify._key_value_store_client", + "name": "ApifyKeyValueStoreClient", "parsedDocstring": { - "text": "Internal request queue client implementation for single-consumer scenarios on the Apify platform.\n\nThis implementation minimizes API calls and resource usage by leveraging local caching and head estimation.\nIt is designed for scenarios where only one client consumes requests from the queue at a time, though multiple\nproducers may add requests concurrently.\n\n### Usage constraints\n\nThis client must operate within the following constraints to function correctly:\n\n- **Single consumer**: Only one client should be consuming (fetching) requests from the queue at any given time.\n- **Multiple producers allowed**: Multiple clients can add requests concurrently, but their forefront requests\nmay not be prioritized immediately since this client relies on local head estimation.\n- **Append-only queue**: Requests should only be added to the queue, never deleted by other clients.\nMarking requests as handled is permitted.\n- **No external modifications**: Other producers can add new requests but should not modify existing ones,\nas modifications won't be reflected in the local cache.\n\nIf these constraints are not met, the client may exhibit unpredictable behavior.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='single'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." + "text": "An Apify platform implementation of the key-value store client." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { @@ -30997,223 +32954,202 @@ } }, { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a deterministic request ID based on a unique key.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 881, - "module": "storage_clients._apify._utils", - "name": "unique_key_to_request_id", - "parsedDocstring": { - "text": "Generate a deterministic request ID based on a unique key.\n", - "args": { - "unique_key": "The unique key to convert into a request ID.", - "request_id_length": "The length of the request ID.\n" - }, - "returns": "A URL-safe, truncated request ID based on the unique key." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A URL-safe, truncated request ID based on the unique key." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Generate a deterministic request ID based on a unique key.\n" + "text": "The secret key used for signing URLs for secure access to key-value store records." } ] }, "flags": {}, - "id": 882, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "unique_key_to_request_id", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique key to convert into a request ID." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 883, - "kind": 32768, - "kindString": "Parameter", - "name": "unique_key", - "type": { - "name": "str", - "type": "reference" - } - }, + "groups": [], + "id": 929, + "module": "storage_clients._apify._models", + "name": "url_signing_secret_key", + "parsedDocstring": { + "text": "The secret key used for signing URLs for secure access to key-value store records." + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the request ID.\n" - } - ] - }, - "defaultValue": "15", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 884, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id_length", - "type": { - "name": "int", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 21 } ], "type": { - "name": "str", - "type": "reference" + "name": "Annotated[str | None, Field(alias='urlSigningSecretKey', default=None)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], + ], "comment": { "summary": [ { "kind": "text", - "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." + "text": "Extended key-value store metadata model for Apify platform.\n\nIncludes additional Apify-specific fields." } ] }, - "decorations": [], + "decorations": [ + { + "args": "('Storage data')", + "name": "docs_group" + } + ], "flags": {}, - "groups": [], - "id": 885, - "module": "storage_clients._apify._utils", - "name": "hash_api_base_url_and_token", + "groups": [ + { + "children": [ + 929 + ], + "title": "Properties" + } + ], + "id": 928, + "module": "storage_clients._apify._models", + "name": "ApifyKeyValueStoreMetadata", "parsedDocstring": { - "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." + "text": "Extended key-value store metadata model for Apify platform.\n\nIncludes additional Apify-specific fields." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 15 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." + "text": "" } ] }, "flags": {}, - "id": 886, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "hash_api_base_url_and_token", - "parameters": [ + "groups": [], + "id": 931, + "module": "storage_clients._apify._models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 887, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" } + ] + }, + "flags": {}, + "groups": [], + "id": 932, + "module": "storage_clients._apify._models", + "name": "lock_expires_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 } ], "type": { - "name": "str", + "name": "datetime", "type": "reference" } } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Response to prolong request lock calls." } ] }, - "flags": {}, - "groups": [], - "id": 888, - "module": "storage_clients._apify._key_value_store_client", - "name": "logger", + "decorations": [ + { + "args": "('Storage data')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 932, + 931 + ], + "title": "Properties" + } + ], + "id": 930, + "module": "storage_clients._apify._models", + "name": "ProlongRequestLockResponse", "parsedDocstring": { - "text": "" + "text": "Response to prolong request lock calls." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { @@ -31226,109 +33162,8 @@ "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 890, - "module": "storage_clients._apify._key_value_store_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n\nPreferably use the `ApifyKeyValueStoreClient.open` class method to create a new instance." - } - ] - }, - "flags": {}, - "id": 891, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 892, - "kind": 32768, - "kindString": "Parameter", - "name": "api_client", - "type": { - "name": "KeyValueStoreClientAsync", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 893, - "kind": 32768, - "kindString": "Parameter", - "name": "api_public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 894, - "kind": 32768, - "kindString": "Parameter", - "name": "lock", - "type": { - "name": "asyncio.Lock", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -31338,628 +33173,317 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 895, - "module": "storage_clients._apify._key_value_store_client", - "name": "get_metadata", + "id": 934, + "module": "storage_clients._apify._models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 42 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 896, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_metadata", - "parameters": [], - "type": { - "name": "ApifyKeyValueStoreMetadata", - "type": "reference", - "target": "738" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n" + "text": "The maximum number of requests that were requested from the queue." } ] }, - "decorations": [ - { - "name": "classmethod" - } - ], "flags": {}, "groups": [], - "id": 897, - "module": "storage_clients._apify._key_value_store_client", - "name": "open", + "id": 935, + "module": "storage_clients._apify._models", + "name": "limit", "parsedDocstring": { - "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n", - "args": { - "id": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias.", - "name": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias.", - "alias": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name.", - "configuration": "The configuration object containing API credentials and settings. Must include a valid\n`token` and `api_base_url`. May also contain a `default_key_value_store_id` for fallback when\nneither `id`, `name`, nor `alias` is provided.\n" - }, - "returns": "An instance for the opened or created storage client." + "text": "The maximum number of requests that were requested from the queue." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 60 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 44 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "An instance for the opened or created storage client." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Open an Apify key-value store client.\n\nThis method creates and initializes a new instance of the Apify key-value store client.\nIt handles authentication, storage lookup/creation, and metadata retrieval.\n" - } - ] - }, - "flags": {}, - "id": 898, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "open", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the KVS to open. If provided, searches for existing KVS by ID.\nMutually exclusive with name and alias." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 899, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the KVS to open (global scope, persists across runs).\nMutually exclusive with id and alias." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 900, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The alias of the KVS to open (run scope, creates unnamed storage).\nMutually exclusive with id and name." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 901, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The configuration object containing API credentials and settings. Must include a valid\n`token` and `api_base_url`. May also contain a `default_key_value_store_id` for fallback when\nneither `id`, `name`, nor `alias` is provided.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 902, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "Configuration", - "type": "reference", - "target": "319" - } - } - ], - "type": { - "name": "ApifyKeyValueStoreClient", + "name": "Annotated[int | None, Field(alias='limit', default=None)]", + "type": "union", + "types": [ + { "type": "reference", - "target": "889" + "name": "int" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Indicates whether the queue has been accessed by multiple clients (consumers)." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 903, - "module": "storage_clients._apify._key_value_store_client", - "name": "purge", + "id": 936, + "module": "storage_clients._apify._models", + "name": "had_multiple_clients", "parsedDocstring": { - "text": "" + "text": "Indicates whether the queue has been accessed by multiple clients (consumers)." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 47 } ], "type": { - "name": "Undefined", + "name": "bool", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 904, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "purge", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The timestamp when the queue was last modified." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 905, - "module": "storage_clients._apify._key_value_store_client", - "name": "drop", + "id": 937, + "module": "storage_clients._apify._models", + "name": "queue_modified_at", "parsedDocstring": { - "text": "" + "text": "The timestamp when the queue was last modified." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 113 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 50 } ], "type": { - "name": "Undefined", + "name": "datetime", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 906, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "drop", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The duration for which the returned requests are locked and cannot be processed by other clients." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 907, - "module": "storage_clients._apify._key_value_store_client", - "name": "get_value", + "id": 938, + "module": "storage_clients._apify._models", + "name": "lock_time", "parsedDocstring": { - "text": "" + "text": "The duration for which the returned requests are locked and cannot be processed by other clients." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 118 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 53 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 908, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_value", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 909, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "KeyValueStoreRecord | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreRecord" - }, - { - "type": "literal", - "value": null - } - ] + "name": "Annotated[timedelta | None, Field(alias='lockSecs', default=None)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Indicates whether the queue contains any locked requests." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 910, - "module": "storage_clients._apify._key_value_store_client", - "name": "set_value", + "id": 939, + "module": "storage_clients._apify._models", + "name": "queue_has_locked_requests", "parsedDocstring": { - "text": "" + "text": "Indicates whether the queue contains any locked requests." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 123 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 56 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 911, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "set_value", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 912, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 913, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 914, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", + "name": "Annotated[bool | None, Field(alias='queueHasLockedRequests', default=False)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { "type": "literal", "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The list of request objects retrieved from the beginning of the queue." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 915, - "module": "storage_clients._apify._key_value_store_client", - "name": "delete_value", + "id": 940, + "module": "storage_clients._apify._models", + "name": "items", "parsedDocstring": { - "text": "" + "text": "The list of request objects retrieved from the beginning of the queue." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 132 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 59 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 916, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete_value", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 917, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request" } - } - ] - }, + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Model for request queue head.\n\nRepresents a collection of requests retrieved from the beginning of a queue,\nincluding metadata about the queue's state and lock information for the requests." + } + ] + }, + "decorations": [ { - "kind": 2048, - "kindString": "Method", + "args": "('Storage data')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 936, + 940, + 935, + 938, + 934, + 939, + 937 + ], + "title": "Properties" + } + ], + "id": 933, + "module": "storage_clients._apify._models", + "name": "RequestQueueHead", + "parsedDocstring": { + "text": "Model for request queue head.\n\nRepresents a collection of requests retrieved from the beginning of a queue,\nincluding metadata about the queue's state and lock information for the requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -31969,109 +33493,30 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 918, - "module": "storage_clients._apify._key_value_store_client", - "name": "iterate_keys", + "id": 942, + "module": "storage_clients._apify._models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 137 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 69 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 919, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "iterate_keys", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 920, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 921, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreRecordMetadata" - } - ] - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -32081,171 +33526,66 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 922, - "module": "storage_clients._apify._key_value_store_client", - "name": "record_exists", + "id": 943, + "module": "storage_clients._apify._models", + "name": "key", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 170 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 71 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 923, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "record_exists", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 924, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n" + "text": "" } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 925, - "module": "storage_clients._apify._key_value_store_client", - "name": "get_public_url", + "id": 944, + "module": "storage_clients._apify._models", + "name": "size", "parsedDocstring": { - "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n", - "args": { - "key": "The key for which the URL should be generated.\n" - }, - "returns": "A public URL that can be used to access the value of the given key in the KVS." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 174 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 72 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A public URL that can be used to access the value of the given key in the KVS." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get a URL for the given key that may be used to publicly access the value in the remote key-value store.\n" - } - ] - }, - "flags": {}, - "id": 926, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key for which the URL should be generated.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 927, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] + } } ], "comment": { "summary": [ { "kind": "text", - "text": "An Apify platform implementation of the key-value store client." + "text": "Model for a key-value store key info.\n\nOnly internal structure." } ] }, @@ -32253,33 +33593,25 @@ "groups": [ { "children": [ - 890, - 915, - 905, - 895, - 925, - 907, - 918, - 897, - 903, - 922, - 910 + 943, + 942, + 944 ], - "title": "Methods" + "title": "Properties" } ], - "id": 889, - "module": "storage_clients._apify._key_value_store_client", - "name": "ApifyKeyValueStoreClient", + "id": 941, + "module": "storage_clients._apify._models", + "name": "KeyValueStoreKeyInfo", "parsedDocstring": { - "text": "An Apify platform implementation of the key-value store client." + "text": "Model for a key-value store key info.\n\nOnly internal structure." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 63 } ], "type": { @@ -32292,103 +33624,74 @@ "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 946, + "module": "storage_clients._apify._models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n" + "text": "" } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 929, - "module": "storage_clients._apify._storage_client", - "name": "__init__", + "id": 947, + "module": "storage_clients._apify._models", + "name": "count", "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "request_queue_access": "Defines how the request queue client behaves. Use `single` mode for a single\nconsumer. It has fewer API calls, meaning better performance and lower costs. If you need multiple\nconcurrent consumers use `shared` mode, but expect worse performance and higher costs due to\nthe additional overhead." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 66 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 83 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "flags": {}, - "id": 930, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defines how the request queue client behaves. Use `single` mode for a single\nconsumer. It has fewer API calls, meaning better performance and lower costs. If you need multiple\nconcurrent consumers use `shared` mode, but expect worse performance and higher costs due to\nthe additional overhead." - } - ] - }, - "defaultValue": "'single'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 931, - "kind": 32768, - "kindString": "Parameter", - "name": "request_queue_access", - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "single" - }, - { - "type": "literal", - "value": "shared" - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -32398,154 +33701,30 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 932, - "module": "storage_clients._apify._storage_client", - "name": "create_dataset_client", + "id": 948, + "module": "storage_clients._apify._models", + "name": "limit", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 933, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_dataset_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 934, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 935, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 936, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 937, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ApifyDatasetClient", - "type": "reference", - "target": "804" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -32555,154 +33734,30 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 938, - "module": "storage_clients._apify._storage_client", - "name": "create_kvs_client", + "id": 949, + "module": "storage_clients._apify._models", + "name": "is_truncated", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 93 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 85 } ], "type": { - "name": "Undefined", + "name": "bool", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 939, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_kvs_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 940, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 941, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 942, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 943, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ApifyKeyValueStoreClient", - "type": "reference", - "target": "889" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -32712,154 +33767,80 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 944, - "module": "storage_clients._apify._storage_client", - "name": "create_rq_client", + "id": 950, + "module": "storage_clients._apify._models", + "name": "items", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 108 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 86 } ], "type": { - "name": "Undefined", - "type": "reference" + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKeyInfo", + "target": "941" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] }, - "signatures": [ - { - "flags": {}, - "id": 945, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_rq_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 946, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 947, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 948, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 949, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ApifyRequestQueueClient", + "flags": {}, + "groups": [], + "id": 951, + "module": "storage_clients._apify._models", + "name": "exclusive_start_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 87 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='exclusiveStartKey', default=None)]", + "type": "union", + "types": [ + { "type": "reference", - "target": "674" + "name": "str" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -32869,102 +33850,73 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 950, - "module": "storage_clients._apify._storage_client", - "name": "get_storage_client_cache_key", + "id": 952, + "module": "storage_clients._apify._models", + "name": "next_exclusive_start_key", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 125 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 88 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 951, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_storage_client_cache_key", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 952, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration", - "type": "reference" - } - } - ], - "type": { - "name": "Hashable", - "type": "reference" + "name": "Annotated[str | None, Field(alias='nextExclusiveStartKey', default=None)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } } ], "comment": { "summary": [ { "kind": "text", - "text": "Apify platform implementation of the storage client.\n\nThis storage client provides access to datasets, key-value stores, and request queues that persist data\nto the Apify platform. Each storage type is implemented with its own specific Apify client that stores data\nin the cloud, making it accessible from anywhere.\n\nThe communication with the Apify platform is handled via the Apify API client for Python, which is an HTTP API\nwrapper. For maximum efficiency and performance of the storage clients, various caching mechanisms are used to\nminimize the number of API calls made to the Apify platform. Data can be inspected and manipulated through\nthe Apify console web interface or via the Apify API.\n\nThe request queue client supports two access modes controlled by the `request_queue_access` parameter:\n\n### Single mode\n\nThe `single` mode is optimized for scenarios with only one consumer. It minimizes API calls, making it faster\nand more cost-efficient compared to the `shared` mode. This option is ideal when a single Actor is responsible\nfor consuming the entire request queue. Using multiple consumers simultaneously may lead to inconsistencies\nor unexpected behavior.\n\nIn this mode, multiple producers can safely add new requests, but forefront requests may not be processed\nimmediately, as the client relies on local head estimation instead of frequent forefront fetching. Requests can\nalso be added or marked as handled by other clients, but they must not be deleted or modified, since such changes\nwould not be reflected in the local cache. If a request is already fully cached locally, marking it as handled\nby another client will be ignored by this client. This does not cause errors but can occasionally result in\nreprocessing a request that was already handled elsewhere. If the request was not yet cached locally, marking\nit as handled poses no issue.\n\n### Shared mode\n\nThe `shared` mode is designed for scenarios with multiple concurrent consumers. It ensures proper synchronization\nand consistency across clients, at the cost of higher API usage and slightly worse performance. This mode is safe\nfor concurrent access from multiple processes, including Actors running in parallel on the Apify platform. It\nshould be used when multiple consumers need to process requests from the same queue simultaneously." + "text": "Model for listing keys in the key-value store.\n\nOnly internal structure." } ] }, - "decorations": [ - { - "args": "('Storage clients')", - "name": "docs_group" - } - ], "flags": {}, "groups": [ { "children": [ - 929, - 932, - 938, - 944, - 950 + 947, + 951, + 949, + 950, + 948, + 946, + 952 ], - "title": "Methods" + "title": "Properties" } ], - "id": 928, - "module": "storage_clients._apify._storage_client", - "name": "ApifyStorageClient", + "id": 945, + "module": "storage_clients._apify._models", + "name": "KeyValueStoreListKeysPage", "parsedDocstring": { - "text": "Apify platform implementation of the storage client.\n\nThis storage client provides access to datasets, key-value stores, and request queues that persist data\nto the Apify platform. Each storage type is implemented with its own specific Apify client that stores data\nin the cloud, making it accessible from anywhere.\n\nThe communication with the Apify platform is handled via the Apify API client for Python, which is an HTTP API\nwrapper. For maximum efficiency and performance of the storage clients, various caching mechanisms are used to\nminimize the number of API calls made to the Apify platform. Data can be inspected and manipulated through\nthe Apify console web interface or via the Apify API.\n\nThe request queue client supports two access modes controlled by the `request_queue_access` parameter:\n\n### Single mode\n\nThe `single` mode is optimized for scenarios with only one consumer. It minimizes API calls, making it faster\nand more cost-efficient compared to the `shared` mode. This option is ideal when a single Actor is responsible\nfor consuming the entire request queue. Using multiple consumers simultaneously may lead to inconsistencies\nor unexpected behavior.\n\nIn this mode, multiple producers can safely add new requests, but forefront requests may not be processed\nimmediately, as the client relies on local head estimation instead of frequent forefront fetching. Requests can\nalso be added or marked as handled by other clients, but they must not be deleted or modified, since such changes\nwould not be reflected in the local cache. If a request is already fully cached locally, marking it as handled\nby another client will be ignored by this client. This does not cause errors but can occasionally result in\nreprocessing a request that was already handled elsewhere. If the request was not yet cached locally, marking\nit as handled poses no issue.\n\n### Shared mode\n\nThe `shared` mode is designed for scenarios with multiple concurrent consumers. It ensures proper synchronization\nand consistency across clients, at the cost of higher API usage and slightly worse performance. This mode is safe\nfor concurrent access from multiple processes, including Actors running in parallel on the Apify platform. It\nshould be used when multiple consumers need to process requests from the same queue simultaneously." + "text": "Model for listing keys in the key-value store.\n\nOnly internal structure." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 75 } ], "type": { @@ -32977,410 +33929,204 @@ "kindString": "Class", "children": [ { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n" + "text": "Id of the request." } ] }, - "decorations": [], "flags": {}, "groups": [], "id": 954, - "module": "storage_clients._smart_apify._storage_client", - "name": "__init__", + "module": "storage_clients._apify._models", + "name": "id", "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "cloud_storage_client": "Storage client used when an Actor is running on the Apify platform, or when\nexplicitly enabled via the `force_cloud` argument. Defaults to `ApifyStorageClient`.", - "local_storage_client": "Storage client used when an Actor is not running on the Apify platform and when\n`force_cloud` flag is not set. Defaults to `FileSystemStorageClient`." - } + "text": "Id of the request." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 35 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 97 } ], "type": { - "name": "Undefined", + "name": "str", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "flags": {}, - "id": 955, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage client used when an Actor is running on the Apify platform, or when\nexplicitly enabled via the `force_cloud` argument. Defaults to `ApifyStorageClient`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 956, - "kind": 32768, - "kindString": "Parameter", - "name": "cloud_storage_client", - "type": { - "name": "StorageClient | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageClient" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage client used when an Actor is not running on the Apify platform and when\n`force_cloud` flag is not set. Defaults to `FileSystemStorageClient`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 957, - "kind": 32768, - "kindString": "Parameter", - "name": "local_storage_client", - "type": { - "name": "StorageClient | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageClient" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Whether the request was already handled." } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 958, - "module": "storage_clients._smart_apify._storage_client", - "name": "__str__", + "id": 955, + "module": "storage_clients._apify._models", + "name": "was_already_handled", "parsedDocstring": { - "text": "" + "text": "Whether the request was already handled." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 100 } ], "type": { - "name": "Undefined", + "name": "bool", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 959, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__str__", - "parameters": [], - "type": { - "name": "str", - "type": "reference" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The hydrated request object (the original one)." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 960, - "module": "storage_clients._smart_apify._storage_client", - "name": "get_storage_client_cache_key", + "id": 956, + "module": "storage_clients._apify._models", + "name": "hydrated", "parsedDocstring": { - "text": "" + "text": "The hydrated request object (the original one)." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 961, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_storage_client_cache_key", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 962, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration", - "type": "reference" - } - } - ], - "type": { - "name": "Hashable", - "type": "reference" + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null } - } - ] + ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The expiration time of the lock on the request." } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 963, - "module": "storage_clients._smart_apify._storage_client", - "name": "create_dataset_client", + "id": 957, + "module": "storage_clients._apify._models", + "name": "lock_expires_at", "parsedDocstring": { - "text": "" + "text": "The expiration time of the lock on the request." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 68 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106 } ], "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 964, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_dataset_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 965, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 966, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 967, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 968, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "DatasetClient", - "type": "reference" + "name": "datetime | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "datetime" + }, + { + "type": "literal", + "value": null } - } - ] - }, + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pydantic model for cached request information.\n\nOnly internal structure." + } + ] + }, + "flags": {}, + "groups": [ { - "kind": 2048, - "kindString": "Method", + "children": [ + 956, + 954, + 957, + 955 + ], + "title": "Properties" + } + ], + "id": 953, + "module": "storage_clients._apify._models", + "name": "CachedRequest", + "parsedDocstring": { + "text": "Pydantic model for cached request information.\n\nOnly internal structure." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ @@ -33390,432 +34136,302 @@ } ] }, - "decorations": [ - { - "name": "override" - } - ], "flags": {}, "groups": [], - "id": 969, - "module": "storage_clients._smart_apify._storage_client", - "name": "create_kvs_client", + "id": 959, + "module": "storage_clients._apify._models", + "name": "model_config", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 81 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 111 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 970, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_kvs_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 971, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 972, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 973, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 974, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "KeyValueStoreClient", - "type": "reference" - } - } - ] + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "\"The number of request queue deletes." } ] }, - "decorations": [ + "flags": {}, + "groups": [], + "id": 960, + "module": "storage_clients._apify._models", + "name": "delete_count", + "parsedDocstring": { + "text": "\"The number of request queue deletes." + }, + "sources": [ { - "name": "override" + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 } ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of request queue head reads." + } + ] + }, "flags": {}, "groups": [], - "id": 975, - "module": "storage_clients._smart_apify._storage_client", - "name": "create_rq_client", + "id": 961, + "module": "storage_clients._apify._models", + "name": "head_item_read_count", "parsedDocstring": { - "text": "" + "text": "The number of request queue head reads." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 94 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 116 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of request queue reads." + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 962, + "module": "storage_clients._apify._models", + "name": "read_count", + "parsedDocstring": { + "text": "The number of request queue reads." + }, + "sources": [ { - "flags": {}, - "id": 976, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_rq_client", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 977, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 978, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 979, - "kind": 32768, - "kindString": "Parameter", - "name": "alias", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 980, - "kind": 32768, - "kindString": "Parameter", - "name": "configuration", - "type": { - "name": "CrawleeConfiguration | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "CrawleeConfiguration" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RequestQueueClient", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 119 } - ] + ], + "type": { + "name": "int", + "type": "reference" + } }, { - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n" + "text": "Storage size in bytes." } ] }, - "decorations": [], "flags": {}, "groups": [], - "id": 981, - "module": "storage_clients._smart_apify._storage_client", - "name": "get_suitable_storage_client", + "id": 963, + "module": "storage_clients._apify._models", + "name": "storage_bytes", "parsedDocstring": { - "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n", - "args": { - "force_cloud": "If True, return `cloud_storage_client`." - } + "text": "Storage size in bytes." }, "sources": [ { "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106 + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 122 } ], "type": { - "name": "Undefined", + "name": "int", "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of request queue writes." + } + ] }, - "signatures": [ + "flags": {}, + "groups": [], + "id": 964, + "module": "storage_clients._apify._models", + "name": "write_count", + "parsedDocstring": { + "text": "The number of request queue writes." + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n" - } - ] - }, - "flags": {}, - "id": 982, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_suitable_storage_client", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, return `cloud_storage_client`." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 983, - "kind": 32768, - "kindString": "Parameter", - "name": "force_cloud", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "StorageClient", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 125 } - ] + ], + "type": { + "name": "int", + "type": "reference" + } } ], "comment": { "summary": [ { "kind": "text", - "text": "Storage client that automatically selects cloud or local storage client based on the environment.\n\nThis storage client provides access to datasets, key-value stores, and request queues by intelligently\ndelegating to either the cloud or local storage client based on the execution environment and configuration.\n\nWhen running on the Apify platform (which is detected via environment variables), this client automatically\nuses the `cloud_storage_client` to store storage data there. When running locally, it uses the\n`local_storage_client` to store storage data there. You can also force cloud storage usage from your\nlocal machine by using the `force_cloud` argument.\n\nThis storage client is designed to work specifically in `Actor` context and provides a seamless development\nexperience where the same code works both locally and on the Apify platform without any changes." + "text": "" } ] }, - "decorations": [ + "flags": {}, + "groups": [ { - "args": "('Storage clients')", - "name": "docs_group" + "children": [ + 960, + 961, + 959, + 962, + 963, + 964 + ], + "title": "Properties" + } + ], + "id": 958, + "module": "storage_clients._apify._models", + "name": "RequestQueueStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 110 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional statistics about the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 966, + "module": "storage_clients._apify._models", + "name": "stats", + "parsedDocstring": { + "text": "Additional statistics about the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 130 + } + ], + "type": { + "name": "RequestQueueStats", + "type": "reference", + "target": "958" + } } ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, "flags": {}, "groups": [ { "children": [ - 954, - 958, - 963, - 969, - 975, - 960, - 981 + 966 ], - "title": "Methods" + "title": "Properties" } ], - "id": 953, - "module": "storage_clients._smart_apify._storage_client", - "name": "SmartApifyStorageClient", + "id": 965, + "module": "storage_clients._apify._models", + "name": "ApifyRequestQueueMetadata", "parsedDocstring": { - "text": "Storage client that automatically selects cloud or local storage client based on the environment.\n\nThis storage client provides access to datasets, key-value stores, and request queues by intelligently\ndelegating to either the cloud or local storage client based on the execution environment and configuration.\n\nWhen running on the Apify platform (which is detected via environment variables), this client automatically\nuses the `cloud_storage_client` to store storage data there. When running locally, it uses the\n`local_storage_client` to store storage data there. You can also force cloud storage usage from your\nlocal machine by using the `force_cloud` argument.\n\nThis storage client is designed to work specifically in `Actor` context and provides a seamless development\nexperience where the same code works both locally and on the Apify platform without any changes." + "text": "" }, "sources": [ { - "character": 1, - "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_models.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 129 } ], "type": { @@ -33837,18 +34453,18 @@ }, "flags": {}, "groups": [], - "id": 984, - "module": "events._apify_event_manager", - "name": "event_data_adapter", + "id": 967, + "module": "storage_clients._apify._request_queue_client", + "name": "logger", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_apify_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 24 } ], "type": { @@ -33868,29 +34484,25 @@ "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n" + "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 986, - "module": "events._apify_event_manager", + "id": 969, + "module": "storage_clients._apify._request_queue_client", "name": "__init__", "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "configuration": "The Actor configuration for the event manager.", - "**kwargs": "Additional event manager options passed to the parent class." - } + "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_apify_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 48 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 38 } ], "type": { @@ -33903,38 +34515,68 @@ "summary": [ { "kind": "text", - "text": "Initialize a new instance.\n" + "text": "Initialize a new instance.\n\nPreferably use the `ApifyRequestQueueClient.open` class method to create a new instance." } ] }, "flags": {}, - "id": 987, + "id": 970, "kind": 4096, "kindString": "Call signature", "modifiers": [], "name": "__init__", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor configuration for the event manager." - } - ] + "flags": { + "isOptional": false, + "keyword-only": true }, + "id": 971, + "kind": 32768, + "kindString": "Parameter", + "name": "api_client", + "type": { + "name": "RequestQueueClientAsync", + "type": "reference" + } + }, + { "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 988, + "id": 972, "kind": 32768, "kindString": "Parameter", - "name": "configuration", + "name": "metadata", "type": { - "name": "Configuration", + "name": "RequestQueueMetadata", + "type": "reference" + } + }, + { + "defaultValue": "'single'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 973, + "kind": 32768, + "kindString": "Parameter", + "name": "access", + "type": { + "name": "Literal", "type": "reference", - "target": "319" + "typeArguments": [ + { + "type": "literal", + "value": "single" + }, + { + "type": "literal", + "value": "shared" + } + ] } } ], @@ -33954,7 +34596,7 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n" } ] }, @@ -33965,17 +34607,18 @@ ], "flags": {}, "groups": [], - "id": 990, - "module": "events._apify_event_manager", - "name": "__aenter__", + "id": 974, + "module": "storage_clients._apify._request_queue_client", + "name": "get_metadata", "parsedDocstring": { - "text": "" + "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n", + "returns": "Request queue metadata with accurate counts and timestamps, combining API data with local estimates." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_apify_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 70 } ], @@ -33985,18 +34628,38 @@ }, "signatures": [ { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Request queue metadata with accurate counts and timestamps, combining API data with local estimates." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve current metadata about the request queue.\n\nThis method fetches metadata from the Apify API and merges it with local estimations to provide\nthe most up-to-date statistics. Local estimations are used to compensate for potential delays\nin API data propagation (typically a few seconds).\n" + } + ] + }, "flags": {}, - "id": 991, + "id": 975, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "__aenter__", + "name": "get_metadata", "parameters": [], "type": { - "name": "Self", - "type": "reference" + "name": "ApifyRequestQueueMetadata", + "type": "reference", + "target": "965" } } ] @@ -34009,29 +34672,37 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n" } ] }, "decorations": [ { - "name": "override" + "name": "classmethod" } ], "flags": {}, "groups": [], - "id": 992, - "module": "events._apify_event_manager", - "name": "__aexit__", + "id": 976, + "module": "storage_clients._apify._request_queue_client", + "name": "open", "parsedDocstring": { - "text": "" + "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n", + "args": { + "id": "ID of an existing request queue to open. Mutually exclusive with `name` and `alias`.", + "name": "Name of the request queue to open or create (persists across Actor runs).\nMutually exclusive with `id` and `alias`.", + "alias": "Alias for the request queue (scoped to current Actor run, creates unnamed storage).\nMutually exclusive with `id` and `name`.", + "configuration": "Configuration object containing API credentials (`token`, `api_base_url`) and\noptionally a `default_request_queue_id` for fallback when no identifier is provided.", + "access": "Access mode controlling the client's behavior:\n- `single`: Optimized for single-consumer scenarios (lower API usage, better performance).\n- `shared`: Optimized for multi-consumer scenarios (more API calls, guaranteed consistency).\n" + }, + "returns": "An instance for the opened or created storage client." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_apify_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 88 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103 } ], "type": { @@ -34040,37 +34711,58 @@ }, "signatures": [ { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "An instance for the opened or created storage client." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Open an Apify request queue client.\n\nThis method creates and initializes a new request queue client instance, handling authentication,\nstorage lookup or creation, metadata retrieval, and initialization of internal caching structures.\n" + } + ] + }, "flags": {}, - "id": 993, + "id": 977, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "__aexit__", + "name": "open", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of an existing request queue to open. Mutually exclusive with `name` and `alias`." + } + ] + }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 994, + "id": 978, "kind": 32768, "kindString": "Parameter", - "name": "exc_type", + "name": "id", "type": { - "name": "type[BaseException] | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ] + "name": "str" }, { "type": "literal", @@ -34080,21 +34772,29 @@ } }, { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the request queue to open or create (persists across Actor runs).\nMutually exclusive with `id` and `alias`." + } + ] + }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 995, + "id": 979, "kind": 32768, "kindString": "Parameter", - "name": "exc_value", + "name": "name", "type": { - "name": "BaseException | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "BaseException" + "name": "str" }, { "type": "literal", @@ -34104,21 +34804,29 @@ } }, { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Alias for the request queue (scoped to current Actor run, creates unnamed storage).\nMutually exclusive with `id` and `name`." + } + ] + }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 996, + "id": 980, "kind": 32768, "kindString": "Parameter", - "name": "exc_traceback", + "name": "alias", "type": { - "name": "TracebackType | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "TracebackType" + "name": "str" }, { "type": "literal", @@ -34126,167 +34834,75 @@ } ] } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configuration object containing API credentials (`token`, `api_base_url`) and\noptionally a `default_request_queue_id` for fallback when no identifier is provided." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 981, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Access mode controlling the client's behavior:\n- `single`: Optimized for single-consumer scenarios (lower API usage, better performance).\n- `shared`: Optimized for multi-consumer scenarios (more API calls, guaranteed consistency).\n" + } + ] + }, + "defaultValue": "'single'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 982, + "kind": 32768, + "kindString": "Parameter", + "name": "access", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "single" + }, + { + "type": "literal", + "value": "shared" + } + ] + } } ], "type": { - "name": "None", - "type": "literal", - "value": null + "name": "ApifyRequestQueueClient", + "type": "reference", + "target": "968" } } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event manager for the Apify platform.\n\nThis class extends Crawlee's `EventManager` to provide Apify-specific functionality, including websocket\nconnectivity to the Apify platform for receiving platform events.\n\nThe event manager handles:\n- Registration and emission of events and their listeners.\n- Websocket connection to Apify platform events.\n- Processing and validation of platform messages.\n- Automatic event forwarding from the platform to local event listeners.\n\nThis class should not be used directly. Use the `Actor.on` and `Actor.off` methods to interact\nwith the event system." - } - ] - }, - "decorations": [ - { - "args": "('Event managers')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 990, - 992, - 986 - ], - "title": "Methods" - } - ], - "id": 985, - "module": "events._apify_event_manager", - "name": "ApifyEventManager", - "parsedDocstring": { - "text": "Event manager for the Apify platform.\n\nThis class extends Crawlee's `EventManager` to provide Apify-specific functionality, including websocket\nconnectivity to the Apify platform for receiving platform events.\n\nThe event manager handles:\n- Registration and emission of events and their listeners.\n- Websocket connection to Apify platform events.\n- Processing and validation of platform messages.\n- Automatic event forwarding from the platform to local event listeners.\n\nThis class should not be used directly. Use the `Actor.on` and `Actor.off` methods to interact\nwith the event system." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_apify_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 32 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 998, - "module": "events._types", - "name": "mem_avg_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 22 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 999, - "module": "events._types", - "name": "mem_current_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1000, - "module": "events._types", - "name": "mem_max_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 - } - ], - "type": { - "name": "float", - "type": "reference" - } }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34296,129 +34912,53 @@ } ] }, - "flags": {}, - "groups": [], - "id": 1001, - "module": "events._types", - "name": "cpu_avg_usage", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "name": "override" } ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 1002, - "module": "events._types", - "name": "cpu_max_usage", + "id": 983, + "module": "storage_clients._apify._request_queue_client", + "name": "purge", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 157 } ], "type": { - "name": "float", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1003, - "module": "events._types", - "name": "cpu_current_usage", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 27 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "flags": {}, + "id": 984, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "purge", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - }, - "flags": {}, - "groups": [], - "id": 1004, - "module": "events._types", - "name": "is_cpu_overloaded", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 } - ], - "type": { - "name": "bool", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34428,26 +34968,49 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1005, - "module": "events._types", - "name": "created_at", + "id": 985, + "module": "storage_clients._apify._request_queue_client", + "name": "drop", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 164 } ], "type": { - "name": "datetime", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "flags": {}, + "id": 986, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "drop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] }, { "kind": 2048, @@ -34461,21 +35024,25 @@ } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1006, - "module": "events._types", - "name": "to_crawlee_format", + "id": 987, + "module": "storage_clients._apify._request_queue_client", + "name": "add_batch_of_requests", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 168 } ], "type": { @@ -34485,97 +35052,60 @@ "signatures": [ { "flags": {}, - "id": 1007, + "id": 988, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "to_crawlee_format", + "modifiers": [ + "async" + ], + "name": "add_batch_of_requests", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 1008, + "id": 989, "kind": 32768, "kindString": "Parameter", - "name": "dedicated_cpus", + "name": "requests", "type": { - "name": "float", + "name": "Sequence", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request" + } + ] + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 990, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", "type": "reference" } } ], "type": { - "name": "EventSystemInfoData", + "name": "AddRequestsResponse", "type": "reference" } } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Event data')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1006 - ], - "title": "Methods" }, { - "children": [ - 1001, - 1003, - 1002, - 1005, - 1004, - 998, - 999, - 1000 - ], - "title": "Properties" - } - ], - "id": 997, - "module": "events._types", - "name": "SystemInfoEventData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34585,36 +35115,62 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1010, - "module": "events._types", - "name": "name", + "id": 991, + "module": "storage_clients._apify._request_queue_client", + "name": "fetch_next_request", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 49 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 177 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.PERSIST_STATE" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 992, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "fetch_next_request", + "parameters": [], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34624,78 +35180,77 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1011, - "module": "events._types", - "name": "data", + "id": 993, + "module": "storage_clients._apify._request_queue_client", + "name": "mark_request_as_handled", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 50 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 181 } ], "type": { - "name": "EventPersistStateData", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1011, - 1010 - ], - "title": "Properties" - } - ], - "id": 1009, - "module": "events._types", - "name": "PersistStateEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 48 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "signatures": [ + { + "flags": {}, + "id": 994, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "mark_request_as_handled", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 995, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34705,36 +35260,77 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1013, - "module": "events._types", - "name": "name", + "id": 996, + "module": "storage_clients._apify._request_queue_client", + "name": "get_request", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 185 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.SYSTEM_INFO" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 997, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 998, + "kind": 32768, + "kindString": "Parameter", + "name": "unique_key", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34744,118 +35340,92 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1014, - "module": "events._types", - "name": "data", + "id": 999, + "module": "storage_clients._apify._request_queue_client", + "name": "reclaim_request", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 56 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 189 } ], "type": { - "name": "SystemInfoEventData", - "type": "reference", - "target": "997" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1014, - 1013 - ], - "title": "Properties" - } - ], - "id": 1012, - "module": "events._types", - "name": "SystemInfoEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 54 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 1000, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "reclaim_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1001, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1002, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "groups": [], - "id": 1016, - "module": "events._types", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.MIGRATING" - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -34865,64 +35435,89 @@ } ] }, + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1017, - "module": "events._types", - "name": "data", + "id": 1003, + "module": "storage_clients._apify._request_queue_client", + "name": "is_empty", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 62 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 198 } ], "type": { - "name": "EventMigratingData", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "flags": {}, + "id": 1004, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "is_empty", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" + } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Request queue client for the Apify platform.\n\nThis client provides access to request queues stored on the Apify platform, supporting both single-consumer\nand multi-consumer scenarios. It manages local caching, request fetching, and state synchronization with the\nplatform's API." } ] }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], "flags": {}, "groups": [ { "children": [ - 1017, - 1016 + 969, + 987, + 985, + 991, + 974, + 996, + 1003, + 993, + 976, + 983, + 999 ], - "title": "Properties" + "title": "Methods" } ], - "id": 1015, - "module": "events._types", - "name": "MigratingEvent", + "id": 968, + "module": "storage_clients._apify._request_queue_client", + "name": "ApifyRequestQueueClient", "parsedDocstring": { - "text": "" + "text": "Request queue client for the Apify platform.\n\nThis client provides access to request queues stored on the Apify platform, supporting both single-consumer\nand multi-consumer scenarios. It manages local caching, request fetching, and state synchronization with the\nplatform's API." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 60 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 27 } ], "type": { @@ -34931,82 +35526,9 @@ } }, { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1019, - "module": "events._types", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.ABORTING" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1020, - "module": "events._types", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 68 - } - ], - "type": { - "name": "EventAbortingData", - "type": "reference" - } - } - ], + "kind": 1024, + "kindString": "Property", + "children": [], "comment": { "summary": [ { @@ -35015,34 +35537,20 @@ } ] }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], "flags": {}, - "groups": [ - { - "children": [ - 1020, - 1019 - ], - "title": "Properties" - } - ], - "id": 1018, - "module": "events._types", - "name": "AbortingEvent", + "groups": [], + "id": 1005, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "logger", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 66 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 22 } ], "type": { @@ -35055,541 +35563,709 @@ "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1022, - "module": "events._types", - "name": "name", + "id": 1007, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "__init__", "parsedDocstring": { - "text": "" + "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n", + "args": { + "api_client": "The Apify API client for request queue operations.", + "metadata": "Initial metadata for the request queue.", + "cache_size": "Maximum number of requests to cache locally.", + "metadata_getter": "Async function to fetch current metadata from the API." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 73 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.EXIT" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new shared request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='shared')` instead of calling this directly.\n" + } + ] + }, + "flags": {}, + "id": 1008, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API client for request queue operations." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1009, + "kind": 32768, + "kindString": "Parameter", + "name": "api_client", + "type": { + "name": "RequestQueueClientAsync", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initial metadata for the request queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1010, + "kind": 32768, + "kindString": "Parameter", + "name": "metadata", + "type": { + "name": "RequestQueueMetadata", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests to cache locally." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1011, + "kind": 32768, + "kindString": "Parameter", + "name": "cache_size", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async function to fetch current metadata from the API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1012, + "kind": 32768, + "kindString": "Parameter", + "name": "metadata_getter", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "[]" + }, + { + "type": "reference", + "name": "Coroutine", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + }, + { + "type": "reference", + "name": "Any" + }, + { + "type": "reference", + "name": "ApifyRequestQueueMetadata", + "target": "965" + } + ] + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1023, - "module": "events._types", - "name": "data", + "id": 1013, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "add_batch_of_requests", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 74 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 82 } ], "type": { - "name": "EventExitData", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1023, - 1022 - ], - "title": "Properties" - } - ], - "id": 1021, - "module": "events._types", - "name": "ExitEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1025, - "module": "events._types", - "name": "name", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 79 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Event.SESSION_RETIRED" - }, - { - "type": "reference", - "name": "Event.BROWSER_LAUNCHED" - }, - { - "type": "reference", - "name": "Event.BROWSER_RETIRED" - }, - { - "type": "reference", - "name": "Event.BROWSER_CLOSED" - }, - { - "type": "reference", - "name": "Event.PAGE_CREATED" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] }, - { - "type": "reference", - "name": "Event.PAGE_CLOSED" + "flags": {}, + "id": 1014, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "add_batch_of_requests", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1015, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "Sequence", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request" + } + ] + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1016, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "AddRequestsResponse", + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1026, - "module": "events._types", - "name": "data", + "id": 1017, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "get_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 87 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 166 } ], "type": { - "name": "Any", + "name": "Undefined", "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1026, - 1025 - ], - "title": "Properties" - } - ], - "id": 1024, - "module": "events._types", - "name": "EventWithoutData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] + }, + "flags": {}, + "id": 1018, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1019, + "kind": 32768, + "kindString": "Parameter", + "name": "unique_key", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1028, - "module": "events._types", - "name": "name", + "id": 1020, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "fetch_next_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 92 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 170 } ], "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "cpuInfo" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] + }, + "flags": {}, + "id": 1021, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "fetch_next_request", + "parameters": [], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1029, - "module": "events._types", - "name": "data", + "id": 1022, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "mark_request_as_handled", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 93 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 212 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] }, - { - "type": "reference", - "name": "Any" + "flags": {}, + "id": 1023, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "mark_request_as_handled", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1024, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1029, - 1028 - ], - "title": "Properties" - } - ], - "id": 1027, - "module": "events._types", - "name": "DeprecatedEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + } + ] + }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1031, - "module": "events._types", - "name": "name", + "id": 1025, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "reclaim_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 98 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 244 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] + }, + "flags": {}, + "id": 1026, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "reclaim_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1027, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1028, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1032, - "module": "events._types", - "name": "data", + "id": 1029, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "is_empty", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ shared access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 99 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 288 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ shared access mode." + } + ] }, - { - "type": "reference", - "name": "Any" + "flags": {}, + "id": 1030, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "is_empty", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" } - ] - } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Internal request queue client implementation for multi-consumer scenarios on the Apify platform.\n\nThis implementation is optimized for scenarios where multiple clients concurrently fetch and process requests\nfrom the same queue. It makes more frequent API calls to ensure consistency across all consumers and uses\nrequest locking to prevent duplicate processing.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='shared'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." } ] }, - "decorations": [ - { - "args": "('Events')", - "name": "docs_group" - } - ], "flags": {}, "groups": [ { "children": [ - 1032, - 1031 + 1007, + 1013, + 1020, + 1017, + 1029, + 1022, + 1025 ], - "title": "Properties" - } - ], - "id": 1030, - "module": "events._types", - "name": "UnknownEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 97 + "title": "Methods" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1033, - "module": "events._types", - "name": "EventMessage", + "id": 1006, + "module": "storage_clients._apify._request_queue_shared_client", + "name": "ApifyRequestQueueSharedClient", "parsedDocstring": { - "text": "" + "text": "Internal request queue client implementation for multi-consumer scenarios on the Apify platform.\n\nThis implementation is optimized for scenarios where multiple clients concurrently fetch and process requests\nfrom the same queue. It makes more frequent API calls to ensure consistency across all consumers and uses\nrequest locking to prevent duplicate processing.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='shared'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." }, "sources": [ { "character": 1, - "fileName": "/src/apify/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 102 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "type": { @@ -35611,18 +36287,18 @@ }, "flags": {}, "groups": [], - "id": 1034, - "module": "request_loaders._apify_request_list", - "name": "URL_NO_COMMAS_REGEX", + "id": 1031, + "module": "storage_clients._apify._request_queue_single_client", + "name": "logger", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "type": { @@ -35635,424 +36311,631 @@ "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1036, - "module": "request_loaders._apify_request_list", - "name": "method", + "id": 1033, + "module": "storage_clients._apify._request_queue_single_client", + "name": "__init__", "parsedDocstring": { - "text": "" + "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n", + "args": { + "api_client": "The Apify API client for request queue operations.", + "metadata": "Initial metadata for the request queue.", + "cache_size": "Maximum number of requests to cache locally." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 52 } ], "type": { - "name": "HttpMethod", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1037, - "module": "request_loaders._apify_request_list", - "name": "payload", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new single-consumer request queue client instance.\n\nUse `ApifyRequestQueueClient.open(access='single')` instead of calling this directly.\n" + } + ] + }, + "flags": {}, + "id": 1034, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API client for request queue operations." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1035, + "kind": 32768, + "kindString": "Parameter", + "name": "api_client", + "type": { + "name": "RequestQueueClientAsync", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initial metadata for the request queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1036, + "kind": 32768, + "kindString": "Parameter", + "name": "metadata", + "type": { + "name": "RequestQueueMetadata", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests to cache locally." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1037, + "kind": 32768, + "kindString": "Parameter", + "name": "cache_size", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], "id": 1038, - "module": "request_loaders._apify_request_list", - "name": "headers", + "module": "storage_clients._apify._request_queue_single_client", + "name": "add_batch_of_requests", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] }, - { - "type": "reference", - "name": "str" + "flags": {}, + "id": 1039, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "add_batch_of_requests", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1040, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "Sequence", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request" + } + ] + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1041, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "AddRequestsResponse", + "type": "reference" } - ] - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1039, - "module": "request_loaders._apify_request_list", - "name": "user_data", + "id": 1042, + "module": "storage_clients._apify._request_queue_single_client", + "name": "get_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 183 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] }, - { - "type": "reference", - "name": "str" + "flags": {}, + "id": 1043, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1044, + "kind": 32768, + "kindString": "Parameter", + "name": "unique_key", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1038, - 1036, - 1037, - 1039 - ], - "title": "Properties" - } - ], - "id": 1035, - "module": "request_loaders._apify_request_list", - "name": "_RequestDetails", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 22 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "_RequestsFromUrlInput", - "target": "1040", - "type": "reference" + } + ] }, { - "name": "_SimpleUrlInput", - "target": "1042", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1041, - "module": "request_loaders._apify_request_list", - "name": "requests_from_url", + "id": 1045, + "module": "storage_clients._apify._request_queue_single_client", + "name": "fetch_next_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 30 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 187 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] }, - "flags": {}, - "groups": [], - "id": 1159, - "module": "request_loaders._apify_request_list", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] + }, + "flags": {}, + "id": 1046, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "fetch_next_request", + "parameters": [], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request" + }, + { + "type": "literal", + "value": null + } + ] + } } - ], - "type": { - "name": "HttpMethod", - "type": "reference" - }, - "inheritedFrom": { - "name": "_RequestDetails.method", - "target": 1036, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1160, - "module": "request_loaders._apify_request_list", - "name": "payload", + "id": 1047, + "module": "storage_clients._apify._request_queue_single_client", + "name": "mark_request_as_handled", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 206 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" }, - "inheritedFrom": { - "name": "_RequestDetails.payload", - "target": 1037, - "type": "reference" - } + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] + }, + "flags": {}, + "id": 1048, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "mark_request_as_handled", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1049, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1161, - "module": "request_loaders._apify_request_list", - "name": "headers", + "id": 1050, + "module": "storage_clients._apify._request_queue_single_client", + "name": "reclaim_request", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 236 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] }, - { - "type": "reference", - "name": "str" + "flags": {}, + "id": 1051, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "reclaim_request", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1052, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Request", + "type": "reference" + } + }, + { + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1053, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "ProcessedRequest | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ProcessedRequest" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "inheritedFrom": { - "name": "_RequestDetails.headers", - "target": 1038, - "type": "reference" - } + } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1162, - "module": "request_loaders._apify_request_list", - "name": "user_data", + "id": 1054, + "module": "storage_clients._apify._request_queue_single_client", + "name": "is_empty", "parsedDocstring": { - "text": "" + "text": "Specific implementation of this method for the RQ single access mode." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 279 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specific implementation of this method for the RQ single access mode." + } + ] }, - { - "type": "reference", - "name": "str" + "flags": {}, + "id": 1055, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "is_empty", + "parameters": [], + "type": { + "name": "bool", + "type": "reference" } - ] - }, - "inheritedFrom": { - "name": "_RequestDetails.user_data", - "target": 1039, - "type": "reference" - } + } + ] } ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Internal request queue client implementation for single-consumer scenarios on the Apify platform.\n\nThis implementation minimizes API calls and resource usage by leveraging local caching and head estimation.\nIt is designed for scenarios where only one client consumes requests from the queue at a time, though multiple\nproducers may add requests concurrently.\n\n### Usage constraints\n\nThis client must operate within the following constraints to function correctly:\n\n- **Single consumer**: Only one client should be consuming (fetching) requests from the queue at any given time.\n- **Multiple producers allowed**: Multiple clients can add requests concurrently, but their forefront requests\nmay not be prioritized immediately since this client relies on local head estimation.\n- **Append-only queue**: Requests should only be added to the queue, never deleted by other clients.\nMarking requests as handled is permitted.\n- **No external modifications**: Other producers can add new requests but should not modify existing ones,\nas modifications won't be reflected in the local cache.\n\nIf these constraints are not met, the client may exhibit unpredictable behavior.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='single'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." } ] }, @@ -36060,119 +36943,138 @@ "groups": [ { "children": [ - 1161, - 1159, - 1160, - 1041, - 1162 + 1033, + 1038, + 1045, + 1042, + 1054, + 1047, + 1050 ], - "title": "Properties" + "title": "Methods" } ], - "id": 1040, - "module": "request_loaders._apify_request_list", - "name": "_RequestsFromUrlInput", + "id": 1032, + "module": "storage_clients._apify._request_queue_single_client", + "name": "ApifyRequestQueueSingleClient", "parsedDocstring": { - "text": "" + "text": "Internal request queue client implementation for single-consumer scenarios on the Apify platform.\n\nThis implementation minimizes API calls and resource usage by leveraging local caching and head estimation.\nIt is designed for scenarios where only one client consumes requests from the queue at a time, though multiple\nproducers may add requests concurrently.\n\n### Usage constraints\n\nThis client must operate within the following constraints to function correctly:\n\n- **Single consumer**: Only one client should be consuming (fetching) requests from the queue at any given time.\n- **Multiple producers allowed**: Multiple clients can add requests concurrently, but their forefront requests\nmay not be prioritized immediately since this client relies on local head estimation.\n- **Append-only queue**: Requests should only be added to the queue, never deleted by other clients.\nMarking requests as handled is permitted.\n- **No external modifications**: Other producers can add new requests but should not modify existing ones,\nas modifications won't be reflected in the local cache.\n\nIf these constraints are not met, the client may exhibit unpredictable behavior.\n\nThis class is used internally by `ApifyRequestQueueClient` when `access='single'` is specified.\n\nPublic methods are not individually documented as they implement the interface defined in `RequestQueueClient`." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 + "fileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { "name": "Undefined", "type": "reference" - }, - "extendedTypes": [ - { - "name": "_RequestDetails", - "target": "1035", - "type": "reference" - } - ] + } }, { "kind": 128, "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n" } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1043, - "module": "request_loaders._apify_request_list", - "name": "url", + "id": 1057, + "module": "storage_clients._apify._storage_client", + "name": "__init__", "parsedDocstring": { - "text": "" + "text": "Initialize a new instance.\n", + "args": { + "request_queue_access": "Defines how the request queue client behaves. Use `single` mode for a single\nconsumer. It has fewer API calls, meaning better performance and lower costs. If you need multiple\nconcurrent consumers use `shared` mode, but expect worse performance and higher costs due to\nthe additional overhead." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34 + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 66 } ], "type": { - "name": "str", + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1163, - "module": "request_loaders._apify_request_list", - "name": "method", - "parsedDocstring": { - "text": "" }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, + "flags": {}, + "id": 1058, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Defines how the request queue client behaves. Use `single` mode for a single\nconsumer. It has fewer API calls, meaning better performance and lower costs. If you need multiple\nconcurrent consumers use `shared` mode, but expect worse performance and higher costs due to\nthe additional overhead." + } + ] + }, + "defaultValue": "'single'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1059, + "kind": 32768, + "kindString": "Parameter", + "name": "request_queue_access", + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "single" + }, + { + "type": "literal", + "value": "shared" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } } - ], - "type": { - "name": "HttpMethod", - "type": "reference" - }, - "inheritedFrom": { - "name": "_RequestDetails.method", - "target": 1036, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ @@ -36182,213 +37084,151 @@ } ] }, - "flags": {}, - "groups": [], - "id": 1164, - "module": "request_loaders._apify_request_list", - "name": "payload", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 + "name": "override" } ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "_RequestDetails.payload", - "target": 1037, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, "flags": {}, "groups": [], - "id": 1165, - "module": "request_loaders._apify_request_list", - "name": "headers", + "id": 1060, + "module": "storage_clients._apify._storage_client", + "name": "create_dataset_client", "parsedDocstring": { "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 78 } ], "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - "inheritedFrom": { - "name": "_RequestDetails.headers", - "target": 1038, + "name": "Undefined", "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] }, - "flags": {}, - "groups": [], - "id": 1166, - "module": "request_loaders._apify_request_list", - "name": "user_data", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 - } - ], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - "inheritedFrom": { - "name": "_RequestDetails.user_data", - "target": 1039, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1165, - 1163, - 1164, - 1043, - 1166 - ], - "title": "Properties" - } - ], - "id": 1042, - "module": "request_loaders._apify_request_list", - "name": "_SimpleUrlInput", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 33 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "_RequestDetails", - "target": "1035", - "type": "reference" - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1044, - "module": "request_loaders._apify_request_list", - "name": "url_input_adapter", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "flags": {}, + "id": 1061, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create_dataset_client", + "parameters": [ + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1062, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1063, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1064, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1065, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "CrawleeConfiguration" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ApifyDatasetClient", + "type": "reference", + "target": "843" + } + } + ] + }, { "kind": 2048, "kindString": "Method", @@ -36397,35 +37237,29 @@ "summary": [ { "kind": "text", - "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n" + "text": "" } ] }, "decorations": [ { - "name": "classmethod" + "name": "override" } ], "flags": {}, "groups": [], - "id": 1046, - "module": "request_loaders._apify_request_list", - "name": "open", + "id": 1066, + "module": "storage_clients._apify._storage_client", + "name": "create_kvs_client", "parsedDocstring": { - "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n", - "args": { - "name": "An optional name for the request list, used for state persistence.", - "request_list_sources_input": "A list of request source dicts in the standard Apify format. Each dict must\ncontain either a `url` key or a `requestsFromUrl` key. If `None` or empty, an empty request list\nis returned.", - "http_client": "HTTP client used to fetch remote URL lists (entries with `requestsFromUrl`). Defaults to\n`ImpitHttpClient` if not provided.\n" - }, - "returns": "A new `ApifyRequestList` populated with the resolved requests." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 69 + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 93 } ], "type": { @@ -36434,49 +37268,47 @@ }, "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A new `ApifyRequestList` populated with the resolved requests." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new `ApifyRequestList` from the standard Apify request list sources input.\n\nEach entry in `request_list_sources_input` is a dict with either a `url` key (for a direct URL) or\na `requestsFromUrl` key (for a remote resource whose response body is scanned for URLs). Optional keys\n`method`, `payload`, `headers`, and `userData` are applied to every request produced from that entry.\n" - } - ] - }, "flags": {}, - "id": 1047, + "id": 1067, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "open", + "name": "create_kvs_client", "parameters": [ { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1068, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "An optional name for the request list, used for state persistence." + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { "defaultValue": "None", "flags": { "isOptional": true, "keyword-only": true }, - "id": 1048, + "id": 1069, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -36496,46 +37328,129 @@ } }, { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1070, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "A list of request source dicts in the standard Apify format. Each dict must\ncontain either a `url` key or a `requestsFromUrl` key. If `None` or empty, an empty request list\nis returned." + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true }, + "id": 1071, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "CrawleeConfiguration" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ApifyKeyValueStoreClient", + "type": "reference", + "target": "889" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 1072, + "module": "storage_clients._apify._storage_client", + "name": "create_rq_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 1073, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create_rq_client", + "parameters": [ + { "defaultValue": "None", "flags": { "isOptional": true, "keyword-only": true }, - "id": 1049, + "id": 1074, "kind": 32768, "kindString": "Parameter", - "name": "request_list_sources_input", + "name": "id", "type": { - "name": "list[dict[str, Any]] | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] + "name": "str" }, { "type": "literal", @@ -36545,30 +37460,72 @@ } }, { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1075, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "HTTP client used to fetch remote URL lists (entries with `requestsFromUrl`). Defaults to\n`ImpitHttpClient` if not provided.\n" + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true }, + "id": 1076, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { "defaultValue": "None", "flags": { "isOptional": true, "keyword-only": true }, - "id": 1050, + "id": 1077, "kind": 32768, "kindString": "Parameter", - "name": "http_client", + "name": "configuration", "type": { - "name": "HttpClient | None", + "name": "CrawleeConfiguration | None", "type": "union", "types": [ { "type": "reference", - "name": "HttpClient" + "name": "CrawleeConfiguration" }, { "type": "literal", @@ -36579,9 +37536,77 @@ } ], "type": { - "name": "ApifyRequestList", + "name": "ApifyRequestQueueClient", "type": "reference", - "target": "1045" + "target": "968" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 1078, + "module": "storage_clients._apify._storage_client", + "name": "get_storage_client_cache_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 125 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 1079, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_storage_client_cache_key", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1080, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration", + "type": "reference" + } + } + ], + "type": { + "name": "Hashable", + "type": "reference" } } ] @@ -36591,13 +37616,13 @@ "summary": [ { "kind": "text", - "text": "A request list that can be constructed from the standard Apify `requestListSources` Actor input format.\n\nThis extends the Crawlee `RequestList` with the ability to parse the request list sources input commonly\nused in Apify Actors. It supports two kinds of entries:\n\n- **Direct URLs** - entries with a `url` key are converted to requests directly.\n- **Remote URL lists** - entries with a `requestsFromUrl` key point to a remote resource (e.g. a plain-text\nfile). The resource is fetched and all URLs found in the response body are extracted and converted to requests.\n\nBoth kinds of entries can optionally specify `method`, `payload`, `headers`, and `userData` fields that will be\napplied to every request created from that entry.\n\n### Usage\n\n```python\nfrom apify import Actor\nfrom apify.request_loaders import ApifyRequestList\n\nasync with Actor:\n actor_input = await Actor.get_input() or {}\n request_list = await ApifyRequestList.open(\n request_list_sources_input=actor_input.get('requestListSources', []),\n )\n```" + "text": "Apify platform implementation of the storage client.\n\nThis storage client provides access to datasets, key-value stores, and request queues that persist data\nto the Apify platform. Each storage type is implemented with its own specific Apify client that stores data\nin the cloud, making it accessible from anywhere.\n\nThe communication with the Apify platform is handled via the Apify API client for Python, which is an HTTP API\nwrapper. For maximum efficiency and performance of the storage clients, various caching mechanisms are used to\nminimize the number of API calls made to the Apify platform. Data can be inspected and manipulated through\nthe Apify console web interface or via the Apify API.\n\nThe request queue client supports two access modes controlled by the `request_queue_access` parameter:\n\n### Single mode\n\nThe `single` mode is optimized for scenarios with only one consumer. It minimizes API calls, making it faster\nand more cost-efficient compared to the `shared` mode. This option is ideal when a single Actor is responsible\nfor consuming the entire request queue. Using multiple consumers simultaneously may lead to inconsistencies\nor unexpected behavior.\n\nIn this mode, multiple producers can safely add new requests, but forefront requests may not be processed\nimmediately, as the client relies on local head estimation instead of frequent forefront fetching. Requests can\nalso be added or marked as handled by other clients, but they must not be deleted or modified, since such changes\nwould not be reflected in the local cache. If a request is already fully cached locally, marking it as handled\nby another client will be ignored by this client. This does not cause errors but can occasionally result in\nreprocessing a request that was already handled elsewhere. If the request was not yet cached locally, marking\nit as handled poses no issue.\n\n### Shared mode\n\nThe `shared` mode is designed for scenarios with multiple concurrent consumers. It ensures proper synchronization\nand consistency across clients, at the cost of higher API usage and slightly worse performance. This mode is safe\nfor concurrent access from multiple processes, including Actors running in parallel on the Apify platform. It\nshould be used when multiple consumers need to process requests from the same queue simultaneously." } ] }, "decorations": [ { - "args": "('Request loaders')", + "args": "('Storage clients')", "name": "docs_group" } ], @@ -36605,23 +37630,27 @@ "groups": [ { "children": [ - 1046 + 1057, + 1060, + 1066, + 1072, + 1078 ], "title": "Methods" } ], - "id": 1045, - "module": "request_loaders._apify_request_list", - "name": "ApifyRequestList", + "id": 1056, + "module": "storage_clients._apify._storage_client", + "name": "ApifyStorageClient", "parsedDocstring": { - "text": "A request list that can be constructed from the standard Apify `requestListSources` Actor input format.\n\nThis extends the Crawlee `RequestList` with the ability to parse the request list sources input commonly\nused in Apify Actors. It supports two kinds of entries:\n\n- **Direct URLs** - entries with a `url` key are converted to requests directly.\n- **Remote URL lists** - entries with a `requestsFromUrl` key point to a remote resource (e.g. a plain-text\nfile). The resource is fetched and all URLs found in the response body are extracted and converted to requests.\n\nBoth kinds of entries can optionally specify `method`, `payload`, `headers`, and `userData` fields that will be\napplied to every request created from that entry.\n\n### Usage\n\n```python\nfrom apify import Actor\nfrom apify.request_loaders import ApifyRequestList\n\nasync with Actor:\n actor_input = await Actor.get_input() or {}\n request_list = await ApifyRequestList.open(\n request_list_sources_input=actor_input.get('requestListSources', []),\n )\n```" + "text": "Apify platform implementation of the storage client.\n\nThis storage client provides access to datasets, key-value stores, and request queues that persist data\nto the Apify platform. Each storage type is implemented with its own specific Apify client that stores data\nin the cloud, making it accessible from anywhere.\n\nThe communication with the Apify platform is handled via the Apify API client for Python, which is an HTTP API\nwrapper. For maximum efficiency and performance of the storage clients, various caching mechanisms are used to\nminimize the number of API calls made to the Apify platform. Data can be inspected and manipulated through\nthe Apify console web interface or via the Apify API.\n\nThe request queue client supports two access modes controlled by the `request_queue_access` parameter:\n\n### Single mode\n\nThe `single` mode is optimized for scenarios with only one consumer. It minimizes API calls, making it faster\nand more cost-efficient compared to the `shared` mode. This option is ideal when a single Actor is responsible\nfor consuming the entire request queue. Using multiple consumers simultaneously may lead to inconsistencies\nor unexpected behavior.\n\nIn this mode, multiple producers can safely add new requests, but forefront requests may not be processed\nimmediately, as the client relies on local head estimation instead of frequent forefront fetching. Requests can\nalso be added or marked as handled by other clients, but they must not be deleted or modified, since such changes\nwould not be reflected in the local cache. If a request is already fully cached locally, marking it as handled\nby another client will be ignored by this client. This does not cause errors but can occasionally result in\nreprocessing a request that was already handled elsewhere. If the request was not yet cached locally, marking\nit as handled poses no issue.\n\n### Shared mode\n\nThe `shared` mode is designed for scenarios with multiple concurrent consumers. It ensures proper synchronization\nand consistency across clients, at the cost of higher API usage and slightly worse performance. This mode is safe\nfor concurrent access from multiple processes, including Actors running in parallel on the Apify platform. It\nshould be used when multiple consumers need to process requests from the same queue simultaneously." }, "sources": [ { "character": 1, - "fileName": "/src/apify/request_loaders/_apify_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 41 + "fileName": "/src/apify/storage_clients/_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 23 } ], "type": { @@ -36637,131 +37666,30 @@ "summary": [ { "kind": "text", - "text": "Generate a basic authentication header for the given username and password." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1051, - "module": "scrapy.utils", - "name": "get_basic_auth_header", - "parsedDocstring": { - "text": "Generate a basic authentication header for the given username and password." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a basic authentication header for the given username and password." - } - ] - }, - "flags": {}, - "id": 1052, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_basic_auth_header", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1053, - "kind": 32768, - "kindString": "Parameter", - "name": "username", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1054, - "kind": 32768, - "kindString": "Parameter", - "name": "password", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "defaultValue": "'latin-1'", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1055, - "kind": 32768, - "kindString": "Parameter", - "name": "auth_encoding", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n" + "text": "Generate a deterministic request ID based on a unique key.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 1056, - "module": "scrapy.utils", - "name": "apply_apify_settings", + "id": 1081, + "module": "storage_clients._apify._utils", + "name": "unique_key_to_request_id", "parsedDocstring": { - "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n", + "text": "Generate a deterministic request ID based on a unique key.\n", "args": { - "settings": "Scrapy project settings to be modified.", - "proxy_config": "Proxy configuration to be stored in the settings.\n" + "unique_key": "The unique key to convert into a request ID.", + "request_id_length": "The length of the request ID.\n" }, - "returns": "Scrapy project settings with custom configurations." + "returns": "A URL-safe, truncated request ID based on the unique key." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/utils.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 + "fileName": "/src/apify/storage_clients/_apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 14 } ], "type": { @@ -36776,7 +37704,7 @@ "content": [ { "kind": "text", - "text": "Scrapy project settings with custom configurations." + "text": "A URL-safe, truncated request ID based on the unique key." } ], "tag": "@returns" @@ -36785,48 +37713,37 @@ "summary": [ { "kind": "text", - "text": "Integrates Apify configuration into a Scrapy project settings.\n\nNote: The function directly modifies the passed `settings` object and also returns it.\n" + "text": "Generate a deterministic request ID based on a unique key.\n" } ] }, "flags": {}, - "id": 1057, + "id": 1082, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "apply_apify_settings", + "name": "unique_key_to_request_id", "parameters": [ { "comment": { "summary": [ { "kind": "text", - "text": "Scrapy project settings to be modified." + "text": "The unique key to convert into a request ID." } ] }, - "defaultValue": "None", "flags": { - "isOptional": true, - "keyword-only": true + "isOptional": false, + "keyword-only": false }, - "id": 1058, + "id": 1083, "kind": 32768, "kindString": "Parameter", - "name": "settings", + "name": "unique_key", "type": { - "name": "Settings | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Settings" - }, - { - "type": "literal", - "value": null - } - ] + "name": "str", + "type": "reference" } }, { @@ -36834,74 +37751,104 @@ "summary": [ { "kind": "text", - "text": "Proxy configuration to be stored in the settings.\n" + "text": "The length of the request ID.\n" } ] }, - "defaultValue": "None", + "defaultValue": "15", "flags": { "isOptional": true, "keyword-only": true }, - "id": 1059, + "id": 1084, "kind": 32768, "kindString": "Parameter", - "name": "proxy_config", + "name": "request_id_length", "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] + "name": "int", + "type": "reference" } } ], "type": { - "name": "Settings", + "name": "str", "type": "reference" } } ] }, { - "kind": 1024, - "kindString": "Property", + "kind": 2048, + "kindString": "Method", "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." } ] }, + "decorations": [], "flags": {}, "groups": [], - "id": 1060, - "module": "scrapy.scheduler", - "name": "logger", + "id": 1085, + "module": "storage_clients._apify._utils", + "name": "hash_api_base_url_and_token", "parsedDocstring": { - "text": "" + "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 + "fileName": "/src/apify/storage_clients/_apify/_utils.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Hash configuration.api_public_base_url and configuration.token in deterministic way." + } + ] + }, + "flags": {}, + "id": 1086, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "hash_api_base_url_and_token", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1087, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "Configuration", + "type": "reference", + "target": "328" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] }, { "kind": 128, @@ -36922,8 +37869,8 @@ "decorations": [], "flags": {}, "groups": [], - "id": 1062, - "module": "scrapy.scheduler", + "id": 1089, + "module": "storage_clients._ppe_dataset_mixin", "name": "__init__", "parsedDocstring": { "text": "" @@ -36931,9 +37878,9 @@ "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 30 + "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "type": { @@ -36943,7 +37890,7 @@ "signatures": [ { "flags": {}, - "id": 1063, + "id": 1138, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -36953,9 +37900,19 @@ "name": "None", "type": "literal", "value": null + }, + "overwrites": { + "name": "DatasetClientPpeMixin.__init__", + "target": 1137, + "type": "reference" } } - ] + ], + "overwrites": { + "name": "DatasetClientPpeMixin.__init__", + "target": 1137, + "type": "reference" + } }, { "kind": 2048, @@ -36965,28 +37922,32 @@ "summary": [ { "kind": "text", - "text": "Open the scheduler.\n" + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + }, + { + "name": "classmethod" + } + ], "flags": {}, "groups": [], - "id": 1064, - "module": "scrapy.scheduler", + "id": 1093, + "module": "storage_clients._file_system._dataset_client", "name": "open", "parsedDocstring": { - "text": "Open the scheduler.\n", - "args": { - "spider": "The spider that the scheduler is associated with." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "type": { @@ -36995,310 +37956,105 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Open the scheduler.\n" - } - ] - }, "flags": {}, - "id": 1065, + "id": 1094, "kind": 4096, "kindString": "Call signature", - "modifiers": [], + "modifiers": [ + "async" + ], "name": "open", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The spider that the scheduler is associated with." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 1066, + "id": 1095, "kind": 32768, "kindString": "Parameter", - "name": "spider", + "name": "id", "type": { - "name": "Spider", - "type": "reference" - } - } - ], - "type": { - "name": "Deferred[None] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Deferred", - "typeArguments": [ + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, { "type": "literal", "value": null } ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1067, - "module": "scrapy.scheduler", - "name": "close", - "parsedDocstring": { - "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n", - "args": { - "reason": "The reason for closing the spider." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 70 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the scheduler.\n\nShut down the event loop and its thread gracefully.\n" } - ] - }, - "flags": {}, - "id": 1068, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "close", - "parameters": [ + }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for closing the spider." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 1069, + "id": 1096, "kind": 32768, "kindString": "Parameter", - "name": "reason", + "name": "name", "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if the scheduler has any pending requests.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1070, - "module": "scrapy.scheduler", - "name": "has_pending_requests", - "parsedDocstring": { - "text": "Check if the scheduler has any pending requests.\n", - "returns": "True if the scheduler has any pending requests, False otherwise." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "True if the scheduler has any pending requests, False otherwise." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Check if the scheduler has any pending requests.\n" - } - ] - }, - "flags": {}, - "id": 1071, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "has_pending_requests", - "parameters": [], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1072, - "module": "scrapy.scheduler", - "name": "enqueue_request", - "parsedDocstring": { - "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n", - "args": { - "request": "The request to add to the scheduler.\n" - }, - "returns": "True if the request was successfully enqueued, False otherwise." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 108 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ + "type": "reference", + "name": "str" + }, { - "kind": "text", - "text": "True if the request was successfully enqueued, False otherwise." + "type": "literal", + "value": null } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Add a request to the scheduler.\n\nThis could be called from either from a spider or a downloader middleware (e.g. redirect, retry, ...).\n" + ] } - ] - }, - "flags": {}, - "id": 1073, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "enqueue_request", - "parameters": [ + }, { - "comment": { - "summary": [ + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1097, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "The request to add to the scheduler.\n" + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 1074, + "id": 1098, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "configuration", "type": { - "name": "Request", - "type": "reference" + "name": "Configuration", + "type": "reference", + "target": "328" } } ], "type": { - "name": "bool", + "name": "Self", "type": "reference" } } @@ -37312,73 +38068,101 @@ "summary": [ { "kind": "text", - "text": "Fetch the next request from the scheduler.\n" + "text": "" } ] }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1075, - "module": "scrapy.scheduler", - "name": "next_request", - "parsedDocstring": { - "text": "Fetch the next request from the scheduler.\n", - "returns": "The next request, or None if there are no more requests." - }, - "sources": [ + "decorations": [ { - "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 142 + "name": "override" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The next request, or None if there are no more requests." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Fetch the next request from the scheduler.\n" - } - ] - }, + "flags": {}, + "groups": [], + "id": 1099, + "module": "storage_clients._file_system._dataset_client", + "name": "push_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 53 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { "flags": {}, - "id": 1076, + "id": 1100, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "next_request", - "parameters": [], - "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request" + "modifiers": [ + "async" + ], + "name": "push_data", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false }, - { - "type": "literal", - "value": null + "id": 1101, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "Sequence[Mapping[str, JsonSerializable]] | Mapping[str, JsonSerializable]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Sequence", + "typeArguments": [ + { + "type": "reference", + "name": "Mapping", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "JsonSerializable" + } + ] + } + ] + }, + { + "type": "reference", + "name": "Mapping", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "JsonSerializable" + } + ] + } + ] } - ] + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null } } ] @@ -37388,7 +38172,7 @@ "summary": [ { "kind": "text", - "text": "A Scrapy scheduler that uses the Apify `RequestQueue` to manage requests.\n\nThis scheduler requires the asyncio Twisted reactor to be installed." + "text": "Apify-specific implementation of the `FileSystemDatasetClient`.\n\nIt extends the functionality of `FileSystemDatasetClient` using `DatasetClientPpeMixin` and updates `push_data` to\nlimit and charge for the synthetic `apify-default-dataset-item` event. This is necessary for consistent behavior\nwhen locally testing the `PAY_PER_EVENT` pricing model." } ] }, @@ -37396,105 +38180,36 @@ "groups": [ { "children": [ - 1062, - 1067, - 1072, - 1070, - 1075, - 1064 + 1089, + 1093, + 1099 ], "title": "Methods" } ], - "id": 1061, - "module": "scrapy.scheduler", - "name": "ApifyScheduler", - "parsedDocstring": { - "text": "A Scrapy scheduler that uses the Apify `RequestQueue` to manage requests.\n\nThis scheduler requires the asyncio Twisted reactor to be installed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/scheduler.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 24 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1077, - "module": "scrapy._actor_runner", - "name": "run_scrapy_actor", + "id": 1088, + "module": "storage_clients._file_system._dataset_client", + "name": "ApifyFileSystemDatasetClient", "parsedDocstring": { - "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." + "text": "Apify-specific implementation of the `FileSystemDatasetClient`.\n\nIt extends the functionality of `FileSystemDatasetClient` using `DatasetClientPpeMixin` and updates `push_data` to\nlimit and charge for the synthetic `apify-default-dataset-item` event. This is necessary for consistent behavior\nwhen locally testing the `PAY_PER_EVENT` pricing model." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_actor_runner.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 10 + "fileName": "/src/apify/storage_clients/_file_system/_dataset_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 18 } ], "type": { "name": "Undefined", "type": "reference" }, - "signatures": [ + "extendedTypes": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start Twisted's reactor and execute the provided Actor coroutine.\n\nThis function installs Twisted's asyncio-compatible reactor, then initiates it and runs the given asyncio\ncoroutine (typically the Actor's main) by converting it to a Deferred. This bridges the asyncio and Twisted\nevent loops, enabling the Apify and Scrapy integration to work together." - } - ] - }, - "flags": {}, - "id": 1078, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "run_scrapy_actor", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1079, - "kind": 32768, - "kindString": "Parameter", - "name": "coro", - "type": { - "name": "Coroutine", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } + "name": "DatasetClientPpeMixin", + "target": "1136", + "type": "reference" } ] }, @@ -37512,8 +38227,8 @@ }, "flags": {}, "groups": [], - "id": 1080, - "module": "scrapy._async_thread", + "id": 1102, + "module": "storage_clients._file_system._key_value_store_client", "name": "logger", "parsedDocstring": { "text": "" @@ -37521,9 +38236,9 @@ "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_async_thread.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 17 } ], "type": { @@ -37550,8 +38265,8 @@ "decorations": [], "flags": {}, "groups": [], - "id": 1082, - "module": "scrapy._async_thread", + "id": 1104, + "module": "storage_clients._file_system._key_value_store_client", "name": "__init__", "parsedDocstring": { "text": "" @@ -37559,9 +38274,9 @@ "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_async_thread.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 27 } ], "type": { @@ -37571,12 +38286,55 @@ "signatures": [ { "flags": {}, - "id": 1083, + "id": 1105, "kind": 4096, "kindString": "Call signature", "modifiers": [], "name": "__init__", - "parameters": [], + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1106, + "kind": 32768, + "kindString": "Parameter", + "name": "metadata", + "type": { + "name": "KeyValueStoreMetadata", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1107, + "kind": 32768, + "kindString": "Parameter", + "name": "path_to_kvs", + "type": { + "name": "Path", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1108, + "kind": 32768, + "kindString": "Parameter", + "name": "lock", + "type": { + "name": "asyncio.Lock", + "type": "reference" + } + } + ], "type": { "name": "None", "type": "literal", @@ -37593,30 +38351,32 @@ "summary": [ { "kind": "text", - "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n" + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + }, + { + "name": "classmethod" + } + ], "flags": {}, "groups": [], - "id": 1084, - "module": "scrapy._async_thread", - "name": "run_coro", + "id": 1109, + "module": "storage_clients._file_system._key_value_store_client", + "name": "open", "parsedDocstring": { - "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n", - "args": { - "coro": "The coroutine to run.", - "timeout": "The maximum number of seconds to wait for the coroutine to finish.\n" - }, - "returns": "The result returned by the coroutine." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_async_thread.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 33 + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 41 } ], "type": { @@ -37625,80 +38385,104 @@ }, "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The result returned by the coroutine." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Run a coroutine on an event loop running in a separate thread.\n\nThis method schedules the coroutine to run on the event loop and blocks until the coroutine completes\nor the specified timeout is reached.\n" - } - ] - }, "flags": {}, - "id": 1085, + "id": 1110, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "run_coro", + "modifiers": [ + "async" + ], + "name": "open", "parameters": [ { - "comment": { - "summary": [ + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1111, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "The coroutine to run." + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 1086, + "id": 1112, "kind": 32768, "kindString": "Parameter", - "name": "coro", + "name": "name", "type": { - "name": "Coroutine", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { - "comment": { - "summary": [ + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1113, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "The maximum number of seconds to wait for the coroutine to finish.\n" + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, - "defaultValue": "timedelta(seconds=60)", + } + }, + { "flags": { - "isOptional": true, - "keyword-only": false + "isOptional": false, + "keyword-only": true }, - "id": 1087, + "id": 1114, "kind": 32768, "kindString": "Parameter", - "name": "timeout", + "name": "configuration", "type": { - "name": "timedelta", + "name": "CrawleeConfiguration", "type": "reference" } } ], "type": { - "name": "Any", + "name": "Self", "type": "reference" } } @@ -37712,28 +38496,29 @@ "summary": [ { "kind": "text", - "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n" + "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1088, - "module": "scrapy._async_thread", - "name": "close", + "id": 1115, + "module": "storage_clients._file_system._key_value_store_client", + "name": "purge", "parsedDocstring": { - "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n", - "args": { - "timeout": "The maximum number of seconds to wait for the event loop thread to exit." - } + "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_async_thread.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 70 + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67 } ], "type": { @@ -37746,41 +38531,19 @@ "summary": [ { "kind": "text", - "text": "Close the event loop and its thread gracefully.\n\nThis method cancels all pending tasks, stops the event loop, and waits for the thread to exit.\nIf the thread does not exit within the given timeout, a forced shutdown is attempted.\n" + "text": "Purges the key-value store by deleting all its contents.\n\nIt deletes all files in the key-value store directory, except for the metadata file and\nthe input related file and its metadata." } ] }, "flags": {}, - "id": 1089, + "id": 1116, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "close", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds to wait for the event loop thread to exit." - } - ] - }, - "defaultValue": "timedelta(seconds=60)", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1090, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "timedelta", - "type": "reference" - } - } + "modifiers": [ + "async" ], + "name": "purge", + "parameters": [], "type": { "name": "None", "type": "literal", @@ -37788,50 +38551,7 @@ } } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Class for running an asyncio event loop in a separate thread.\n\nThis allows running asynchronous coroutines from synchronous code by executingthem on an event loop\nthat runs in its own dedicated thread." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1082, - 1088, - 1084 - ], - "title": "Methods" - } - ], - "id": 1081, - "module": "scrapy._async_thread", - "name": "AsyncThread", - "parsedDocstring": { - "text": "Class for running an asyncio event loop in a separate thread.\n\nThis allows running asynchronous coroutines from synchronous code by executingthem on an event loop\nthat runs in its own dedicated thread." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/_async_thread.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 16 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { "kind": 2048, "kindString": "Method", @@ -37840,29 +38560,29 @@ "summary": [ { "kind": "text", - "text": "Create a new instance.\n" + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1092, - "module": "scrapy.middlewares.apify_proxy", - "name": "__init__", + "id": 1117, + "module": "storage_clients._file_system._key_value_store_client", + "name": "get_value", "parsedDocstring": { - "text": "Create a new instance.\n", - "args": { - "proxy_settings": "Dictionary containing proxy settings, provided by the Actor input.", - "auth_encoding": "Encoding for basic authentication (default is 'latin-1')." - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 89 } ], "type": { @@ -37871,52 +38591,91 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new instance.\n" - } - ] - }, "flags": {}, - "id": 1093, + "id": 1118, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "modifiers": [ + "async" + ], + "name": "get_value", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dictionary containing proxy settings, provided by the Actor input." - } - ] - }, "flags": { "isOptional": false, - "keyword-only": false + "keyword-only": true }, - "id": 1094, + "id": 1119, "kind": 32768, "kindString": "Parameter", - "name": "proxy_settings", + "name": "key", "type": { - "name": "dict", + "name": "str", "type": "reference" } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null + } + ], + "type": { + "name": "KeyValueStoreRecord | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreRecord" + }, + { + "type": "literal", + "value": null + } + ] } } ] - }, + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify-specific implementation of the `FileSystemKeyValueStoreClient`.\n\nThe only difference is that it overrides the `purge` method to delete all files in the key-value store\ndirectory, except for the metadata file and the `INPUT.json` file." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1104, + 1117, + 1109, + 1115 + ], + "title": "Methods" + } + ], + "id": 1103, + "module": "storage_clients._file_system._key_value_store_client", + "name": "ApifyFileSystemKeyValueStoreClient", + "parsedDocstring": { + "text": "Apify-specific implementation of the `FileSystemKeyValueStoreClient`.\n\nThe only difference is that it overrides the `purge` method to delete all files in the key-value store\ndirectory, except for the metadata file and the `INPUT.json` file." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ { "kind": 2048, "kindString": "Method", @@ -37925,32 +38684,29 @@ "summary": [ { "kind": "text", - "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class." + "text": "" } ] }, "decorations": [ { - "name": "classmethod" + "name": "override" } ], "flags": {}, "groups": [], - "id": 1095, - "module": "scrapy.middlewares.apify_proxy", - "name": "from_crawler", + "id": 1121, + "module": "storage_clients._file_system._storage_client", + "name": "get_storage_client_cache_key", "parsedDocstring": { - "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class.", - "args": { - "crawler": "Scrapy Crawler object.\n" - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 39 + "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 } ], "type": { @@ -37959,48 +38715,32 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create an instance of ApifyHttpProxyMiddleware from a Scrapy Crawler.\n\n\nReturns: Instance of the class." - } - ] - }, "flags": {}, - "id": 1096, + "id": 1122, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "from_crawler", + "name": "get_storage_client_cache_key", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scrapy Crawler object.\n" - } - ] - }, "flags": { "isOptional": false, "keyword-only": false }, - "id": 1097, + "id": 1123, "kind": 32768, "kindString": "Parameter", - "name": "crawler", + "name": "configuration", "type": { - "name": "Crawler", - "type": "reference" + "name": "Configuration", + "type": "reference", + "target": "328" } } ], "type": { - "name": "ApifyHttpProxyMiddleware", - "type": "reference", - "target": "1091" + "name": "Hashable", + "type": "reference" } } ] @@ -38013,29 +38753,29 @@ "summary": [ { "kind": "text", - "text": "Process a Scrapy request by assigning a new proxy.\n" + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1098, - "module": "scrapy.middlewares.apify_proxy", - "name": "process_request", + "id": 1124, + "module": "storage_clients._file_system._storage_client", + "name": "create_kvs_client", "parsedDocstring": { - "text": "Process a Scrapy request by assigning a new proxy.\n", - "args": { - "request": "Scrapy Request object.", - "spider": "Scrapy Spider object.\n" - } + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67 + "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 } ], "type": { @@ -38044,72 +38784,120 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Process a Scrapy request by assigning a new proxy.\n" - } - ] - }, "flags": {}, - "id": 1099, + "id": 1125, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "process_request", + "name": "create_kvs_client", "parameters": [ { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1126, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "Scrapy Request object." + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1100, + "id": 1127, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "name", "type": { - "name": "Request", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { - "comment": { - "summary": [ + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1128, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "Scrapy Spider object.\n" + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1101, + "id": 1129, "kind": 32768, "kindString": "Parameter", - "name": "spider", + "name": "configuration", "type": { - "name": "Spider", - "type": "reference" + "name": "Configuration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Configuration", + "target": "328" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "None", - "type": "literal", - "value": null + "name": "FileSystemKeyValueStoreClient", + "type": "reference" } } ] @@ -38122,31 +38910,29 @@ "summary": [ { "kind": "text", - "text": "Process an exception that occurs during request processing.\n" + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1102, - "module": "scrapy.middlewares.apify_proxy", - "name": "process_exception", + "id": 1130, + "module": "storage_clients._file_system._storage_client", + "name": "create_dataset_client", "parsedDocstring": { - "text": "Process an exception that occurs during request processing.\n", - "args": { - "request": "Scrapy Request object.", - "exception": "Exception object.", - "spider": "Scrapy Spider object.\n" - }, - "returns": "Returning None, meaning Scrapy will continue processing this exception, executing any other\nprocess_exception() methods of installed middleware, until no middleware is left and the default\nexception handling kicks in." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89 + "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 54 } ], "type": { @@ -38155,254 +38941,121 @@ }, "signatures": [ { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Returning None, meaning Scrapy will continue processing this exception, executing any other\nprocess_exception() methods of installed middleware, until no middleware is left and the default\nexception handling kicks in." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Process an exception that occurs during request processing.\n" - } - ] - }, "flags": {}, - "id": 1103, + "id": 1131, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "process_exception", + "modifiers": [ + "async" + ], + "name": "create_dataset_client", "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scrapy Request object." - } - ] - }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1104, + "id": 1132, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "id", "type": { - "name": "Request", - "type": "reference" - } - }, - { - "comment": { - "summary": [ + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "Exception object." + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1105, + "id": 1133, "kind": 32768, "kindString": "Parameter", - "name": "exception", + "name": "name", "type": { - "name": "Exception", - "type": "reference" - } - }, - { - "comment": { - "summary": [ + "name": "str | None", + "type": "union", + "types": [ { - "kind": "text", - "text": "Scrapy Spider object.\n" + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null } ] - }, + } + }, + { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1106, + "id": 1134, "kind": 32768, "kindString": "Parameter", - "name": "spider", + "name": "alias", "type": { - "name": "Spider", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify HTTP proxy middleware for Scrapy.\n\nThis middleware enhances request processing by adding a 'proxy' field to the request's meta and an authentication\nheader. It draws inspiration from the `HttpProxyMiddleware` included by default in Scrapy projects. The proxy URL\nis sourced from the settings under the `APIFY_PROXY_SETTINGS` key. The value of this key, a dictionary, should be\nprovided by the Actor input. An example of the proxy settings:\n\nproxy_settings = {'useApifyProxy': true, 'apifyProxyGroups': []}" - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1092, - 1095, - 1102, - 1098 - ], - "title": "Methods" - } - ], - "id": 1091, - "module": "scrapy.middlewares.apify_proxy", - "name": "ApifyHttpProxyMiddleware", - "parsedDocstring": { - "text": "Apify HTTP proxy middleware for Scrapy.\n\nThis middleware enhances request processing by adding a 'proxy' field to the request's meta and an authentication\nheader. It draws inspiration from the `HttpProxyMiddleware` included by default in Scrapy projects. The proxy URL\nis sourced from the settings under the `APIFY_PROXY_SETTINGS` key. The value of this key, a dictionary, should be\nprovided by the Actor input. An example of the proxy settings:\n\nproxy_settings = {'useApifyProxy': true, 'apifyProxyGroups': []}" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/middlewares/apify_proxy.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1107, - "module": "scrapy.pipelines.actor_dataset_push", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pushes the provided Scrapy item to the Actor's default dataset." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1109, - "module": "scrapy.pipelines.actor_dataset_push", - "name": "process_item", - "parsedDocstring": { - "text": "Pushes the provided Scrapy item to the Actor's default dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 22 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pushes the provided Scrapy item to the Actor's default dataset." + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } - ] - }, - "flags": {}, - "id": 1110, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "process_item", - "parameters": [ + }, { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1111, + "id": 1135, "kind": 32768, "kindString": "Parameter", - "name": "item", + "name": "configuration", "type": { - "name": "Item", - "type": "reference" + "name": "Configuration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Configuration", + "target": "328" + }, + { + "type": "literal", + "value": null + } + ] } } ], "type": { - "name": "Item", - "type": "reference" + "name": "ApifyFileSystemDatasetClient", + "type": "reference", + "target": "1088" } } ] @@ -38412,7 +39065,7 @@ "summary": [ { "kind": "text", - "text": "A Scrapy pipeline for pushing items to an Actor's default dataset.\n\nThis pipeline is designed to be enabled only when the Scrapy project is run as an Actor." + "text": "Apify-specific implementation of the file system storage client.\n\nThe only difference is that it uses `ApifyFileSystemKeyValueStoreClient` for key-value stores,\nwhich overrides the `purge` method to delete all files in the key-value store directory\nexcept for the metadata file and the `INPUT.json` file." } ] }, @@ -38420,56 +39073,25 @@ "groups": [ { "children": [ - 1109 + 1130, + 1124, + 1121 ], "title": "Methods" } ], - "id": 1108, - "module": "scrapy.pipelines.actor_dataset_push", - "name": "ActorDatasetPushPipeline", - "parsedDocstring": { - "text": "A Scrapy pipeline for pushing items to an Actor's default dataset.\n\nThis pipeline is designed to be enabled only when the Scrapy project is run as an Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 16 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1112, - "module": "scrapy.requests", - "name": "logger", + "id": 1120, + "module": "storage_clients._file_system._storage_client", + "name": "ApifyFileSystemStorageClient", "parsedDocstring": { - "text": "" + "text": "Apify-specific implementation of the file system storage client.\n\nThe only difference is that it uses `ApifyFileSystemKeyValueStoreClient` for key-value stores,\nwhich overrides the `purge` method to delete all files in the key-value store directory\nexcept for the metadata file and the `INPUT.json` file." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/requests.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 18 + "fileName": "/src/apify/storage_clients/_file_system/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 19 } ], "type": { @@ -38478,283 +39100,112 @@ } }, { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Convert a Scrapy request to an Apify request.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1113, - "module": "scrapy.requests", - "name": "to_apify_request", - "parsedDocstring": { - "text": "Convert a Scrapy request to an Apify request.\n", - "args": { - "scrapy_request": "The Scrapy request to be converted.", - "spider": "The Scrapy spider that the request is associated with.\n" - }, - "returns": "The converted Apify request if the conversion was successful, otherwise None." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/requests.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "kind": 128, + "kindString": "Class", + "children": [ { + "kind": 2048, + "kindString": "Method", + "children": [], "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The converted Apify request if the conversion was successful, otherwise None." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Convert a Scrapy request to an Apify request.\n" + "text": "" } ] }, + "decorations": [], "flags": {}, - "id": 1114, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "to_apify_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Scrapy request to be converted." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1115, - "kind": 32768, - "kindString": "Parameter", - "name": "scrapy_request", - "type": { - "name": "ScrapyRequest", - "type": "reference" - } - }, + "groups": [], + "id": 1137, + "module": "storage_clients._ppe_dataset_mixin", + "name": "__init__", + "parsedDocstring": { + "text": "" + }, + "sources": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Scrapy spider that the request is associated with.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1116, - "kind": 32768, - "kindString": "Parameter", - "name": "spider", - "type": { - "name": "Spider", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 15 } ], "type": { - "name": "ApifyRequest | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ApifyRequest" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Convert an Apify request to a Scrapy request.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1117, - "module": "scrapy.requests", - "name": "to_scrapy_request", - "parsedDocstring": { - "text": "Convert an Apify request to a Scrapy request.\n", - "args": { - "apify_request": "The Apify request to be converted.", - "spider": "The Scrapy spider that the request is associated with.\n" - }, - "returns": "The converted Scrapy request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/requests.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 96 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The converted Scrapy request." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Convert an Apify request to a Scrapy request.\n" - } - ] + "name": "Undefined", + "type": "reference" }, - "flags": {}, - "id": 1118, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "to_scrapy_request", - "parameters": [ + "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify request to be converted." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1119, - "kind": 32768, - "kindString": "Parameter", - "name": "apify_request", + "flags": {}, + "id": 1138, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [], "type": { - "name": "ApifyRequest", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Scrapy spider that the request is associated with.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false + "name": "None", + "type": "literal", + "value": null }, - "id": 1120, - "kind": 32768, - "kindString": "Parameter", - "name": "spider", - "type": { - "name": "Spider", + "overwrites": { + "name": "DatasetClientPpeMixin.__init__", + "target": 1137, "type": "reference" } } - ], - "type": { - "name": "ScrapyRequest", - "type": "reference" - } + ] } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + ], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "A mixin for dataset clients to add support for PPE pricing model and tracking synthetic events." } ] }, "flags": {}, - "groups": [], - "id": 1121, - "module": "scrapy.extensions._httpcache", - "name": "logger", + "groups": [ + { + "children": [ + 1137 + ], + "title": "Methods" + } + ], + "id": 1136, + "module": "storage_clients._ppe_dataset_mixin", + "name": "DatasetClientPpeMixin", "parsedDocstring": { - "text": "" + "text": "A mixin for dataset clients to add support for PPE pricing model and tracking synthetic events." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 12 } ], "type": { "name": "Undefined", "type": "reference" - } + }, + "extendedBy": [ + { + "name": "ApifyDatasetClient", + "target": "843", + "type": "reference" + }, + { + "name": "ApifyFileSystemDatasetClient", + "target": "1088", + "type": "reference" + } + ] }, { "kind": 128, @@ -38768,25 +39219,29 @@ "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 1123, - "module": "scrapy.extensions._httpcache", + "id": 1140, + "module": "storage_clients._smart_apify._storage_client", "name": "__init__", "parsedDocstring": { - "text": "" + "text": "Initialize a new instance.\n", + "args": { + "cloud_storage_client": "Storage client used when an Actor is running on the Apify platform, or when\nexplicitly enabled via the `force_cloud` argument. Defaults to `ApifyStorageClient`.", + "local_storage_client": "Storage client used when an Actor is not running on the Apify platform and when\n`force_cloud` flag is not set. Defaults to `FileSystemStorageClient`." + } }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 38 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 } ], "type": { @@ -38795,25 +39250,85 @@ }, "signatures": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, "flags": {}, - "id": 1124, + "id": 1141, "kind": 4096, "kindString": "Call signature", "modifiers": [], "name": "__init__", "parameters": [ { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage client used when an Actor is running on the Apify platform, or when\nexplicitly enabled via the `force_cloud` argument. Defaults to `ApifyStorageClient`." + } + ] + }, + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1125, + "id": 1142, "kind": 32768, "kindString": "Parameter", - "name": "settings", + "name": "cloud_storage_client", "type": { - "name": "BaseSettings", - "type": "reference" + "name": "StorageClient | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageClient" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage client used when an Actor is not running on the Apify platform and when\n`force_cloud` flag is not set. Defaults to `FileSystemStorageClient`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1143, + "kind": 32768, + "kindString": "Parameter", + "name": "local_storage_client", + "type": { + "name": "StorageClient | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageClient" + }, + { + "type": "literal", + "value": null + } + ] } } ], @@ -38833,25 +39348,25 @@ "summary": [ { "kind": "text", - "text": "Open the cache storage for a spider." + "text": "" } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 1126, - "module": "scrapy.extensions._httpcache", - "name": "open_spider", + "id": 1144, + "module": "storage_clients._smart_apify._storage_client", + "name": "__str__", "parsedDocstring": { - "text": "Open the cache storage for a spider." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 46 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 52 } ], "type": { @@ -38860,40 +39375,84 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Open the cache storage for a spider." - } - ] - }, "flags": {}, - "id": 1127, + "id": 1145, "kind": 4096, "kindString": "Call signature", "modifiers": [], - "name": "open_spider", + "name": "__str__", + "parameters": [], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "name": "override" + } + ], + "flags": {}, + "groups": [], + "id": 1146, + "module": "storage_clients._smart_apify._storage_client", + "name": "get_storage_client_cache_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 59 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 1147, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_storage_client_cache_key", "parameters": [ { "flags": { "isOptional": false, "keyword-only": false }, - "id": 1128, + "id": 1148, "kind": 32768, "kindString": "Parameter", - "name": "spider", + "name": "configuration", "type": { - "name": "Spider", + "name": "CrawleeConfiguration", "type": "reference" } } ], "type": { - "name": "None", - "type": "literal", - "value": null + "name": "Hashable", + "type": "reference" } } ] @@ -38906,25 +39465,29 @@ "summary": [ { "kind": "text", - "text": "Close the cache storage for a spider." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1129, - "module": "scrapy.extensions._httpcache", - "name": "close_spider", + "id": 1149, + "module": "storage_clients._smart_apify._storage_client", + "name": "create_dataset_client", "parsedDocstring": { - "text": "Close the cache storage for a spider." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 69 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 68 } ], "type": { @@ -38933,52 +39496,107 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the cache storage for a spider." - } - ] - }, "flags": {}, - "id": 1130, + "id": 1150, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "close_spider", + "modifiers": [ + "async" + ], + "name": "create_dataset_client", "parameters": [ { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1131, + "id": 1151, "kind": 32768, "kindString": "Parameter", - "name": "_", + "name": "id", "type": { - "name": "Spider", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { "defaultValue": "None", "flags": { "isOptional": true, - "keyword-only": false + "keyword-only": true }, - "id": 1132, + "id": 1152, "kind": 32768, "kindString": "Parameter", - "name": "current_time", + "name": "name", "type": { - "name": "int | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1153, + "kind": 32768, + "kindString": "Parameter", + "name": "alias", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1154, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "CrawleeConfiguration" }, { "type": "literal", @@ -38989,9 +39607,8 @@ } ], "type": { - "name": "None", - "type": "literal", - "value": null + "name": "DatasetClient", + "type": "reference" } } ] @@ -39004,25 +39621,29 @@ "summary": [ { "kind": "text", - "text": "Retrieve a response from the cache storage." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1133, - "module": "scrapy.extensions._httpcache", - "name": "retrieve_response", + "id": 1155, + "module": "storage_clients._smart_apify._storage_client", + "name": "create_kvs_client", "parsedDocstring": { - "text": "Retrieve a response from the cache storage." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 112 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81 } ], "type": { @@ -39031,66 +39652,107 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a response from the cache storage." - } - ] - }, "flags": {}, - "id": 1134, + "id": 1156, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "retrieve_response", + "modifiers": [ + "async" + ], + "name": "create_kvs_client", "parameters": [ { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1135, + "id": 1157, "kind": 32768, "kindString": "Parameter", - "name": "_", + "name": "id", "type": { - "name": "Spider", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1136, + "id": 1158, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "name", "type": { - "name": "Request", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { "defaultValue": "None", "flags": { "isOptional": true, - "keyword-only": false + "keyword-only": true }, - "id": 1137, + "id": 1159, "kind": 32768, "kindString": "Parameter", - "name": "current_time", + "name": "alias", "type": { - "name": "int | None", + "name": "str | None", "type": "union", "types": [ { "type": "reference", - "name": "int" + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1160, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "CrawleeConfiguration" }, { "type": "literal", @@ -39101,18 +39763,8 @@ } ], "type": { - "name": "Response | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Response" - }, - { - "type": "literal", - "value": null - } - ] + "name": "KeyValueStoreClient", + "type": "reference" } } ] @@ -39125,25 +39777,29 @@ "summary": [ { "kind": "text", - "text": "Store a response in the cache storage." + "text": "" } ] }, - "decorations": [], + "decorations": [ + { + "name": "override" + } + ], "flags": {}, "groups": [], - "id": 1138, - "module": "scrapy.extensions._httpcache", - "name": "store_response", + "id": 1161, + "module": "storage_clients._smart_apify._storage_client", + "name": "create_rq_client", "parsedDocstring": { - "text": "Store a response in the cache storage." + "text": "" }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 144 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 } ], "type": { @@ -39152,518 +39808,255 @@ }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Store a response in the cache storage." - } - ] - }, "flags": {}, - "id": 1139, + "id": 1162, "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "store_response", + "modifiers": [ + "async" + ], + "name": "create_rq_client", "parameters": [ { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1140, + "id": 1163, "kind": 32768, "kindString": "Parameter", - "name": "_", + "name": "id", "type": { - "name": "Spider", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1141, + "id": 1164, "kind": 32768, "kindString": "Parameter", - "name": "request", + "name": "name", "type": { - "name": "Request", - "type": "reference" + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] } }, { + "defaultValue": "None", "flags": { - "isOptional": false, - "keyword-only": false + "isOptional": true, + "keyword-only": true }, - "id": 1142, + "id": 1165, "kind": 32768, "kindString": "Parameter", - "name": "response", + "name": "alias", "type": { - "name": "Response", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Scrapy cache storage that uses the Apify `KeyValueStore` to store responses.\n\nIt can be set as a storage for Scrapy's built-in `HttpCacheMiddleware`, which caches\nresponses to requests. See HTTPCache middleware settings (prefixed with `HTTPCACHE_`)\nin the Scrapy documentation for more information. Requires the asyncio Twisted reactor\nto be installed." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1123, - 1129, - 1126, - 1133, - 1138 - ], - "title": "Methods" - } - ], - "id": 1122, - "module": "scrapy.extensions._httpcache", - "name": "ApifyCacheStorage", - "parsedDocstring": { - "text": "A Scrapy cache storage that uses the Apify `KeyValueStore` to store responses.\n\nIt can be set as a storage for Scrapy's built-in `HttpCacheMiddleware`, which caches\nresponses to requests. See HTTPCache middleware settings (prefixed with `HTTPCACHE_`)\nin the Scrapy documentation for more information. Requires the asyncio Twisted reactor\nto be installed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dump a dictionary to a gzip-compressed byte stream." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1143, - "module": "scrapy.extensions._httpcache", - "name": "to_gzip", - "parsedDocstring": { - "text": "Dump a dictionary to a gzip-compressed byte stream." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 164 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dump a dictionary to a gzip-compressed byte stream." - } - ] - }, - "flags": {}, - "id": 1144, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "to_gzip", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1145, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "dict", - "type": "reference" - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1146, - "kind": 32768, - "kindString": "Parameter", - "name": "mtime", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Load a dictionary from a gzip-compressed byte stream." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1147, - "module": "scrapy.extensions._httpcache", - "name": "from_gzip", - "parsedDocstring": { - "text": "Load a dictionary from a gzip-compressed byte stream." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 172 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Load a dictionary from a gzip-compressed byte stream." - } - ] - }, - "flags": {}, - "id": 1148, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "from_gzip", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1149, - "kind": 32768, - "kindString": "Parameter", - "name": "gzip_bytes", + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1166, + "kind": 32768, + "kindString": "Parameter", + "name": "configuration", + "type": { + "name": "CrawleeConfiguration | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "CrawleeConfiguration" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], "type": { - "name": "bytes", + "name": "RequestQueueClient", "type": "reference" } } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1150, - "module": "scrapy.extensions._httpcache", - "name": "read_gzip_time", - "parsedDocstring": { - "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + ] + }, { + "kind": 2048, + "kindString": "Method", + "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Read the modification time from a gzip-compressed byte stream without decompressing the data." + "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n" } ] }, + "decorations": [], "flags": {}, - "id": 1151, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "read_gzip_time", - "parameters": [ + "groups": [], + "id": 1167, + "module": "storage_clients._smart_apify._storage_client", + "name": "get_suitable_storage_client", + "parsedDocstring": { + "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n", + "args": { + "force_cloud": "If True, return `cloud_storage_client`." + } + }, + "sources": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1152, - "kind": 32768, - "kindString": "Parameter", - "name": "gzip_bytes", - "type": { - "name": "bytes", - "type": "reference" - } + "character": 1, + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106 } ], "type": { - "name": "int", + "name": "Undefined", "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1153, - "module": "scrapy.extensions._httpcache", - "name": "get_kvs_name", - "parsedDocstring": { - "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n", - "args": { - "spider_name": "Value of the Spider instance's name attribute.", - "max_length": "Maximum length of the key value store name.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify/scrapy/extensions/_httpcache.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 187 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the key value store name for a spider.\n\nThe key value store name is derived from the spider name by replacing all special characters\nwith hyphens and trimming leading and trailing hyphens. The resulting name is prefixed with\n'httpcache-' and truncated to the maximum length.\n\nThe documentation\n[about storages](https://docs.apify.com/platform/storage/usage#named-and-unnamed-storages)\nmentions that names can be up to 63 characters long, so the default max length is set to 60.\n\nSuch naming isn't unique per spider, but should be sufficiently unique for most use cases.\nThe name of the key value store should indicate to which spider it belongs, e.g. in\nthe listing in the Apify's console.\n\n\nReturns: Key value store name.\n" - } - ] }, - "flags": {}, - "id": 1154, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_kvs_name", - "parameters": [ + "signatures": [ { "comment": { "summary": [ { "kind": "text", - "text": "Value of the Spider instance's name attribute." + "text": "Get a suitable storage client based on the global configuration and the value of the force_cloud flag.\n" } ] }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1155, - "kind": 32768, - "kindString": "Parameter", - "name": "spider_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum length of the key value store name.\n" + "flags": {}, + "id": 1168, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_suitable_storage_client", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, return `cloud_storage_client`." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1169, + "kind": 32768, + "kindString": "Parameter", + "name": "force_cloud", + "type": { + "name": "bool", + "type": "reference" } - ] - }, - "defaultValue": "60", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1156, - "kind": 32768, - "kindString": "Parameter", - "name": "max_length", + } + ], "type": { - "name": "int", + "name": "StorageClient", "type": "reference" } } - ], - "type": { - "name": "str", - "type": "reference" - } + ] } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], + ], "comment": { "summary": [ { "kind": "text", - "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." + "text": "Storage client that automatically selects cloud or local storage client based on the environment.\n\nThis storage client provides access to datasets, key-value stores, and request queues by intelligently\ndelegating to either the cloud or local storage client based on the execution environment and configuration.\n\nWhen running on the Apify platform (which is detected via environment variables), this client automatically\nuses the `cloud_storage_client` to store storage data there. When running locally, it uses the\n`local_storage_client` to store storage data there. You can also force cloud storage usage from your\nlocal machine by using the `force_cloud` argument.\n\nThis storage client is designed to work specifically in `Actor` context and provides a seamless development\nexperience where the same code works both locally and on the Apify platform without any changes." } ] }, - "decorations": [], + "decorations": [ + { + "args": "('Storage clients')", + "name": "docs_group" + } + ], "flags": {}, - "groups": [], - "id": 1157, - "module": "scrapy._logging_config", - "name": "initialize_logging", + "groups": [ + { + "children": [ + 1140, + 1144, + 1149, + 1155, + 1161, + 1146, + 1167 + ], + "title": "Methods" + } + ], + "id": 1139, + "module": "storage_clients._smart_apify._storage_client", + "name": "SmartApifyStorageClient", "parsedDocstring": { - "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." + "text": "Storage client that automatically selects cloud or local storage client based on the environment.\n\nThis storage client provides access to datasets, key-value stores, and request queues by intelligently\ndelegating to either the cloud or local storage client based on the execution environment and configuration.\n\nWhen running on the Apify platform (which is detected via environment variables), this client automatically\nuses the `cloud_storage_client` to store storage data there. When running locally, it uses the\n`local_storage_client` to store storage data there. You can also force cloud storage usage from your\nlocal machine by using the `force_cloud` argument.\n\nThis storage client is designed to work specifically in `Actor` context and provides a seamless development\nexperience where the same code works both locally and on the Apify platform without any changes." }, "sources": [ { "character": 1, - "fileName": "/src/apify/scrapy/_logging_config.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "fileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "type": { "name": "Undefined", "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configure logging for Apify Actors and adjust Scrapy's logging settings." - } - ] - }, - "flags": {}, - "id": 1158, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "initialize_logging", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] + } }, { "kind": 128, @@ -39691,7 +40084,7 @@ ], "flags": {}, "groups": [], - "id": 4876, + "id": 4095, "module": "storages._base", "name": "id", "parsedDocstring": { @@ -39701,9 +40094,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L20" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L20" } ], "type": { @@ -39713,7 +40106,7 @@ "ref": {} }, "permalink": "/python/api/class/Storage#id", - "parentId": 3680 + "parentId": 2888 }, { "kind": 1024, @@ -39737,7 +40130,7 @@ ], "flags": {}, "groups": [], - "id": 4877, + "id": 4096, "module": "storages._base", "name": "name", "parsedDocstring": { @@ -39747,9 +40140,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 25, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L25" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L25" } ], "type": { @@ -39769,7 +40162,7 @@ ] }, "permalink": "/python/api/class/Storage#name", - "parentId": 3680 + "parentId": 2888 }, { "kind": 2048, @@ -39790,7 +40183,7 @@ ], "flags": {}, "groups": [], - "id": 4878, + "id": 4097, "module": "storages._base", "name": "get_metadata", "parsedDocstring": { @@ -39800,9 +40193,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L29" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L29" } ], "type": { @@ -39822,7 +40215,7 @@ ] }, "flags": {}, - "id": 4879, + "id": 4098, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -39840,15 +40233,15 @@ { "type": "reference", "name": "DatasetMetadata", - "target": "3639", + "target": "1709", "ref": { - "id": 4834, + "id": 2915, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 128, @@ -39858,15 +40251,15 @@ { "type": "reference", "name": "KeyValueStoreMetadata", - "target": "3642", + "target": "1712", "ref": { - "id": 4837, + "id": 2918, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "kind": 128, @@ -39878,15 +40271,15 @@ { "type": "reference", "name": "RequestQueueMetadata", - "target": "3644", + "target": "1714", "ref": { - "id": 4839, + "id": 2920, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "kind": 128, @@ -39897,15 +40290,15 @@ }, "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 4878, + "id": 4097, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -39913,11 +40306,11 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#get_metadata" } }, - "parentId": 3683 + "parentId": 2891 } ], "permalink": "/python/api/class/Storage#get_metadata", - "parentId": 3680 + "parentId": 2888 }, { "kind": 2048, @@ -39941,7 +40334,7 @@ ], "flags": {}, "groups": [], - "id": 4880, + "id": 4099, "module": "storages._base", "name": "open", "parsedDocstring": { @@ -39958,9 +40351,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L34" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L34" } ], "type": { @@ -39980,7 +40373,7 @@ ] }, "flags": {}, - "id": 4881, + "id": 4100, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -40002,7 +40395,7 @@ "isOptional": true, "keyword-only": true }, - "id": 4882, + "id": 4101, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -40022,7 +40415,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -40038,7 +40431,7 @@ "isOptional": true, "keyword-only": true }, - "id": 4883, + "id": 4102, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -40058,7 +40451,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -40074,7 +40467,7 @@ "isOptional": true, "keyword-only": true }, - "id": 4884, + "id": 4103, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -40094,7 +40487,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -40110,7 +40503,7 @@ "isOptional": true, "keyword-only": true }, - "id": 4885, + "id": 4104, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -40121,14 +40514,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 1430, + "id": 1589, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -40142,7 +40535,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -40158,7 +40551,7 @@ "isOptional": true, "keyword-only": true }, - "id": 4886, + "id": 4105, "kind": 32768, "kindString": "Parameter", "name": "storage_client", @@ -40169,14 +40562,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 3979, + "id": 3621, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -40190,20 +40583,20 @@ } ] }, - "parentId": 3686 + "parentId": 2894 } ], "type": { "name": "Storage", "type": "reference", - "target": "3680", + "target": "2888", "ref": { - "id": 4875, + "id": 4094, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -40213,15 +40606,15 @@ }, "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 4880, + "id": 4099, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -40229,11 +40622,11 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#open" } }, - "parentId": 3685 + "parentId": 2893 } ], "permalink": "/python/api/class/Storage#open", - "parentId": 3680 + "parentId": 2888 }, { "kind": 2048, @@ -40254,7 +40647,7 @@ ], "flags": {}, "groups": [], - "id": 4887, + "id": 4106, "module": "storages._base", "name": "drop", "parsedDocstring": { @@ -40264,9 +40657,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 57, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L57" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L57" } ], "type": { @@ -40286,7 +40679,7 @@ ] }, "flags": {}, - "id": 4888, + "id": 4107, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -40301,15 +40694,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 3535, + "id": 3845, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -40317,11 +40710,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 3692 + "parentId": 2900 } ], "permalink": "/python/api/class/Storage#drop", - "parentId": 3680 + "parentId": 2888 }, { "kind": 2048, @@ -40342,7 +40735,7 @@ ], "flags": {}, "groups": [], - "id": 4889, + "id": 4108, "module": "storages._base", "name": "purge", "parsedDocstring": { @@ -40352,9 +40745,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 61, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L61" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L61" } ], "type": { @@ -40374,7 +40767,7 @@ ] }, "flags": {}, - "id": 4890, + "id": 4109, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -40388,28 +40781,28 @@ "value": {} }, "overwrites": { - "name": "Storage.purge", - "target": 3694, + "name": "RequestManager.purge", + "target": 2641, "type": "reference", "ref": { - "id": 4889, + "id": 3847, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "kind": 2048, - "permalink": "https://crawlee.dev/python/api/class/Storage#purge" + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" } }, - "parentId": 3694 + "parentId": 2902 } ], "permalink": "/python/api/class/Storage#purge", - "parentId": 3680 + "parentId": 2888 } ], "comment": { @@ -40430,22 +40823,22 @@ "groups": [ { "children": [ - 4887, - 4878, - 4880, - 4889 + 4106, + 4097, + 4099, + 4108 ], "title": "Methods" }, { "children": [ - 4876, - 4877 + 4095, + 4096 ], "title": "Properties" } ], - "id": 4875, + "id": 4094, "module": "storages._base", "name": "Storage", "parsedDocstring": { @@ -40455,9 +40848,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_base.py#L15" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_base.py#L15" } ], "type": { @@ -40469,15 +40862,15 @@ "extendedBy": [ { "name": "KeyValueStore", - "target": "3700", + "target": "2663", "type": "reference", "ref": { - "id": 4895, + "id": 3869, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40 } ], @@ -40486,39 +40879,39 @@ } }, { - "name": "Dataset", - "target": "3766", + "name": "RequestQueue", + "target": "2726", "type": "reference", "ref": { - "id": 4961, + "id": 3932, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "fileName": "/src/crawlee/storages/_request_queue.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/Dataset" + "permalink": "https://crawlee.dev/python/api/class/RequestQueue" } }, { - "name": "RequestQueue", - "target": "3852", + "name": "Dataset", + "target": "2804", "type": "reference", "ref": { - "id": 5047, + "id": 4010, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "fileName": "/src/crawlee/storages/_dataset.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/RequestQueue" + "permalink": "https://crawlee.dev/python/api/class/Dataset" } } ], @@ -40544,7 +40937,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8814, + "id": 6914, "module": "storages._dataset", "name": "__init__", "parsedDocstring": { @@ -40559,9 +40952,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 69, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L69" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L69" } ], "type": { @@ -40581,7 +40974,7 @@ ] }, "flags": {}, - "id": 8815, + "id": 6915, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -40600,29 +40993,29 @@ "isOptional": false, "keyword-only": false }, - "id": 8816, + "id": 6916, "kind": 32768, "kindString": "Parameter", "name": "client", "type": { "name": "DatasetClient", "type": "reference", - "target": "2808", + "target": "2381", "ref": { - "id": 7855, + "id": 6490, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 128, "permalink": "https://crawlee.dev/python/api/class/DatasetClient" } }, - "parentId": 3768 + "parentId": 2806 }, { "comment": { @@ -40637,7 +41030,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8817, + "id": 6917, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -40647,7 +41040,7 @@ "target": 0, "ref": {} }, - "parentId": 3768 + "parentId": 2806 }, { "comment": { @@ -40662,7 +41055,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8818, + "id": 6918, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -40682,7 +41075,7 @@ } ] }, - "parentId": 3768 + "parentId": 2806 } ], "type": { @@ -40690,11 +41083,11 @@ "type": "literal", "value": {} }, - "parentId": 3767 + "parentId": 2805 } ], "permalink": "/python/api/class/Dataset#__init__", - "parentId": 3766 + "parentId": 2804 }, { "kind": 1024, @@ -40718,7 +41111,7 @@ ], "flags": {}, "groups": [], - "id": 8819, + "id": 6919, "module": "storages._base", "name": "id", "parsedDocstring": { @@ -40728,9 +41121,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 87, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L87" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L87" } ], "type": { @@ -40741,15 +41134,15 @@ }, "overwrites": { "name": "Storage.id", - "target": 3681, + "target": 2889, "type": "reference", "ref": { - "id": 8728, + "id": 6998, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -40758,7 +41151,7 @@ } }, "permalink": "/python/api/class/Dataset#id", - "parentId": 3766 + "parentId": 2804 }, { "kind": 1024, @@ -40782,7 +41175,7 @@ ], "flags": {}, "groups": [], - "id": 8820, + "id": 6920, "module": "storages._base", "name": "name", "parsedDocstring": { @@ -40792,9 +41185,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 92, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L92" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L92" } ], "type": { @@ -40815,15 +41208,15 @@ }, "overwrites": { "name": "Storage.name", - "target": 3682, + "target": 2890, "type": "reference", "ref": { - "id": 8729, + "id": 6999, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 25 } ], @@ -40832,7 +41225,7 @@ } }, "permalink": "/python/api/class/Dataset#name", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -40853,7 +41246,7 @@ ], "flags": {}, "groups": [], - "id": 8821, + "id": 6921, "module": "storages._base", "name": "get_metadata", "parsedDocstring": { @@ -40863,9 +41256,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 96, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L96" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L96" } ], "type": { @@ -40885,7 +41278,7 @@ ] }, "flags": {}, - "id": 8731, + "id": 7001, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -40903,15 +41296,15 @@ { "type": "reference", "name": "DatasetMetadata", - "target": "3639", + "target": "1709", "ref": { - "id": 8686, + "id": 5818, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 128, @@ -40921,15 +41314,15 @@ { "type": "reference", "name": "KeyValueStoreMetadata", - "target": "3642", + "target": "1712", "ref": { - "id": 8689, + "id": 5821, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "kind": 128, @@ -40941,15 +41334,15 @@ { "type": "reference", "name": "RequestQueueMetadata", - "target": "3644", + "target": "1714", "ref": { - "id": 8691, + "id": 5823, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "kind": 128, @@ -40960,15 +41353,15 @@ }, "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 8730, + "id": 7000, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -40976,20 +41369,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#get_metadata" } }, - "parentId": 3774 + "parentId": 2812 } ], "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 8730, + "id": 7000, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -40998,7 +41391,7 @@ } }, "permalink": "/python/api/class/Dataset#get_metadata", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -41022,7 +41415,7 @@ ], "flags": {}, "groups": [], - "id": 8823, + "id": 6923, "module": "storages._base", "name": "open", "parsedDocstring": { @@ -41039,9 +41432,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 101, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L101" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L101" } ], "type": { @@ -41061,7 +41454,7 @@ ] }, "flags": {}, - "id": 8733, + "id": 7003, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -41083,7 +41476,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8734, + "id": 7004, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -41103,7 +41496,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -41119,7 +41512,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8735, + "id": 7005, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -41139,7 +41532,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -41155,7 +41548,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8736, + "id": 7006, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -41175,7 +41568,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -41191,7 +41584,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8737, + "id": 7007, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -41202,14 +41595,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 5282, + "id": 4492, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -41223,7 +41616,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -41239,7 +41632,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8738, + "id": 7008, "kind": 32768, "kindString": "Parameter", "name": "storage_client", @@ -41250,14 +41643,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 7831, + "id": 6524, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -41271,20 +41664,20 @@ } ] }, - "parentId": 3686 + "parentId": 2894 } ], "type": { "name": "Storage", "type": "reference", - "target": "3680", + "target": "2888", "ref": { - "id": 8727, + "id": 6997, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -41294,15 +41687,15 @@ }, "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 8732, + "id": 7002, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -41310,20 +41703,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#open" } }, - "parentId": 3776 + "parentId": 2814 } ], "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 8732, + "id": 7002, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -41332,7 +41725,7 @@ } }, "permalink": "/python/api/class/Dataset#open", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -41353,7 +41746,7 @@ ], "flags": {}, "groups": [], - "id": 8830, + "id": 6930, "module": "storages._base", "name": "drop", "parsedDocstring": { @@ -41363,9 +41756,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 128, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L128" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L128" } ], "type": { @@ -41385,7 +41778,7 @@ ] }, "flags": {}, - "id": 8740, + "id": 7010, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -41400,15 +41793,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 7387, + "id": 6748, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -41416,20 +41809,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 3783 + "parentId": 2821 } ], "overwrites": { "name": "Storage.drop", - "target": 3692, + "target": 2900, "type": "reference", "ref": { - "id": 8739, + "id": 7009, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 57 } ], @@ -41438,7 +41831,7 @@ } }, "permalink": "/python/api/class/Dataset#drop", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -41459,7 +41852,7 @@ ], "flags": {}, "groups": [], - "id": 8832, + "id": 6932, "module": "storages._base", "name": "purge", "parsedDocstring": { @@ -41469,9 +41862,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 134, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L134" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L134" } ], "type": { @@ -41491,7 +41884,7 @@ ] }, "flags": {}, - "id": 8742, + "id": 7012, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -41505,37 +41898,37 @@ "value": {} }, "overwrites": { - "name": "Storage.purge", - "target": 3694, + "name": "RequestManager.purge", + "target": 2641, "type": "reference", "ref": { - "id": 8741, + "id": 6750, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "kind": 2048, - "permalink": "https://crawlee.dev/python/api/class/Storage#purge" + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" } }, - "parentId": 3785 + "parentId": 2823 } ], "overwrites": { "name": "Storage.purge", - "target": 3694, + "target": 2902, "type": "reference", "ref": { - "id": 8741, + "id": 7011, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 61 } ], @@ -41544,7 +41937,7 @@ } }, "permalink": "/python/api/class/Dataset#purge", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -41561,7 +41954,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8834, + "id": 6934, "module": "storages._dataset", "name": "push_data", "parsedDocstring": { @@ -41574,9 +41967,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 137, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L137" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L137" } ], "type": { @@ -41596,7 +41989,7 @@ ] }, "flags": {}, - "id": 8835, + "id": 6935, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -41617,21 +42010,21 @@ "isOptional": false, "keyword-only": false }, - "id": 8836, + "id": 6936, "kind": 32768, "kindString": "Parameter", "name": "data", "type": { - "name": "list[dict[str, Any]] | dict[str, Any]", + "name": "Sequence[Mapping[str, JsonSerializable]] | Mapping[str, JsonSerializable]", "type": "union", "types": [ { "type": "reference", - "name": "list", + "name": "Sequence", "typeArguments": [ { "type": "reference", - "name": "dict", + "name": "Mapping", "typeArguments": [ { "type": "reference", @@ -41641,7 +42034,7 @@ }, { "type": "reference", - "name": "Any", + "name": "JsonSerializable", "target": 0, "ref": {} } @@ -41655,7 +42048,7 @@ }, { "type": "reference", - "name": "dict", + "name": "Mapping", "typeArguments": [ { "type": "reference", @@ -41665,7 +42058,7 @@ }, { "type": "reference", - "name": "Any", + "name": "JsonSerializable", "target": 0, "ref": {} } @@ -41675,7 +42068,7 @@ } ] }, - "parentId": 3788 + "parentId": 2826 } ], "type": { @@ -41683,11 +42076,11 @@ "type": "literal", "value": {} }, - "parentId": 3787 + "parentId": 2825 } ], "permalink": "/python/api/class/Dataset#push_data", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -41704,7 +42097,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8837, + "id": 6937, "module": "storages._dataset", "name": "get_data", "parsedDocstring": { @@ -41728,9 +42121,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 150, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L150" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L150" } ], "type": { @@ -41761,7 +42154,7 @@ ] }, "flags": {}, - "id": 8838, + "id": 6938, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -41783,7 +42176,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8839, + "id": 6939, "kind": 32768, "kindString": "Parameter", "name": "offset", @@ -41793,7 +42186,7 @@ "target": 0, "ref": {} }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41809,7 +42202,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8840, + "id": 6940, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -41829,7 +42222,7 @@ } ] }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41845,7 +42238,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8841, + "id": 6941, "kind": 32768, "kindString": "Parameter", "name": "clean", @@ -41855,7 +42248,7 @@ "target": 0, "ref": {} }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41871,7 +42264,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8842, + "id": 6942, "kind": 32768, "kindString": "Parameter", "name": "desc", @@ -41881,7 +42274,7 @@ "target": 0, "ref": {} }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41897,7 +42290,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8843, + "id": 6943, "kind": 32768, "kindString": "Parameter", "name": "fields", @@ -41925,7 +42318,7 @@ } ] }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41941,7 +42334,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8844, + "id": 6944, "kind": 32768, "kindString": "Parameter", "name": "omit", @@ -41969,7 +42362,7 @@ } ] }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -41985,7 +42378,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8845, + "id": 6945, "kind": 32768, "kindString": "Parameter", "name": "unwind", @@ -42013,7 +42406,7 @@ } ] }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -42029,7 +42422,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8846, + "id": 6946, "kind": 32768, "kindString": "Parameter", "name": "skip_empty", @@ -42039,7 +42432,7 @@ "target": 0, "ref": {} }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -42055,7 +42448,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8847, + "id": 6947, "kind": 32768, "kindString": "Parameter", "name": "skip_hidden", @@ -42065,7 +42458,7 @@ "target": 0, "ref": {} }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -42081,7 +42474,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8848, + "id": 6948, "kind": 32768, "kindString": "Parameter", "name": "flatten", @@ -42109,7 +42502,7 @@ } ] }, - "parentId": 3791 + "parentId": 2829 }, { "comment": { @@ -42125,7 +42518,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8849, + "id": 6949, "kind": 32768, "kindString": "Parameter", "name": "view", @@ -42145,32 +42538,32 @@ } ] }, - "parentId": 3791 + "parentId": 2829 } ], "type": { "name": "DatasetItemsListPage", "type": "reference", - "target": "3658", + "target": "1728", "ref": { - "id": 8705, + "id": 5837, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 110 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 } ], "kind": 128, "permalink": "https://crawlee.dev/python/api/class/DatasetItemsListPage" } }, - "parentId": 3790 + "parentId": 2828 } ], "permalink": "/python/api/class/Dataset#get_data", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -42187,7 +42580,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8850, + "id": 6950, "module": "storages._dataset", "name": "iterate_items", "parsedDocstring": { @@ -42208,9 +42601,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 201, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L201" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L201" } ], "type": { @@ -42230,7 +42623,7 @@ ] }, "flags": {}, - "id": 8851, + "id": 6951, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -42252,7 +42645,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8852, + "id": 6952, "kind": 32768, "kindString": "Parameter", "name": "offset", @@ -42262,7 +42655,7 @@ "target": 0, "ref": {} }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42278,7 +42671,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8853, + "id": 6953, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -42298,7 +42691,7 @@ } ] }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42314,7 +42707,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8854, + "id": 6954, "kind": 32768, "kindString": "Parameter", "name": "clean", @@ -42324,7 +42717,7 @@ "target": 0, "ref": {} }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42340,7 +42733,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8855, + "id": 6955, "kind": 32768, "kindString": "Parameter", "name": "desc", @@ -42350,7 +42743,7 @@ "target": 0, "ref": {} }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42366,7 +42759,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8856, + "id": 6956, "kind": 32768, "kindString": "Parameter", "name": "fields", @@ -42394,7 +42787,7 @@ } ] }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42410,7 +42803,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8857, + "id": 6957, "kind": 32768, "kindString": "Parameter", "name": "omit", @@ -42438,7 +42831,7 @@ } ] }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42454,7 +42847,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8858, + "id": 6958, "kind": 32768, "kindString": "Parameter", "name": "unwind", @@ -42482,7 +42875,7 @@ } ] }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42498,7 +42891,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8859, + "id": 6959, "kind": 32768, "kindString": "Parameter", "name": "skip_empty", @@ -42508,7 +42901,7 @@ "target": 0, "ref": {} }, - "parentId": 3804 + "parentId": 2842 }, { "comment": { @@ -42524,7 +42917,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8860, + "id": 6960, "kind": 32768, "kindString": "Parameter", "name": "skip_hidden", @@ -42534,7 +42927,7 @@ "target": 0, "ref": {} }, - "parentId": 3804 + "parentId": 2842 } ], "type": { @@ -42543,7 +42936,7 @@ "typeArguments": [ { "type": "reference", - "name": "dict", + "name": "Mapping", "typeArguments": [ { "type": "reference", @@ -42553,7 +42946,7 @@ }, { "type": "reference", - "name": "Any", + "name": "JsonSerializable", "target": 0, "ref": {} } @@ -42565,11 +42958,11 @@ "target": 0, "ref": {} }, - "parentId": 3803 + "parentId": 2841 } ], "permalink": "/python/api/class/Dataset#iterate_items", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -42586,7 +42979,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8861, + "id": 6961, "module": "storages._dataset", "name": "list_items", "parsedDocstring": { @@ -42608,9 +43001,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 249, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L249" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L249" } ], "type": { @@ -42641,7 +43034,7 @@ ] }, "flags": {}, - "id": 8862, + "id": 6962, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -42663,7 +43056,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8863, + "id": 6963, "kind": 32768, "kindString": "Parameter", "name": "offset", @@ -42673,7 +43066,7 @@ "target": 0, "ref": {} }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42689,7 +43082,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8864, + "id": 6964, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -42709,7 +43102,7 @@ } ] }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42725,7 +43118,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8865, + "id": 6965, "kind": 32768, "kindString": "Parameter", "name": "clean", @@ -42735,7 +43128,7 @@ "target": 0, "ref": {} }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42751,7 +43144,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8866, + "id": 6966, "kind": 32768, "kindString": "Parameter", "name": "desc", @@ -42761,7 +43154,7 @@ "target": 0, "ref": {} }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42777,7 +43170,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8867, + "id": 6967, "kind": 32768, "kindString": "Parameter", "name": "fields", @@ -42805,7 +43198,7 @@ } ] }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42821,7 +43214,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8868, + "id": 6968, "kind": 32768, "kindString": "Parameter", "name": "omit", @@ -42849,7 +43242,7 @@ } ] }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42865,7 +43258,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8869, + "id": 6969, "kind": 32768, "kindString": "Parameter", "name": "unwind", @@ -42893,7 +43286,7 @@ } ] }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42909,7 +43302,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8870, + "id": 6970, "kind": 32768, "kindString": "Parameter", "name": "skip_empty", @@ -42919,7 +43312,7 @@ "target": 0, "ref": {} }, - "parentId": 3815 + "parentId": 2853 }, { "comment": { @@ -42935,7 +43328,7 @@ "isOptional": true, "keyword-only": true }, - "id": 8871, + "id": 6971, "kind": 32768, "kindString": "Parameter", "name": "skip_hidden", @@ -42945,7 +43338,7 @@ "target": 0, "ref": {} }, - "parentId": 3815 + "parentId": 2853 } ], "type": { @@ -42954,7 +43347,7 @@ "typeArguments": [ { "type": "reference", - "name": "dict", + "name": "Mapping", "typeArguments": [ { "type": "reference", @@ -42964,7 +43357,7 @@ }, { "type": "reference", - "name": "Any", + "name": "JsonSerializable", "target": 0, "ref": {} } @@ -42976,11 +43369,11 @@ "target": 0, "ref": {} }, - "parentId": 3814 + "parentId": 2852 } ], "permalink": "/python/api/class/Dataset#list_items", - "parentId": 3766 + "parentId": 2804 }, { "kind": 2048, @@ -42997,7 +43390,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 8872, + "id": 6972, "module": "storages._dataset", "name": "export_to", "parsedDocstring": { @@ -43016,9 +43409,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 323, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L323" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L323" } ], "type": { @@ -43038,7 +43431,7 @@ ] }, "flags": {}, - "id": 8873, + "id": 6973, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -43059,7 +43452,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8874, + "id": 6974, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -43069,7 +43462,7 @@ "target": 0, "ref": {} }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43085,7 +43478,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8875, + "id": 6975, "kind": 32768, "kindString": "Parameter", "name": "content_type", @@ -43105,7 +43498,7 @@ "target": 0, "ref": {} }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43121,7 +43514,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8876, + "id": 6976, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_id", @@ -43141,7 +43534,7 @@ } ] }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43157,7 +43550,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8877, + "id": 6977, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_name", @@ -43177,7 +43570,7 @@ } ] }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43193,7 +43586,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8878, + "id": 6978, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_storage_client", @@ -43204,14 +43597,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 7831, + "id": 6524, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -43225,7 +43618,7 @@ } ] }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43241,7 +43634,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8879, + "id": 6979, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_configuration", @@ -43252,14 +43645,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 5282, + "id": 4492, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -43273,7 +43666,7 @@ } ] }, - "parentId": 3826 + "parentId": 2864 }, { "comment": { @@ -43288,7 +43681,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8880, + "id": 6980, "kind": 32768, "kindString": "Parameter", "name": "kwargs", @@ -43298,7 +43691,7 @@ "target": 0, "ref": {} }, - "parentId": 3826 + "parentId": 2864 } ], "type": { @@ -43306,7 +43699,7 @@ "type": "literal", "value": {} }, - "parentId": 3825 + "parentId": 2863 }, { "comment": { @@ -43318,7 +43711,7 @@ ] }, "flags": {}, - "id": 8881, + "id": 6981, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -43339,7 +43732,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8882, + "id": 6982, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -43349,7 +43742,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "comment": { @@ -43364,7 +43757,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8883, + "id": 6983, "kind": 32768, "kindString": "Parameter", "name": "content_type", @@ -43380,7 +43773,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "comment": { @@ -43396,7 +43789,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8884, + "id": 6984, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_id", @@ -43416,7 +43809,7 @@ } ] }, - "parentId": 3834 + "parentId": 2872 }, { "comment": { @@ -43432,7 +43825,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8885, + "id": 6985, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_name", @@ -43452,7 +43845,7 @@ } ] }, - "parentId": 3834 + "parentId": 2872 }, { "comment": { @@ -43468,7 +43861,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8886, + "id": 6986, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_storage_client", @@ -43479,14 +43872,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 7831, + "id": 6524, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -43500,7 +43893,7 @@ } ] }, - "parentId": 3834 + "parentId": 2872 }, { "comment": { @@ -43516,7 +43909,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8887, + "id": 6987, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_configuration", @@ -43527,14 +43920,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 5282, + "id": 4492, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -43548,7 +43941,7 @@ } ] }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43567,7 +43960,7 @@ "optional": true }, "groups": [], - "id": 5590, + "id": 4438, "module": "_types", "name": "skipkeys", "parsedDocstring": { @@ -43577,9 +43970,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 753, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L753" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 757, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L757" } ], "type": { @@ -43596,7 +43989,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43615,7 +44008,7 @@ "optional": true }, "groups": [], - "id": 5591, + "id": 4439, "module": "_types", "name": "ensure_ascii", "parsedDocstring": { @@ -43625,9 +44018,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 757, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L757" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 761, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L761" } ], "type": { @@ -43644,7 +44037,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43663,7 +44056,7 @@ "optional": true }, "groups": [], - "id": 5592, + "id": 4440, "module": "_types", "name": "check_circular", "parsedDocstring": { @@ -43673,9 +44066,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 760, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L760" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 764, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L764" } ], "type": { @@ -43692,7 +44085,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43711,7 +44104,7 @@ "optional": true }, "groups": [], - "id": 5593, + "id": 4441, "module": "_types", "name": "allow_nan", "parsedDocstring": { @@ -43721,9 +44114,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 764, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L764" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 768, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L768" } ], "type": { @@ -43740,7 +44133,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43759,7 +44152,7 @@ "optional": true }, "groups": [], - "id": 5594, + "id": 4442, "module": "_types", "name": "cls", "parsedDocstring": { @@ -43769,9 +44162,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 768, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L768" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 772, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L772" } ], "type": { @@ -43789,14 +44182,14 @@ "ref": {} } ], - "target": "981", + "target": "3727", "ref": { - "id": 6028, + "id": 7836, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/sitemap.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -43808,7 +44201,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43827,7 +44220,7 @@ "optional": true }, "groups": [], - "id": 5595, + "id": 4443, "module": "_types", "name": "indent", "parsedDocstring": { @@ -43837,9 +44230,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 771, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L771" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 775, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L775" } ], "type": { @@ -43856,7 +44249,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43875,7 +44268,7 @@ "optional": true }, "groups": [], - "id": 5596, + "id": 4444, "module": "_types", "name": "separators", "parsedDocstring": { @@ -43885,9 +44278,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 774, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L774" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 778, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L778" } ], "type": { @@ -43918,7 +44311,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43937,7 +44330,7 @@ "optional": true }, "groups": [], - "id": 5597, + "id": 4445, "module": "_types", "name": "default", "parsedDocstring": { @@ -43947,9 +44340,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 778, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L778" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 782, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L782" } ], "type": { @@ -43966,7 +44359,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 }, { "kind": 1024, @@ -43985,7 +44378,7 @@ "optional": true }, "groups": [], - "id": 5598, + "id": 4446, "module": "_types", "name": "sort_keys", "parsedDocstring": { @@ -43995,9 +44388,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 782, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L782" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 786, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L786" } ], "type": { @@ -44014,7 +44407,7 @@ "target": 0, "ref": {} }, - "parentId": 3834 + "parentId": 2872 } ], "type": { @@ -44022,7 +44415,7 @@ "type": "literal", "value": {} }, - "parentId": 3825 + "parentId": 2863 }, { "comment": { @@ -44034,7 +44427,7 @@ ] }, "flags": {}, - "id": 8889, + "id": 6989, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -44055,7 +44448,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8890, + "id": 6990, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -44065,7 +44458,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "comment": { @@ -44080,7 +44473,7 @@ "isOptional": false, "keyword-only": false }, - "id": 8891, + "id": 6991, "kind": 32768, "kindString": "Parameter", "name": "content_type", @@ -44096,7 +44489,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "comment": { @@ -44112,7 +44505,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8892, + "id": 6992, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_id", @@ -44132,7 +44525,7 @@ } ] }, - "parentId": 3842 + "parentId": 2880 }, { "comment": { @@ -44148,7 +44541,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8893, + "id": 6993, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_name", @@ -44168,7 +44561,7 @@ } ] }, - "parentId": 3842 + "parentId": 2880 }, { "comment": { @@ -44184,7 +44577,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8894, + "id": 6994, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_storage_client", @@ -44195,14 +44588,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 7831, + "id": 6524, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -44216,7 +44609,7 @@ } ] }, - "parentId": 3842 + "parentId": 2880 }, { "comment": { @@ -44232,7 +44625,7 @@ "isOptional": true, "keyword-only": false }, - "id": 8895, + "id": 6995, "kind": 32768, "kindString": "Parameter", "name": "to_kvs_configuration", @@ -44243,14 +44636,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 5282, + "id": 4492, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -44264,7 +44657,7 @@ } ] }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44283,7 +44676,7 @@ "optional": true }, "groups": [], - "id": 5600, + "id": 4448, "module": "_types", "name": "dialect", "parsedDocstring": { @@ -44293,9 +44686,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 789, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L789" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 793, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L793" } ], "type": { @@ -44312,7 +44705,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44331,7 +44724,7 @@ "optional": true }, "groups": [], - "id": 5601, + "id": 4449, "module": "_types", "name": "delimiter", "parsedDocstring": { @@ -44341,9 +44734,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 792, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L792" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 796, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L796" } ], "type": { @@ -44360,7 +44753,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44379,7 +44772,7 @@ "optional": true }, "groups": [], - "id": 5602, + "id": 4450, "module": "_types", "name": "doublequote", "parsedDocstring": { @@ -44389,9 +44782,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 795, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L795" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 799, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L799" } ], "type": { @@ -44408,7 +44801,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44427,7 +44820,7 @@ "optional": true }, "groups": [], - "id": 5603, + "id": 4451, "module": "_types", "name": "escapechar", "parsedDocstring": { @@ -44437,9 +44830,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 799, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L799" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 803, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L803" } ], "type": { @@ -44456,7 +44849,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44475,7 +44868,7 @@ "optional": true }, "groups": [], - "id": 5604, + "id": 4452, "module": "_types", "name": "lineterminator", "parsedDocstring": { @@ -44485,9 +44878,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 803, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L803" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 807, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L807" } ], "type": { @@ -44504,7 +44897,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44523,7 +44916,7 @@ "optional": true }, "groups": [], - "id": 5605, + "id": 4453, "module": "_types", "name": "quotechar", "parsedDocstring": { @@ -44533,9 +44926,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 806, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L806" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 810, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L810" } ], "type": { @@ -44552,7 +44945,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44571,7 +44964,7 @@ "optional": true }, "groups": [], - "id": 5606, + "id": 4454, "module": "_types", "name": "quoting", "parsedDocstring": { @@ -44581,9 +44974,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 810, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L810" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 814, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L814" } ], "type": { @@ -44592,7 +44985,25 @@ "typeArguments": [ { "type": "reference", - "name": "int", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": 0 + }, + { + "type": "literal", + "value": 1 + }, + { + "type": "literal", + "value": 2 + }, + { + "type": "literal", + "value": 3 + } + ], "target": 0, "ref": {} } @@ -44600,7 +45011,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44619,7 +45030,7 @@ "optional": true }, "groups": [], - "id": 5607, + "id": 4455, "module": "_types", "name": "skipinitialspace", "parsedDocstring": { @@ -44629,9 +45040,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 814, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L814" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 818, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L818" } ], "type": { @@ -44648,7 +45059,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 }, { "kind": 1024, @@ -44667,7 +45078,7 @@ "optional": true }, "groups": [], - "id": 5608, + "id": 4456, "module": "_types", "name": "strict", "parsedDocstring": { @@ -44677,9 +45088,9 @@ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 817, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_types.py#L817" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 821, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_types.py#L821" } ], "type": { @@ -44696,7 +45107,7 @@ "target": 0, "ref": {} }, - "parentId": 3842 + "parentId": 2880 } ], "type": { @@ -44704,11 +45115,11 @@ "type": "literal", "value": {} }, - "parentId": 3825 + "parentId": 2863 } ], "permalink": "/python/api/class/Dataset#export_to", - "parentId": 3766 + "parentId": 2804 } ], "comment": { @@ -44729,28 +45140,28 @@ "groups": [ { "children": [ - 8814, - 8830, - 8872, - 8837, - 8821, - 8850, - 8861, - 8823, - 8832, - 8834 + 6914, + 6930, + 6972, + 6937, + 6921, + 6950, + 6961, + 6923, + 6932, + 6934 ], "title": "Methods" }, { "children": [ - 8819, - 8820 + 6919, + 6920 ], "title": "Properties" } ], - "id": 8813, + "id": 6913, "module": "storages._dataset", "name": "Dataset", "parsedDocstring": { @@ -44760,9 +45171,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_dataset.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_dataset.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_dataset.py#L33" } ], "type": { @@ -44774,15 +45185,15 @@ "extendedTypes": [ { "name": "Storage", - "target": "3680", + "target": "2888", "type": "reference", "ref": { - "id": 8727, + "id": 6997, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -44813,7 +45224,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12596, + "id": 10500, "module": "storages._key_value_store", "name": "__init__", "parsedDocstring": { @@ -44828,9 +45239,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 78, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L78" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L78" } ], "type": { @@ -44850,7 +45261,7 @@ ] }, "flags": {}, - "id": 12597, + "id": 10501, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -44869,21 +45280,21 @@ "isOptional": false, "keyword-only": false }, - "id": 12598, + "id": 10502, "kind": 32768, "kindString": "Parameter", "name": "client", "type": { "name": "KeyValueStoreClient", "type": "reference", - "target": "2842", + "target": "2328", "ref": { - "id": 11737, + "id": 10164, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 14 } ], @@ -44891,7 +45302,7 @@ "permalink": "https://crawlee.dev/python/api/class/KeyValueStoreClient" } }, - "parentId": 3702 + "parentId": 2665 }, { "comment": { @@ -44906,7 +45317,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12599, + "id": 10503, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -44916,7 +45327,7 @@ "target": 0, "ref": {} }, - "parentId": 3702 + "parentId": 2665 }, { "comment": { @@ -44931,7 +45342,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12600, + "id": 10504, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -44951,7 +45362,7 @@ } ] }, - "parentId": 3702 + "parentId": 2665 } ], "type": { @@ -44959,11 +45370,11 @@ "type": "literal", "value": {} }, - "parentId": 3701 + "parentId": 2664 } ], "permalink": "/python/api/class/KeyValueStore#__init__", - "parentId": 3700 + "parentId": 2663 }, { "kind": 1024, @@ -44987,7 +45398,7 @@ ], "flags": {}, "groups": [], - "id": 12601, + "id": 10505, "module": "storages._base", "name": "id", "parsedDocstring": { @@ -44997,9 +45408,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 99, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L99" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L99" } ], "type": { @@ -45010,15 +45421,15 @@ }, "overwrites": { "name": "Storage.id", - "target": 3681, + "target": 2889, "type": "reference", "ref": { - "id": 12576, + "id": 10725, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -45027,7 +45438,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#id", - "parentId": 3700 + "parentId": 2663 }, { "kind": 1024, @@ -45051,7 +45462,7 @@ ], "flags": {}, "groups": [], - "id": 12602, + "id": 10506, "module": "storages._base", "name": "name", "parsedDocstring": { @@ -45061,9 +45472,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 104, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L104" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L104" } ], "type": { @@ -45084,15 +45495,15 @@ }, "overwrites": { "name": "Storage.name", - "target": 3682, + "target": 2890, "type": "reference", "ref": { - "id": 12577, + "id": 10726, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 25 } ], @@ -45101,7 +45512,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#name", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -45122,7 +45533,7 @@ ], "flags": {}, "groups": [], - "id": 12603, + "id": 10507, "module": "storages._base", "name": "get_metadata", "parsedDocstring": { @@ -45132,9 +45543,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 108, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L108" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L108" } ], "type": { @@ -45154,7 +45565,7 @@ ] }, "flags": {}, - "id": 12579, + "id": 10728, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -45172,15 +45583,15 @@ { "type": "reference", "name": "DatasetMetadata", - "target": "3639", + "target": "1709", "ref": { - "id": 12534, + "id": 9545, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 128, @@ -45190,15 +45601,15 @@ { "type": "reference", "name": "KeyValueStoreMetadata", - "target": "3642", + "target": "1712", "ref": { - "id": 12537, + "id": 9548, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "kind": 128, @@ -45210,15 +45621,15 @@ { "type": "reference", "name": "RequestQueueMetadata", - "target": "3644", + "target": "1714", "ref": { - "id": 12539, + "id": 9550, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "kind": 128, @@ -45229,15 +45640,15 @@ }, "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 12578, + "id": 10727, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -45245,20 +45656,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#get_metadata" } }, - "parentId": 3708 + "parentId": 2671 } ], "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 12578, + "id": 10727, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -45267,7 +45678,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#get_metadata", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -45291,7 +45702,7 @@ ], "flags": {}, "groups": [], - "id": 12605, + "id": 10509, "module": "storages._base", "name": "open", "parsedDocstring": { @@ -45308,9 +45719,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 113, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L113" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L113" } ], "type": { @@ -45330,7 +45741,7 @@ ] }, "flags": {}, - "id": 12581, + "id": 10730, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -45352,7 +45763,7 @@ "isOptional": true, "keyword-only": true }, - "id": 12582, + "id": 10731, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -45372,7 +45783,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -45388,7 +45799,7 @@ "isOptional": true, "keyword-only": true }, - "id": 12583, + "id": 10732, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -45408,7 +45819,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -45424,7 +45835,7 @@ "isOptional": true, "keyword-only": true }, - "id": 12584, + "id": 10733, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -45444,7 +45855,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -45460,7 +45871,7 @@ "isOptional": true, "keyword-only": true }, - "id": 12585, + "id": 10734, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -45471,14 +45882,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 9130, + "id": 8219, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -45492,7 +45903,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -45508,7 +45919,7 @@ "isOptional": true, "keyword-only": true }, - "id": 12586, + "id": 10735, "kind": 32768, "kindString": "Parameter", "name": "storage_client", @@ -45519,14 +45930,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 11679, + "id": 10251, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -45540,20 +45951,20 @@ } ] }, - "parentId": 3686 + "parentId": 2894 } ], "type": { "name": "Storage", "type": "reference", - "target": "3680", + "target": "2888", "ref": { - "id": 12575, + "id": 10724, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -45563,15 +45974,15 @@ }, "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 12580, + "id": 10729, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -45579,20 +45990,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#open" } }, - "parentId": 3710 + "parentId": 2673 } ], "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 12580, + "id": 10729, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -45601,7 +46012,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#open", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -45622,7 +46033,7 @@ ], "flags": {}, "groups": [], - "id": 12612, + "id": 10516, "module": "storages._base", "name": "drop", "parsedDocstring": { @@ -45632,9 +46043,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 140, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L140" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L140" } ], "type": { @@ -45654,7 +46065,7 @@ ] }, "flags": {}, - "id": 12588, + "id": 10737, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -45669,15 +46080,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 11235, + "id": 10475, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -45685,20 +46096,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 3717 + "parentId": 2680 } ], "overwrites": { "name": "Storage.drop", - "target": 3692, + "target": 2900, "type": "reference", "ref": { - "id": 12587, + "id": 10736, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 57 } ], @@ -45707,7 +46118,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#drop", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -45728,7 +46139,7 @@ ], "flags": {}, "groups": [], - "id": 12614, + "id": 10518, "module": "storages._base", "name": "purge", "parsedDocstring": { @@ -45738,9 +46149,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 148, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L148" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L148" } ], "type": { @@ -45760,7 +46171,7 @@ ] }, "flags": {}, - "id": 12590, + "id": 10739, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -45774,37 +46185,37 @@ "value": {} }, "overwrites": { - "name": "Storage.purge", - "target": 3694, + "name": "RequestManager.purge", + "target": 2641, "type": "reference", "ref": { - "id": 12589, + "id": 10477, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "kind": 2048, - "permalink": "https://crawlee.dev/python/api/class/Storage#purge" + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" } }, - "parentId": 3719 + "parentId": 2682 } ], "overwrites": { "name": "Storage.purge", - "target": 3694, + "target": 2902, "type": "reference", "ref": { - "id": 12589, + "id": 10738, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 61 } ], @@ -45813,7 +46224,7 @@ } }, "permalink": "/python/api/class/KeyValueStore#purge", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -45830,7 +46241,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12616, + "id": 10520, "module": "storages._key_value_store", "name": "get_value", "parsedDocstring": { @@ -45845,9 +46256,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 160, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L160" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L160" } ], "type": { @@ -45878,7 +46289,7 @@ ] }, "flags": {}, - "id": 12617, + "id": 10521, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -45899,7 +46310,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12618, + "id": 10522, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -45909,7 +46320,7 @@ "target": 0, "ref": {} }, - "parentId": 3722 + "parentId": 2685 }, { "comment": { @@ -45925,7 +46336,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12619, + "id": 10523, "kind": 32768, "kindString": "Parameter", "name": "default_value", @@ -45936,15 +46347,15 @@ { "type": "reference", "name": "T", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -45957,7 +46368,7 @@ } ] }, - "parentId": 3722 + "parentId": 2685 } ], "type": { @@ -45967,15 +46378,15 @@ { "type": "reference", "name": "T", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -45988,7 +46399,7 @@ } ] }, - "parentId": 3721 + "parentId": 2684 }, { "comment": { @@ -46011,7 +46422,7 @@ ] }, "flags": {}, - "id": 12648, + "id": 10552, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46032,7 +46443,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12649, + "id": 10553, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46042,7 +46453,7 @@ "target": 0, "ref": {} }, - "parentId": 3753 + "parentId": 2716 } ], "type": { @@ -46051,7 +46462,7 @@ "target": 0, "ref": {} }, - "parentId": 3721 + "parentId": 2684 }, { "comment": { @@ -46074,7 +46485,7 @@ ] }, "flags": {}, - "id": 12650, + "id": 10554, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46095,7 +46506,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12651, + "id": 10555, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46105,7 +46516,7 @@ "target": 0, "ref": {} }, - "parentId": 3755 + "parentId": 2718 }, { "comment": { @@ -46120,50 +46531,50 @@ "isOptional": false, "keyword-only": false }, - "id": 12652, + "id": 10556, "kind": 32768, "kindString": "Parameter", "name": "default_value", "type": { "name": "T", "type": "reference", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, "permalink": "https://crawlee.dev/python/api#T" } }, - "parentId": 3755 + "parentId": 2718 } ], "type": { "name": "T", "type": "reference", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, "permalink": "https://crawlee.dev/python/api#T" } }, - "parentId": 3721 + "parentId": 2684 }, { "comment": { @@ -46186,7 +46597,7 @@ ] }, "flags": {}, - "id": 12653, + "id": 10557, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46207,7 +46618,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12654, + "id": 10558, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46217,7 +46628,7 @@ "target": 0, "ref": {} }, - "parentId": 3758 + "parentId": 2721 }, { "comment": { @@ -46233,7 +46644,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12655, + "id": 10559, "kind": 32768, "kindString": "Parameter", "name": "default_value", @@ -46244,15 +46655,15 @@ { "type": "reference", "name": "T", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -46265,7 +46676,7 @@ } ] }, - "parentId": 3758 + "parentId": 2721 } ], "type": { @@ -46275,15 +46686,15 @@ { "type": "reference", "name": "T", - "target": "299", + "target": "83", "ref": { - "id": 9194, + "id": 7919, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 36 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -46296,11 +46707,11 @@ } ] }, - "parentId": 3721 + "parentId": 2684 } ], "permalink": "/python/api/class/KeyValueStore#get_value", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -46317,7 +46728,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12620, + "id": 10524, "module": "storages._key_value_store", "name": "set_value", "parsedDocstring": { @@ -46332,9 +46743,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 173, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L173" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L173" } ], "type": { @@ -46354,7 +46765,7 @@ ] }, "flags": {}, - "id": 12621, + "id": 10525, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46375,7 +46786,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12622, + "id": 10526, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46385,7 +46796,7 @@ "target": 0, "ref": {} }, - "parentId": 3726 + "parentId": 2689 }, { "comment": { @@ -46400,7 +46811,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12623, + "id": 10527, "kind": 32768, "kindString": "Parameter", "name": "value", @@ -46410,7 +46821,7 @@ "target": 0, "ref": {} }, - "parentId": 3726 + "parentId": 2689 }, { "comment": { @@ -46426,7 +46837,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12624, + "id": 10528, "kind": 32768, "kindString": "Parameter", "name": "content_type", @@ -46446,7 +46857,7 @@ } ] }, - "parentId": 3726 + "parentId": 2689 } ], "type": { @@ -46454,11 +46865,11 @@ "type": "literal", "value": {} }, - "parentId": 3725 + "parentId": 2688 } ], "permalink": "/python/api/class/KeyValueStore#set_value", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -46475,7 +46886,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12625, + "id": 10529, "module": "storages._key_value_store", "name": "delete_value", "parsedDocstring": { @@ -46488,9 +46899,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 188, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L188" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L188" } ], "type": { @@ -46510,7 +46921,7 @@ ] }, "flags": {}, - "id": 12626, + "id": 10530, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46531,7 +46942,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12627, + "id": 10531, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46541,7 +46952,7 @@ "target": 0, "ref": {} }, - "parentId": 3731 + "parentId": 2694 } ], "type": { @@ -46549,11 +46960,11 @@ "type": "literal", "value": {} }, - "parentId": 3730 + "parentId": 2693 } ], "permalink": "/python/api/class/KeyValueStore#delete_value", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -46570,7 +46981,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12628, + "id": 10532, "module": "storages._key_value_store", "name": "iterate_keys", "parsedDocstring": { @@ -46584,9 +46995,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 196, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L196" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L196" } ], "type": { @@ -46606,7 +47017,7 @@ ] }, "flags": {}, - "id": 12629, + "id": 10533, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46628,7 +47039,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12630, + "id": 10534, "kind": 32768, "kindString": "Parameter", "name": "exclusive_start_key", @@ -46648,7 +47059,7 @@ } ] }, - "parentId": 3734 + "parentId": 2697 }, { "comment": { @@ -46664,7 +47075,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12631, + "id": 10535, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -46684,7 +47095,7 @@ } ] }, - "parentId": 3734 + "parentId": 2697 } ], "type": { @@ -46694,15 +47105,15 @@ { "type": "reference", "name": "KeyValueStoreRecordMetadata", - "target": "3650", + "target": "1720", "ref": { - "id": 12545, + "id": 9556, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81 } ], "kind": 128, @@ -46713,11 +47124,11 @@ "target": 0, "ref": {} }, - "parentId": 3733 + "parentId": 2696 } ], "permalink": "/python/api/class/KeyValueStore#iterate_keys", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -46734,7 +47145,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12632, + "id": 10536, "module": "storages._key_value_store", "name": "list_keys", "parsedDocstring": { @@ -46749,9 +47160,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 216, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L216" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L216" } ], "type": { @@ -46782,7 +47193,7 @@ ] }, "flags": {}, - "id": 12633, + "id": 10537, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46804,7 +47215,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12634, + "id": 10538, "kind": 32768, "kindString": "Parameter", "name": "exclusive_start_key", @@ -46824,7 +47235,7 @@ } ] }, - "parentId": 3738 + "parentId": 2701 }, { "comment": { @@ -46840,7 +47251,7 @@ "isOptional": true, "keyword-only": false }, - "id": 12635, + "id": 10539, "kind": 32768, "kindString": "Parameter", "name": "limit", @@ -46850,7 +47261,7 @@ "target": 0, "ref": {} }, - "parentId": 3738 + "parentId": 2701 } ], "type": { @@ -46860,15 +47271,15 @@ { "type": "reference", "name": "KeyValueStoreRecordMetadata", - "target": "3650", + "target": "1720", "ref": { - "id": 12545, + "id": 9556, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81 } ], "kind": 128, @@ -46879,11 +47290,11 @@ "target": 0, "ref": {} }, - "parentId": 3737 + "parentId": 2700 } ], "permalink": "/python/api/class/KeyValueStore#list_keys", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -46900,7 +47311,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12636, + "id": 10540, "module": "storages._key_value_store", "name": "record_exists", "parsedDocstring": { @@ -46914,9 +47325,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 240, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L240" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L240" } ], "type": { @@ -46947,7 +47358,7 @@ ] }, "flags": {}, - "id": 12637, + "id": 10541, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -46968,7 +47379,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12638, + "id": 10542, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -46978,7 +47389,7 @@ "target": 0, "ref": {} }, - "parentId": 3742 + "parentId": 2705 } ], "type": { @@ -46987,11 +47398,11 @@ "target": 0, "ref": {} }, - "parentId": 3741 + "parentId": 2704 } ], "permalink": "/python/api/class/KeyValueStore#record_exists", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -47008,7 +47419,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12639, + "id": 10543, "module": "storages._key_value_store", "name": "get_public_url", "parsedDocstring": { @@ -47022,9 +47433,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 251, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L251" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L251" } ], "type": { @@ -47055,7 +47466,7 @@ ] }, "flags": {}, - "id": 12640, + "id": 10544, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -47076,7 +47487,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12641, + "id": 10545, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -47086,7 +47497,7 @@ "target": 0, "ref": {} }, - "parentId": 3745 + "parentId": 2708 } ], "type": { @@ -47095,11 +47506,11 @@ "target": 0, "ref": {} }, - "parentId": 3744 + "parentId": 2707 } ], "permalink": "/python/api/class/KeyValueStore#get_public_url", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -47116,7 +47527,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12642, + "id": 10546, "module": "storages._key_value_store", "name": "get_auto_saved_value", "parsedDocstring": { @@ -47131,9 +47542,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 262, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L262" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L262" } ], "type": { @@ -47164,7 +47575,7 @@ ] }, "flags": {}, - "id": 12643, + "id": 10547, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -47185,7 +47596,7 @@ "isOptional": false, "keyword-only": false }, - "id": 12644, + "id": 10548, "kind": 32768, "kindString": "Parameter", "name": "key", @@ -47195,7 +47606,7 @@ "target": 0, "ref": {} }, - "parentId": 3748 + "parentId": 2711 }, { "comment": { @@ -47211,17 +47622,17 @@ "isOptional": true, "keyword-only": false }, - "id": 12645, + "id": 10549, "kind": 32768, "kindString": "Parameter", "name": "default_value", "type": { - "name": "dict[str, JsonSerializable] | None", + "name": "MutableMapping[str, JsonSerializable] | None", "type": "union", "types": [ { "type": "reference", - "name": "dict", + "name": "MutableMapping", "typeArguments": [ { "type": "reference", @@ -47245,11 +47656,11 @@ } ] }, - "parentId": 3748 + "parentId": 2711 } ], "type": { - "name": "dict", + "name": "MutableMapping", "type": "reference", "typeArguments": [ { @@ -47268,11 +47679,11 @@ "target": 0, "ref": {} }, - "parentId": 3747 + "parentId": 2710 } ], "permalink": "/python/api/class/KeyValueStore#get_auto_saved_value", - "parentId": 3700 + "parentId": 2663 }, { "kind": 2048, @@ -47289,7 +47700,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 12646, + "id": 10550, "module": "storages._key_value_store", "name": "persist_autosaved_values", "parsedDocstring": { @@ -47299,9 +47710,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 299, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L299" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L299" } ], "type": { @@ -47321,7 +47732,7 @@ ] }, "flags": {}, - "id": 12647, + "id": 10551, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -47334,11 +47745,11 @@ "type": "literal", "value": {} }, - "parentId": 3751 + "parentId": 2714 } ], "permalink": "/python/api/class/KeyValueStore#persist_autosaved_values", - "parentId": 3700 + "parentId": 2663 } ], "comment": { @@ -47359,32 +47770,32 @@ "groups": [ { "children": [ - 12596, - 12625, - 12612, - 12642, - 12603, - 12639, - 12616, - 12628, - 12632, - 12605, - 12646, - 12614, - 12636, - 12620 + 10500, + 10529, + 10516, + 10546, + 10507, + 10543, + 10520, + 10532, + 10536, + 10509, + 10550, + 10518, + 10540, + 10524 ], "title": "Methods" }, { "children": [ - 12601, - 12602 + 10505, + 10506 ], "title": "Properties" } ], - "id": 12595, + "id": 10499, "module": "storages._key_value_store", "name": "KeyValueStore", "parsedDocstring": { @@ -47394,9 +47805,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_key_value_store.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_key_value_store.py#L40" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_key_value_store.py#L40" } ], "type": { @@ -47408,15 +47819,15 @@ "extendedTypes": [ { "name": "Storage", - "target": "3680", + "target": "2888", "type": "reference", "ref": { - "id": 12575, + "id": 10724, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -47447,7 +47858,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16508, + "id": 13466, "module": "storages._request_queue", "name": "__init__", "parsedDocstring": { @@ -47462,9 +47873,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L74" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L74" } ], "type": { @@ -47484,7 +47895,7 @@ ] }, "flags": {}, - "id": 16509, + "id": 13467, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -47503,21 +47914,21 @@ "isOptional": false, "keyword-only": false }, - "id": 16510, + "id": 13468, "kind": 32768, "kindString": "Parameter", "name": "client", "type": { "name": "RequestQueueClient", "type": "reference", - "target": "2759", + "target": "2356", "ref": { - "id": 15414, + "id": 13095, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 13 } ], @@ -47525,7 +47936,7 @@ "permalink": "https://crawlee.dev/python/api/class/RequestQueueClient" } }, - "parentId": 3854 + "parentId": 2728 }, { "comment": { @@ -47540,7 +47951,7 @@ "isOptional": false, "keyword-only": false }, - "id": 16511, + "id": 13469, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -47550,7 +47961,7 @@ "target": 0, "ref": {} }, - "parentId": 3854 + "parentId": 2728 }, { "comment": { @@ -47565,7 +47976,7 @@ "isOptional": false, "keyword-only": false }, - "id": 16512, + "id": 13470, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -47585,7 +47996,7 @@ } ] }, - "parentId": 3854 + "parentId": 2728 } ], "type": { @@ -47593,11 +48004,11 @@ "type": "literal", "value": {} }, - "parentId": 3853 + "parentId": 2727 } ], "permalink": "/python/api/class/RequestQueue#__init__", - "parentId": 3852 + "parentId": 2726 }, { "kind": 1024, @@ -47621,7 +48032,7 @@ ], "flags": {}, "groups": [], - "id": 16513, + "id": 13471, "module": "storages._base", "name": "id", "parsedDocstring": { @@ -47631,9 +48042,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 95, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L95" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L95" } ], "type": { @@ -47644,15 +48055,15 @@ }, "overwrites": { "name": "Storage.id", - "target": 3681, + "target": 2889, "type": "reference", "ref": { - "id": 16336, + "id": 13628, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -47661,7 +48072,7 @@ } }, "permalink": "/python/api/class/RequestQueue#id", - "parentId": 3852 + "parentId": 2726 }, { "kind": 1024, @@ -47685,7 +48096,7 @@ ], "flags": {}, "groups": [], - "id": 16514, + "id": 13472, "module": "storages._base", "name": "name", "parsedDocstring": { @@ -47695,9 +48106,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 100, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L100" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L100" } ], "type": { @@ -47718,15 +48129,15 @@ }, "overwrites": { "name": "Storage.name", - "target": 3682, + "target": 2890, "type": "reference", "ref": { - "id": 16337, + "id": 13629, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 25 } ], @@ -47735,7 +48146,7 @@ } }, "permalink": "/python/api/class/RequestQueue#name", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -47756,7 +48167,7 @@ ], "flags": {}, "groups": [], - "id": 16515, + "id": 13473, "module": "storages._base", "name": "get_metadata", "parsedDocstring": { @@ -47766,9 +48177,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 104, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L104" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L104" } ], "type": { @@ -47788,7 +48199,7 @@ ] }, "flags": {}, - "id": 16339, + "id": 13631, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -47806,15 +48217,15 @@ { "type": "reference", "name": "DatasetMetadata", - "target": "3639", + "target": "1709", "ref": { - "id": 16294, + "id": 12448, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 128, @@ -47824,15 +48235,15 @@ { "type": "reference", "name": "KeyValueStoreMetadata", - "target": "3642", + "target": "1712", "ref": { - "id": 16297, + "id": 12451, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "kind": 128, @@ -47844,15 +48255,15 @@ { "type": "reference", "name": "RequestQueueMetadata", - "target": "3644", + "target": "1714", "ref": { - "id": 16299, + "id": 12453, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "kind": 128, @@ -47863,15 +48274,15 @@ }, "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 16338, + "id": 13630, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -47879,20 +48290,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#get_metadata" } }, - "parentId": 3860 + "parentId": 2734 } ], "overwrites": { "name": "Storage.get_metadata", - "target": 3683, + "target": 2891, "type": "reference", "ref": { - "id": 16338, + "id": 13630, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -47901,7 +48312,7 @@ } }, "permalink": "/python/api/class/RequestQueue#get_metadata", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -47922,7 +48333,7 @@ ], "flags": {}, "groups": [], - "id": 16517, + "id": 13475, "module": "request_loaders._request_loader", "name": "get_handled_count", "parsedDocstring": { @@ -47932,9 +48343,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 108, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L108" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L108" } ], "type": { @@ -47954,7 +48365,7 @@ ] }, "flags": {}, - "id": 14930, + "id": 13246, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -47970,15 +48381,15 @@ }, "overwrites": { "name": "RequestManager.get_handled_count", - "target": 3995, + "target": 4148, "type": "reference", "ref": { - "id": 16650, + "id": 14887, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -47986,20 +48397,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_handled_count" } }, - "parentId": 3862 + "parentId": 2736 } ], "overwrites": { "name": "RequestManager.get_handled_count", - "target": 3995, + "target": 4148, "type": "reference", "ref": { - "id": 16650, + "id": 14887, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -48008,7 +48419,7 @@ } }, "permalink": "/python/api/class/RequestQueue#get_handled_count", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48029,7 +48440,7 @@ ], "flags": {}, "groups": [], - "id": 16519, + "id": 13477, "module": "request_loaders._request_loader", "name": "get_total_count", "parsedDocstring": { @@ -48039,9 +48450,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 113, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L113" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L113" } ], "type": { @@ -48061,7 +48472,7 @@ ] }, "flags": {}, - "id": 14932, + "id": 13248, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48077,15 +48488,15 @@ }, "overwrites": { "name": "RequestManager.get_total_count", - "target": 3996, + "target": 4149, "type": "reference", "ref": { - "id": 16651, + "id": 14888, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -48093,20 +48504,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_total_count" } }, - "parentId": 3864 + "parentId": 2738 } ], "overwrites": { "name": "RequestManager.get_total_count", - "target": 3996, + "target": 4149, "type": "reference", "ref": { - "id": 16651, + "id": 14888, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -48115,7 +48526,7 @@ } }, "permalink": "/python/api/class/RequestQueue#get_total_count", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48139,7 +48550,7 @@ ], "flags": {}, "groups": [], - "id": 16521, + "id": 13479, "module": "storages._base", "name": "open", "parsedDocstring": { @@ -48156,9 +48567,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 119, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L119" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L119" } ], "type": { @@ -48178,7 +48589,7 @@ ] }, "flags": {}, - "id": 16341, + "id": 13633, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48200,7 +48611,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16342, + "id": 13634, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -48220,7 +48631,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -48236,7 +48647,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16343, + "id": 13635, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -48256,7 +48667,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -48272,7 +48683,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16344, + "id": 13636, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -48292,7 +48703,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -48308,7 +48719,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16345, + "id": 13637, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -48319,14 +48730,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 12890, + "id": 11122, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -48340,7 +48751,7 @@ } ] }, - "parentId": 3686 + "parentId": 2894 }, { "comment": { @@ -48356,7 +48767,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16346, + "id": 13638, "kind": 32768, "kindString": "Parameter", "name": "storage_client", @@ -48367,14 +48778,14 @@ { "type": "reference", "name": "StorageClient", - "target": "2784", + "target": "2415", "ref": { - "id": 15439, + "id": 13154, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -48388,20 +48799,20 @@ } ] }, - "parentId": 3686 + "parentId": 2894 } ], "type": { "name": "Storage", "type": "reference", - "target": "3680", + "target": "2888", "ref": { - "id": 16335, + "id": 13627, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -48411,15 +48822,15 @@ }, "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 16340, + "id": 13632, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -48427,20 +48838,20 @@ "permalink": "https://crawlee.dev/python/api/class/Storage#open" } }, - "parentId": 3866 + "parentId": 2740 } ], "overwrites": { "name": "Storage.open", - "target": 3685, + "target": 2893, "type": "reference", "ref": { - "id": 16340, + "id": 13632, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -48449,7 +48860,7 @@ } }, "permalink": "/python/api/class/RequestQueue#open", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48470,7 +48881,7 @@ ], "flags": {}, "groups": [], - "id": 16528, + "id": 13486, "module": "storages._base", "name": "drop", "parsedDocstring": { @@ -48480,9 +48891,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 144, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L144" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L144" } ], "type": { @@ -48502,7 +48913,7 @@ ] }, "flags": {}, - "id": 16348, + "id": 13640, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48517,15 +48928,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 14995, + "id": 13378, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -48533,20 +48944,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 3873 + "parentId": 2747 } ], "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 14995, + "id": 13378, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -48555,7 +48966,7 @@ } }, "permalink": "/python/api/class/RequestQueue#drop", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48576,7 +48987,7 @@ ], "flags": {}, "groups": [], - "id": 16530, + "id": 13488, "module": "storages._base", "name": "purge", "parsedDocstring": { @@ -48586,9 +48997,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 152, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L152" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L152" } ], "type": { @@ -48608,7 +49019,7 @@ ] }, "flags": {}, - "id": 16350, + "id": 13642, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48622,46 +49033,46 @@ "value": {} }, "overwrites": { - "name": "Storage.purge", - "target": 3694, + "name": "RequestManager.purge", + "target": 2641, "type": "reference", "ref": { - "id": 16349, + "id": 13380, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "kind": 2048, - "permalink": "https://crawlee.dev/python/api/class/Storage#purge" + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" } }, - "parentId": 3875 + "parentId": 2749 } ], "overwrites": { - "name": "Storage.purge", - "target": 3694, + "name": "RequestManager.purge", + "target": 2641, "type": "reference", "ref": { - "id": 16349, + "id": 13380, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 61 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 } ], "kind": 2048, - "permalink": "https://crawlee.dev/python/api/class/Storage#purge" + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" } }, "permalink": "/python/api/class/RequestQueue#purge", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48682,7 +49093,7 @@ ], "flags": {}, "groups": [], - "id": 16532, + "id": 13490, "module": "request_loaders._request_manager", "name": "add_request", "parsedDocstring": { @@ -48697,9 +49108,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 156, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L156" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 177, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L177" } ], "type": { @@ -48730,7 +49141,7 @@ ] }, "flags": {}, - "id": 14998, + "id": 13383, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48751,7 +49162,7 @@ "isOptional": false, "keyword-only": false }, - "id": 14999, + "id": 13384, "kind": 32768, "kindString": "Parameter", "name": "request", @@ -48768,14 +49179,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -48785,7 +49196,7 @@ } ] }, - "parentId": 2343 + "parentId": 2644 }, { "comment": { @@ -48801,7 +49212,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15000, + "id": 13385, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -48811,7 +49222,7 @@ "target": 0, "ref": {} }, - "parentId": 2343 + "parentId": 2644 } ], "type": { @@ -48821,15 +49232,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 16320, + "id": 12474, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -48844,37 +49255,37 @@ }, "overwrites": { "name": "RequestManager.add_request", - "target": 2342, + "target": 2643, "type": "reference", "ref": { - "id": 14997, + "id": 13382, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_request" } }, - "parentId": 3877 + "parentId": 2751 } ], "overwrites": { "name": "RequestManager.add_request", - "target": 2342, + "target": 2643, "type": "reference", "ref": { - "id": 14997, + "id": 13382, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 2048, @@ -48882,7 +49293,7 @@ } }, "permalink": "/python/api/class/RequestQueue#add_request", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -48899,7 +49310,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16536, + "id": 13494, "module": "request_loaders._request_manager", "name": "add_requests", "parsedDocstring": { @@ -48917,9 +49328,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 180, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L180" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 201, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L201" } ], "type": { @@ -48939,7 +49350,7 @@ ] }, "flags": {}, - "id": 15002, + "id": 13387, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -48960,7 +49371,7 @@ "isOptional": false, "keyword-only": false }, - "id": 15003, + "id": 13388, "kind": 32768, "kindString": "Parameter", "name": "requests", @@ -48980,14 +49391,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -49001,7 +49412,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -49017,7 +49428,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15004, + "id": 13389, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -49027,7 +49438,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -49043,7 +49454,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15005, + "id": 13390, "kind": 32768, "kindString": "Parameter", "name": "batch_size", @@ -49053,7 +49464,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -49069,7 +49480,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15006, + "id": 13391, "kind": 32768, "kindString": "Parameter", "name": "wait_time_between_batches", @@ -49079,7 +49490,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -49095,7 +49506,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15007, + "id": 13392, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added", @@ -49105,7 +49516,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -49121,7 +49532,7 @@ "isOptional": true, "keyword-only": true }, - "id": 15008, + "id": 13393, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added_timeout", @@ -49141,7 +49552,7 @@ } ] }, - "parentId": 2347 + "parentId": 2648 } ], "type": { @@ -49151,37 +49562,37 @@ }, "overwrites": { "name": "RequestManager.add_requests", - "target": 2346, + "target": 2647, "type": "reference", "ref": { - "id": 15001, + "id": 13386, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_requests" } }, - "parentId": 3881 + "parentId": 2755 } ], "overwrites": { "name": "RequestManager.add_requests", - "target": 2346, + "target": 2647, "type": "reference", "ref": { - "id": 15001, + "id": 13386, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 } ], "kind": 2048, @@ -49189,7 +49600,7 @@ } }, "permalink": "/python/api/class/RequestQueue#add_requests", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49206,7 +49617,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16544, + "id": 13502, "module": "storages._request_queue", "name": "fetch_next_request", "parsedDocstring": { @@ -49217,9 +49628,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 230, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L230" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 251, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L251" } ], "type": { @@ -49250,7 +49661,7 @@ ] }, "flags": {}, - "id": 16545, + "id": 13503, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -49265,14 +49676,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -49288,15 +49699,15 @@ }, "overwrites": { "name": "RequestManager.fetch_next_request", - "target": 3999, + "target": 4152, "type": "reference", "ref": { - "id": 16654, + "id": 14891, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -49304,20 +49715,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#fetch_next_request" } }, - "parentId": 3889 + "parentId": 2763 } ], "overwrites": { "name": "RequestManager.fetch_next_request", - "target": 3999, + "target": 4152, "type": "reference", "ref": { - "id": 16654, + "id": 14891, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -49326,7 +49737,7 @@ } }, "permalink": "/python/api/class/RequestQueue#fetch_next_request", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49343,7 +49754,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16546, + "id": 13504, "module": "storages._request_queue", "name": "get_request", "parsedDocstring": { @@ -49357,9 +49768,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 247, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L247" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 268, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L268" } ], "type": { @@ -49390,7 +49801,7 @@ ] }, "flags": {}, - "id": 16547, + "id": 13505, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -49411,7 +49822,7 @@ "isOptional": false, "keyword-only": false }, - "id": 16548, + "id": 13506, "kind": 32768, "kindString": "Parameter", "name": "unique_key", @@ -49421,7 +49832,7 @@ "target": 0, "ref": {} }, - "parentId": 3892 + "parentId": 2766 } ], "type": { @@ -49431,14 +49842,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -49452,11 +49863,11 @@ } ] }, - "parentId": 3891 + "parentId": 2765 } ], "permalink": "/python/api/class/RequestQueue#get_request", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49473,7 +49884,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16549, + "id": 13507, "module": "storages._request_queue", "name": "mark_request_as_handled", "parsedDocstring": { @@ -49487,9 +49898,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 258, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L258" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 279, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L279" } ], "type": { @@ -49520,7 +49931,7 @@ ] }, "flags": {}, - "id": 16550, + "id": 13508, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -49541,21 +49952,21 @@ "isOptional": false, "keyword-only": false }, - "id": 16551, + "id": 13509, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -49563,7 +49974,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 3895 + "parentId": 2769 } ], "type": { @@ -49573,15 +49984,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 16320, + "id": 12474, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -49596,15 +50007,15 @@ }, "overwrites": { "name": "RequestManager.mark_request_as_handled", - "target": 4000, + "target": 4153, "type": "reference", "ref": { - "id": 16655, + "id": 14892, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -49612,20 +50023,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#mark_request_as_handled" } }, - "parentId": 3894 + "parentId": 2768 } ], "overwrites": { "name": "RequestManager.mark_request_as_handled", - "target": 4000, + "target": 4153, "type": "reference", "ref": { - "id": 16655, + "id": 14892, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -49634,7 +50045,7 @@ } }, "permalink": "/python/api/class/RequestQueue#mark_request_as_handled", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49651,7 +50062,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16552, + "id": 13510, "module": "storages._request_queue", "name": "reclaim_request", "parsedDocstring": { @@ -49666,9 +50077,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 273, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L273" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 294, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L294" } ], "type": { @@ -49699,7 +50110,7 @@ ] }, "flags": {}, - "id": 16553, + "id": 13511, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -49720,21 +50131,21 @@ "isOptional": false, "keyword-only": false }, - "id": 16554, + "id": 13512, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 12805, + "id": 11247, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -49742,7 +50153,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 3898 + "parentId": 2772 }, { "comment": { @@ -49758,7 +50169,7 @@ "isOptional": true, "keyword-only": true }, - "id": 16555, + "id": 13513, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -49768,7 +50179,7 @@ "target": 0, "ref": {} }, - "parentId": 3898 + "parentId": 2772 } ], "type": { @@ -49778,15 +50189,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 16320, + "id": 12474, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -49801,37 +50212,37 @@ }, "overwrites": { "name": "RequestManager.reclaim_request", - "target": 2354, + "target": 2655, "type": "reference", "ref": { - "id": 15009, + "id": 13394, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#reclaim_request" } }, - "parentId": 3897 + "parentId": 2771 } ], "overwrites": { "name": "RequestManager.reclaim_request", - "target": 2354, + "target": 2655, "type": "reference", "ref": { - "id": 15009, + "id": 13394, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "kind": 2048, @@ -49839,7 +50250,7 @@ } }, "permalink": "/python/api/class/RequestQueue#reclaim_request", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49856,7 +50267,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16556, + "id": 13514, "module": "storages._request_queue", "name": "is_empty", "parsedDocstring": { @@ -49867,9 +50278,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 295, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L295" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 316, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L316" } ], "type": { @@ -49900,7 +50311,7 @@ ] }, "flags": {}, - "id": 16557, + "id": 13515, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -49916,15 +50327,15 @@ }, "overwrites": { "name": "RequestManager.is_empty", - "target": 3997, + "target": 4150, "type": "reference", "ref": { - "id": 16652, + "id": 14889, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -49932,20 +50343,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_empty" } }, - "parentId": 3901 + "parentId": 2775 } ], "overwrites": { "name": "RequestManager.is_empty", - "target": 3997, + "target": 4150, "type": "reference", "ref": { - "id": 16652, + "id": 14889, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -49954,7 +50365,7 @@ } }, "permalink": "/python/api/class/RequestQueue#is_empty", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -49971,7 +50382,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16558, + "id": 13516, "module": "storages._request_queue", "name": "is_finished", "parsedDocstring": { @@ -49982,9 +50393,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 307, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L307" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 328, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L328" } ], "type": { @@ -50015,7 +50426,7 @@ ] }, "flags": {}, - "id": 16559, + "id": 13517, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -50031,15 +50442,15 @@ }, "overwrites": { "name": "RequestManager.is_finished", - "target": 3998, + "target": 4151, "type": "reference", "ref": { - "id": 16653, + "id": 14890, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -50047,20 +50458,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_finished" } }, - "parentId": 3903 + "parentId": 2777 } ], "overwrites": { "name": "RequestManager.is_finished", - "target": 3998, + "target": 4151, "type": "reference", "ref": { - "id": 16653, + "id": 14890, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -50069,7 +50480,7 @@ } }, "permalink": "/python/api/class/RequestQueue#is_finished", - "parentId": 3852 + "parentId": 2726 }, { "kind": 2048, @@ -50086,7 +50497,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 16659, + "id": 14897, "module": "request_loaders._request_loader", "name": "to_tandem", "parsedDocstring": { @@ -50099,9 +50510,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L56" } ], "type": { @@ -50121,7 +50532,7 @@ ] }, "flags": {}, - "id": 14943, + "id": 13259, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -50143,7 +50554,7 @@ "isOptional": true, "keyword-only": false }, - "id": 14944, + "id": 13260, "kind": 32768, "kindString": "Parameter", "name": "request_manager", @@ -50153,20 +50564,20 @@ "target": 0, "ref": {} }, - "parentId": 2288 + "parentId": 2520 } ], "type": { "name": "RequestManagerTandem", "type": "reference", - "target": "2359", + "target": "2523", "ref": { - "id": 15014, + "id": 13262, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -50176,15 +50587,15 @@ }, "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 14942, + "id": 13258, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -50192,20 +50603,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#to_tandem" } }, - "parentId": 4004 + "parentId": 4158 } ], "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 14942, + "id": 13258, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -50214,7 +50625,7 @@ } }, "permalink": "/python/api/class/RequestQueue#to_tandem", - "parentId": 3852 + "parentId": 2726 } ], "comment": { @@ -50235,34 +50646,34 @@ "groups": [ { "children": [ - 16508, - 16532, - 16536, - 16528, - 16544, - 16517, - 16515, - 16546, - 16519, - 16556, - 16558, - 16549, - 16521, - 16530, - 16552, - 16659 + 13466, + 13490, + 13494, + 13486, + 13502, + 13475, + 13473, + 13504, + 13477, + 13514, + 13516, + 13507, + 13479, + 13488, + 13510, + 14897 ], "title": "Methods" }, { "children": [ - 16513, - 16514 + 13471, + 13472 ], "title": "Properties" } ], - "id": 16507, + "id": 13465, "module": "storages._request_queue", "name": "RequestQueue", "parsedDocstring": { @@ -50272,9 +50683,9 @@ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storages/_request_queue.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storages/_request_queue.py#L33" } ], "type": { @@ -50286,15 +50697,15 @@ "extendedTypes": [ { "name": "Storage", - "target": "3680", + "target": "2888", "type": "reference", "ref": { - "id": 16335, + "id": 13627, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -50304,15 +50715,15 @@ }, { "name": "RequestManager", - "target": "2339", + "target": "2638", "type": "reference", "ref": { - "id": 14994, + "id": 13377, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 18 } ], @@ -50342,7 +50753,7 @@ }, "flags": {}, "groups": [], - "id": 20336, + "id": 16644, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -50352,9 +50763,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 173, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L173" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 176, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L176" } ], "type": { @@ -50364,7 +50775,7 @@ "ref": {} }, "permalink": "/python/api/class/AddRequestsResponse#model_config", - "parentId": 3676 + "parentId": 1746 }, { "kind": 1024, @@ -50380,7 +50791,7 @@ }, "flags": {}, "groups": [], - "id": 20337, + "id": 16645, "module": "storage_clients.models", "name": "processed_requests", "parsedDocstring": { @@ -50390,9 +50801,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 175, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L175" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 178, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L178" } ], "type": { @@ -50402,15 +50813,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 20324, + "id": 16632, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -50422,7 +50833,7 @@ "ref": {} }, "permalink": "/python/api/class/AddRequestsResponse#processed_requests", - "parentId": 3676 + "parentId": 1746 }, { "kind": 1024, @@ -50438,7 +50849,7 @@ }, "flags": {}, "groups": [], - "id": 20338, + "id": 16646, "module": "storage_clients.models", "name": "unprocessed_requests", "parsedDocstring": { @@ -50448,9 +50859,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 179, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L179" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 182, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L182" } ], "type": { @@ -50460,15 +50871,15 @@ { "type": "reference", "name": "UnprocessedRequest", - "target": "3671", + "target": "1741", "ref": { - "id": 20330, + "id": 16638, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 154 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 157 } ], "kind": 128, @@ -50480,7 +50891,7 @@ "ref": {} }, "permalink": "/python/api/class/AddRequestsResponse#unprocessed_requests", - "parentId": 3676 + "parentId": 1746 } ], "comment": { @@ -50501,14 +50912,14 @@ "groups": [ { "children": [ - 20336, - 20337, - 20338 + 16644, + 16645, + 16646 ], "title": "Properties" } ], - "id": 20335, + "id": 16643, "module": "storage_clients.models", "name": "AddRequestsResponse", "parsedDocstring": { @@ -50518,9 +50929,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 165, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L165" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 168, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L168" } ], "type": { @@ -50550,7 +50961,7 @@ }, "flags": {}, "groups": [], - "id": 23997, + "id": 18375, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -50560,9 +50971,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 113, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L113" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 116, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L116" } ], "type": { @@ -50572,7 +50983,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#model_config", - "parentId": 3658 + "parentId": 1728 }, { "kind": 1024, @@ -50588,7 +50999,7 @@ }, "flags": {}, "groups": [], - "id": 23998, + "id": 18376, "module": "storage_clients.models", "name": "count", "parsedDocstring": { @@ -50598,9 +51009,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 115, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L115" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 118, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L118" } ], "type": { @@ -50610,7 +51021,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#count", - "parentId": 3658 + "parentId": 1728 }, { "kind": 1024, @@ -50626,7 +51037,7 @@ }, "flags": {}, "groups": [], - "id": 23999, + "id": 18377, "module": "storage_clients.models", "name": "offset", "parsedDocstring": { @@ -50636,9 +51047,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 118, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L118" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 121, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L121" } ], "type": { @@ -50648,7 +51059,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#offset", - "parentId": 3658 + "parentId": 1728 }, { "kind": 1024, @@ -50664,7 +51075,7 @@ }, "flags": {}, "groups": [], - "id": 24000, + "id": 18378, "module": "storage_clients.models", "name": "limit", "parsedDocstring": { @@ -50674,9 +51085,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 121, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L121" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 124, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L124" } ], "type": { @@ -50686,7 +51097,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#limit", - "parentId": 3658 + "parentId": 1728 }, { "kind": 1024, @@ -50702,7 +51113,7 @@ }, "flags": {}, "groups": [], - "id": 24001, + "id": 18379, "module": "storage_clients.models", "name": "total", "parsedDocstring": { @@ -50712,9 +51123,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 124, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L124" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 127, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L127" } ], "type": { @@ -50724,7 +51135,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#total", - "parentId": 3658 + "parentId": 1728 }, { "kind": 1024, @@ -50740,7 +51151,7 @@ }, "flags": {}, "groups": [], - "id": 24002, + "id": 18380, "module": "storage_clients.models", "name": "desc", "parsedDocstring": { @@ -50750,9 +51161,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 127, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L127" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 130, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L130" } ], "type": { @@ -50762,7 +51173,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetItemsListPage#desc", - "parentId": 3658 + "parentId": 1728 } ], "comment": { @@ -50783,17 +51194,17 @@ "groups": [ { "children": [ - 23998, - 24002, - 24000, - 23997, - 23999, - 24001 + 18376, + 18380, + 18378, + 18375, + 18377, + 18379 ], "title": "Properties" } ], - "id": 23996, + "id": 18374, "module": "storage_clients.models", "name": "DatasetItemsListPage", "parsedDocstring": { @@ -50803,9 +51214,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 110, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L110" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L113" } ], "type": { @@ -50835,7 +51246,7 @@ }, "flags": {}, "groups": [], - "id": 27642, + "id": 20090, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -50845,9 +51256,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 45, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L45" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 48, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L48" } ], "type": { @@ -50858,16 +51269,16 @@ }, "overwrites": { "name": "StorageMetadata.model_config", - "target": 3633, + "target": 1703, "type": "reference", "ref": { - "id": 27635, + "id": 20083, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "kind": 1024, @@ -50875,7 +51286,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#model_config", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -50891,7 +51302,7 @@ }, "flags": {}, "groups": [], - "id": 27643, + "id": 20091, "module": "storage_clients.models", "name": "item_count", "parsedDocstring": { @@ -50901,9 +51312,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 47, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L47" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 50, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L50" } ], "type": { @@ -50913,7 +51324,7 @@ "ref": {} }, "permalink": "/python/api/class/DatasetMetadata#item_count", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -50929,7 +51340,7 @@ }, "flags": {}, "groups": [], - "id": 27934, + "id": 22572, "module": "storage_clients.models", "name": "id", "parsedDocstring": { @@ -50939,9 +51350,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L25" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L28" } ], "type": { @@ -50952,16 +51363,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.id", - "target": 3634, + "target": 1704, "type": "reference", "ref": { - "id": 27636, + "id": 20084, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 } ], "kind": 1024, @@ -50969,7 +51380,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#id", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -50985,7 +51396,7 @@ }, "flags": {}, "groups": [], - "id": 27935, + "id": 22573, "module": "storage_clients.models", "name": "name", "parsedDocstring": { @@ -50995,9 +51406,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L28" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L31" } ], "type": { @@ -51008,16 +51419,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.name", - "target": 3635, + "target": 1705, "type": "reference", "ref": { - "id": 27637, + "id": 20085, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 } ], "kind": 1024, @@ -51025,7 +51436,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#name", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -51041,7 +51452,7 @@ }, "flags": {}, "groups": [], - "id": 27936, + "id": 22574, "module": "storage_clients.models", "name": "accessed_at", "parsedDocstring": { @@ -51051,9 +51462,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L31" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L34" } ], "type": { @@ -51064,16 +51475,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.accessed_at", - "target": 3636, + "target": 1706, "type": "reference", "ref": { - "id": 27638, + "id": 20086, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -51081,7 +51492,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#accessed_at", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -51097,7 +51508,7 @@ }, "flags": {}, "groups": [], - "id": 27937, + "id": 22575, "module": "storage_clients.models", "name": "created_at", "parsedDocstring": { @@ -51107,9 +51518,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L34" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L37" } ], "type": { @@ -51120,16 +51531,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.created_at", - "target": 3637, + "target": 1707, "type": "reference", "ref": { - "id": 27639, + "id": 20087, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "kind": 1024, @@ -51137,7 +51548,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#created_at", - "parentId": 3639 + "parentId": 1709 }, { "kind": 1024, @@ -51153,7 +51564,7 @@ }, "flags": {}, "groups": [], - "id": 27938, + "id": 22576, "module": "storage_clients.models", "name": "modified_at", "parsedDocstring": { @@ -51163,9 +51574,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L37" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L40" } ], "type": { @@ -51176,16 +51587,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.modified_at", - "target": 3638, + "target": 1708, "type": "reference", "ref": { - "id": 27640, + "id": 20088, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40 } ], "kind": 1024, @@ -51193,7 +51604,7 @@ } }, "permalink": "/python/api/class/DatasetMetadata#modified_at", - "parentId": 3639 + "parentId": 1709 } ], "comment": { @@ -51214,18 +51625,18 @@ "groups": [ { "children": [ - 27936, - 27937, - 27934, - 27643, - 27642, - 27938, - 27935 + 22574, + 22575, + 22572, + 20091, + 20090, + 22576, + 22573 ], "title": "Properties" } ], - "id": 27641, + "id": 20089, "module": "storage_clients.models", "name": "DatasetMetadata", "parsedDocstring": { @@ -51235,9 +51646,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L42" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L45" } ], "type": { @@ -51249,16 +51660,16 @@ "extendedTypes": [ { "name": "StorageMetadata", - "target": "3632", + "target": "1702", "type": "reference", "ref": { - "id": 27634, + "id": 20082, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "kind": 128, @@ -51287,7 +51698,7 @@ }, "flags": {}, "groups": [], - "id": 31581, + "id": 24289, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -51297,9 +51708,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 55, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L55" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 58, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L58" } ], "type": { @@ -51310,16 +51721,16 @@ }, "overwrites": { "name": "StorageMetadata.model_config", - "target": 3633, + "target": 1703, "type": "reference", "ref": { - "id": 31571, + "id": 24279, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "kind": 1024, @@ -51327,7 +51738,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#model_config", - "parentId": 3642 + "parentId": 1712 }, { "kind": 1024, @@ -51343,7 +51754,7 @@ }, "flags": {}, "groups": [], - "id": 31875, + "id": 26773, "module": "storage_clients.models", "name": "id", "parsedDocstring": { @@ -51353,9 +51764,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L25" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L28" } ], "type": { @@ -51366,16 +51777,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.id", - "target": 3634, + "target": 1704, "type": "reference", "ref": { - "id": 31572, + "id": 24280, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 } ], "kind": 1024, @@ -51383,7 +51794,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#id", - "parentId": 3642 + "parentId": 1712 }, { "kind": 1024, @@ -51399,7 +51810,7 @@ }, "flags": {}, "groups": [], - "id": 31876, + "id": 26774, "module": "storage_clients.models", "name": "name", "parsedDocstring": { @@ -51409,9 +51820,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L28" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L31" } ], "type": { @@ -51422,16 +51833,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.name", - "target": 3635, + "target": 1705, "type": "reference", "ref": { - "id": 31573, + "id": 24281, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 } ], "kind": 1024, @@ -51439,7 +51850,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#name", - "parentId": 3642 + "parentId": 1712 }, { "kind": 1024, @@ -51455,7 +51866,7 @@ }, "flags": {}, "groups": [], - "id": 31877, + "id": 26775, "module": "storage_clients.models", "name": "accessed_at", "parsedDocstring": { @@ -51465,9 +51876,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L31" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L34" } ], "type": { @@ -51478,16 +51889,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.accessed_at", - "target": 3636, + "target": 1706, "type": "reference", "ref": { - "id": 31574, + "id": 24282, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -51495,7 +51906,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#accessed_at", - "parentId": 3642 + "parentId": 1712 }, { "kind": 1024, @@ -51511,7 +51922,7 @@ }, "flags": {}, "groups": [], - "id": 31878, + "id": 26776, "module": "storage_clients.models", "name": "created_at", "parsedDocstring": { @@ -51521,9 +51932,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L34" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L37" } ], "type": { @@ -51534,16 +51945,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.created_at", - "target": 3637, + "target": 1707, "type": "reference", "ref": { - "id": 31575, + "id": 24283, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "kind": 1024, @@ -51551,7 +51962,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#created_at", - "parentId": 3642 + "parentId": 1712 }, { "kind": 1024, @@ -51567,7 +51978,7 @@ }, "flags": {}, "groups": [], - "id": 31879, + "id": 26777, "module": "storage_clients.models", "name": "modified_at", "parsedDocstring": { @@ -51577,9 +51988,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L37" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L40" } ], "type": { @@ -51590,16 +52001,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.modified_at", - "target": 3638, + "target": 1708, "type": "reference", "ref": { - "id": 31576, + "id": 24284, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40 } ], "kind": 1024, @@ -51607,7 +52018,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreMetadata#modified_at", - "parentId": 3642 + "parentId": 1712 } ], "comment": { @@ -51628,17 +52039,17 @@ "groups": [ { "children": [ - 31877, - 31878, - 31875, - 31581, - 31879, - 31876 + 26775, + 26776, + 26773, + 24289, + 26777, + 26774 ], "title": "Properties" } ], - "id": 31580, + "id": 24288, "module": "storage_clients.models", "name": "KeyValueStoreMetadata", "parsedDocstring": { @@ -51648,9 +52059,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L52" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L55" } ], "type": { @@ -51662,16 +52073,16 @@ "extendedTypes": [ { "name": "StorageMetadata", - "target": "3632", + "target": "1702", "type": "reference", "ref": { - "id": 31570, + "id": 24278, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "kind": 128, @@ -51700,7 +52111,7 @@ }, "flags": {}, "groups": [], - "id": 35535, + "id": 28503, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -51710,9 +52121,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L103" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L106" } ], "type": { @@ -51723,16 +52134,16 @@ }, "overwrites": { "name": "KeyValueStoreRecordMetadata.model_config", - "target": 3651, + "target": 1721, "type": "reference", "ref": { - "id": 35530, + "id": 28498, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 81 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84 } ], "kind": 1024, @@ -51740,7 +52151,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreRecord#model_config", - "parentId": 3655 + "parentId": 1725 }, { "kind": 1024, @@ -51756,7 +52167,7 @@ }, "flags": {}, "groups": [], - "id": 35536, + "id": 28504, "module": "storage_clients.models", "name": "value", "parsedDocstring": { @@ -51766,23 +52177,23 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 105, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L105" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L108" } ], "type": { "name": "KvsValueType", "type": "reference", - "target": "3631", + "target": "1701", "ref": { - "id": 35510, + "id": 28478, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 1024, @@ -51790,7 +52201,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreRecord#value", - "parentId": 3655 + "parentId": 1725 }, { "kind": 1024, @@ -51806,7 +52217,7 @@ }, "flags": {}, "groups": [], - "id": 35808, + "id": 30966, "module": "storage_clients.models", "name": "key", "parsedDocstring": { @@ -51816,9 +52227,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 83, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L83" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 86, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L86" } ], "type": { @@ -51829,16 +52240,16 @@ }, "inheritedFrom": { "name": "KeyValueStoreRecordMetadata.key", - "target": 3652, + "target": 1722, "type": "reference", "ref": { - "id": 35531, + "id": 28499, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 83 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 86 } ], "kind": 1024, @@ -51846,7 +52257,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreRecord#key", - "parentId": 3655 + "parentId": 1725 }, { "kind": 1024, @@ -51862,7 +52273,7 @@ }, "flags": {}, "groups": [], - "id": 35809, + "id": 30967, "module": "storage_clients.models", "name": "content_type", "parsedDocstring": { @@ -51872,9 +52283,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L89" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 92, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L92" } ], "type": { @@ -51885,16 +52296,16 @@ }, "inheritedFrom": { "name": "KeyValueStoreRecordMetadata.content_type", - "target": 3653, + "target": 1723, "type": "reference", "ref": { - "id": 35532, + "id": 28500, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 92 } ], "kind": 1024, @@ -51902,7 +52313,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreRecord#content_type", - "parentId": 3655 + "parentId": 1725 }, { "kind": 1024, @@ -51918,7 +52329,7 @@ }, "flags": {}, "groups": [], - "id": 35810, + "id": 30968, "module": "storage_clients.models", "name": "size", "parsedDocstring": { @@ -51928,9 +52339,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 95, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L95" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L98" } ], "type": { @@ -51941,16 +52352,16 @@ }, "inheritedFrom": { "name": "KeyValueStoreRecordMetadata.size", - "target": 3654, + "target": 1724, "type": "reference", "ref": { - "id": 35533, + "id": 28501, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 95 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98 } ], "kind": 1024, @@ -51958,7 +52369,7 @@ } }, "permalink": "/python/api/class/KeyValueStoreRecord#size", - "parentId": 3655 + "parentId": 1725 } ], "comment": { @@ -51979,16 +52390,16 @@ "groups": [ { "children": [ - 35809, - 35808, - 35535, - 35810, - 35536 + 30967, + 30966, + 28503, + 30968, + 28504 ], "title": "Properties" } ], - "id": 35534, + "id": 28502, "module": "storage_clients.models", "name": "KeyValueStoreRecord", "parsedDocstring": { @@ -51998,9 +52409,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 100, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L100" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L103" } ], "type": { @@ -52012,16 +52423,16 @@ "extendedTypes": [ { "name": "KeyValueStoreRecordMetadata", - "target": "3650", + "target": "1720", "type": "reference", "ref": { - "id": 35529, + "id": 28497, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81 } ], "kind": 128, @@ -52050,7 +52461,7 @@ }, "flags": {}, "groups": [], - "id": 39461, + "id": 32689, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -52060,9 +52471,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 81, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L81" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L84" } ], "type": { @@ -52072,7 +52483,7 @@ "ref": {} }, "permalink": "/python/api/class/KeyValueStoreRecordMetadata#model_config", - "parentId": 3650 + "parentId": 1720 }, { "kind": 1024, @@ -52088,7 +52499,7 @@ }, "flags": {}, "groups": [], - "id": 39462, + "id": 32690, "module": "storage_clients.models", "name": "key", "parsedDocstring": { @@ -52098,9 +52509,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 83, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L83" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 86, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L86" } ], "type": { @@ -52110,7 +52521,7 @@ "ref": {} }, "permalink": "/python/api/class/KeyValueStoreRecordMetadata#key", - "parentId": 3650 + "parentId": 1720 }, { "kind": 1024, @@ -52126,7 +52537,7 @@ }, "flags": {}, "groups": [], - "id": 39463, + "id": 32691, "module": "storage_clients.models", "name": "content_type", "parsedDocstring": { @@ -52136,9 +52547,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 89, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L89" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 92, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L92" } ], "type": { @@ -52148,7 +52559,7 @@ "ref": {} }, "permalink": "/python/api/class/KeyValueStoreRecordMetadata#content_type", - "parentId": 3650 + "parentId": 1720 }, { "kind": 1024, @@ -52164,7 +52575,7 @@ }, "flags": {}, "groups": [], - "id": 39464, + "id": 32692, "module": "storage_clients.models", "name": "size", "parsedDocstring": { @@ -52174,9 +52585,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 95, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L95" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 98, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L98" } ], "type": { @@ -52196,7 +52607,7 @@ ] }, "permalink": "/python/api/class/KeyValueStoreRecordMetadata#size", - "parentId": 3650 + "parentId": 1720 } ], "comment": { @@ -52217,15 +52628,15 @@ "groups": [ { "children": [ - 39463, - 39462, - 39461, - 39464 + 32691, + 32690, + 32689, + 32692 ], "title": "Properties" } ], - "id": 39460, + "id": 32688, "module": "storage_clients.models", "name": "KeyValueStoreRecordMetadata", "parsedDocstring": { @@ -52235,9 +52646,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 78, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L78" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 81, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L81" } ], "type": { @@ -52249,16 +52660,16 @@ "extendedBy": [ { "name": "KeyValueStoreRecord", - "target": "3655", + "target": "1725", "type": "reference", "ref": { - "id": 39465, + "id": 32693, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 100 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 103 } ], "kind": 128, @@ -52287,7 +52698,7 @@ }, "flags": {}, "groups": [], - "id": 43131, + "id": 34429, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -52297,9 +52708,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 143, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L143" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 146, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L146" } ], "type": { @@ -52309,7 +52720,7 @@ "ref": {} }, "permalink": "/python/api/class/ProcessedRequest#model_config", - "parentId": 3665 + "parentId": 1735 }, { "kind": 1024, @@ -52325,7 +52736,7 @@ }, "flags": {}, "groups": [], - "id": 43132, + "id": 34430, "module": "storage_clients.models", "name": "id", "parsedDocstring": { @@ -52335,9 +52746,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 145, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L145" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 148, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L148" } ], "type": { @@ -52357,7 +52768,7 @@ ] }, "permalink": "/python/api/class/ProcessedRequest#id", - "parentId": 3665 + "parentId": 1735 }, { "kind": 1024, @@ -52373,7 +52784,7 @@ }, "flags": {}, "groups": [], - "id": 43133, + "id": 34431, "module": "storage_clients.models", "name": "unique_key", "parsedDocstring": { @@ -52383,9 +52794,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 148, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L148" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 151, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L151" } ], "type": { @@ -52395,7 +52806,7 @@ "ref": {} }, "permalink": "/python/api/class/ProcessedRequest#unique_key", - "parentId": 3665 + "parentId": 1735 }, { "kind": 1024, @@ -52411,7 +52822,7 @@ }, "flags": {}, "groups": [], - "id": 43134, + "id": 34432, "module": "storage_clients.models", "name": "was_already_present", "parsedDocstring": { @@ -52421,9 +52832,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 149, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L149" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 152, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L152" } ], "type": { @@ -52433,7 +52844,7 @@ "ref": {} }, "permalink": "/python/api/class/ProcessedRequest#was_already_present", - "parentId": 3665 + "parentId": 1735 }, { "kind": 1024, @@ -52449,7 +52860,7 @@ }, "flags": {}, "groups": [], - "id": 43135, + "id": 34433, "module": "storage_clients.models", "name": "was_already_handled", "parsedDocstring": { @@ -52459,9 +52870,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 150, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L150" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 153, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L153" } ], "type": { @@ -52471,7 +52882,7 @@ "ref": {} }, "permalink": "/python/api/class/ProcessedRequest#was_already_handled", - "parentId": 3665 + "parentId": 1735 } ], "comment": { @@ -52492,16 +52903,16 @@ "groups": [ { "children": [ - 43132, - 43131, - 43133, - 43135, - 43134 + 34430, + 34429, + 34431, + 34433, + 34432 ], "title": "Properties" } ], - "id": 43130, + "id": 34428, "module": "storage_clients.models", "name": "ProcessedRequest", "parsedDocstring": { @@ -52511,9 +52922,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L140" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L143" } ], "type": { @@ -52543,7 +52954,7 @@ }, "flags": {}, "groups": [], - "id": 43286, + "id": 34942, "module": "_request", "name": "model_config", "parsedDocstring": { @@ -52553,9 +52964,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 169, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L169" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L169" } ], "type": { @@ -52565,7 +52976,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#model_config", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52581,7 +52992,7 @@ }, "flags": {}, "groups": [], - "id": 43287, + "id": 34943, "module": "_request", "name": "unique_key", "parsedDocstring": { @@ -52591,9 +53002,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 171, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L171" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L171" } ], "type": { @@ -52603,7 +53014,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#unique_key", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52619,7 +53030,7 @@ }, "flags": {}, "groups": [], - "id": 43288, + "id": 34944, "module": "_request", "name": "url", "parsedDocstring": { @@ -52629,9 +53040,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 183, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L183" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L183" } ], "type": { @@ -52641,7 +53052,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#url", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52657,7 +53068,7 @@ }, "flags": {}, "groups": [], - "id": 43289, + "id": 34945, "module": "_request", "name": "method", "parsedDocstring": { @@ -52667,23 +53078,23 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 187, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L187" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L187" } ], "type": { "name": "HttpMethod", "type": "reference", - "target": "300", + "target": "84", "ref": { - "id": 43435, + "id": 34517, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 38 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 36 } ], "kind": 1024, @@ -52691,7 +53102,7 @@ } }, "permalink": "/python/api/class/Request#method", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52707,7 +53118,7 @@ }, "flags": {}, "groups": [], - "id": 43290, + "id": 34946, "module": "_request", "name": "payload", "parsedDocstring": { @@ -52717,9 +53128,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 190, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L190" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L190" } ], "type": { @@ -52729,15 +53140,15 @@ { "type": "reference", "name": "HttpPayload", - "target": "301", + "target": "85", "ref": { - "id": 43436, + "id": 34518, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 40 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 38 } ], "kind": 1024, @@ -52751,7 +53162,7 @@ ] }, "permalink": "/python/api/class/Request#payload", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52767,7 +53178,7 @@ }, "flags": {}, "groups": [], - "id": 43291, + "id": 34947, "module": "_request", "name": "retry_count", "parsedDocstring": { @@ -52777,9 +53188,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 230, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L230" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 231, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L231" } ], "type": { @@ -52789,7 +53200,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#retry_count", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52805,7 +53216,7 @@ }, "flags": {}, "groups": [], - "id": 43292, + "id": 34948, "module": "_request", "name": "no_retry", "parsedDocstring": { @@ -52815,9 +53226,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 233, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L233" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 234, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L234" } ], "type": { @@ -52827,7 +53238,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#no_retry", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52843,7 +53254,7 @@ }, "flags": {}, "groups": [], - "id": 43293, + "id": 34949, "module": "_request", "name": "loaded_url", "parsedDocstring": { @@ -52853,9 +53264,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 236, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L236" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 237, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L237" } ], "type": { @@ -52875,7 +53286,7 @@ ] }, "permalink": "/python/api/class/Request#loaded_url", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -52891,7 +53302,7 @@ }, "flags": {}, "groups": [], - "id": 43294, + "id": 34950, "module": "_request", "name": "handled_at", "parsedDocstring": { @@ -52901,9 +53312,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L239" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 240, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L240" } ], "type": { @@ -52923,7 +53334,7 @@ ] }, "permalink": "/python/api/class/Request#handled_at", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -52944,7 +53355,7 @@ ], "flags": {}, "groups": [], - "id": 43295, + "id": 34951, "module": "_request", "name": "from_url", "parsedDocstring": { @@ -52969,9 +53380,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 243, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L243" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 244, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L244" } ], "type": { @@ -52991,7 +53402,7 @@ ] }, "flags": {}, - "id": 43296, + "id": 34952, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -53010,7 +53421,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43297, + "id": 34953, "kind": 32768, "kindString": "Parameter", "name": "url", @@ -53020,7 +53431,7 @@ "target": 0, "ref": {} }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53036,29 +53447,29 @@ "isOptional": true, "keyword-only": true }, - "id": 43298, + "id": 34954, "kind": 32768, "kindString": "Parameter", "name": "method", "type": { "name": "HttpMethod", "type": "reference", - "target": "300", + "target": "84", "ref": { - "id": 43435, + "id": 34517, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 38 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 36 } ], "kind": 1024, "permalink": "https://crawlee.dev/python/api#HttpMethod" } }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53074,7 +53485,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43299, + "id": 34955, "kind": 32768, "kindString": "Parameter", "name": "headers", @@ -53088,15 +53499,15 @@ { "type": "reference", "name": "HttpHeaders", - "target": "306", + "target": "91", "ref": { - "id": 43441, + "id": 34524, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 60 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 61 } ], "kind": 128, @@ -53131,7 +53542,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53147,7 +53558,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43300, + "id": 34956, "kind": 32768, "kindString": "Parameter", "name": "payload", @@ -53161,15 +53572,15 @@ { "type": "reference", "name": "HttpPayload", - "target": "301", + "target": "85", "ref": { - "id": 43436, + "id": 34518, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 40 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 38 } ], "kind": 1024, @@ -53190,7 +53601,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53206,7 +53617,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43301, + "id": 34957, "kind": 32768, "kindString": "Parameter", "name": "label", @@ -53226,7 +53637,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53242,7 +53653,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43302, + "id": 34958, "kind": 32768, "kindString": "Parameter", "name": "session_id", @@ -53262,7 +53673,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53278,7 +53689,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43303, + "id": 34959, "kind": 32768, "kindString": "Parameter", "name": "unique_key", @@ -53298,7 +53709,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53314,7 +53725,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43304, + "id": 34960, "kind": 32768, "kindString": "Parameter", "name": "keep_url_fragment", @@ -53324,7 +53735,7 @@ "target": 0, "ref": {} }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53340,7 +53751,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43305, + "id": 34961, "kind": 32768, "kindString": "Parameter", "name": "use_extended_unique_key", @@ -53350,7 +53761,7 @@ "target": 0, "ref": {} }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53366,7 +53777,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43306, + "id": 34962, "kind": 32768, "kindString": "Parameter", "name": "always_enqueue", @@ -53376,7 +53787,7 @@ "target": 0, "ref": {} }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53392,7 +53803,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43307, + "id": 34963, "kind": 32768, "kindString": "Parameter", "name": "enqueue_strategy", @@ -53403,15 +53814,15 @@ { "type": "reference", "name": "EnqueueStrategy", - "target": "303", + "target": "88", "ref": { - "id": 43438, + "id": 34521, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 44 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 1024, @@ -53424,7 +53835,7 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "comment": { @@ -53440,7 +53851,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43308, + "id": 34964, "kind": 32768, "kindString": "Parameter", "name": "max_retries", @@ -53460,14 +53871,14 @@ } ] }, - "parentId": 161 + "parentId": 519 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 43309, + "id": 34965, "kind": 32768, "kindString": "Parameter", "name": "kwargs", @@ -53477,7 +53888,7 @@ "target": 0, "ref": {} }, - "parentId": 161 + "parentId": 519 } ], "type": { @@ -53486,11 +53897,11 @@ "target": 0, "ref": {} }, - "parentId": 160 + "parentId": 518 } ], "permalink": "/python/api/class/Request#from_url", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -53507,7 +53918,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 43310, + "id": 34966, "module": "_request", "name": "get_query_param_from_url", "parsedDocstring": { @@ -53517,9 +53928,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 344, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L344" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 345, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L345" } ], "type": { @@ -53539,7 +53950,7 @@ ] }, "flags": {}, - "id": 43311, + "id": 34967, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -53550,7 +53961,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43312, + "id": 34968, "kind": 32768, "kindString": "Parameter", "name": "param", @@ -53560,7 +53971,7 @@ "target": 0, "ref": {} }, - "parentId": 176 + "parentId": 534 }, { "defaultValue": "None", @@ -53568,7 +53979,7 @@ "isOptional": true, "keyword-only": true }, - "id": 43313, + "id": 34969, "kind": 32768, "kindString": "Parameter", "name": "default", @@ -53588,7 +53999,7 @@ } ] }, - "parentId": 176 + "parentId": 534 } ], "type": { @@ -53607,11 +54018,11 @@ } ] }, - "parentId": 175 + "parentId": 533 } ], "permalink": "/python/api/class/Request#get_query_param_from_url", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -53632,7 +54043,7 @@ ], "flags": {}, "groups": [], - "id": 43314, + "id": 34970, "module": "_request", "name": "label", "parsedDocstring": { @@ -53642,9 +54053,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 350, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L350" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 351, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L351" } ], "type": { @@ -53664,7 +54075,7 @@ ] }, "permalink": "/python/api/class/Request#label", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -53685,7 +54096,7 @@ ], "flags": {}, "groups": [], - "id": 43315, + "id": 34971, "module": "_request", "name": "session_id", "parsedDocstring": { @@ -53695,9 +54106,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 355, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L355" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 356, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L356" } ], "type": { @@ -53717,7 +54128,7 @@ ] }, "permalink": "/python/api/class/Request#session_id", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -53738,7 +54149,7 @@ ], "flags": {}, "groups": [], - "id": 43316, + "id": 34972, "module": "_request", "name": "crawlee_data", "parsedDocstring": { @@ -53748,22 +54159,22 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 360, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L360" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 361, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L361" } ], "type": { "name": "CrawleeRequestData", "type": "reference", - "target": "99", + "target": "457", "ref": { - "id": 43234, + "id": 34890, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34 } ], @@ -53772,7 +54183,7 @@ } }, "permalink": "/python/api/class/Request#crawlee_data", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -53793,7 +54204,7 @@ ], "flags": {}, "groups": [], - "id": 43317, + "id": 34973, "module": "_request", "name": "crawl_depth", "parsedDocstring": { @@ -53803,9 +54214,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 369, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L369" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 370, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L370" } ], "type": { @@ -53815,7 +54226,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#crawl_depth", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -53837,7 +54248,7 @@ ], "flags": {}, "groups": [], - "id": 43318, + "id": 34974, "module": "_request", "name": "crawl_depth", "parsedDocstring": { @@ -53847,9 +54258,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 374, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L374" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 375, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L375" } ], "type": { @@ -53861,7 +54272,7 @@ "signatures": [ { "flags": {}, - "id": 43319, + "id": 34975, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -53872,7 +54283,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43320, + "id": 34976, "kind": 32768, "kindString": "Parameter", "name": "new_value", @@ -53882,7 +54293,7 @@ "target": 0, "ref": {} }, - "parentId": 184 + "parentId": 542 } ], "type": { @@ -53890,11 +54301,11 @@ "type": "literal", "value": {} }, - "parentId": 183 + "parentId": 541 } ], "permalink": "/python/api/class/Request#crawl_depth", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -53915,7 +54326,7 @@ ], "flags": {}, "groups": [], - "id": 43321, + "id": 34977, "module": "_request", "name": "state", "parsedDocstring": { @@ -53925,22 +54336,22 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 378, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L378" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 379, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L379" } ], "type": { "name": "RequestState", "type": "reference", - "target": "90", + "target": "448", "ref": { - "id": 43225, + "id": 34881, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 21 } ], @@ -53949,7 +54360,7 @@ } }, "permalink": "/python/api/class/Request#state", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -53971,7 +54382,7 @@ ], "flags": {}, "groups": [], - "id": 43322, + "id": 34978, "module": "_request", "name": "state", "parsedDocstring": { @@ -53981,9 +54392,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 383, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L383" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 384, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L384" } ], "type": { @@ -53995,7 +54406,7 @@ "signatures": [ { "flags": {}, - "id": 43323, + "id": 34979, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -54006,21 +54417,21 @@ "isOptional": false, "keyword-only": false }, - "id": 43324, + "id": 34980, "kind": 32768, "kindString": "Parameter", "name": "new_state", "type": { "name": "RequestState", "type": "reference", - "target": "90", + "target": "448", "ref": { - "id": 43225, + "id": 34881, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 21 } ], @@ -54028,7 +54439,7 @@ "permalink": "https://crawlee.dev/python/api/class/RequestState" } }, - "parentId": 188 + "parentId": 546 } ], "type": { @@ -54036,11 +54447,11 @@ "type": "literal", "value": {} }, - "parentId": 187 + "parentId": 545 } ], "permalink": "/python/api/class/Request#state", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54061,7 +54472,7 @@ ], "flags": {}, "groups": [], - "id": 43325, + "id": 34981, "module": "_request", "name": "max_retries", "parsedDocstring": { @@ -54071,9 +54482,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 387, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L387" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 388, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L388" } ], "type": { @@ -54093,7 +54504,7 @@ ] }, "permalink": "/python/api/class/Request#max_retries", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54114,7 +54525,7 @@ ], "flags": {}, "groups": [], - "id": 43326, + "id": 34982, "module": "_request", "name": "session_rotation_count", "parsedDocstring": { @@ -54124,9 +54535,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 392, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L392" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 393, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L393" } ], "type": { @@ -54146,7 +54557,7 @@ ] }, "permalink": "/python/api/class/Request#session_rotation_count", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -54168,7 +54579,7 @@ ], "flags": {}, "groups": [], - "id": 43327, + "id": 34983, "module": "_request", "name": "session_rotation_count", "parsedDocstring": { @@ -54178,9 +54589,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 397, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L397" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 398, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L398" } ], "type": { @@ -54192,7 +54603,7 @@ "signatures": [ { "flags": {}, - "id": 43328, + "id": 34984, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -54203,7 +54614,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43329, + "id": 34985, "kind": 32768, "kindString": "Parameter", "name": "new_session_rotation_count", @@ -54213,7 +54624,7 @@ "target": 0, "ref": {} }, - "parentId": 193 + "parentId": 551 } ], "type": { @@ -54221,11 +54632,11 @@ "type": "literal", "value": {} }, - "parentId": 192 + "parentId": 550 } ], "permalink": "/python/api/class/Request#session_rotation_count", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54246,7 +54657,7 @@ ], "flags": {}, "groups": [], - "id": 43330, + "id": 34986, "module": "_request", "name": "enqueue_strategy", "parsedDocstring": { @@ -54256,23 +54667,23 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 401, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L401" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 402, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L402" } ], "type": { "name": "EnqueueStrategy", "type": "reference", - "target": "303", + "target": "88", "ref": { - "id": 43438, + "id": 34521, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 44 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 1024, @@ -54280,7 +54691,7 @@ } }, "permalink": "/python/api/class/Request#enqueue_strategy", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -54302,7 +54713,7 @@ ], "flags": {}, "groups": [], - "id": 43331, + "id": 34987, "module": "_request", "name": "enqueue_strategy", "parsedDocstring": { @@ -54312,9 +54723,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 406, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L406" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 407, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L407" } ], "type": { @@ -54326,7 +54737,7 @@ "signatures": [ { "flags": {}, - "id": 43332, + "id": 34988, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -54337,29 +54748,29 @@ "isOptional": false, "keyword-only": false }, - "id": 43333, + "id": 34989, "kind": 32768, "kindString": "Parameter", "name": "new_enqueue_strategy", "type": { "name": "EnqueueStrategy", "type": "reference", - "target": "303", + "target": "88", "ref": { - "id": 43438, + "id": 34521, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 44 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 1024, "permalink": "https://crawlee.dev/python/api#EnqueueStrategy" } }, - "parentId": 197 + "parentId": 555 } ], "type": { @@ -54367,11 +54778,11 @@ "type": "literal", "value": {} }, - "parentId": 196 + "parentId": 554 } ], "permalink": "/python/api/class/Request#enqueue_strategy", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54392,7 +54803,7 @@ ], "flags": {}, "groups": [], - "id": 43334, + "id": 34990, "module": "_request", "name": "last_proxy_tier", "parsedDocstring": { @@ -54402,9 +54813,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 410, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L410" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 411, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L411" } ], "type": { @@ -54424,7 +54835,7 @@ ] }, "permalink": "/python/api/class/Request#last_proxy_tier", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -54446,7 +54857,7 @@ ], "flags": {}, "groups": [], - "id": 43335, + "id": 34991, "module": "_request", "name": "last_proxy_tier", "parsedDocstring": { @@ -54456,9 +54867,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 415, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L415" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 416, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L416" } ], "type": { @@ -54470,7 +54881,7 @@ "signatures": [ { "flags": {}, - "id": 43336, + "id": 34992, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -54481,7 +54892,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43337, + "id": 34993, "kind": 32768, "kindString": "Parameter", "name": "new_value", @@ -54491,7 +54902,7 @@ "target": 0, "ref": {} }, - "parentId": 201 + "parentId": 559 } ], "type": { @@ -54499,11 +54910,11 @@ "type": "literal", "value": {} }, - "parentId": 200 + "parentId": 558 } ], "permalink": "/python/api/class/Request#last_proxy_tier", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54524,7 +54935,7 @@ ], "flags": {}, "groups": [], - "id": 43338, + "id": 34994, "module": "_request", "name": "forefront", "parsedDocstring": { @@ -54534,9 +54945,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 419, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L419" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 420, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L420" } ], "type": { @@ -54546,7 +54957,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#forefront", - "parentId": 150 + "parentId": 508 }, { "kind": 2048, @@ -54568,7 +54979,7 @@ ], "flags": {}, "groups": [], - "id": 43339, + "id": 34995, "module": "_request", "name": "forefront", "parsedDocstring": { @@ -54578,9 +54989,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 424, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L424" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 425, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L425" } ], "type": { @@ -54592,7 +55003,7 @@ "signatures": [ { "flags": {}, - "id": 43340, + "id": 34996, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -54603,7 +55014,7 @@ "isOptional": false, "keyword-only": false }, - "id": 43341, + "id": 34997, "kind": 32768, "kindString": "Parameter", "name": "new_value", @@ -54613,7 +55024,7 @@ "target": 0, "ref": {} }, - "parentId": 205 + "parentId": 563 } ], "type": { @@ -54621,11 +55032,11 @@ "type": "literal", "value": {} }, - "parentId": 204 + "parentId": 562 } ], "permalink": "/python/api/class/Request#forefront", - "parentId": 150 + "parentId": 508 }, { "kind": 1024, @@ -54646,7 +55057,7 @@ ], "flags": {}, "groups": [], - "id": 43342, + "id": 34998, "module": "_request", "name": "was_already_handled", "parsedDocstring": { @@ -54656,9 +55067,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 428, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L428" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 429, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L429" } ], "type": { @@ -54668,7 +55079,7 @@ "ref": {} }, "permalink": "/python/api/class/Request#was_already_handled", - "parentId": 150 + "parentId": 508 } ], "comment": { @@ -54689,44 +55100,44 @@ "groups": [ { "children": [ - 43318, - 43331, - 43339, - 43295, - 43310, - 43335, - 43327, - 43322 + 34974, + 34987, + 34995, + 34951, + 34966, + 34991, + 34983, + 34978 ], "title": "Methods" }, { "children": [ - 43317, - 43316, - 43330, - 43338, - 43294, - 43314, - 43334, - 43293, - 43325, - 43289, - 43286, - 43292, - 43290, - 43291, - 43315, - 43326, - 43321, - 43287, - 43288, - 43342 + 34973, + 34972, + 34986, + 34994, + 34950, + 34970, + 34990, + 34949, + 34981, + 34945, + 34942, + 34948, + 34946, + 34947, + 34971, + 34982, + 34977, + 34943, + 34944, + 34998 ], "title": "Properties" } ], - "id": 43285, + "id": 34941, "module": "_request", "name": "Request", "parsedDocstring": { @@ -54736,9 +55147,9 @@ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/_request.py#L145" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/_request.py#L145" } ], "type": { @@ -54750,16 +55161,16 @@ "extendedBy": [ { "name": "RequestWithLock", - "target": "208", + "target": "566", "type": "reference", "ref": { - "id": 43343, + "id": 34999, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 433 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 434 } ], "kind": 128, @@ -54788,7 +55199,7 @@ }, "flags": {}, "groups": [], - "id": 47086, + "id": 36714, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -54798,9 +55209,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 62, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L62" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 65, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L65" } ], "type": { @@ -54811,16 +55222,16 @@ }, "overwrites": { "name": "StorageMetadata.model_config", - "target": 3633, + "target": 1703, "type": "reference", "ref": { - "id": 47074, + "id": 36702, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26 } ], "kind": 1024, @@ -54828,7 +55239,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#model_config", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -54844,7 +55255,7 @@ }, "flags": {}, "groups": [], - "id": 47087, + "id": 36715, "module": "storage_clients.models", "name": "had_multiple_clients", "parsedDocstring": { @@ -54854,9 +55265,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 64, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L64" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 67, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L67" } ], "type": { @@ -54866,7 +55277,7 @@ "ref": {} }, "permalink": "/python/api/class/RequestQueueMetadata#had_multiple_clients", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -54882,7 +55293,7 @@ }, "flags": {}, "groups": [], - "id": 47088, + "id": 36716, "module": "storage_clients.models", "name": "handled_request_count", "parsedDocstring": { @@ -54892,9 +55303,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 67, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L67" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 70, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L70" } ], "type": { @@ -54904,7 +55315,7 @@ "ref": {} }, "permalink": "/python/api/class/RequestQueueMetadata#handled_request_count", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -54920,7 +55331,7 @@ }, "flags": {}, "groups": [], - "id": 47089, + "id": 36717, "module": "storage_clients.models", "name": "pending_request_count", "parsedDocstring": { @@ -54930,9 +55341,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 70, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L70" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 73, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L73" } ], "type": { @@ -54942,7 +55353,7 @@ "ref": {} }, "permalink": "/python/api/class/RequestQueueMetadata#pending_request_count", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -54958,7 +55369,7 @@ }, "flags": {}, "groups": [], - "id": 47090, + "id": 36718, "module": "storage_clients.models", "name": "total_request_count", "parsedDocstring": { @@ -54968,9 +55379,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 73, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L73" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 76, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L76" } ], "type": { @@ -54980,7 +55391,7 @@ "ref": {} }, "permalink": "/python/api/class/RequestQueueMetadata#total_request_count", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -54996,7 +55407,7 @@ }, "flags": {}, "groups": [], - "id": 47383, + "id": 39201, "module": "storage_clients.models", "name": "id", "parsedDocstring": { @@ -55006,9 +55417,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L25" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L28" } ], "type": { @@ -55019,16 +55430,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.id", - "target": 3634, + "target": 1704, "type": "reference", "ref": { - "id": 47075, + "id": 36703, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28 } ], "kind": 1024, @@ -55036,7 +55447,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#id", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -55052,7 +55463,7 @@ }, "flags": {}, "groups": [], - "id": 47384, + "id": 39202, "module": "storage_clients.models", "name": "name", "parsedDocstring": { @@ -55062,9 +55473,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L28" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L31" } ], "type": { @@ -55075,16 +55486,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.name", - "target": 3635, + "target": 1705, "type": "reference", "ref": { - "id": 47076, + "id": 36704, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31 } ], "kind": 1024, @@ -55092,7 +55503,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#name", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -55108,7 +55519,7 @@ }, "flags": {}, "groups": [], - "id": 47385, + "id": 39203, "module": "storage_clients.models", "name": "accessed_at", "parsedDocstring": { @@ -55118,9 +55529,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L31" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L34" } ], "type": { @@ -55131,16 +55542,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.accessed_at", - "target": 3636, + "target": 1706, "type": "reference", "ref": { - "id": 47077, + "id": 36705, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34 } ], "kind": 1024, @@ -55148,7 +55559,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#accessed_at", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -55164,7 +55575,7 @@ }, "flags": {}, "groups": [], - "id": 47386, + "id": 39204, "module": "storage_clients.models", "name": "created_at", "parsedDocstring": { @@ -55174,9 +55585,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L34" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L37" } ], "type": { @@ -55187,16 +55598,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.created_at", - "target": 3637, + "target": 1707, "type": "reference", "ref": { - "id": 47078, + "id": 36706, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37 } ], "kind": 1024, @@ -55204,7 +55615,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#created_at", - "parentId": 3644 + "parentId": 1714 }, { "kind": 1024, @@ -55220,7 +55631,7 @@ }, "flags": {}, "groups": [], - "id": 47387, + "id": 39205, "module": "storage_clients.models", "name": "modified_at", "parsedDocstring": { @@ -55230,9 +55641,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L37" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L40" } ], "type": { @@ -55243,16 +55654,16 @@ }, "inheritedFrom": { "name": "StorageMetadata.modified_at", - "target": 3638, + "target": 1708, "type": "reference", "ref": { - "id": 47079, + "id": 36707, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40 } ], "kind": 1024, @@ -55260,7 +55671,7 @@ } }, "permalink": "/python/api/class/RequestQueueMetadata#modified_at", - "parentId": 3644 + "parentId": 1714 } ], "comment": { @@ -55281,21 +55692,21 @@ "groups": [ { "children": [ - 47385, - 47386, - 47087, - 47088, - 47383, - 47086, - 47387, - 47384, - 47089, - 47090 + 39203, + 39204, + 36715, + 36716, + 39201, + 36714, + 39205, + 39202, + 36717, + 36718 ], "title": "Properties" } ], - "id": 47085, + "id": 36713, "module": "storage_clients.models", "name": "RequestQueueMetadata", "parsedDocstring": { @@ -55305,9 +55716,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L59" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L62" } ], "type": { @@ -55319,16 +55730,16 @@ "extendedTypes": [ { "name": "StorageMetadata", - "target": "3632", + "target": "1702", "type": "reference", "ref": { - "id": 47073, + "id": 36701, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "kind": 128, @@ -55357,7 +55768,7 @@ }, "flags": {}, "groups": [], - "id": 51020, + "id": 40908, "module": "storage_clients.models", "name": "model_config", "parsedDocstring": { @@ -55367,9 +55778,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 23, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L23" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 26, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L26" } ], "type": { @@ -55379,7 +55790,7 @@ "ref": {} }, "permalink": "/python/api/class/StorageMetadata#model_config", - "parentId": 3632 + "parentId": 1702 }, { "kind": 1024, @@ -55395,7 +55806,7 @@ }, "flags": {}, "groups": [], - "id": 51021, + "id": 40909, "module": "storage_clients.models", "name": "id", "parsedDocstring": { @@ -55405,9 +55816,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 25, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L25" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 28, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L28" } ], "type": { @@ -55417,7 +55828,7 @@ "ref": {} }, "permalink": "/python/api/class/StorageMetadata#id", - "parentId": 3632 + "parentId": 1702 }, { "kind": 1024, @@ -55433,7 +55844,7 @@ }, "flags": {}, "groups": [], - "id": 51022, + "id": 40910, "module": "storage_clients.models", "name": "name", "parsedDocstring": { @@ -55443,9 +55854,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 28, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L28" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 31, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L31" } ], "type": { @@ -55465,7 +55876,7 @@ ] }, "permalink": "/python/api/class/StorageMetadata#name", - "parentId": 3632 + "parentId": 1702 }, { "kind": 1024, @@ -55481,7 +55892,7 @@ }, "flags": {}, "groups": [], - "id": 51023, + "id": 40911, "module": "storage_clients.models", "name": "accessed_at", "parsedDocstring": { @@ -55491,9 +55902,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L31" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 34, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L34" } ], "type": { @@ -55503,7 +55914,7 @@ "ref": {} }, "permalink": "/python/api/class/StorageMetadata#accessed_at", - "parentId": 3632 + "parentId": 1702 }, { "kind": 1024, @@ -55519,7 +55930,7 @@ }, "flags": {}, "groups": [], - "id": 51024, + "id": 40912, "module": "storage_clients.models", "name": "created_at", "parsedDocstring": { @@ -55529,9 +55940,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L34" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 37, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L37" } ], "type": { @@ -55541,7 +55952,7 @@ "ref": {} }, "permalink": "/python/api/class/StorageMetadata#created_at", - "parentId": 3632 + "parentId": 1702 }, { "kind": 1024, @@ -55557,7 +55968,7 @@ }, "flags": {}, "groups": [], - "id": 51025, + "id": 40913, "module": "storage_clients.models", "name": "modified_at", "parsedDocstring": { @@ -55567,9 +55978,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L37" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 40, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L40" } ], "type": { @@ -55579,7 +55990,7 @@ "ref": {} }, "permalink": "/python/api/class/StorageMetadata#modified_at", - "parentId": 3632 + "parentId": 1702 } ], "comment": { @@ -55600,17 +56011,17 @@ "groups": [ { "children": [ - 51023, - 51024, - 51021, - 51020, - 51025, - 51022 + 40911, + 40912, + 40909, + 40908, + 40913, + 40910 ], "title": "Properties" } ], - "id": 51019, + "id": 40907, "module": "storage_clients.models", "name": "StorageMetadata", "parsedDocstring": { @@ -55620,9 +56031,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 17, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/models.py#L17" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/models.py#L20" } ], "type": { @@ -55634,16 +56045,16 @@ "extendedBy": [ { "name": "DatasetMetadata", - "target": "3639", + "target": "1709", "type": "reference", "ref": { - "id": 51026, + "id": 40914, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 } ], "kind": 128, @@ -55652,16 +56063,16 @@ }, { "name": "KeyValueStoreMetadata", - "target": "3642", + "target": "1712", "type": "reference", "ref": { - "id": 51029, + "id": 40917, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 52 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 55 } ], "kind": 128, @@ -55670,16 +56081,16 @@ }, { "name": "RequestQueueMetadata", - "target": "3644", + "target": "1714", "type": "reference", "ref": { - "id": 51031, + "id": 40919, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 59 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 } ], "kind": 128, @@ -55709,7 +56120,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 52939, + "id": 44990, "module": "events._event_manager", "name": "__init__", "parsedDocstring": { @@ -55723,9 +56134,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 63, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L63" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L63" } ], "type": { @@ -55745,7 +56156,7 @@ ] }, "flags": {}, - "id": 52940, + "id": 44991, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -55765,7 +56176,7 @@ "isOptional": true, "keyword-only": true }, - "id": 52941, + "id": 44992, "kind": 32768, "kindString": "Parameter", "name": "persist_state_interval", @@ -55775,7 +56186,7 @@ "target": 0, "ref": {} }, - "parentId": 1909 + "parentId": 4072 }, { "comment": { @@ -55791,7 +56202,7 @@ "isOptional": true, "keyword-only": true }, - "id": 52942, + "id": 44993, "kind": 32768, "kindString": "Parameter", "name": "close_timeout", @@ -55811,7 +56222,7 @@ } ] }, - "parentId": 1909 + "parentId": 4072 } ], "type": { @@ -55819,11 +56230,11 @@ "type": "literal", "value": {} }, - "parentId": 1908 + "parentId": 4071 } ], "permalink": "/python/api/class/EventManager#__init__", - "parentId": 1907 + "parentId": 4070 }, { "kind": 1024, @@ -55844,7 +56255,7 @@ ], "flags": {}, "groups": [], - "id": 52943, + "id": 44994, "module": "events._event_manager", "name": "active", "parsedDocstring": { @@ -55854,9 +56265,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 100, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L100" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L100" } ], "type": { @@ -55866,7 +56277,7 @@ "ref": {} }, "permalink": "/python/api/class/EventManager#active", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -55876,26 +56287,26 @@ "summary": [ { "kind": "text", - "text": "Initialize the event manager upon entering the async context.\n" + "text": "Initialize the event manager upon entering the async context." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 52944, + "id": 44995, "module": "events._event_manager", "name": "__aenter__", "parsedDocstring": { - "text": "Initialize the event manager upon entering the async context.\n" + "text": "Initialize the event manager upon entering the async context." }, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 104, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L104" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L104" } ], "type": { @@ -55910,12 +56321,12 @@ "summary": [ { "kind": "text", - "text": "Initialize the event manager upon entering the async context.\n" + "text": "Initialize the event manager upon entering the async context." } ] }, "flags": {}, - "id": 52945, + "id": 44996, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -55926,14 +56337,14 @@ "type": { "name": "EventManager", "type": "reference", - "target": "1907", + "target": "4070", "ref": { - "id": 52938, + "id": 44989, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 55 } ], @@ -55941,11 +56352,11 @@ "permalink": "https://crawlee.dev/python/api/class/EventManager" } }, - "parentId": 1913 + "parentId": 4076 } ], "permalink": "/python/api/class/EventManager#__aenter__", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -55962,7 +56373,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 52946, + "id": 44997, "module": "events._event_manager", "name": "__aexit__", "parsedDocstring": { @@ -55972,9 +56383,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 117, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L117" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L113" } ], "type": { @@ -55994,7 +56405,7 @@ ] }, "flags": {}, - "id": 52947, + "id": 44998, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -56007,7 +56418,7 @@ "isOptional": false, "keyword-only": false }, - "id": 52948, + "id": 44999, "kind": 32768, "kindString": "Parameter", "name": "exc_type", @@ -56026,14 +56437,14 @@ "ref": {} } ], - "target": "981", + "target": "3727", "ref": { - "id": 52012, + "id": 44646, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/sitemap.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -56047,14 +56458,14 @@ } ] }, - "parentId": 1916 + "parentId": 4079 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 52949, + "id": 45000, "kind": 32768, "kindString": "Parameter", "name": "exc_value", @@ -56074,14 +56485,14 @@ } ] }, - "parentId": 1916 + "parentId": 4079 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 52950, + "id": 45001, "kind": 32768, "kindString": "Parameter", "name": "exc_traceback", @@ -56101,7 +56512,7 @@ } ] }, - "parentId": 1916 + "parentId": 4079 } ], "type": { @@ -56109,11 +56520,11 @@ "type": "literal", "value": {} }, - "parentId": 1915 + "parentId": 4078 } ], "permalink": "/python/api/class/EventManager#__aexit__", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -56130,7 +56541,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 52951, + "id": 45002, "module": "events._event_manager", "name": "on", "parsedDocstring": { @@ -56144,9 +56555,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L157" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L160" } ], "type": { @@ -56166,7 +56577,7 @@ ] }, "flags": {}, - "id": 52952, + "id": 45003, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56185,21 +56596,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52953, + "id": 45004, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 52899, + "id": 44934, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -56207,7 +56618,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1921 + "parentId": 4084 }, { "comment": { @@ -56222,7 +56633,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52954, + "id": 45005, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56237,14 +56648,14 @@ "ref": {} } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56252,7 +56663,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1921 + "parentId": 4084 } ], "type": { @@ -56260,7 +56671,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56272,7 +56683,7 @@ ] }, "flags": {}, - "id": 52966, + "id": 45017, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56291,7 +56702,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52967, + "id": 45018, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56309,7 +56720,7 @@ "target": 0, "ref": {} }, - "parentId": 1935 + "parentId": 4098 }, { "comment": { @@ -56324,7 +56735,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52968, + "id": 45019, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56335,14 +56746,14 @@ { "type": "reference", "name": "EventPersistStateData", - "target": "1881", + "target": "4028", "ref": { - "id": 52912, + "id": 44947, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40 } ], @@ -56351,14 +56762,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56366,7 +56777,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1935 + "parentId": 4098 } ], "type": { @@ -56374,7 +56785,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56386,7 +56797,7 @@ ] }, "flags": {}, - "id": 52969, + "id": 45020, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56405,7 +56816,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52970, + "id": 45021, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56423,7 +56834,7 @@ "target": 0, "ref": {} }, - "parentId": 1938 + "parentId": 4101 }, { "comment": { @@ -56438,7 +56849,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52971, + "id": 45022, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56449,14 +56860,14 @@ { "type": "reference", "name": "EventSystemInfoData", - "target": "1884", + "target": "4031", "ref": { - "id": 52915, + "id": 44950, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 49 } ], @@ -56465,14 +56876,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56480,7 +56891,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1938 + "parentId": 4101 } ], "type": { @@ -56488,7 +56899,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56500,7 +56911,7 @@ ] }, "flags": {}, - "id": 52972, + "id": 45023, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56519,7 +56930,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52973, + "id": 45024, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56537,7 +56948,7 @@ "target": 0, "ref": {} }, - "parentId": 1941 + "parentId": 4104 }, { "comment": { @@ -56552,7 +56963,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52974, + "id": 45025, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56563,14 +56974,14 @@ { "type": "reference", "name": "EventMigratingData", - "target": "1888", + "target": "4035", "ref": { - "id": 52919, + "id": 44954, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -56579,14 +56990,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56594,7 +57005,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1941 + "parentId": 4104 } ], "type": { @@ -56602,7 +57013,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56614,7 +57025,7 @@ ] }, "flags": {}, - "id": 52975, + "id": 45026, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56633,7 +57044,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52976, + "id": 45027, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56651,7 +57062,7 @@ "target": 0, "ref": {} }, - "parentId": 1944 + "parentId": 4107 }, { "comment": { @@ -56666,7 +57077,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52977, + "id": 45028, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56677,14 +57088,14 @@ { "type": "reference", "name": "EventAbortingData", - "target": "1891", + "target": "4038", "ref": { - "id": 52922, + "id": 44957, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 73 } ], @@ -56693,14 +57104,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56708,7 +57119,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1944 + "parentId": 4107 } ], "type": { @@ -56716,7 +57127,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56728,7 +57139,7 @@ ] }, "flags": {}, - "id": 52978, + "id": 45029, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56747,7 +57158,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52979, + "id": 45030, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56765,7 +57176,7 @@ "target": 0, "ref": {} }, - "parentId": 1947 + "parentId": 4110 }, { "comment": { @@ -56780,7 +57191,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52980, + "id": 45031, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56791,14 +57202,14 @@ { "type": "reference", "name": "EventExitData", - "target": "1893", + "target": "4040", "ref": { - "id": 52924, + "id": 44959, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 80 } ], @@ -56807,14 +57218,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56822,7 +57233,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1947 + "parentId": 4110 } ], "type": { @@ -56830,7 +57241,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56842,7 +57253,7 @@ ] }, "flags": {}, - "id": 52981, + "id": 45032, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56861,7 +57272,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52982, + "id": 45033, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -56879,7 +57290,7 @@ "target": 0, "ref": {} }, - "parentId": 1950 + "parentId": 4113 }, { "comment": { @@ -56894,7 +57305,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52983, + "id": 45034, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -56905,14 +57316,14 @@ { "type": "reference", "name": "EventCrawlerStatusData", - "target": "1895", + "target": "4042", "ref": { - "id": 52926, + "id": 44961, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 87 } ], @@ -56921,14 +57332,14 @@ } } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -56936,7 +57347,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1950 + "parentId": 4113 } ], "type": { @@ -56944,7 +57355,7 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 }, { "comment": { @@ -56956,7 +57367,7 @@ ] }, "flags": {}, - "id": 52984, + "id": 45035, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -56975,21 +57386,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52985, + "id": 45036, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 52899, + "id": 44934, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -56997,7 +57408,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1953 + "parentId": 4116 }, { "comment": { @@ -57012,7 +57423,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52986, + "id": 45037, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -57025,14 +57436,14 @@ "value": {} } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -57040,7 +57451,7 @@ "permalink": "https://crawlee.dev/python/api#EventListener" } }, - "parentId": 1953 + "parentId": 4116 } ], "type": { @@ -57048,11 +57459,11 @@ "type": "literal", "value": {} }, - "parentId": 1920 + "parentId": 4083 } ], "permalink": "/python/api/class/EventManager#on", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -57069,7 +57480,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 52955, + "id": 45006, "module": "events._event_manager", "name": "off", "parsedDocstring": { @@ -57083,9 +57494,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 207, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L207" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L210" } ], "type": { @@ -57105,7 +57516,7 @@ ] }, "flags": {}, - "id": 52956, + "id": 45007, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57124,21 +57535,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52957, + "id": 45008, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 52899, + "id": 44934, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -57146,7 +57557,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1925 + "parentId": 4088 }, { "comment": { @@ -57162,7 +57573,7 @@ "isOptional": true, "keyword-only": true }, - "id": 52958, + "id": 45009, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -57181,14 +57592,14 @@ "ref": {} } ], - "target": "1902", + "target": "4049", "ref": { - "id": 52933, + "id": 44968, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 112 } ], @@ -57202,7 +57613,7 @@ } ] }, - "parentId": 1925 + "parentId": 4088 } ], "type": { @@ -57210,11 +57621,11 @@ "type": "literal", "value": {} }, - "parentId": 1924 + "parentId": 4087 } ], "permalink": "/python/api/class/EventManager#off", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -57235,7 +57646,7 @@ ], "flags": {}, "groups": [], - "id": 52959, + "id": 45010, "module": "events._event_manager", "name": "emit", "parsedDocstring": { @@ -57249,9 +57660,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L239" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L242" } ], "type": { @@ -57271,7 +57682,7 @@ ] }, "flags": {}, - "id": 52960, + "id": 45011, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57290,21 +57701,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52961, + "id": 45012, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 52899, + "id": 44934, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -57312,7 +57723,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1929 + "parentId": 4092 }, { "comment": { @@ -57327,21 +57738,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52962, + "id": 45013, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventData", "type": "reference", - "target": "1899", + "target": "4046", "ref": { - "id": 52930, + "id": 44965, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 99 } ], @@ -57349,7 +57760,7 @@ "permalink": "https://crawlee.dev/python/api#EventData" } }, - "parentId": 1929 + "parentId": 4092 } ], "type": { @@ -57357,7 +57768,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57369,7 +57780,7 @@ ] }, "flags": {}, - "id": 52987, + "id": 45038, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57388,7 +57799,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52988, + "id": 45039, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57406,7 +57817,7 @@ "target": 0, "ref": {} }, - "parentId": 1956 + "parentId": 4119 }, { "comment": { @@ -57421,21 +57832,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52989, + "id": 45040, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventPersistStateData", "type": "reference", - "target": "1881", + "target": "4028", "ref": { - "id": 52912, + "id": 44947, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40 } ], @@ -57443,7 +57854,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventPersistStateData" } }, - "parentId": 1956 + "parentId": 4119 } ], "type": { @@ -57451,7 +57862,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57463,7 +57874,7 @@ ] }, "flags": {}, - "id": 52990, + "id": 45041, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57482,7 +57893,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52991, + "id": 45042, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57500,7 +57911,7 @@ "target": 0, "ref": {} }, - "parentId": 1959 + "parentId": 4122 }, { "comment": { @@ -57515,21 +57926,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52992, + "id": 45043, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventSystemInfoData", "type": "reference", - "target": "1884", + "target": "4031", "ref": { - "id": 52915, + "id": 44950, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 49 } ], @@ -57537,7 +57948,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventSystemInfoData" } }, - "parentId": 1959 + "parentId": 4122 } ], "type": { @@ -57545,7 +57956,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57557,7 +57968,7 @@ ] }, "flags": {}, - "id": 52993, + "id": 45044, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57576,7 +57987,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52994, + "id": 45045, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57594,7 +58005,7 @@ "target": 0, "ref": {} }, - "parentId": 1962 + "parentId": 4125 }, { "comment": { @@ -57609,21 +58020,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52995, + "id": 45046, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventMigratingData", "type": "reference", - "target": "1888", + "target": "4035", "ref": { - "id": 52919, + "id": 44954, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -57631,7 +58042,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventMigratingData" } }, - "parentId": 1962 + "parentId": 4125 } ], "type": { @@ -57639,7 +58050,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57651,7 +58062,7 @@ ] }, "flags": {}, - "id": 52996, + "id": 45047, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57670,7 +58081,7 @@ "isOptional": false, "keyword-only": true }, - "id": 52997, + "id": 45048, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57688,7 +58099,7 @@ "target": 0, "ref": {} }, - "parentId": 1965 + "parentId": 4128 }, { "comment": { @@ -57703,21 +58114,21 @@ "isOptional": false, "keyword-only": true }, - "id": 52998, + "id": 45049, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventAbortingData", "type": "reference", - "target": "1891", + "target": "4038", "ref": { - "id": 52922, + "id": 44957, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 73 } ], @@ -57725,7 +58136,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventAbortingData" } }, - "parentId": 1965 + "parentId": 4128 } ], "type": { @@ -57733,7 +58144,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57745,7 +58156,7 @@ ] }, "flags": {}, - "id": 52999, + "id": 45050, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57764,7 +58175,7 @@ "isOptional": false, "keyword-only": true }, - "id": 53000, + "id": 45051, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57782,7 +58193,7 @@ "target": 0, "ref": {} }, - "parentId": 1968 + "parentId": 4131 }, { "comment": { @@ -57797,21 +58208,21 @@ "isOptional": false, "keyword-only": true }, - "id": 53001, + "id": 45052, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventExitData", "type": "reference", - "target": "1893", + "target": "4040", "ref": { - "id": 52924, + "id": 44959, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 80 } ], @@ -57819,7 +58230,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventExitData" } }, - "parentId": 1968 + "parentId": 4131 } ], "type": { @@ -57827,7 +58238,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57839,7 +58250,7 @@ ] }, "flags": {}, - "id": 53002, + "id": 45053, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57858,7 +58269,7 @@ "isOptional": false, "keyword-only": true }, - "id": 53003, + "id": 45054, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -57876,7 +58287,7 @@ "target": 0, "ref": {} }, - "parentId": 1971 + "parentId": 4134 }, { "comment": { @@ -57891,21 +58302,21 @@ "isOptional": false, "keyword-only": true }, - "id": 53004, + "id": 45055, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventCrawlerStatusData", "type": "reference", - "target": "1895", + "target": "4042", "ref": { - "id": 52926, + "id": 44961, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 87 } ], @@ -57913,7 +58324,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventCrawlerStatusData" } }, - "parentId": 1971 + "parentId": 4134 } ], "type": { @@ -57921,7 +58332,7 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 }, { "comment": { @@ -57933,7 +58344,7 @@ ] }, "flags": {}, - "id": 53005, + "id": 45056, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -57952,21 +58363,21 @@ "isOptional": false, "keyword-only": true }, - "id": 53006, + "id": 45057, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 52899, + "id": 44934, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -57974,7 +58385,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1974 + "parentId": 4137 }, { "comment": { @@ -57989,7 +58400,7 @@ "isOptional": false, "keyword-only": true }, - "id": 53007, + "id": 45058, "kind": 32768, "kindString": "Parameter", "name": "event_data", @@ -57999,7 +58410,7 @@ "target": 0, "ref": {} }, - "parentId": 1974 + "parentId": 4137 } ], "type": { @@ -58007,11 +58418,11 @@ "type": "literal", "value": {} }, - "parentId": 1928 + "parentId": 4091 } ], "permalink": "/python/api/class/EventManager#emit", - "parentId": 1907 + "parentId": 4070 }, { "kind": 2048, @@ -58032,7 +58443,7 @@ ], "flags": {}, "groups": [], - "id": 52963, + "id": 45014, "module": "events._event_manager", "name": "wait_for_all_listeners_to_complete", "parsedDocstring": { @@ -58045,9 +58456,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 249, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L249" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L252" } ], "type": { @@ -58067,7 +58478,7 @@ ] }, "flags": {}, - "id": 52964, + "id": 45015, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -58089,7 +58500,7 @@ "isOptional": true, "keyword-only": true }, - "id": 52965, + "id": 45016, "kind": 32768, "kindString": "Parameter", "name": "timeout", @@ -58109,7 +58520,7 @@ } ] }, - "parentId": 1933 + "parentId": 4096 } ], "type": { @@ -58117,11 +58528,11 @@ "type": "literal", "value": {} }, - "parentId": 1932 + "parentId": 4095 } ], "permalink": "/python/api/class/EventManager#wait_for_all_listeners_to_complete", - "parentId": 1907 + "parentId": 4070 } ], "comment": { @@ -58142,24 +58553,24 @@ "groups": [ { "children": [ - 52944, - 52946, - 52939, - 52959, - 52955, - 52951, - 52963 + 44995, + 44997, + 44990, + 45010, + 45006, + 45002, + 45014 ], "title": "Methods" }, { "children": [ - 52943 + 44994 ], "title": "Properties" } ], - "id": 52938, + "id": 44989, "module": "events._event_manager", "name": "EventManager", "parsedDocstring": { @@ -58169,9 +58580,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 55, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L55" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L55" } ], "type": { @@ -58183,15 +58594,15 @@ "extendedBy": [ { "name": "LocalEventManager", - "target": "1853", + "target": "4051", "type": "reference", "ref": { - "id": 52884, + "id": 44970, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26 } ], @@ -58222,7 +58633,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 54861, + "id": 49110, "module": "events._local_event_manager", "name": "__init__", "parsedDocstring": { @@ -58236,9 +58647,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 34, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_local_event_manager.py#L34" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_local_event_manager.py#L34" } ], "type": { @@ -58258,7 +58669,7 @@ ] }, "flags": {}, - "id": 54862, + "id": 49111, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -58278,7 +58689,7 @@ "isOptional": true, "keyword-only": false }, - "id": 54863, + "id": 49112, "kind": 32768, "kindString": "Parameter", "name": "system_info_interval", @@ -58288,7 +58699,7 @@ "target": 0, "ref": {} }, - "parentId": 1855 + "parentId": 4053 }, { "kind": 1024, @@ -58307,7 +58718,7 @@ "optional": true }, "groups": [], - "id": 54912, + "id": 49126, "module": "events._event_manager", "name": "persist_state_interval", "parsedDocstring": { @@ -58317,9 +58728,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 47, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L47" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L47" } ], "type": { @@ -58336,7 +58747,7 @@ "target": 0, "ref": {} }, - "parentId": 1855 + "parentId": 4053 }, { "kind": 1024, @@ -58355,7 +58766,7 @@ "optional": true }, "groups": [], - "id": 54913, + "id": 49127, "module": "events._event_manager", "name": "close_timeout", "parsedDocstring": { @@ -58365,9 +58776,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 50, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L50" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L50" } ], "type": { @@ -58393,7 +58804,7 @@ "target": 0, "ref": {} }, - "parentId": 1855 + "parentId": 4053 } ], "type": { @@ -58403,15 +58814,15 @@ }, "overwrites": { "name": "EventManager.__init__", - "target": 1908, + "target": 4071, "type": "reference", "ref": { - "id": 54915, + "id": 49129, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 63 } ], @@ -58419,20 +58830,20 @@ "permalink": "https://crawlee.dev/python/api/class/EventManager#__init__" } }, - "parentId": 1854 + "parentId": 4052 } ], "overwrites": { "name": "EventManager.__init__", - "target": 1908, + "target": 4071, "type": "reference", "ref": { - "id": 54915, + "id": 49129, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 63 } ], @@ -58441,7 +58852,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#__init__", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -58462,7 +58873,7 @@ ], "flags": {}, "groups": [], - "id": 54865, + "id": 49114, "module": "events._local_event_manager", "name": "from_config", "parsedDocstring": { @@ -58475,9 +58886,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 59, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_local_event_manager.py#L59" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_local_event_manager.py#L59" } ], "type": { @@ -58497,7 +58908,7 @@ ] }, "flags": {}, - "id": 54866, + "id": 49115, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -58517,7 +58928,7 @@ "isOptional": true, "keyword-only": false }, - "id": 54867, + "id": 49116, "kind": 32768, "kindString": "Parameter", "name": "config", @@ -58528,14 +58939,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 53242, + "id": 45441, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -58549,20 +58960,20 @@ } ] }, - "parentId": 1859 + "parentId": 4057 } ], "type": { "name": "LocalEventManager", "type": "reference", - "target": "1853", + "target": "4051", "ref": { - "id": 54860, + "id": 49109, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26 } ], @@ -58570,11 +58981,11 @@ "permalink": "https://crawlee.dev/python/api/class/LocalEventManager" } }, - "parentId": 1858 + "parentId": 4056 } ], "permalink": "/python/api/class/LocalEventManager#from_config", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -58591,7 +59002,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 54868, + "id": 49117, "module": "events._local_event_manager", "name": "__aenter__", "parsedDocstring": { @@ -58601,9 +59012,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 72, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_local_event_manager.py#L72" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_local_event_manager.py#L72" } ], "type": { @@ -58623,7 +59034,7 @@ ] }, "flags": {}, - "id": 54869, + "id": 49118, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -58634,14 +59045,14 @@ "type": { "name": "LocalEventManager", "type": "reference", - "target": "1853", + "target": "4051", "ref": { - "id": 54860, + "id": 49109, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26 } ], @@ -58651,15 +59062,15 @@ }, "overwrites": { "name": "EventManager.__aenter__", - "target": 1913, + "target": 4076, "type": "reference", "ref": { - "id": 54920, + "id": 49134, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 104 } ], @@ -58667,20 +59078,20 @@ "permalink": "https://crawlee.dev/python/api/class/EventManager#__aenter__" } }, - "parentId": 1861 + "parentId": 4059 } ], "overwrites": { "name": "EventManager.__aenter__", - "target": 1913, + "target": 4076, "type": "reference", "ref": { - "id": 54920, + "id": 49134, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 104 } ], @@ -58689,7 +59100,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#__aenter__", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -58706,7 +59117,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 54870, + "id": 49119, "module": "events._local_event_manager", "name": "__aexit__", "parsedDocstring": { @@ -58716,9 +59127,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 81, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_local_event_manager.py#L81" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 84, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_local_event_manager.py#L84" } ], "type": { @@ -58738,7 +59149,7 @@ ] }, "flags": {}, - "id": 54871, + "id": 49120, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -58751,7 +59162,7 @@ "isOptional": false, "keyword-only": false }, - "id": 54872, + "id": 49121, "kind": 32768, "kindString": "Parameter", "name": "exc_type", @@ -58770,14 +59181,14 @@ "ref": {} } ], - "target": "981", + "target": "3727", "ref": { - "id": 53988, + "id": 48785, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/sitemap.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -58791,14 +59202,14 @@ } ] }, - "parentId": 1864 + "parentId": 4062 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 54873, + "id": 49122, "kind": 32768, "kindString": "Parameter", "name": "exc_value", @@ -58818,14 +59229,14 @@ } ] }, - "parentId": 1864 + "parentId": 4062 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 54874, + "id": 49123, "kind": 32768, "kindString": "Parameter", "name": "exc_traceback", @@ -58845,7 +59256,7 @@ } ] }, - "parentId": 1864 + "parentId": 4062 } ], "type": { @@ -58855,37 +59266,37 @@ }, "overwrites": { "name": "EventManager.__aexit__", - "target": 1915, + "target": 4078, "type": "reference", "ref": { - "id": 54922, + "id": 49136, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 117 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#__aexit__" } }, - "parentId": 1863 + "parentId": 4061 } ], "overwrites": { "name": "EventManager.__aexit__", - "target": 1915, + "target": 4078, "type": "reference", "ref": { - "id": 54922, + "id": 49136, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 117 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 113 } ], "kind": 2048, @@ -58893,7 +59304,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#__aexit__", - "parentId": 1853 + "parentId": 4051 }, { "kind": 1024, @@ -58914,7 +59325,7 @@ ], "flags": {}, "groups": [], - "id": 57012, + "id": 49198, "module": "events._event_manager", "name": "active", "parsedDocstring": { @@ -58924,9 +59335,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 100, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L100" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L100" } ], "type": { @@ -58937,15 +59348,15 @@ }, "inheritedFrom": { "name": "EventManager.active", - "target": 1912, + "target": 4075, "type": "reference", "ref": { - "id": 54919, + "id": 49133, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 100 } ], @@ -58954,7 +59365,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#active", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -58971,7 +59382,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 57013, + "id": 49199, "module": "events._event_manager", "name": "on", "parsedDocstring": { @@ -58985,9 +59396,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L157" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L160" } ], "type": { @@ -59007,7 +59418,7 @@ ] }, "flags": {}, - "id": 54928, + "id": 49142, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59026,21 +59437,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54929, + "id": 49143, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 54875, + "id": 49073, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -59048,7 +59459,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1921 + "parentId": 4084 }, { "comment": { @@ -59063,7 +59474,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54930, + "id": 49144, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59073,7 +59484,7 @@ "target": 0, "ref": {} }, - "parentId": 1921 + "parentId": 4084 } ], "type": { @@ -59084,23 +59495,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59112,7 +59523,7 @@ ] }, "flags": {}, - "id": 54942, + "id": 49156, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59131,7 +59542,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54943, + "id": 49157, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59141,7 +59552,7 @@ "target": 0, "ref": {} }, - "parentId": 1935 + "parentId": 4098 }, { "comment": { @@ -59156,7 +59567,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54944, + "id": 49158, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59166,7 +59577,7 @@ "target": 0, "ref": {} }, - "parentId": 1935 + "parentId": 4098 } ], "type": { @@ -59177,23 +59588,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59205,7 +59616,7 @@ ] }, "flags": {}, - "id": 54945, + "id": 49159, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59224,7 +59635,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54946, + "id": 49160, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59234,7 +59645,7 @@ "target": 0, "ref": {} }, - "parentId": 1938 + "parentId": 4101 }, { "comment": { @@ -59249,7 +59660,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54947, + "id": 49161, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59259,7 +59670,7 @@ "target": 0, "ref": {} }, - "parentId": 1938 + "parentId": 4101 } ], "type": { @@ -59270,23 +59681,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59298,7 +59709,7 @@ ] }, "flags": {}, - "id": 54948, + "id": 49162, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59317,7 +59728,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54949, + "id": 49163, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59327,7 +59738,7 @@ "target": 0, "ref": {} }, - "parentId": 1941 + "parentId": 4104 }, { "comment": { @@ -59342,7 +59753,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54950, + "id": 49164, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59352,7 +59763,7 @@ "target": 0, "ref": {} }, - "parentId": 1941 + "parentId": 4104 } ], "type": { @@ -59363,23 +59774,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59391,7 +59802,7 @@ ] }, "flags": {}, - "id": 54951, + "id": 49165, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59410,7 +59821,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54952, + "id": 49166, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59420,7 +59831,7 @@ "target": 0, "ref": {} }, - "parentId": 1944 + "parentId": 4107 }, { "comment": { @@ -59435,7 +59846,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54953, + "id": 49167, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59445,7 +59856,7 @@ "target": 0, "ref": {} }, - "parentId": 1944 + "parentId": 4107 } ], "type": { @@ -59456,23 +59867,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59484,7 +59895,7 @@ ] }, "flags": {}, - "id": 54954, + "id": 49168, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59503,7 +59914,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54955, + "id": 49169, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59513,7 +59924,7 @@ "target": 0, "ref": {} }, - "parentId": 1947 + "parentId": 4110 }, { "comment": { @@ -59528,7 +59939,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54956, + "id": 49170, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59538,7 +59949,7 @@ "target": 0, "ref": {} }, - "parentId": 1947 + "parentId": 4110 } ], "type": { @@ -59549,23 +59960,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59577,7 +59988,7 @@ ] }, "flags": {}, - "id": 54957, + "id": 49171, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59596,7 +60007,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54958, + "id": 49172, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -59606,7 +60017,7 @@ "target": 0, "ref": {} }, - "parentId": 1950 + "parentId": 4113 }, { "comment": { @@ -59621,7 +60032,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54959, + "id": 49173, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59631,7 +60042,7 @@ "target": 0, "ref": {} }, - "parentId": 1950 + "parentId": 4113 } ], "type": { @@ -59642,23 +60053,23 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 }, { "comment": { @@ -59670,7 +60081,7 @@ ] }, "flags": {}, - "id": 54960, + "id": 49174, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59689,21 +60100,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54961, + "id": 49175, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 54875, + "id": 49073, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -59711,7 +60122,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1953 + "parentId": 4116 }, { "comment": { @@ -59726,7 +60137,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54962, + "id": 49176, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59736,7 +60147,7 @@ "target": 0, "ref": {} }, - "parentId": 1953 + "parentId": 4116 } ], "type": { @@ -59747,37 +60158,37 @@ }, "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#on" } }, - "parentId": 4006 + "parentId": 4141 } ], "inheritedFrom": { "name": "EventManager.on", - "target": 1920, + "target": 4083, "type": "reference", "ref": { - "id": 54927, + "id": 49141, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 157 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 160 } ], "kind": 2048, @@ -59785,7 +60196,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#on", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -59802,7 +60213,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 57014, + "id": 49200, "module": "events._event_manager", "name": "off", "parsedDocstring": { @@ -59816,9 +60227,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 207, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L207" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L210" } ], "type": { @@ -59838,7 +60249,7 @@ ] }, "flags": {}, - "id": 54932, + "id": 49146, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -59857,21 +60268,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54933, + "id": 49147, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 54875, + "id": 49073, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -59879,7 +60290,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1925 + "parentId": 4088 }, { "comment": { @@ -59895,7 +60306,7 @@ "isOptional": true, "keyword-only": true }, - "id": 54934, + "id": 49148, "kind": 32768, "kindString": "Parameter", "name": "listener", @@ -59905,7 +60316,7 @@ "target": 0, "ref": {} }, - "parentId": 1925 + "parentId": 4088 } ], "type": { @@ -59916,37 +60327,37 @@ }, "inheritedFrom": { "name": "EventManager.off", - "target": 1924, + "target": 4087, "type": "reference", "ref": { - "id": 54931, + "id": 49145, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 207 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#off" } }, - "parentId": 4007 + "parentId": 4142 } ], "inheritedFrom": { "name": "EventManager.off", - "target": 1924, + "target": 4087, "type": "reference", "ref": { - "id": 54931, + "id": 49145, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 207 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210 } ], "kind": 2048, @@ -59954,7 +60365,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#off", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -59975,7 +60386,7 @@ ], "flags": {}, "groups": [], - "id": 57015, + "id": 49201, "module": "events._event_manager", "name": "emit", "parsedDocstring": { @@ -59989,9 +60400,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L239" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L242" } ], "type": { @@ -60011,7 +60422,7 @@ ] }, "flags": {}, - "id": 54936, + "id": 49150, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60030,21 +60441,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54937, + "id": 49151, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 54875, + "id": 49073, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -60052,7 +60463,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1929 + "parentId": 4092 }, { "comment": { @@ -60067,21 +60478,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54938, + "id": 49152, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventData", "type": "reference", - "target": "1899", + "target": "4046", "ref": { - "id": 54906, + "id": 49104, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 99 } ], @@ -60089,7 +60500,7 @@ "permalink": "https://crawlee.dev/python/api#EventData" } }, - "parentId": 1929 + "parentId": 4092 } ], "type": { @@ -60100,23 +60511,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60128,7 +60539,7 @@ ] }, "flags": {}, - "id": 54963, + "id": 49177, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60147,7 +60558,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54964, + "id": 49178, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60157,7 +60568,7 @@ "target": 0, "ref": {} }, - "parentId": 1956 + "parentId": 4119 }, { "comment": { @@ -60172,21 +60583,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54965, + "id": 49179, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventPersistStateData", "type": "reference", - "target": "1881", + "target": "4028", "ref": { - "id": 54888, + "id": 49086, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40 } ], @@ -60194,7 +60605,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventPersistStateData" } }, - "parentId": 1956 + "parentId": 4119 } ], "type": { @@ -60205,23 +60616,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60233,7 +60644,7 @@ ] }, "flags": {}, - "id": 54966, + "id": 49180, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60252,7 +60663,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54967, + "id": 49181, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60262,7 +60673,7 @@ "target": 0, "ref": {} }, - "parentId": 1959 + "parentId": 4122 }, { "comment": { @@ -60277,21 +60688,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54968, + "id": 49182, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventSystemInfoData", "type": "reference", - "target": "1884", + "target": "4031", "ref": { - "id": 54891, + "id": 49089, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 49 } ], @@ -60299,7 +60710,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventSystemInfoData" } }, - "parentId": 1959 + "parentId": 4122 } ], "type": { @@ -60310,23 +60721,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60338,7 +60749,7 @@ ] }, "flags": {}, - "id": 54969, + "id": 49183, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60357,7 +60768,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54970, + "id": 49184, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60367,7 +60778,7 @@ "target": 0, "ref": {} }, - "parentId": 1962 + "parentId": 4125 }, { "comment": { @@ -60382,21 +60793,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54971, + "id": 49185, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventMigratingData", "type": "reference", - "target": "1888", + "target": "4035", "ref": { - "id": 54895, + "id": 49093, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -60404,7 +60815,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventMigratingData" } }, - "parentId": 1962 + "parentId": 4125 } ], "type": { @@ -60415,23 +60826,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60443,7 +60854,7 @@ ] }, "flags": {}, - "id": 54972, + "id": 49186, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60462,7 +60873,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54973, + "id": 49187, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60472,7 +60883,7 @@ "target": 0, "ref": {} }, - "parentId": 1965 + "parentId": 4128 }, { "comment": { @@ -60487,21 +60898,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54974, + "id": 49188, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventAbortingData", "type": "reference", - "target": "1891", + "target": "4038", "ref": { - "id": 54898, + "id": 49096, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 73 } ], @@ -60509,7 +60920,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventAbortingData" } }, - "parentId": 1965 + "parentId": 4128 } ], "type": { @@ -60520,23 +60931,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60548,7 +60959,7 @@ ] }, "flags": {}, - "id": 54975, + "id": 49189, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60567,7 +60978,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54976, + "id": 49190, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60577,7 +60988,7 @@ "target": 0, "ref": {} }, - "parentId": 1968 + "parentId": 4131 }, { "comment": { @@ -60592,21 +61003,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54977, + "id": 49191, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventExitData", "type": "reference", - "target": "1893", + "target": "4040", "ref": { - "id": 54900, + "id": 49098, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 80 } ], @@ -60614,7 +61025,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventExitData" } }, - "parentId": 1968 + "parentId": 4131 } ], "type": { @@ -60625,23 +61036,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60653,7 +61064,7 @@ ] }, "flags": {}, - "id": 54978, + "id": 49192, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60672,7 +61083,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54979, + "id": 49193, "kind": 32768, "kindString": "Parameter", "name": "event", @@ -60682,7 +61093,7 @@ "target": 0, "ref": {} }, - "parentId": 1971 + "parentId": 4134 }, { "comment": { @@ -60697,21 +61108,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54980, + "id": 49194, "kind": 32768, "kindString": "Parameter", "name": "event_data", "type": { "name": "EventCrawlerStatusData", "type": "reference", - "target": "1895", + "target": "4042", "ref": { - "id": 54902, + "id": 49100, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 87 } ], @@ -60719,7 +61130,7 @@ "permalink": "https://crawlee.dev/python/api/class/EventCrawlerStatusData" } }, - "parentId": 1971 + "parentId": 4134 } ], "type": { @@ -60730,23 +61141,23 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 }, { "comment": { @@ -60758,7 +61169,7 @@ ] }, "flags": {}, - "id": 54981, + "id": 49195, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -60777,21 +61188,21 @@ "isOptional": false, "keyword-only": true }, - "id": 54982, + "id": 49196, "kind": 32768, "kindString": "Parameter", "name": "event", "type": { "name": "Event", "type": "reference", - "target": "1868", + "target": "4015", "ref": { - "id": 54875, + "id": 49073, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -60799,7 +61210,7 @@ "permalink": "https://crawlee.dev/python/api/enum/Event" } }, - "parentId": 1974 + "parentId": 4137 }, { "comment": { @@ -60814,7 +61225,7 @@ "isOptional": false, "keyword-only": true }, - "id": 54983, + "id": 49197, "kind": 32768, "kindString": "Parameter", "name": "event_data", @@ -60824,7 +61235,7 @@ "target": 0, "ref": {} }, - "parentId": 1974 + "parentId": 4137 } ], "type": { @@ -60835,37 +61246,37 @@ }, "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#emit" } }, - "parentId": 4008 + "parentId": 4143 } ], "inheritedFrom": { "name": "EventManager.emit", - "target": 1928, + "target": 4091, "type": "reference", "ref": { - "id": 54935, + "id": 49149, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 239 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 242 } ], "kind": 2048, @@ -60873,7 +61284,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#emit", - "parentId": 1853 + "parentId": 4051 }, { "kind": 2048, @@ -60894,7 +61305,7 @@ ], "flags": {}, "groups": [], - "id": 57016, + "id": 49202, "module": "events._event_manager", "name": "wait_for_all_listeners_to_complete", "parsedDocstring": { @@ -60907,9 +61318,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 249, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_event_manager.py#L249" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_event_manager.py#L252" } ], "type": { @@ -60929,7 +61340,7 @@ ] }, "flags": {}, - "id": 54940, + "id": 49154, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -60951,7 +61362,7 @@ "isOptional": true, "keyword-only": true }, - "id": 54941, + "id": 49155, "kind": 32768, "kindString": "Parameter", "name": "timeout", @@ -60961,7 +61372,7 @@ "target": 0, "ref": {} }, - "parentId": 1933 + "parentId": 4096 } ], "type": { @@ -60972,37 +61383,37 @@ }, "inheritedFrom": { "name": "EventManager.wait_for_all_listeners_to_complete", - "target": 1932, + "target": 4095, "type": "reference", "ref": { - "id": 54939, + "id": 49153, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 249 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/EventManager#wait_for_all_listeners_to_complete" } }, - "parentId": 4009 + "parentId": 4144 } ], "inheritedFrom": { "name": "EventManager.wait_for_all_listeners_to_complete", - "target": 1932, + "target": 4095, "type": "reference", "ref": { - "id": 54939, + "id": 49153, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 249 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 252 } ], "kind": 2048, @@ -61010,7 +61421,7 @@ } }, "permalink": "/python/api/class/LocalEventManager#wait_for_all_listeners_to_complete", - "parentId": 1853 + "parentId": 4051 } ], "comment": { @@ -61031,25 +61442,25 @@ "groups": [ { "children": [ - 54868, - 54870, - 54861, - 57015, - 54865, - 57014, - 57013, - 57016 + 49117, + 49119, + 49110, + 49201, + 49114, + 49200, + 49199, + 49202 ], "title": "Methods" }, { "children": [ - 57012 + 49198 ], "title": "Properties" } ], - "id": 54860, + "id": 49109, "module": "events._local_event_manager", "name": "LocalEventManager", "parsedDocstring": { @@ -61059,9 +61470,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_local_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_local_event_manager.py#L26" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_local_event_manager.py#L26" } ], "type": { @@ -61073,15 +61484,15 @@ "extendedTypes": [ { "name": "EventManager", - "target": "1907", + "target": "4070", "type": "reference", "ref": { - "id": 54914, + "id": 49128, "sources": [ { "character": 1, "fileName": "/src/crawlee/events/_event_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 55 } ], @@ -61111,7 +61522,7 @@ }, "flags": {}, "groups": [], - "id": 58885, + "id": 53218, "module": "events._types", "name": "PERSIST_STATE", "parsedDocstring": { @@ -61121,9 +61532,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L19" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L19" } ], "type": { @@ -61131,7 +61542,7 @@ "value": "'persistState'" }, "permalink": "/python/api/enum/Event#PERSIST_STATE", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61147,7 +61558,7 @@ }, "flags": {}, "groups": [], - "id": 58886, + "id": 53219, "module": "events._types", "name": "SYSTEM_INFO", "parsedDocstring": { @@ -61157,9 +61568,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L20" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L20" } ], "type": { @@ -61167,7 +61578,7 @@ "value": "'systemInfo'" }, "permalink": "/python/api/enum/Event#SYSTEM_INFO", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61183,7 +61594,7 @@ }, "flags": {}, "groups": [], - "id": 58887, + "id": 53220, "module": "events._types", "name": "MIGRATING", "parsedDocstring": { @@ -61193,9 +61604,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 21, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L21" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L21" } ], "type": { @@ -61203,7 +61614,7 @@ "value": "'migrating'" }, "permalink": "/python/api/enum/Event#MIGRATING", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61219,7 +61630,7 @@ }, "flags": {}, "groups": [], - "id": 58888, + "id": 53221, "module": "events._types", "name": "ABORTING", "parsedDocstring": { @@ -61229,9 +61640,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L22" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L22" } ], "type": { @@ -61239,7 +61650,7 @@ "value": "'aborting'" }, "permalink": "/python/api/enum/Event#ABORTING", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61255,7 +61666,7 @@ }, "flags": {}, "groups": [], - "id": 58889, + "id": 53222, "module": "events._types", "name": "EXIT", "parsedDocstring": { @@ -61265,9 +61676,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 23, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L23" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L23" } ], "type": { @@ -61275,7 +61686,7 @@ "value": "'exit'" }, "permalink": "/python/api/enum/Event#EXIT", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61291,7 +61702,7 @@ }, "flags": {}, "groups": [], - "id": 58890, + "id": 53223, "module": "events._types", "name": "SESSION_RETIRED", "parsedDocstring": { @@ -61301,9 +61712,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L26" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L26" } ], "type": { @@ -61311,7 +61722,7 @@ "value": "'sessionRetired'" }, "permalink": "/python/api/enum/Event#SESSION_RETIRED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61327,7 +61738,7 @@ }, "flags": {}, "groups": [], - "id": 58891, + "id": 53224, "module": "events._types", "name": "BROWSER_LAUNCHED", "parsedDocstring": { @@ -61337,9 +61748,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L29" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L29" } ], "type": { @@ -61347,7 +61758,7 @@ "value": "'browserLaunched'" }, "permalink": "/python/api/enum/Event#BROWSER_LAUNCHED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61363,7 +61774,7 @@ }, "flags": {}, "groups": [], - "id": 58892, + "id": 53225, "module": "events._types", "name": "BROWSER_RETIRED", "parsedDocstring": { @@ -61373,9 +61784,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 30, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L30" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L30" } ], "type": { @@ -61383,7 +61794,7 @@ "value": "'browserRetired'" }, "permalink": "/python/api/enum/Event#BROWSER_RETIRED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61399,7 +61810,7 @@ }, "flags": {}, "groups": [], - "id": 58893, + "id": 53226, "module": "events._types", "name": "BROWSER_CLOSED", "parsedDocstring": { @@ -61409,9 +61820,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L31" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L31" } ], "type": { @@ -61419,7 +61830,7 @@ "value": "'browserClosed'" }, "permalink": "/python/api/enum/Event#BROWSER_CLOSED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61435,7 +61846,7 @@ }, "flags": {}, "groups": [], - "id": 58894, + "id": 53227, "module": "events._types", "name": "PAGE_CREATED", "parsedDocstring": { @@ -61445,9 +61856,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 32, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L32" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L32" } ], "type": { @@ -61455,7 +61866,7 @@ "value": "'pageCreated'" }, "permalink": "/python/api/enum/Event#PAGE_CREATED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61471,7 +61882,7 @@ }, "flags": {}, "groups": [], - "id": 58895, + "id": 53228, "module": "events._types", "name": "PAGE_CLOSED", "parsedDocstring": { @@ -61481,9 +61892,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L33" } ], "type": { @@ -61491,7 +61902,7 @@ "value": "'pageClosed'" }, "permalink": "/python/api/enum/Event#PAGE_CLOSED", - "parentId": 1868 + "parentId": 4015 }, { "kind": 16, @@ -61507,7 +61918,7 @@ }, "flags": {}, "groups": [], - "id": 58896, + "id": 53229, "module": "events._types", "name": "CRAWLER_STATUS", "parsedDocstring": { @@ -61517,9 +61928,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 36, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L36" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L36" } ], "type": { @@ -61527,7 +61938,7 @@ "value": "'crawlerStatus'" }, "permalink": "/python/api/enum/Event#CRAWLER_STATUS", - "parentId": 1868 + "parentId": 4015 } ], "comment": { @@ -61548,23 +61959,23 @@ "groups": [ { "children": [ - 58888, - 58893, - 58891, - 58892, - 58896, - 58889, - 58887, - 58895, - 58894, - 58885, - 58890, - 58886 + 53221, + 53226, + 53224, + 53225, + 53229, + 53222, + 53220, + 53228, + 53227, + 53218, + 53223, + 53219 ], "title": "Enumeration members" } ], - "id": 58884, + "id": 53217, "module": "events._types", "name": "Event", "parsedDocstring": { @@ -61574,9 +61985,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L15" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L15" } ], "type": { @@ -61606,7 +62017,7 @@ }, "flags": {}, "groups": [], - "id": 60788, + "id": 57268, "module": "events._types", "name": "model_config", "parsedDocstring": { @@ -61616,9 +62027,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 76, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L76" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L76" } ], "type": { @@ -61628,7 +62039,7 @@ "ref": {} }, "permalink": "/python/api/class/EventAbortingData#model_config", - "parentId": 1891 + "parentId": 4038 } ], "comment": { @@ -61649,12 +62060,12 @@ "groups": [ { "children": [ - 60788 + 57268 ], "title": "Properties" } ], - "id": 60787, + "id": 57267, "module": "events._types", "name": "EventAbortingData", "parsedDocstring": { @@ -61664,9 +62075,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 73, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L73" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L73" } ], "type": { @@ -61696,7 +62107,7 @@ }, "flags": {}, "groups": [], - "id": 62682, + "id": 61309, "module": "events._types", "name": "model_config", "parsedDocstring": { @@ -61706,9 +62117,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 83, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L83" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L83" } ], "type": { @@ -61718,7 +62129,7 @@ "ref": {} }, "permalink": "/python/api/class/EventExitData#model_config", - "parentId": 1893 + "parentId": 4040 } ], "comment": { @@ -61739,12 +62150,12 @@ "groups": [ { "children": [ - 62682 + 61309 ], "title": "Properties" } ], - "id": 62681, + "id": 61308, "module": "events._types", "name": "EventExitData", "parsedDocstring": { @@ -61754,9 +62165,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 80, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L80" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L80" } ], "type": { @@ -61786,7 +62197,7 @@ }, "flags": {}, "groups": [], - "id": 64571, + "id": 65345, "module": "events._types", "name": "model_config", "parsedDocstring": { @@ -61796,9 +62207,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 65, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L65" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L65" } ], "type": { @@ -61808,7 +62219,7 @@ "ref": {} }, "permalink": "/python/api/class/EventMigratingData#model_config", - "parentId": 1888 + "parentId": 4035 }, { "kind": 1024, @@ -61824,7 +62235,7 @@ }, "flags": {}, "groups": [], - "id": 64572, + "id": 65346, "module": "events._types", "name": "time_remaining", "parsedDocstring": { @@ -61834,9 +62245,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 69, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L69" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L69" } ], "type": { @@ -61846,14 +62257,14 @@ { "type": "reference", "name": "timedelta_secs", - "target": "791", + "target": "3522", "ref": { - "id": 63473, + "id": 64831, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 68 } ], @@ -61868,7 +62279,7 @@ ] }, "permalink": "/python/api/class/EventMigratingData#time_remaining", - "parentId": 1888 + "parentId": 4035 } ], "comment": { @@ -61889,13 +62300,13 @@ "groups": [ { "children": [ - 64571, - 64572 + 65345, + 65346 ], "title": "Properties" } ], - "id": 64570, + "id": 65344, "module": "events._types", "name": "EventMigratingData", "parsedDocstring": { @@ -61905,9 +62316,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L62" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L62" } ], "type": { @@ -61937,7 +62348,7 @@ }, "flags": {}, "groups": [], - "id": 66454, + "id": 69375, "module": "events._types", "name": "model_config", "parsedDocstring": { @@ -61947,9 +62358,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 43, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L43" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L43" } ], "type": { @@ -61959,7 +62370,7 @@ "ref": {} }, "permalink": "/python/api/class/EventPersistStateData#model_config", - "parentId": 1881 + "parentId": 4028 }, { "kind": 1024, @@ -61975,7 +62386,7 @@ }, "flags": {}, "groups": [], - "id": 66455, + "id": 69376, "module": "events._types", "name": "is_migrating", "parsedDocstring": { @@ -61985,9 +62396,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L45" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L45" } ], "type": { @@ -61997,7 +62408,7 @@ "ref": {} }, "permalink": "/python/api/class/EventPersistStateData#is_migrating", - "parentId": 1881 + "parentId": 4028 } ], "comment": { @@ -62018,13 +62429,13 @@ "groups": [ { "children": [ - 66455, - 66454 + 69376, + 69375 ], "title": "Properties" } ], - "id": 66453, + "id": 69374, "module": "events._types", "name": "EventPersistStateData", "parsedDocstring": { @@ -62034,9 +62445,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L40" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L40" } ], "type": { @@ -62066,7 +62477,7 @@ }, "flags": {}, "groups": [], - "id": 68340, + "id": 73408, "module": "events._types", "name": "model_config", "parsedDocstring": { @@ -62076,9 +62487,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 52, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L52" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L52" } ], "type": { @@ -62088,7 +62499,7 @@ "ref": {} }, "permalink": "/python/api/class/EventSystemInfoData#model_config", - "parentId": 1884 + "parentId": 4031 }, { "kind": 1024, @@ -62104,7 +62515,7 @@ }, "flags": {}, "groups": [], - "id": 68341, + "id": 73409, "module": "events._types", "name": "cpu_info", "parsedDocstring": { @@ -62114,22 +62525,22 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 54, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L54" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L54" } ], "type": { "name": "CpuInfo", "type": "reference", - "target": "887", + "target": "3647", "ref": { - "id": 67342, + "id": 73023, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/system.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 36 } ], @@ -62138,7 +62549,7 @@ } }, "permalink": "/python/api/class/EventSystemInfoData#cpu_info", - "parentId": 1884 + "parentId": 4031 }, { "kind": 1024, @@ -62154,7 +62565,7 @@ }, "flags": {}, "groups": [], - "id": 68342, + "id": 73410, "module": "events._types", "name": "memory_info", "parsedDocstring": { @@ -62164,22 +62575,22 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 55, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L55" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L55" } ], "type": { "name": "MemoryUsageInfo", "type": "reference", - "target": "890", + "target": "3650", "ref": { - "id": 67345, + "id": 73026, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/system.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 59 } ], @@ -62188,7 +62599,7 @@ } }, "permalink": "/python/api/class/EventSystemInfoData#memory_info", - "parentId": 1884 + "parentId": 4031 } ], "comment": { @@ -62209,14 +62620,14 @@ "groups": [ { "children": [ - 68341, - 68342, - 68340 + 73409, + 73410, + 73408 ], "title": "Properties" } ], - "id": 68339, + "id": 73407, "module": "events._types", "name": "EventSystemInfoData", "parsedDocstring": { @@ -62226,9 +62637,9 @@ { "character": 1, "fileName": "/src/crawlee/events/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 49, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/events/_types.py#L49" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/events/_types.py#L49" } ], "type": { @@ -62259,7 +62670,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 71127, + "id": 75826, "module": "storage_clients._base._storage_client", "name": "get_storage_client_cache_key", "parsedDocstring": { @@ -62269,9 +62680,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L33" } ], "type": { @@ -62291,7 +62702,7 @@ ] }, "flags": {}, - "id": 71128, + "id": 75827, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -62302,21 +62713,21 @@ "isOptional": false, "keyword-only": false }, - "id": 71129, + "id": 75828, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "235", + "target": "383", "ref": { - "id": 68577, + "id": 73793, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -62324,7 +62735,7 @@ "permalink": "https://crawlee.dev/python/api/class/Configuration" } }, - "parentId": 2786 + "parentId": 2417 } ], "type": { @@ -62335,15 +62746,15 @@ }, "overwrites": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 71127, + "id": 75826, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -62351,11 +62762,11 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_storage_client_cache_key" } }, - "parentId": 2785 + "parentId": 2416 } ], "permalink": "/python/api/class/StorageClient#get_storage_client_cache_key", - "parentId": 2784 + "parentId": 2415 }, { "kind": 2048, @@ -62376,7 +62787,7 @@ ], "flags": {}, "groups": [], - "id": 71130, + "id": 75829, "module": "storage_clients._base._storage_client", "name": "create_dataset_client", "parsedDocstring": { @@ -62386,9 +62797,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L42" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L42" } ], "type": { @@ -62408,7 +62819,7 @@ ] }, "flags": {}, - "id": 71131, + "id": 75830, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -62422,7 +62833,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71132, + "id": 75831, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -62442,7 +62853,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -62450,7 +62861,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71133, + "id": 75832, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -62470,7 +62881,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -62478,7 +62889,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71134, + "id": 75833, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -62498,7 +62909,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -62506,7 +62917,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71135, + "id": 75834, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -62517,14 +62928,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 68577, + "id": 73793, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -62538,21 +62949,21 @@ } ] }, - "parentId": 2789 + "parentId": 2420 } ], "type": { "name": "DatasetClient", "type": "reference", - "target": "2808", + "target": "2381", "ref": { - "id": 71150, + "id": 75791, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 128, @@ -62561,15 +62972,15 @@ }, "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 71130, + "id": 75829, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -62577,11 +62988,11 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_dataset_client" } }, - "parentId": 2788 + "parentId": 2419 } ], "permalink": "/python/api/class/StorageClient#create_dataset_client", - "parentId": 2784 + "parentId": 2415 }, { "kind": 2048, @@ -62602,7 +63013,7 @@ ], "flags": {}, "groups": [], - "id": 71136, + "id": 75835, "module": "storage_clients._base._storage_client", "name": "create_kvs_client", "parsedDocstring": { @@ -62612,9 +63023,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L53" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L53" } ], "type": { @@ -62634,7 +63045,7 @@ ] }, "flags": {}, - "id": 71137, + "id": 75836, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -62648,7 +63059,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71138, + "id": 75837, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -62668,7 +63079,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -62676,7 +63087,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71139, + "id": 75838, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -62696,7 +63107,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -62704,7 +63115,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71140, + "id": 75839, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -62724,7 +63135,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -62732,7 +63143,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71141, + "id": 75840, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -62743,14 +63154,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 68577, + "id": 73793, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -62764,20 +63175,20 @@ } ] }, - "parentId": 2795 + "parentId": 2426 } ], "type": { "name": "KeyValueStoreClient", "type": "reference", - "target": "2842", + "target": "2328", "ref": { - "id": 71184, + "id": 75738, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 14 } ], @@ -62787,15 +63198,15 @@ }, "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 71136, + "id": 75835, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -62803,11 +63214,11 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_kvs_client" } }, - "parentId": 2794 + "parentId": 2425 } ], "permalink": "/python/api/class/StorageClient#create_kvs_client", - "parentId": 2784 + "parentId": 2415 }, { "kind": 2048, @@ -62828,7 +63239,7 @@ ], "flags": {}, "groups": [], - "id": 71142, + "id": 75841, "module": "storage_clients._base._storage_client", "name": "create_rq_client", "parsedDocstring": { @@ -62838,9 +63249,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L64" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L64" } ], "type": { @@ -62860,7 +63271,7 @@ ] }, "flags": {}, - "id": 71143, + "id": 75842, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -62874,7 +63285,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71144, + "id": 75843, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -62894,7 +63305,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -62902,7 +63313,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71145, + "id": 75844, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -62922,7 +63333,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -62930,7 +63341,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71146, + "id": 75845, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -62950,7 +63361,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -62958,7 +63369,7 @@ "isOptional": true, "keyword-only": true }, - "id": 71147, + "id": 75846, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -62969,14 +63380,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 68577, + "id": 73793, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -62990,20 +63401,20 @@ } ] }, - "parentId": 2801 + "parentId": 2432 } ], "type": { "name": "RequestQueueClient", "type": "reference", - "target": "2759", + "target": "2356", "ref": { - "id": 71101, + "id": 75766, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 13 } ], @@ -63013,15 +63424,15 @@ }, "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 71142, + "id": 75841, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -63029,11 +63440,11 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_rq_client" } }, - "parentId": 2800 + "parentId": 2431 } ], "permalink": "/python/api/class/StorageClient#create_rq_client", - "parentId": 2784 + "parentId": 2415 }, { "kind": 2048, @@ -63050,7 +63461,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 71148, + "id": 75847, "module": "storage_clients._base._storage_client", "name": "get_rate_limit_errors", "parsedDocstring": { @@ -63060,9 +63471,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L74" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L74" } ], "type": { @@ -63082,7 +63493,7 @@ ] }, "flags": {}, - "id": 71149, + "id": 75848, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -63108,11 +63519,11 @@ "target": 0, "ref": {} }, - "parentId": 2806 + "parentId": 2437 } ], "permalink": "/python/api/class/StorageClient#get_rate_limit_errors", - "parentId": 2784 + "parentId": 2415 } ], "comment": { @@ -63133,16 +63544,16 @@ "groups": [ { "children": [ - 71130, - 71136, - 71142, - 71148, - 71127 + 75829, + 75835, + 75841, + 75847, + 75826 ], "title": "Methods" } ], - "id": 71126, + "id": 75825, "module": "storage_clients._base._storage_client", "name": "StorageClient", "parsedDocstring": { @@ -63152,9 +63563,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L19" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L19" } ], "type": { @@ -63165,34 +63576,34 @@ }, "extendedBy": [ { - "name": "FileSystemStorageClient", - "target": "2870", + "name": "RedisStorageClient", + "target": "1664", "type": "reference", "ref": { - "id": 71212, + "id": 75074, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 20 + "fileName": "/src/crawlee/storage_clients/_redis/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 19 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/FileSystemStorageClient" + "permalink": "https://crawlee.dev/python/api/class/RedisStorageClient" } }, { "name": "MemoryStorageClient", - "target": "3108", + "target": "1863", "type": "reference", "ref": { - "id": 71450, + "id": 75273, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_memory/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15 } ], @@ -63201,35 +63612,35 @@ } }, { - "name": "RedisStorageClient", - "target": "3222", + "name": "FileSystemStorageClient", + "target": "2019", "type": "reference", "ref": { - "id": 71564, + "id": 75429, "sources": [ { "character": 1, - "fileName": "/src/crawlee/storage_clients/_redis/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 19 + "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 20 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/RedisStorageClient" + "permalink": "https://crawlee.dev/python/api/class/FileSystemStorageClient" } }, { "name": "SqlStorageClient", - "target": "3591", + "target": "2276", "type": "reference", "ref": { - "id": 71933, + "id": 75686, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 32 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 } ], "kind": 128, @@ -63263,7 +63674,7 @@ ], "flags": {}, "groups": [], - "id": 75042, + "id": 77712, "module": "storage_clients._base._storage_client", "name": "create_dataset_client", "parsedDocstring": { @@ -63273,9 +63684,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_memory/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_memory/_storage_client.py#L31" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_memory/_storage_client.py#L31" } ], "type": { @@ -63295,7 +63706,7 @@ ] }, "flags": {}, - "id": 74722, + "id": 78268, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -63309,7 +63720,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74723, + "id": 78269, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -63329,7 +63740,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -63337,7 +63748,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74724, + "id": 78270, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -63357,7 +63768,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -63365,7 +63776,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74725, + "id": 78271, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -63385,7 +63796,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -63393,7 +63804,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74726, + "id": 78272, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -63404,14 +63815,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 72168, + "id": 76231, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -63425,21 +63836,21 @@ } ] }, - "parentId": 2789 + "parentId": 2420 } ], "type": { "name": "DatasetClient", "type": "reference", - "target": "2808", + "target": "2381", "ref": { - "id": 74741, + "id": 78229, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 128, @@ -63448,15 +63859,15 @@ }, "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 74721, + "id": 78267, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -63464,20 +63875,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_dataset_client" } }, - "parentId": 3109 + "parentId": 1864 } ], "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 74721, + "id": 78267, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -63486,7 +63897,7 @@ } }, "permalink": "/python/api/class/MemoryStorageClient#create_dataset_client", - "parentId": 3108 + "parentId": 1863 }, { "kind": 2048, @@ -63507,7 +63918,7 @@ ], "flags": {}, "groups": [], - "id": 75048, + "id": 77718, "module": "storage_clients._base._storage_client", "name": "create_kvs_client", "parsedDocstring": { @@ -63517,9 +63928,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_memory/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_memory/_storage_client.py#L45" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_memory/_storage_client.py#L45" } ], "type": { @@ -63539,7 +63950,7 @@ ] }, "flags": {}, - "id": 74728, + "id": 78274, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -63553,7 +63964,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74729, + "id": 78275, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -63573,7 +63984,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -63581,7 +63992,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74730, + "id": 78276, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -63601,7 +64012,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -63609,7 +64020,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74731, + "id": 78277, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -63629,7 +64040,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -63637,7 +64048,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74732, + "id": 78278, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -63648,14 +64059,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 72168, + "id": 76231, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -63669,20 +64080,20 @@ } ] }, - "parentId": 2795 + "parentId": 2426 } ], "type": { "name": "KeyValueStoreClient", "type": "reference", - "target": "2842", + "target": "2328", "ref": { - "id": 74775, + "id": 78176, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 14 } ], @@ -63692,15 +64103,15 @@ }, "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 74727, + "id": 78273, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -63708,20 +64119,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_kvs_client" } }, - "parentId": 3115 + "parentId": 1870 } ], "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 74727, + "id": 78273, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -63730,7 +64141,7 @@ } }, "permalink": "/python/api/class/MemoryStorageClient#create_kvs_client", - "parentId": 3108 + "parentId": 1863 }, { "kind": 2048, @@ -63751,7 +64162,7 @@ ], "flags": {}, "groups": [], - "id": 75054, + "id": 77724, "module": "storage_clients._base._storage_client", "name": "create_rq_client", "parsedDocstring": { @@ -63761,9 +64172,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_memory/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 59, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_memory/_storage_client.py#L59" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_memory/_storage_client.py#L59" } ], "type": { @@ -63783,7 +64194,7 @@ ] }, "flags": {}, - "id": 74734, + "id": 78280, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -63797,7 +64208,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74735, + "id": 78281, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -63817,7 +64228,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -63825,7 +64236,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74736, + "id": 78282, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -63845,7 +64256,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -63853,7 +64264,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74737, + "id": 78283, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -63873,7 +64284,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -63881,7 +64292,7 @@ "isOptional": true, "keyword-only": true }, - "id": 74738, + "id": 78284, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -63892,14 +64303,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 72168, + "id": 76231, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -63913,20 +64324,20 @@ } ] }, - "parentId": 2801 + "parentId": 2432 } ], "type": { "name": "RequestQueueClient", "type": "reference", - "target": "2759", + "target": "2356", "ref": { - "id": 74692, + "id": 78204, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 13 } ], @@ -63936,15 +64347,15 @@ }, "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 74733, + "id": 78279, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -63952,20 +64363,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_rq_client" } }, - "parentId": 3121 + "parentId": 1876 } ], "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 74733, + "id": 78279, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -63974,7 +64385,7 @@ } }, "permalink": "/python/api/class/MemoryStorageClient#create_rq_client", - "parentId": 3108 + "parentId": 1863 }, { "kind": 2048, @@ -63991,7 +64402,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 75921, + "id": 80057, "module": "storage_clients._base._storage_client", "name": "get_storage_client_cache_key", "parsedDocstring": { @@ -64001,9 +64412,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L33" } ], "type": { @@ -64023,7 +64434,7 @@ ] }, "flags": {}, - "id": 74719, + "id": 78265, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -64034,21 +64445,21 @@ "isOptional": false, "keyword-only": false }, - "id": 74720, + "id": 78266, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "235", + "target": "383", "ref": { - "id": 72168, + "id": 76231, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -64056,7 +64467,7 @@ "permalink": "https://crawlee.dev/python/api/class/Configuration" } }, - "parentId": 2786 + "parentId": 2417 } ], "type": { @@ -64067,15 +64478,15 @@ }, "inheritedFrom": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 74718, + "id": 78264, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -64083,20 +64494,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_storage_client_cache_key" } }, - "parentId": 3988 + "parentId": 4209 } ], "inheritedFrom": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 74718, + "id": 78264, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -64105,7 +64516,7 @@ } }, "permalink": "/python/api/class/MemoryStorageClient#get_storage_client_cache_key", - "parentId": 3108 + "parentId": 1863 }, { "kind": 2048, @@ -64122,7 +64533,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 75922, + "id": 80058, "module": "storage_clients._base._storage_client", "name": "get_rate_limit_errors", "parsedDocstring": { @@ -64132,9 +64543,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L74" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L74" } ], "type": { @@ -64154,7 +64565,7 @@ ] }, "flags": {}, - "id": 74740, + "id": 78286, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -64168,15 +64579,15 @@ }, "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 74739, + "id": 78285, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -64184,20 +64595,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_rate_limit_errors" } }, - "parentId": 3989 + "parentId": 4210 } ], "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 74739, + "id": 78285, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -64206,7 +64617,7 @@ } }, "permalink": "/python/api/class/MemoryStorageClient#get_rate_limit_errors", - "parentId": 3108 + "parentId": 1863 } ], "comment": { @@ -64227,16 +64638,16 @@ "groups": [ { "children": [ - 75042, - 75048, - 75054, - 75922, - 75921 + 77712, + 77718, + 77724, + 80058, + 80057 ], "title": "Methods" } ], - "id": 75041, + "id": 77711, "module": "storage_clients._memory._storage_client", "name": "MemoryStorageClient", "parsedDocstring": { @@ -64246,9 +64657,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_memory/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 15, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_memory/_storage_client.py#L15" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_memory/_storage_client.py#L15" } ], "type": { @@ -64260,15 +64671,15 @@ "extendedTypes": [ { "name": "StorageClient", - "target": "2784", + "target": "2415", "type": "reference", "ref": { - "id": 74717, + "id": 78263, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -64299,7 +64710,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 78793, + "id": 82078, "module": "storage_clients._base._storage_client", "name": "get_storage_client_cache_key", "parsedDocstring": { @@ -64309,9 +64720,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 38, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_file_system/_storage_client.py#L38" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_file_system/_storage_client.py#L38" } ], "type": { @@ -64331,7 +64742,7 @@ ] }, "flags": {}, - "id": 78708, + "id": 82475, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -64342,21 +64753,21 @@ "isOptional": false, "keyword-only": false }, - "id": 78709, + "id": 82476, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "235", + "target": "383", "ref": { - "id": 76157, + "id": 80441, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -64364,7 +64775,7 @@ "permalink": "https://crawlee.dev/python/api/class/Configuration" } }, - "parentId": 2786 + "parentId": 2417 } ], "type": { @@ -64375,15 +64786,15 @@ }, "overwrites": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 78707, + "id": 82474, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -64391,20 +64802,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_storage_client_cache_key" } }, - "parentId": 2871 + "parentId": 2020 } ], "overwrites": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 78707, + "id": 82474, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -64413,7 +64824,7 @@ } }, "permalink": "/python/api/class/FileSystemStorageClient#get_storage_client_cache_key", - "parentId": 2870 + "parentId": 2019 }, { "kind": 2048, @@ -64434,7 +64845,7 @@ ], "flags": {}, "groups": [], - "id": 78796, + "id": 82081, "module": "storage_clients._base._storage_client", "name": "create_dataset_client", "parsedDocstring": { @@ -64444,9 +64855,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 43, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_file_system/_storage_client.py#L43" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_file_system/_storage_client.py#L43" } ], "type": { @@ -64466,7 +64877,7 @@ ] }, "flags": {}, - "id": 78711, + "id": 82478, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -64480,7 +64891,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78712, + "id": 82479, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -64500,7 +64911,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -64508,7 +64919,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78713, + "id": 82480, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -64528,7 +64939,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -64536,7 +64947,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78714, + "id": 82481, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -64556,7 +64967,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -64564,7 +64975,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78715, + "id": 82482, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -64575,14 +64986,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 76157, + "id": 80441, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -64596,21 +65007,21 @@ } ] }, - "parentId": 2789 + "parentId": 2420 } ], "type": { "name": "DatasetClient", "type": "reference", - "target": "2808", + "target": "2381", "ref": { - "id": 78730, + "id": 82439, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 128, @@ -64619,15 +65030,15 @@ }, "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 78710, + "id": 82477, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -64635,20 +65046,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_dataset_client" } }, - "parentId": 2874 + "parentId": 2023 } ], "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 78710, + "id": 82477, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -64657,7 +65068,7 @@ } }, "permalink": "/python/api/class/FileSystemStorageClient#create_dataset_client", - "parentId": 2870 + "parentId": 2019 }, { "kind": 2048, @@ -64678,7 +65089,7 @@ ], "flags": {}, "groups": [], - "id": 78802, + "id": 82087, "module": "storage_clients._base._storage_client", "name": "create_kvs_client", "parsedDocstring": { @@ -64688,9 +65099,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 57, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_file_system/_storage_client.py#L57" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_file_system/_storage_client.py#L57" } ], "type": { @@ -64710,7 +65121,7 @@ ] }, "flags": {}, - "id": 78717, + "id": 82484, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -64724,7 +65135,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78718, + "id": 82485, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -64744,7 +65155,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -64752,7 +65163,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78719, + "id": 82486, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -64772,7 +65183,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -64780,7 +65191,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78720, + "id": 82487, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -64800,7 +65211,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -64808,7 +65219,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78721, + "id": 82488, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -64819,14 +65230,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 76157, + "id": 80441, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -64840,20 +65251,20 @@ } ] }, - "parentId": 2795 + "parentId": 2426 } ], "type": { "name": "KeyValueStoreClient", "type": "reference", - "target": "2842", + "target": "2328", "ref": { - "id": 78764, + "id": 82386, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 14 } ], @@ -64863,15 +65274,15 @@ }, "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 78716, + "id": 82483, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -64879,20 +65290,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_kvs_client" } }, - "parentId": 2880 + "parentId": 2029 } ], "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 78716, + "id": 82483, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -64901,7 +65312,7 @@ } }, "permalink": "/python/api/class/FileSystemStorageClient#create_kvs_client", - "parentId": 2870 + "parentId": 2019 }, { "kind": 2048, @@ -64922,7 +65333,7 @@ ], "flags": {}, "groups": [], - "id": 78808, + "id": 82093, "module": "storage_clients._base._storage_client", "name": "create_rq_client", "parsedDocstring": { @@ -64932,9 +65343,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 71, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_file_system/_storage_client.py#L71" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_file_system/_storage_client.py#L71" } ], "type": { @@ -64954,7 +65365,7 @@ ] }, "flags": {}, - "id": 78723, + "id": 82490, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -64968,7 +65379,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78724, + "id": 82491, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -64988,7 +65399,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -64996,7 +65407,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78725, + "id": 82492, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -65016,7 +65427,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -65024,7 +65435,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78726, + "id": 82493, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -65044,7 +65455,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -65052,7 +65463,7 @@ "isOptional": true, "keyword-only": true }, - "id": 78727, + "id": 82494, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -65063,14 +65474,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 76157, + "id": 80441, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -65084,20 +65495,20 @@ } ] }, - "parentId": 2801 + "parentId": 2432 } ], "type": { "name": "RequestQueueClient", "type": "reference", - "target": "2759", + "target": "2356", "ref": { - "id": 78681, + "id": 82414, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 13 } ], @@ -65107,15 +65518,15 @@ }, "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 78722, + "id": 82489, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -65123,20 +65534,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_rq_client" } }, - "parentId": 2886 + "parentId": 2035 } ], "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 78722, + "id": 82489, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -65145,7 +65556,7 @@ } }, "permalink": "/python/api/class/FileSystemStorageClient#create_rq_client", - "parentId": 2870 + "parentId": 2019 }, { "kind": 2048, @@ -65162,7 +65573,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 79909, + "id": 84269, "module": "storage_clients._base._storage_client", "name": "get_rate_limit_errors", "parsedDocstring": { @@ -65172,9 +65583,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L74" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L74" } ], "type": { @@ -65194,7 +65605,7 @@ ] }, "flags": {}, - "id": 78729, + "id": 82496, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -65208,15 +65619,15 @@ }, "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 78728, + "id": 82495, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -65224,20 +65635,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_rate_limit_errors" } }, - "parentId": 3987 + "parentId": 4211 } ], "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 78728, + "id": 82495, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -65246,7 +65657,7 @@ } }, "permalink": "/python/api/class/FileSystemStorageClient#get_rate_limit_errors", - "parentId": 2870 + "parentId": 2019 } ], "comment": { @@ -65267,16 +65678,16 @@ "groups": [ { "children": [ - 78796, - 78802, - 78808, - 79909, - 78793 + 82081, + 82087, + 82093, + 84269, + 82078 ], "title": "Methods" } ], - "id": 78792, + "id": 82077, "module": "storage_clients._file_system._storage_client", "name": "FileSystemStorageClient", "parsedDocstring": { @@ -65286,9 +65697,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_file_system/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_file_system/_storage_client.py#L20" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_file_system/_storage_client.py#L20" } ], "type": { @@ -65300,15 +65711,15 @@ "extendedTypes": [ { "name": "StorageClient", - "target": "2784", + "target": "2415", "type": "reference", "ref": { - "id": 78706, + "id": 82473, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -65339,7 +65750,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83501, + "id": 86546, "module": "storage_clients._sql._storage_client", "name": "__init__", "parsedDocstring": { @@ -65353,9 +65764,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 54, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L54" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 57, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L57" } ], "type": { @@ -65375,7 +65786,7 @@ ] }, "flags": {}, - "id": 83502, + "id": 86547, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -65395,7 +65806,7 @@ "isOptional": true, "keyword-only": true }, - "id": 83503, + "id": 86548, "kind": 32768, "kindString": "Parameter", "name": "connection_string", @@ -65415,7 +65826,7 @@ } ] }, - "parentId": 3593 + "parentId": 2278 }, { "comment": { @@ -65431,7 +65842,7 @@ "isOptional": true, "keyword-only": true }, - "id": 83504, + "id": 86549, "kind": 32768, "kindString": "Parameter", "name": "engine", @@ -65451,7 +65862,7 @@ } ] }, - "parentId": 3593 + "parentId": 2278 } ], "type": { @@ -65459,11 +65870,11 @@ "type": "literal", "value": {} }, - "parentId": 3592 + "parentId": 2277 } ], "permalink": "/python/api/class/SqlStorageClient#__init__", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -65480,7 +65891,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83505, + "id": 86550, "module": "storage_clients._sql._storage_client", "name": "__aenter__", "parsedDocstring": { @@ -65490,9 +65901,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 86, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L86" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 88, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L88" } ], "type": { @@ -65512,7 +65923,7 @@ ] }, "flags": {}, - "id": 83506, + "id": 86551, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -65523,26 +65934,26 @@ "type": { "name": "SqlStorageClient", "type": "reference", - "target": "3591", + "target": "2276", "ref": { - "id": 83500, + "id": 86545, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 32 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 } ], "kind": 128, "permalink": "https://crawlee.dev/python/api/class/SqlStorageClient" } }, - "parentId": 3596 + "parentId": 2281 } ], "permalink": "/python/api/class/SqlStorageClient#__aenter__", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -65559,7 +65970,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83507, + "id": 86552, "module": "storage_clients._sql._storage_client", "name": "__aexit__", "parsedDocstring": { @@ -65569,9 +65980,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 90, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L90" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 92, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L92" } ], "type": { @@ -65591,7 +66002,7 @@ ] }, "flags": {}, - "id": 83508, + "id": 86553, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -65604,7 +66015,7 @@ "isOptional": false, "keyword-only": false }, - "id": 83509, + "id": 86554, "kind": 32768, "kindString": "Parameter", "name": "exc_type", @@ -65623,14 +66034,14 @@ "ref": {} } ], - "target": "981", + "target": "3727", "ref": { - "id": 80890, + "id": 87996, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/sitemap.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 62 } ], @@ -65644,14 +66055,14 @@ } ] }, - "parentId": 3599 + "parentId": 2284 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 83510, + "id": 86555, "kind": 32768, "kindString": "Parameter", "name": "exc_value", @@ -65671,14 +66082,14 @@ } ] }, - "parentId": 3599 + "parentId": 2284 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 83511, + "id": 86556, "kind": 32768, "kindString": "Parameter", "name": "exc_traceback", @@ -65698,7 +66109,7 @@ } ] }, - "parentId": 3599 + "parentId": 2284 } ], "type": { @@ -65706,11 +66117,11 @@ "type": "literal", "value": {} }, - "parentId": 3598 + "parentId": 2283 } ], "permalink": "/python/api/class/SqlStorageClient#__aexit__", - "parentId": 3591 + "parentId": 2276 }, { "kind": 1024, @@ -65731,7 +66142,7 @@ ], "flags": {}, "groups": [], - "id": 83512, + "id": 86557, "module": "storage_clients._sql._storage_client", "name": "engine", "parsedDocstring": { @@ -65741,9 +66152,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 100, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L100" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 102, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L102" } ], "type": { @@ -65753,7 +66164,7 @@ "ref": {} }, "permalink": "/python/api/class/SqlStorageClient#engine", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -65770,7 +66181,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83513, + "id": 86558, "module": "storage_clients._sql._storage_client", "name": "get_dialect_name", "parsedDocstring": { @@ -65780,9 +66191,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L106" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 108, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L108" } ], "type": { @@ -65802,7 +66213,7 @@ ] }, "flags": {}, - "id": 83514, + "id": 86559, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -65824,11 +66235,11 @@ } ] }, - "parentId": 3604 + "parentId": 2289 } ], "permalink": "/python/api/class/SqlStorageClient#get_dialect_name", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -65845,7 +66256,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83515, + "id": 86560, "module": "storage_clients._sql._storage_client", "name": "initialize", "parsedDocstring": { @@ -65855,9 +66266,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 110, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L110" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 112, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L112" } ], "type": { @@ -65877,7 +66288,7 @@ ] }, "flags": {}, - "id": 83516, + "id": 86561, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -65890,21 +66301,21 @@ "isOptional": false, "keyword-only": false }, - "id": 83517, + "id": 86562, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "235", + "target": "383", "ref": { - "id": 80144, + "id": 84652, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -65912,7 +66323,7 @@ "permalink": "https://crawlee.dev/python/api/class/Configuration" } }, - "parentId": 3607 + "parentId": 2292 } ], "type": { @@ -65920,11 +66331,11 @@ "type": "literal", "value": {} }, - "parentId": 3606 + "parentId": 2291 } ], "permalink": "/python/api/class/SqlStorageClient#initialize", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -65941,7 +66352,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83518, + "id": 86563, "module": "storage_clients._sql._storage_client", "name": "close", "parsedDocstring": { @@ -65951,9 +66362,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 161, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L161" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 157, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L157" } ], "type": { @@ -65973,7 +66384,7 @@ ] }, "flags": {}, - "id": 83519, + "id": 86564, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -65986,11 +66397,11 @@ "type": "literal", "value": {} }, - "parentId": 3609 + "parentId": 2294 } ], "permalink": "/python/api/class/SqlStorageClient#close", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66007,7 +66418,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83520, + "id": 86565, "module": "storage_clients._sql._storage_client", "name": "create_session", "parsedDocstring": { @@ -66018,9 +66429,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 167, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L167" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L167" } ], "type": { @@ -66051,7 +66462,7 @@ ] }, "flags": {}, - "id": 83521, + "id": 86566, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -66063,11 +66474,11 @@ "target": 0, "ref": {} }, - "parentId": 3611 + "parentId": 2296 } ], "permalink": "/python/api/class/SqlStorageClient#create_session", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66088,7 +66499,7 @@ ], "flags": {}, "groups": [], - "id": 83522, + "id": 86567, "module": "storage_clients._base._storage_client", "name": "create_dataset_client", "parsedDocstring": { @@ -66098,9 +66509,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 178, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L178" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L178" } ], "type": { @@ -66120,7 +66531,7 @@ ] }, "flags": {}, - "id": 82698, + "id": 86689, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -66134,7 +66545,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82699, + "id": 86690, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -66154,7 +66565,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -66162,7 +66573,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82700, + "id": 86691, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -66182,7 +66593,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -66190,7 +66601,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82701, + "id": 86692, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -66210,7 +66621,7 @@ } ] }, - "parentId": 2789 + "parentId": 2420 }, { "defaultValue": "None", @@ -66218,7 +66629,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82702, + "id": 86693, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -66229,14 +66640,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 80144, + "id": 84652, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -66250,21 +66661,21 @@ } ] }, - "parentId": 2789 + "parentId": 2420 } ], "type": { "name": "DatasetClient", "type": "reference", - "target": "2808", + "target": "2381", "ref": { - "id": 82717, + "id": 86650, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_dataset_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 13 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 16 } ], "kind": 128, @@ -66273,15 +66684,15 @@ }, "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 82697, + "id": 86688, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -66289,20 +66700,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_dataset_client" } }, - "parentId": 3613 + "parentId": 2298 } ], "overwrites": { "name": "StorageClient.create_dataset_client", - "target": 2788, + "target": 2419, "type": "reference", "ref": { - "id": 82697, + "id": 86688, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 42 } ], @@ -66311,7 +66722,7 @@ } }, "permalink": "/python/api/class/SqlStorageClient#create_dataset_client", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66332,7 +66743,7 @@ ], "flags": {}, "groups": [], - "id": 83528, + "id": 86573, "module": "storage_clients._base._storage_client", "name": "create_kvs_client", "parsedDocstring": { @@ -66342,9 +66753,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 200, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L200" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L200" } ], "type": { @@ -66364,7 +66775,7 @@ ] }, "flags": {}, - "id": 82704, + "id": 86695, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -66378,7 +66789,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82705, + "id": 86696, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -66398,7 +66809,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -66406,7 +66817,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82706, + "id": 86697, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -66426,7 +66837,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -66434,7 +66845,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82707, + "id": 86698, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -66454,7 +66865,7 @@ } ] }, - "parentId": 2795 + "parentId": 2426 }, { "defaultValue": "None", @@ -66462,7 +66873,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82708, + "id": 86699, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -66473,14 +66884,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 80144, + "id": 84652, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -66494,20 +66905,20 @@ } ] }, - "parentId": 2795 + "parentId": 2426 } ], "type": { "name": "KeyValueStoreClient", "type": "reference", - "target": "2842", + "target": "2328", "ref": { - "id": 82751, + "id": 86597, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_key_value_store_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 14 } ], @@ -66517,15 +66928,15 @@ }, "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 82703, + "id": 86694, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -66533,20 +66944,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_kvs_client" } }, - "parentId": 3619 + "parentId": 2304 } ], "overwrites": { "name": "StorageClient.create_kvs_client", - "target": 2794, + "target": 2425, "type": "reference", "ref": { - "id": 82703, + "id": 86694, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -66555,7 +66966,7 @@ } }, "permalink": "/python/api/class/SqlStorageClient#create_kvs_client", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66576,7 +66987,7 @@ ], "flags": {}, "groups": [], - "id": 83534, + "id": 86579, "module": "storage_clients._base._storage_client", "name": "create_rq_client", "parsedDocstring": { @@ -66586,9 +66997,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 222, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L222" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L222" } ], "type": { @@ -66608,7 +67019,7 @@ ] }, "flags": {}, - "id": 82710, + "id": 86701, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -66622,7 +67033,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82711, + "id": 86702, "kind": 32768, "kindString": "Parameter", "name": "id", @@ -66642,7 +67053,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -66650,7 +67061,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82712, + "id": 86703, "kind": 32768, "kindString": "Parameter", "name": "name", @@ -66670,7 +67081,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -66678,7 +67089,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82713, + "id": 86704, "kind": 32768, "kindString": "Parameter", "name": "alias", @@ -66698,7 +67109,7 @@ } ] }, - "parentId": 2801 + "parentId": 2432 }, { "defaultValue": "None", @@ -66706,7 +67117,7 @@ "isOptional": true, "keyword-only": true }, - "id": 82714, + "id": 86705, "kind": 32768, "kindString": "Parameter", "name": "configuration", @@ -66717,14 +67128,14 @@ { "type": "reference", "name": "Configuration", - "target": "235", + "target": "383", "ref": { - "id": 80144, + "id": 84652, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -66738,20 +67149,20 @@ } ] }, - "parentId": 2801 + "parentId": 2432 } ], "type": { "name": "RequestQueueClient", "type": "reference", - "target": "2759", + "target": "2356", "ref": { - "id": 82668, + "id": 86625, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_request_queue_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 13 } ], @@ -66761,15 +67172,15 @@ }, "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 82709, + "id": 86700, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -66777,20 +67188,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#create_rq_client" } }, - "parentId": 3625 + "parentId": 2310 } ], "overwrites": { "name": "StorageClient.create_rq_client", - "target": 2800, + "target": 2431, "type": "reference", "ref": { - "id": 82709, + "id": 86700, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 64 } ], @@ -66799,7 +67210,7 @@ } }, "permalink": "/python/api/class/SqlStorageClient#create_rq_client", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66816,7 +67227,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83901, + "id": 88481, "module": "storage_clients._base._storage_client", "name": "get_storage_client_cache_key", "parsedDocstring": { @@ -66826,9 +67237,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L33" } ], "type": { @@ -66848,7 +67259,7 @@ ] }, "flags": {}, - "id": 82695, + "id": 86686, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -66859,21 +67270,21 @@ "isOptional": false, "keyword-only": false }, - "id": 82696, + "id": 86687, "kind": 32768, "kindString": "Parameter", "name": "configuration", "type": { "name": "Configuration", "type": "reference", - "target": "235", + "target": "383", "ref": { - "id": 80144, + "id": 84652, "sources": [ { "character": 1, "fileName": "/src/crawlee/configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 20 } ], @@ -66881,7 +67292,7 @@ "permalink": "https://crawlee.dev/python/api/class/Configuration" } }, - "parentId": 2786 + "parentId": 2417 } ], "type": { @@ -66892,15 +67303,15 @@ }, "inheritedFrom": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 82694, + "id": 86685, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -66908,20 +67319,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_storage_client_cache_key" } }, - "parentId": 3992 + "parentId": 4212 } ], "inheritedFrom": { "name": "StorageClient.get_storage_client_cache_key", - "target": 2785, + "target": 2416, "type": "reference", "ref": { - "id": 82694, + "id": 86685, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -66930,7 +67341,7 @@ } }, "permalink": "/python/api/class/SqlStorageClient#get_storage_client_cache_key", - "parentId": 3591 + "parentId": 2276 }, { "kind": 2048, @@ -66947,7 +67358,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 83902, + "id": 88482, "module": "storage_clients._base._storage_client", "name": "get_rate_limit_errors", "parsedDocstring": { @@ -66957,9 +67368,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_base/_storage_client.py#L74" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_base/_storage_client.py#L74" } ], "type": { @@ -66979,7 +67390,7 @@ ] }, "flags": {}, - "id": 82716, + "id": 86707, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -66993,15 +67404,15 @@ }, "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 82715, + "id": 86706, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -67009,20 +67420,20 @@ "permalink": "https://crawlee.dev/python/api/class/StorageClient#get_rate_limit_errors" } }, - "parentId": 3993 + "parentId": 4213 } ], "inheritedFrom": { "name": "StorageClient.get_rate_limit_errors", - "target": 2806, + "target": 2437, "type": "reference", "ref": { - "id": 82715, + "id": 86706, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 74 } ], @@ -67031,7 +67442,7 @@ } }, "permalink": "/python/api/class/SqlStorageClient#get_rate_limit_errors", - "parentId": 3591 + "parentId": 2276 } ], "comment": { @@ -67052,29 +67463,29 @@ "groups": [ { "children": [ - 83505, - 83507, - 83501, - 83518, - 83522, - 83528, - 83534, - 83520, - 83513, - 83902, - 83901, - 83515 + 86550, + 86552, + 86546, + 86563, + 86567, + 86573, + 86579, + 86565, + 86558, + 88482, + 88481, + 86560 ], "title": "Methods" }, { "children": [ - 83512 + 86557 ], "title": "Properties" } ], - "id": 83500, + "id": 86545, "module": "storage_clients._sql._storage_client", "name": "SqlStorageClient", "parsedDocstring": { @@ -67084,9 +67495,9 @@ { "character": 1, "fileName": "/src/crawlee/storage_clients/_sql/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 32, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/storage_clients/_sql/_storage_client.py#L32" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/storage_clients/_sql/_storage_client.py#L35" } ], "type": { @@ -67098,15 +67509,15 @@ "extendedTypes": [ { "name": "StorageClient", - "target": "2784", + "target": "2415", "type": "reference", "ref": { - "id": 82693, + "id": 86684, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/_base/_storage_client.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 19 } ], @@ -67141,7 +67552,7 @@ ], "flags": {}, "groups": [], - "id": 86176, + "id": 90988, "module": "request_loaders._request_loader", "name": "get_handled_count", "parsedDocstring": { @@ -67151,9 +67562,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L29" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L29" } ], "type": { @@ -67173,7 +67584,7 @@ ] }, "flags": {}, - "id": 86177, + "id": 90989, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67189,15 +67600,15 @@ }, "overwrites": { "name": "RequestLoader.get_handled_count", - "target": 2274, + "target": 2506, "type": "reference", "ref": { - "id": 86176, + "id": 90988, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -67205,11 +67616,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#get_handled_count" } }, - "parentId": 2274 + "parentId": 2506 } ], "permalink": "/python/api/class/RequestLoader#get_handled_count", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67230,7 +67641,7 @@ ], "flags": {}, "groups": [], - "id": 86178, + "id": 90990, "module": "request_loaders._request_loader", "name": "get_total_count", "parsedDocstring": { @@ -67240,9 +67651,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L33" } ], "type": { @@ -67262,7 +67673,7 @@ ] }, "flags": {}, - "id": 86179, + "id": 90991, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67278,15 +67689,15 @@ }, "overwrites": { "name": "RequestLoader.get_total_count", - "target": 2276, + "target": 2508, "type": "reference", "ref": { - "id": 86178, + "id": 90990, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -67294,11 +67705,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#get_total_count" } }, - "parentId": 2276 + "parentId": 2508 } ], "permalink": "/python/api/class/RequestLoader#get_total_count", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67319,7 +67730,7 @@ ], "flags": {}, "groups": [], - "id": 86180, + "id": 90992, "module": "request_loaders._request_loader", "name": "is_empty", "parsedDocstring": { @@ -67329,9 +67740,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L37" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L37" } ], "type": { @@ -67351,7 +67762,7 @@ ] }, "flags": {}, - "id": 86181, + "id": 90993, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67367,15 +67778,15 @@ }, "overwrites": { "name": "RequestLoader.is_empty", - "target": 2278, + "target": 2510, "type": "reference", "ref": { - "id": 86180, + "id": 90992, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -67383,11 +67794,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#is_empty" } }, - "parentId": 2278 + "parentId": 2510 } ], "permalink": "/python/api/class/RequestLoader#is_empty", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67408,7 +67819,7 @@ ], "flags": {}, "groups": [], - "id": 86182, + "id": 90994, "module": "request_loaders._request_loader", "name": "is_finished", "parsedDocstring": { @@ -67418,9 +67829,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L41" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L41" } ], "type": { @@ -67440,7 +67851,7 @@ ] }, "flags": {}, - "id": 86183, + "id": 90995, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67456,15 +67867,15 @@ }, "overwrites": { "name": "RequestLoader.is_finished", - "target": 2280, + "target": 2512, "type": "reference", "ref": { - "id": 86182, + "id": 90994, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -67472,11 +67883,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#is_finished" } }, - "parentId": 2280 + "parentId": 2512 } ], "permalink": "/python/api/class/RequestLoader#is_finished", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67497,7 +67908,7 @@ ], "flags": {}, "groups": [], - "id": 86184, + "id": 90996, "module": "request_loaders._request_loader", "name": "fetch_next_request", "parsedDocstring": { @@ -67507,9 +67918,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L45" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L45" } ], "type": { @@ -67529,7 +67940,7 @@ ] }, "flags": {}, - "id": 86185, + "id": 90997, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67544,14 +67955,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 84052, + "id": 88990, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -67567,15 +67978,15 @@ }, "overwrites": { "name": "RequestLoader.fetch_next_request", - "target": 2282, + "target": 2514, "type": "reference", "ref": { - "id": 86184, + "id": 90996, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -67583,11 +67994,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#fetch_next_request" } }, - "parentId": 2282 + "parentId": 2514 } ], "permalink": "/python/api/class/RequestLoader#fetch_next_request", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67608,7 +68019,7 @@ ], "flags": {}, "groups": [], - "id": 86186, + "id": 90998, "module": "request_loaders._request_loader", "name": "mark_request_as_handled", "parsedDocstring": { @@ -67618,9 +68029,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L53" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L53" } ], "type": { @@ -67640,7 +68051,7 @@ ] }, "flags": {}, - "id": 86187, + "id": 90999, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67653,21 +68064,21 @@ "isOptional": false, "keyword-only": false }, - "id": 86188, + "id": 91000, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 84052, + "id": 88990, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -67675,7 +68086,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2285 + "parentId": 2517 } ], "type": { @@ -67685,15 +68096,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 87567, + "id": 90217, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -67708,15 +68119,15 @@ }, "overwrites": { "name": "RequestLoader.mark_request_as_handled", - "target": 2284, + "target": 2516, "type": "reference", "ref": { - "id": 86186, + "id": 90998, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -67724,11 +68135,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#mark_request_as_handled" } }, - "parentId": 2284 + "parentId": 2516 } ], "permalink": "/python/api/class/RequestLoader#mark_request_as_handled", - "parentId": 2273 + "parentId": 2505 }, { "kind": 2048, @@ -67745,7 +68156,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 86189, + "id": 91001, "module": "request_loaders._request_loader", "name": "to_tandem", "parsedDocstring": { @@ -67758,9 +68169,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L56" } ], "type": { @@ -67780,7 +68191,7 @@ ] }, "flags": {}, - "id": 86190, + "id": 91002, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -67802,7 +68213,7 @@ "isOptional": true, "keyword-only": false }, - "id": 86191, + "id": 91003, "kind": 32768, "kindString": "Parameter", "name": "request_manager", @@ -67813,14 +68224,14 @@ { "type": "reference", "name": "RequestManager", - "target": "2339", + "target": "2638", "ref": { - "id": 86241, + "id": 91120, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 18 } ], @@ -67834,20 +68245,20 @@ } ] }, - "parentId": 2288 + "parentId": 2520 } ], "type": { "name": "RequestManagerTandem", "type": "reference", - "target": "2359", + "target": "2523", "ref": { - "id": 86261, + "id": 91005, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -67855,11 +68266,11 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManagerTandem" } }, - "parentId": 2287 + "parentId": 2519 } ], "permalink": "/python/api/class/RequestLoader#to_tandem", - "parentId": 2273 + "parentId": 2505 } ], "comment": { @@ -67880,18 +68291,18 @@ "groups": [ { "children": [ - 86184, - 86176, - 86178, - 86180, - 86182, - 86186, - 86189 + 90996, + 90988, + 90990, + 90992, + 90994, + 90998, + 91001 ], "title": "Methods" } ], - "id": 86175, + "id": 90987, "module": "request_loaders._request_loader", "name": "RequestLoader", "parsedDocstring": { @@ -67901,9 +68312,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 17, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L17" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L17" } ], "type": { @@ -67915,16 +68326,16 @@ "extendedBy": [ { "name": "SitemapRequestLoader", - "target": "2302", + "target": "2571", "type": "reference", "ref": { - "id": 86204, + "id": 91053, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 } ], "kind": 128, @@ -67932,39 +68343,39 @@ } }, { - "name": "RequestManager", - "target": "2339", + "name": "RequestList", + "target": "2617", "type": "reference", "ref": { - "id": 86241, + "id": 91099, "sources": [ { "character": 1, - "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 18 + "fileName": "/src/crawlee/request_loaders/_request_list.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/RequestManager" + "permalink": "https://crawlee.dev/python/api/class/RequestList" } }, { - "name": "RequestList", - "target": "2403", + "name": "RequestManager", + "target": "2638", "type": "reference", "ref": { - "id": 86305, + "id": 91120, "sources": [ { "character": 1, - "fileName": "/src/crawlee/request_loaders/_request_list.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 32 + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 18 } ], "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/RequestList" + "permalink": "https://crawlee.dev/python/api/class/RequestManager" } } ], @@ -67994,7 +68405,7 @@ ], "flags": {}, "groups": [], - "id": 89907, + "id": 93759, "module": "request_loaders._request_manager", "name": "drop", "parsedDocstring": { @@ -68004,9 +68415,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager.py#L22" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L22" } ], "type": { @@ -68026,7 +68437,7 @@ ] }, "flags": {}, - "id": 89908, + "id": 93760, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68041,15 +68452,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 89907, + "id": 93759, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -68057,11 +68468,77 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 2340 + "parentId": 2639 } ], "permalink": "/python/api/class/RequestManager#drop", - "parentId": 2339 + "parentId": 2638 + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 93761, + "module": "request_loaders._request_manager", + "name": "purge", + "parsedDocstring": { + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L25" + } + ], + "type": { + "name": "Undefined", + "type": "reference", + "target": 0, + "ref": {} + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + } + ] + }, + "flags": {}, + "id": 93762, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "purge", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": {} + }, + "parentId": 2641 + } + ], + "permalink": "/python/api/class/RequestManager#purge", + "parentId": 2638 }, { "kind": 2048, @@ -68082,7 +68559,7 @@ ], "flags": {}, "groups": [], - "id": 89909, + "id": 93763, "module": "request_loaders._request_manager", "name": "add_request", "parsedDocstring": { @@ -68097,9 +68574,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager.py#L26" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L32" } ], "type": { @@ -68130,7 +68607,7 @@ ] }, "flags": {}, - "id": 89910, + "id": 93764, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68151,7 +68628,7 @@ "isOptional": false, "keyword-only": false }, - "id": 89911, + "id": 93765, "kind": 32768, "kindString": "Parameter", "name": "request", @@ -68168,14 +68645,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 87717, + "id": 91628, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -68185,7 +68662,7 @@ } ] }, - "parentId": 2343 + "parentId": 2644 }, { "comment": { @@ -68201,7 +68678,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89912, + "id": 93766, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -68211,7 +68688,7 @@ "target": 0, "ref": {} }, - "parentId": 2343 + "parentId": 2644 } ], "type": { @@ -68221,15 +68698,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 91232, + "id": 92855, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -68244,27 +68721,27 @@ }, "overwrites": { "name": "RequestManager.add_request", - "target": 2342, + "target": 2643, "type": "reference", "ref": { - "id": 89909, + "id": 93763, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_request" } }, - "parentId": 2342 + "parentId": 2643 } ], "permalink": "/python/api/class/RequestManager#add_request", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -68281,7 +68758,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 89913, + "id": 93767, "module": "request_loaders._request_manager", "name": "add_requests", "parsedDocstring": { @@ -68299,9 +68776,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager.py#L43" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L49" } ], "type": { @@ -68321,7 +68798,7 @@ ] }, "flags": {}, - "id": 89914, + "id": 93768, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68342,7 +68819,7 @@ "isOptional": false, "keyword-only": false }, - "id": 89915, + "id": 93769, "kind": 32768, "kindString": "Parameter", "name": "requests", @@ -68362,14 +68839,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 87717, + "id": 91628, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -68383,7 +68860,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -68399,7 +68876,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89916, + "id": 93770, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -68409,7 +68886,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -68425,7 +68902,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89917, + "id": 93771, "kind": 32768, "kindString": "Parameter", "name": "batch_size", @@ -68435,7 +68912,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -68451,7 +68928,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89918, + "id": 93772, "kind": 32768, "kindString": "Parameter", "name": "wait_time_between_batches", @@ -68461,7 +68938,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -68477,7 +68954,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89919, + "id": 93773, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added", @@ -68487,7 +68964,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -68503,7 +68980,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89920, + "id": 93774, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added_timeout", @@ -68523,7 +69000,7 @@ } ] }, - "parentId": 2347 + "parentId": 2648 } ], "type": { @@ -68533,27 +69010,27 @@ }, "overwrites": { "name": "RequestManager.add_requests", - "target": 2346, + "target": 2647, "type": "reference", "ref": { - "id": 89913, + "id": 93767, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_requests" } }, - "parentId": 2346 + "parentId": 2647 } ], "permalink": "/python/api/class/RequestManager#add_requests", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -68574,7 +69051,7 @@ ], "flags": {}, "groups": [], - "id": 89921, + "id": 93775, "module": "request_loaders._request_manager", "name": "reclaim_request", "parsedDocstring": { @@ -68584,9 +69061,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager.py#L71" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L77" } ], "type": { @@ -68606,7 +69083,7 @@ ] }, "flags": {}, - "id": 89922, + "id": 93776, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68619,21 +69096,21 @@ "isOptional": false, "keyword-only": false }, - "id": 89923, + "id": 93777, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 87717, + "id": 91628, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -68641,7 +69118,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2355 + "parentId": 2656 }, { "defaultValue": "False", @@ -68649,7 +69126,7 @@ "isOptional": true, "keyword-only": true }, - "id": 89924, + "id": 93778, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -68659,7 +69136,7 @@ "target": 0, "ref": {} }, - "parentId": 2355 + "parentId": 2656 } ], "type": { @@ -68669,15 +69146,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 91232, + "id": 92855, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -68692,27 +69169,27 @@ }, "overwrites": { "name": "RequestManager.reclaim_request", - "target": 2354, + "target": 2655, "type": "reference", "ref": { - "id": 89921, + "id": 93775, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#reclaim_request" } }, - "parentId": 2354 + "parentId": 2655 } ], "permalink": "/python/api/class/RequestManager#reclaim_request", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -68733,7 +69210,7 @@ ], "flags": {}, "groups": [], - "id": 91562, + "id": 95268, "module": "request_loaders._request_loader", "name": "get_handled_count", "parsedDocstring": { @@ -68743,9 +69220,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L29" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L29" } ], "type": { @@ -68765,7 +69242,7 @@ ] }, "flags": {}, - "id": 89842, + "id": 93627, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68781,15 +69258,15 @@ }, "overwrites": { "name": "RequestManager.get_handled_count", - "target": 3995, + "target": 4148, "type": "reference", "ref": { - "id": 91562, + "id": 95268, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -68797,20 +69274,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_handled_count" } }, - "parentId": 3995 + "parentId": 4148 } ], "inheritedFrom": { "name": "RequestLoader.get_handled_count", - "target": 2274, + "target": 2506, "type": "reference", "ref": { - "id": 89841, + "id": 93626, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -68819,7 +69296,7 @@ } }, "permalink": "/python/api/class/RequestManager#get_handled_count", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -68840,7 +69317,7 @@ ], "flags": {}, "groups": [], - "id": 91563, + "id": 95269, "module": "request_loaders._request_loader", "name": "get_total_count", "parsedDocstring": { @@ -68850,9 +69327,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L33" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L33" } ], "type": { @@ -68872,7 +69349,7 @@ ] }, "flags": {}, - "id": 89844, + "id": 93629, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68888,15 +69365,15 @@ }, "overwrites": { "name": "RequestManager.get_total_count", - "target": 3996, + "target": 4149, "type": "reference", "ref": { - "id": 91563, + "id": 95269, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -68904,20 +69381,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_total_count" } }, - "parentId": 3996 + "parentId": 4149 } ], "inheritedFrom": { "name": "RequestLoader.get_total_count", - "target": 2276, + "target": 2508, "type": "reference", "ref": { - "id": 89843, + "id": 93628, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -68926,7 +69403,7 @@ } }, "permalink": "/python/api/class/RequestManager#get_total_count", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -68947,7 +69424,7 @@ ], "flags": {}, "groups": [], - "id": 91564, + "id": 95270, "module": "request_loaders._request_loader", "name": "is_empty", "parsedDocstring": { @@ -68957,9 +69434,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L37" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L37" } ], "type": { @@ -68979,7 +69456,7 @@ ] }, "flags": {}, - "id": 89846, + "id": 93631, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -68995,15 +69472,15 @@ }, "overwrites": { "name": "RequestManager.is_empty", - "target": 3997, + "target": 4150, "type": "reference", "ref": { - "id": 91564, + "id": 95270, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -69011,20 +69488,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_empty" } }, - "parentId": 3997 + "parentId": 4150 } ], "inheritedFrom": { "name": "RequestLoader.is_empty", - "target": 2278, + "target": 2510, "type": "reference", "ref": { - "id": 89845, + "id": 93630, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -69033,7 +69510,7 @@ } }, "permalink": "/python/api/class/RequestManager#is_empty", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -69054,7 +69531,7 @@ ], "flags": {}, "groups": [], - "id": 91565, + "id": 95271, "module": "request_loaders._request_loader", "name": "is_finished", "parsedDocstring": { @@ -69064,9 +69541,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L41" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L41" } ], "type": { @@ -69086,7 +69563,7 @@ ] }, "flags": {}, - "id": 89848, + "id": 93633, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69102,15 +69579,15 @@ }, "overwrites": { "name": "RequestManager.is_finished", - "target": 3998, + "target": 4151, "type": "reference", "ref": { - "id": 91565, + "id": 95271, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -69118,20 +69595,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_finished" } }, - "parentId": 3998 + "parentId": 4151 } ], "inheritedFrom": { "name": "RequestLoader.is_finished", - "target": 2280, + "target": 2512, "type": "reference", "ref": { - "id": 89847, + "id": 93632, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -69140,7 +69617,7 @@ } }, "permalink": "/python/api/class/RequestManager#is_finished", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -69161,7 +69638,7 @@ ], "flags": {}, "groups": [], - "id": 91566, + "id": 95272, "module": "request_loaders._request_loader", "name": "fetch_next_request", "parsedDocstring": { @@ -69171,9 +69648,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L45" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L45" } ], "type": { @@ -69193,7 +69670,7 @@ ] }, "flags": {}, - "id": 89850, + "id": 93635, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69209,15 +69686,15 @@ }, "overwrites": { "name": "RequestManager.fetch_next_request", - "target": 3999, + "target": 4152, "type": "reference", "ref": { - "id": 91566, + "id": 95272, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -69225,20 +69702,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#fetch_next_request" } }, - "parentId": 3999 + "parentId": 4152 } ], "inheritedFrom": { "name": "RequestLoader.fetch_next_request", - "target": 2282, + "target": 2514, "type": "reference", "ref": { - "id": 89849, + "id": 93634, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -69247,7 +69724,7 @@ } }, "permalink": "/python/api/class/RequestManager#fetch_next_request", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -69268,7 +69745,7 @@ ], "flags": {}, "groups": [], - "id": 91567, + "id": 95273, "module": "request_loaders._request_loader", "name": "mark_request_as_handled", "parsedDocstring": { @@ -69278,9 +69755,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L53" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L53" } ], "type": { @@ -69300,7 +69777,7 @@ ] }, "flags": {}, - "id": 89852, + "id": 93637, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69313,21 +69790,21 @@ "isOptional": false, "keyword-only": false }, - "id": 89853, + "id": 93638, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 87717, + "id": 91628, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -69335,7 +69812,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2285 + "parentId": 2517 } ], "type": { @@ -69346,15 +69823,15 @@ }, "overwrites": { "name": "RequestManager.mark_request_as_handled", - "target": 4000, + "target": 4153, "type": "reference", "ref": { - "id": 91567, + "id": 95273, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -69362,20 +69839,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#mark_request_as_handled" } }, - "parentId": 4000 + "parentId": 4153 } ], "inheritedFrom": { "name": "RequestLoader.mark_request_as_handled", - "target": 2284, + "target": 2516, "type": "reference", "ref": { - "id": 89851, + "id": 93636, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -69384,7 +69861,7 @@ } }, "permalink": "/python/api/class/RequestManager#mark_request_as_handled", - "parentId": 2339 + "parentId": 2638 }, { "kind": 2048, @@ -69401,7 +69878,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 91568, + "id": 95274, "module": "request_loaders._request_loader", "name": "to_tandem", "parsedDocstring": { @@ -69414,9 +69891,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L56" } ], "type": { @@ -69436,7 +69913,7 @@ ] }, "flags": {}, - "id": 89855, + "id": 93640, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69458,7 +69935,7 @@ "isOptional": true, "keyword-only": false }, - "id": 89856, + "id": 93641, "kind": 32768, "kindString": "Parameter", "name": "request_manager", @@ -69468,20 +69945,20 @@ "target": 0, "ref": {} }, - "parentId": 2288 + "parentId": 2520 } ], "type": { "name": "RequestManagerTandem", "type": "reference", - "target": "2359", + "target": "2523", "ref": { - "id": 89926, + "id": 93643, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -69491,15 +69968,15 @@ }, "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 89854, + "id": 93639, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -69507,20 +69984,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#to_tandem" } }, - "parentId": 4001 + "parentId": 4154 } ], "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 89854, + "id": 93639, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -69529,7 +70006,7 @@ } }, "permalink": "/python/api/class/RequestManager#to_tandem", - "parentId": 2339 + "parentId": 2638 } ], "comment": { @@ -69550,22 +70027,23 @@ "groups": [ { "children": [ - 89909, - 89913, - 89907, - 91566, - 91562, - 91563, - 91564, - 91565, - 91567, - 89921, - 91568 + 93763, + 93767, + 93759, + 95272, + 95268, + 95269, + 95270, + 95271, + 95273, + 93761, + 93775, + 95274 ], "title": "Methods" } ], - "id": 89906, + "id": 93758, "module": "request_loaders._request_manager", "name": "RequestManager", "parsedDocstring": { @@ -69575,9 +70053,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 18, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager.py#L18" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L18" } ], "type": { @@ -69589,15 +70067,15 @@ "extendedTypes": [ { "name": "RequestLoader", - "target": "2273", + "target": "2505", "type": "reference", "ref": { - "id": 89840, + "id": 93625, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 17 } ], @@ -69607,17 +70085,35 @@ } ], "extendedBy": [ + { + "name": "ThrottlingRequestManager", + "target": "2441", + "type": "reference", + "ref": { + "id": 93561, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_throttling_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 35 + } + ], + "kind": 128, + "permalink": "https://crawlee.dev/python/api/class/ThrottlingRequestManager" + } + }, { "name": "RequestManagerTandem", - "target": "2359", + "target": "2523", "type": "reference", "ref": { - "id": 89926, + "id": 93643, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -69627,15 +70123,15 @@ }, { "name": "RequestQueue", - "target": "3852", + "target": "2726", "type": "reference", "ref": { - "id": 91419, + "id": 93846, "sources": [ { "character": 1, "fileName": "/src/crawlee/storages/_request_queue.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -69666,7 +70162,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 93928, + "id": 97798, "module": "request_loaders._request_manager_tandem", "name": "__init__", "parsedDocstring": { @@ -69676,9 +70172,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 31, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L31" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L31" } ], "type": { @@ -69690,7 +70186,7 @@ "signatures": [ { "flags": {}, - "id": 93929, + "id": 97799, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -69701,21 +70197,21 @@ "isOptional": false, "keyword-only": false }, - "id": 93930, + "id": 97800, "kind": 32768, "kindString": "Parameter", "name": "request_loader", "type": { "name": "RequestLoader", "type": "reference", - "target": "2273", + "target": "2505", "ref": { - "id": 93841, + "id": 97779, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 17 } ], @@ -69723,28 +70219,28 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader" } }, - "parentId": 2361 + "parentId": 2525 }, { "flags": { "isOptional": false, "keyword-only": false }, - "id": 93931, + "id": 97801, "kind": 32768, "kindString": "Parameter", "name": "request_manager", "type": { "name": "RequestManager", "type": "reference", - "target": "2339", + "target": "2638", "ref": { - "id": 93907, + "id": 97912, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 18 } ], @@ -69752,7 +70248,7 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager" } }, - "parentId": 2361 + "parentId": 2525 } ], "type": { @@ -69760,11 +70256,11 @@ "type": "literal", "value": {} }, - "parentId": 2360 + "parentId": 2524 } ], "permalink": "/python/api/class/RequestManagerTandem#__init__", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -69785,7 +70281,7 @@ ], "flags": {}, "groups": [], - "id": 93932, + "id": 97802, "module": "request_loaders._request_loader", "name": "get_handled_count", "parsedDocstring": { @@ -69795,9 +70291,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 36, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L36" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L36" } ], "type": { @@ -69817,7 +70313,7 @@ ] }, "flags": {}, - "id": 93843, + "id": 97781, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69833,15 +70329,15 @@ }, "overwrites": { "name": "RequestManager.get_handled_count", - "target": 3995, + "target": 4148, "type": "reference", "ref": { - "id": 95563, + "id": 99422, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -69849,20 +70345,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_handled_count" } }, - "parentId": 2364 + "parentId": 2528 } ], "overwrites": { "name": "RequestManager.get_handled_count", - "target": 3995, + "target": 4148, "type": "reference", "ref": { - "id": 95563, + "id": 99422, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -69871,7 +70367,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#get_handled_count", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -69892,7 +70388,7 @@ ], "flags": {}, "groups": [], - "id": 93934, + "id": 97804, "module": "request_loaders._request_loader", "name": "get_total_count", "parsedDocstring": { @@ -69902,9 +70398,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 40, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L40" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L40" } ], "type": { @@ -69924,7 +70420,7 @@ ] }, "flags": {}, - "id": 93845, + "id": 97783, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -69940,15 +70436,15 @@ }, "overwrites": { "name": "RequestManager.get_total_count", - "target": 3996, + "target": 4149, "type": "reference", "ref": { - "id": 95564, + "id": 99423, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -69956,20 +70452,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#get_total_count" } }, - "parentId": 2366 + "parentId": 2530 } ], "overwrites": { "name": "RequestManager.get_total_count", - "target": 3996, + "target": 4149, "type": "reference", "ref": { - "id": 95564, + "id": 99423, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -69978,7 +70474,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#get_total_count", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -69999,7 +70495,7 @@ ], "flags": {}, "groups": [], - "id": 93936, + "id": 97806, "module": "request_loaders._request_loader", "name": "is_empty", "parsedDocstring": { @@ -70009,9 +70505,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 44, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L44" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L44" } ], "type": { @@ -70031,7 +70527,7 @@ ] }, "flags": {}, - "id": 93847, + "id": 97785, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70047,15 +70543,15 @@ }, "overwrites": { "name": "RequestManager.is_empty", - "target": 3997, + "target": 4150, "type": "reference", "ref": { - "id": 95565, + "id": 99424, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -70063,20 +70559,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_empty" } }, - "parentId": 2368 + "parentId": 2532 } ], "overwrites": { "name": "RequestManager.is_empty", - "target": 3997, + "target": 4150, "type": "reference", "ref": { - "id": 95565, + "id": 99424, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -70085,7 +70581,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#is_empty", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -70106,7 +70602,7 @@ ], "flags": {}, "groups": [], - "id": 93938, + "id": 97808, "module": "request_loaders._request_loader", "name": "is_finished", "parsedDocstring": { @@ -70116,9 +70612,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 48, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L48" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L48" } ], "type": { @@ -70138,7 +70634,7 @@ ] }, "flags": {}, - "id": 93849, + "id": 97787, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70154,15 +70650,15 @@ }, "overwrites": { "name": "RequestManager.is_finished", - "target": 3998, + "target": 4151, "type": "reference", "ref": { - "id": 95566, + "id": 99425, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -70170,20 +70666,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#is_finished" } }, - "parentId": 2370 + "parentId": 2534 } ], "overwrites": { "name": "RequestManager.is_finished", - "target": 3998, + "target": 4151, "type": "reference", "ref": { - "id": 95566, + "id": 99425, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -70192,7 +70688,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#is_finished", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -70213,7 +70709,7 @@ ], "flags": {}, "groups": [], - "id": 93940, + "id": 97810, "module": "request_loaders._request_manager", "name": "add_request", "parsedDocstring": { @@ -70228,9 +70724,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 52, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L52" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L52" } ], "type": { @@ -70261,7 +70757,7 @@ ] }, "flags": {}, - "id": 93911, + "id": 97918, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70282,7 +70778,7 @@ "isOptional": false, "keyword-only": false }, - "id": 93912, + "id": 97919, "kind": 32768, "kindString": "Parameter", "name": "request", @@ -70299,14 +70795,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 91718, + "id": 95782, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -70316,7 +70812,7 @@ } ] }, - "parentId": 2343 + "parentId": 2644 }, { "comment": { @@ -70332,7 +70828,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93913, + "id": 97920, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -70342,7 +70838,7 @@ "target": 0, "ref": {} }, - "parentId": 2343 + "parentId": 2644 } ], "type": { @@ -70352,15 +70848,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 95233, + "id": 97009, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -70375,37 +70871,37 @@ }, "overwrites": { "name": "RequestManager.add_request", - "target": 2342, + "target": 2643, "type": "reference", "ref": { - "id": 93910, + "id": 97917, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_request" } }, - "parentId": 2372 + "parentId": 2536 } ], "overwrites": { "name": "RequestManager.add_request", - "target": 2342, + "target": 2643, "type": "reference", "ref": { - "id": 93910, + "id": 97917, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 26 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 32 } ], "kind": 2048, @@ -70413,7 +70909,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#add_request", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -70430,7 +70926,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 93944, + "id": 97814, "module": "request_loaders._request_manager", "name": "add_requests", "parsedDocstring": { @@ -70448,9 +70944,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L56" } ], "type": { @@ -70470,7 +70966,7 @@ ] }, "flags": {}, - "id": 93915, + "id": 97922, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70491,7 +70987,7 @@ "isOptional": false, "keyword-only": false }, - "id": 93916, + "id": 97923, "kind": 32768, "kindString": "Parameter", "name": "requests", @@ -70511,14 +71007,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 91718, + "id": 95782, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -70532,7 +71028,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -70548,7 +71044,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93917, + "id": 97924, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -70558,7 +71054,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -70574,7 +71070,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93918, + "id": 97925, "kind": 32768, "kindString": "Parameter", "name": "batch_size", @@ -70584,7 +71080,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -70600,7 +71096,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93919, + "id": 97926, "kind": 32768, "kindString": "Parameter", "name": "wait_time_between_batches", @@ -70610,7 +71106,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -70626,7 +71122,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93920, + "id": 97927, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added", @@ -70636,7 +71132,7 @@ "target": 0, "ref": {} }, - "parentId": 2347 + "parentId": 2648 }, { "comment": { @@ -70652,7 +71148,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93921, + "id": 97928, "kind": 32768, "kindString": "Parameter", "name": "wait_for_all_requests_to_be_added_timeout", @@ -70672,7 +71168,7 @@ } ] }, - "parentId": 2347 + "parentId": 2648 } ], "type": { @@ -70682,37 +71178,37 @@ }, "overwrites": { "name": "RequestManager.add_requests", - "target": 2346, + "target": 2647, "type": "reference", "ref": { - "id": 93914, + "id": 97921, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#add_requests" } }, - "parentId": 2376 + "parentId": 2540 } ], "overwrites": { "name": "RequestManager.add_requests", - "target": 2346, + "target": 2647, "type": "reference", "ref": { - "id": 93914, + "id": 97921, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 43 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 49 } ], "kind": 2048, @@ -70720,7 +71216,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#add_requests", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -70741,7 +71237,7 @@ ], "flags": {}, "groups": [], - "id": 93952, + "id": 97822, "module": "request_loaders._request_loader", "name": "fetch_next_request", "parsedDocstring": { @@ -70751,9 +71247,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 76, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L76" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L76" } ], "type": { @@ -70773,7 +71269,7 @@ ] }, "flags": {}, - "id": 93851, + "id": 97789, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70789,15 +71285,15 @@ }, "overwrites": { "name": "RequestManager.fetch_next_request", - "target": 3999, + "target": 4152, "type": "reference", "ref": { - "id": 95567, + "id": 99426, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -70805,20 +71301,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#fetch_next_request" } }, - "parentId": 2384 + "parentId": 2548 } ], "overwrites": { "name": "RequestManager.fetch_next_request", - "target": 3999, + "target": 4152, "type": "reference", "ref": { - "id": 95567, + "id": 99426, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -70827,7 +71323,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#fetch_next_request", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -70848,7 +71344,7 @@ ], "flags": {}, "groups": [], - "id": 93954, + "id": 97824, "module": "request_loaders._request_manager", "name": "reclaim_request", "parsedDocstring": { @@ -70858,9 +71354,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 99, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L99" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 102, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L102" } ], "type": { @@ -70880,7 +71376,7 @@ ] }, "flags": {}, - "id": 93923, + "id": 97930, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -70893,21 +71389,21 @@ "isOptional": false, "keyword-only": false }, - "id": 93924, + "id": 97931, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 91718, + "id": 95782, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -70915,7 +71411,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2355 + "parentId": 2656 }, { "defaultValue": "False", @@ -70923,7 +71419,7 @@ "isOptional": true, "keyword-only": true }, - "id": 93925, + "id": 97932, "kind": 32768, "kindString": "Parameter", "name": "forefront", @@ -70933,7 +71429,7 @@ "target": 0, "ref": {} }, - "parentId": 2355 + "parentId": 2656 } ], "type": { @@ -70943,15 +71439,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 95233, + "id": 97009, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -70966,37 +71462,37 @@ }, "overwrites": { "name": "RequestManager.reclaim_request", - "target": 2354, + "target": 2655, "type": "reference", "ref": { - "id": 93922, + "id": 97929, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "kind": 2048, "permalink": "https://crawlee.dev/python/api/class/RequestManager#reclaim_request" } }, - "parentId": 2386 + "parentId": 2550 } ], "overwrites": { "name": "RequestManager.reclaim_request", - "target": 2354, + "target": 2655, "type": "reference", "ref": { - "id": 93922, + "id": 97929, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 71 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 77 } ], "kind": 2048, @@ -71004,7 +71500,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#reclaim_request", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -71025,7 +71521,7 @@ ], "flags": {}, "groups": [], - "id": 93958, + "id": 97828, "module": "request_loaders._request_loader", "name": "mark_request_as_handled", "parsedDocstring": { @@ -71035,9 +71531,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 103, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L103" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 106, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L106" } ], "type": { @@ -71057,7 +71553,7 @@ ] }, "flags": {}, - "id": 93853, + "id": 97791, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -71070,21 +71566,21 @@ "isOptional": false, "keyword-only": false }, - "id": 93854, + "id": 97792, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 91718, + "id": 95782, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -71092,7 +71588,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2285 + "parentId": 2517 } ], "type": { @@ -71103,15 +71599,15 @@ }, "overwrites": { "name": "RequestManager.mark_request_as_handled", - "target": 4000, + "target": 4153, "type": "reference", "ref": { - "id": 95568, + "id": 99427, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -71119,20 +71615,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#mark_request_as_handled" } }, - "parentId": 2390 + "parentId": 2554 } ], "overwrites": { "name": "RequestManager.mark_request_as_handled", - "target": 4000, + "target": 4153, "type": "reference", "ref": { - "id": 95568, + "id": 99427, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -71141,7 +71637,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#mark_request_as_handled", - "parentId": 2359 + "parentId": 2523 }, { "kind": 2048, @@ -71162,7 +71658,7 @@ ], "flags": {}, "groups": [], - "id": 93961, + "id": 97831, "module": "request_loaders._request_manager", "name": "drop", "parsedDocstring": { @@ -71172,9 +71668,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 107, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L107" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 110, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L110" } ], "type": { @@ -71194,7 +71690,7 @@ ] }, "flags": {}, - "id": 93909, + "id": 97914, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -71209,15 +71705,15 @@ }, "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 93908, + "id": 97913, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -71225,20 +71721,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestManager#drop" } }, - "parentId": 2393 + "parentId": 2557 } ], "overwrites": { "name": "RequestManager.drop", - "target": 2340, + "target": 2639, "type": "reference", "ref": { - "id": 93908, + "id": 97913, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 22 } ], @@ -71247,7 +71743,110 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#drop", - "parentId": 2359 + "parentId": 2523 + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 99430, + "module": "request_loaders._request_manager", + "name": "purge", + "parsedDocstring": { + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager.py#L25" + } + ], + "type": { + "name": "Undefined", + "type": "reference", + "target": 0, + "ref": {} + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Remove all queued requests from this manager while keeping it usable.\n\nDefault implementation is a no-op. Subclasses with persistent state should override to clear it." + } + ] + }, + "flags": {}, + "id": 97916, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "purge", + "parameters": [], + "type": { + "name": "None", + "type": "reference", + "target": 0, + "ref": {} + }, + "inheritedFrom": { + "name": "RequestManager.purge", + "target": 2641, + "type": "reference", + "ref": { + "id": 97915, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 + } + ], + "kind": 2048, + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" + } + }, + "parentId": 4156 + } + ], + "inheritedFrom": { + "name": "RequestManager.purge", + "target": 2641, + "type": "reference", + "ref": { + "id": 97915, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_request_manager.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 25 + } + ], + "kind": 2048, + "permalink": "https://crawlee.dev/python/api/class/RequestManager#purge" + } + }, + "permalink": "/python/api/class/RequestManagerTandem#purge", + "parentId": 2523 }, { "kind": 2048, @@ -71264,7 +71863,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 95571, + "id": 99431, "module": "request_loaders._request_loader", "name": "to_tandem", "parsedDocstring": { @@ -71277,9 +71876,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L56" } ], "type": { @@ -71299,7 +71898,7 @@ ] }, "flags": {}, - "id": 93856, + "id": 97794, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -71321,7 +71920,7 @@ "isOptional": true, "keyword-only": false }, - "id": 93857, + "id": 97795, "kind": 32768, "kindString": "Parameter", "name": "request_manager", @@ -71331,20 +71930,20 @@ "target": 0, "ref": {} }, - "parentId": 2288 + "parentId": 2520 } ], "type": { "name": "RequestManagerTandem", "type": "reference", - "target": "2359", + "target": "2523", "ref": { - "id": 93927, + "id": 97797, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -71354,15 +71953,15 @@ }, "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 93855, + "id": 97793, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -71370,20 +71969,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#to_tandem" } }, - "parentId": 4003 + "parentId": 4157 } ], "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 93855, + "id": 97793, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -71392,7 +71991,7 @@ } }, "permalink": "/python/api/class/RequestManagerTandem#to_tandem", - "parentId": 2359 + "parentId": 2523 } ], "comment": { @@ -71413,23 +72012,24 @@ "groups": [ { "children": [ - 93928, - 93940, - 93944, - 93961, - 93952, - 93932, - 93934, - 93936, - 93938, - 93958, - 93954, - 95571 + 97798, + 97810, + 97814, + 97831, + 97822, + 97802, + 97804, + 97806, + 97808, + 97828, + 99430, + 97824, + 99431 ], "title": "Methods" } ], - "id": 93927, + "id": 97797, "module": "request_loaders._request_manager_tandem", "name": "RequestManagerTandem", "parsedDocstring": { @@ -71439,9 +72039,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_manager_tandem.py#L24" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_manager_tandem.py#L24" } ], "type": { @@ -71453,15 +72053,15 @@ "extendedTypes": [ { "name": "RequestManager", - "target": "2339", + "target": "2638", "type": "reference", "ref": { - "id": 93907, + "id": 97912, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 18 } ], @@ -71492,7 +72092,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 97874, + "id": 102003, "module": "request_loaders._sitemap_request_loader", "name": "__init__", "parsedDocstring": { @@ -71502,6 +72102,7 @@ "proxy_info": "Optional proxy to use for fetching sitemaps.", "include": "List of glob or regex patterns to include URLs.", "exclude": "List of glob or regex patterns to exclude URLs.", + "enqueue_strategy": "Strategy used to decide which sitemap-derived URLs (both nested-sitemap entries and\nURL entries) are kept relative to the parent sitemap URL. Defaults to `'same-hostname'`, matching\nthe sitemap protocol's same-host expectation and the `enqueue_links` default; pass `'all'` to\ndisable filtering. Note: regardless of `enqueue_strategy`, entries with non-`http(s)` schemes are\nalways filtered out.", "max_buffer_size": "Maximum number of URLs to buffer in memory.", "http_client": "the instance of `HttpClient` to use for fetching sitemaps.", "persist_state_key": "A key for persisting the loader's state in the KeyValueStore.\nWhen provided, allows resuming from where it left off after interruption.\nIf None, no state persistence occurs.", @@ -71512,9 +72113,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 106, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L106" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 109, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L109" } ], "type": { @@ -71534,7 +72135,7 @@ ] }, "flags": {}, - "id": 97875, + "id": 102004, "kind": 4096, "kindString": "Call signature", "modifiers": [], @@ -71553,7 +72154,7 @@ "isOptional": false, "keyword-only": false }, - "id": 97876, + "id": 102005, "kind": 32768, "kindString": "Parameter", "name": "sitemap_urls", @@ -71571,7 +72172,7 @@ "target": 0, "ref": {} }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71586,21 +72187,21 @@ "isOptional": false, "keyword-only": false }, - "id": 97877, + "id": 102006, "kind": 32768, "kindString": "Parameter", "name": "http_client", "type": { "name": "HttpClient", "type": "reference", - "target": "2070", + "target": "1429", "ref": { - "id": 97641, + "id": 100860, "sources": [ { "character": 1, "fileName": "/src/crawlee/http_clients/_base.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 75 } ], @@ -71608,7 +72209,7 @@ "permalink": "https://crawlee.dev/python/api/class/HttpClient" } }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71624,7 +72225,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97878, + "id": 102007, "kind": 32768, "kindString": "Parameter", "name": "proxy_info", @@ -71635,14 +72236,14 @@ { "type": "reference", "name": "ProxyInfo", - "target": "254", + "target": "38", "ref": { - "id": 95825, + "id": 99469, "sources": [ { "character": 1, "fileName": "/src/crawlee/proxy_configuration.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 26 } ], @@ -71656,7 +72257,7 @@ } ] }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71672,7 +72273,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97879, + "id": 102008, "kind": 32768, "kindString": "Parameter", "name": "include", @@ -71704,14 +72305,14 @@ { "type": "reference", "name": "Glob", - "target": "784", + "target": "3504", "ref": { - "id": 96355, + "id": 102935, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/globs.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 11 } ], @@ -71731,7 +72332,7 @@ } ] }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71747,7 +72348,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97880, + "id": 102009, "kind": 32768, "kindString": "Parameter", "name": "exclude", @@ -71779,14 +72380,14 @@ { "type": "reference", "name": "Glob", - "target": "784", + "target": "3504", "ref": { - "id": 96355, + "id": 102935, "sources": [ { "character": 1, "fileName": "/src/crawlee/_utils/globs.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 11 } ], @@ -71806,7 +72407,45 @@ } ] }, - "parentId": 2304 + "parentId": 2573 + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Strategy used to decide which sitemap-derived URLs (both nested-sitemap entries and\nURL entries) are kept relative to the parent sitemap URL. Defaults to `'same-hostname'`, matching\nthe sitemap protocol's same-host expectation and the `enqueue_links` default; pass `'all'` to\ndisable filtering. Note: regardless of `enqueue_strategy`, entries with non-`http(s)` schemes are\nalways filtered out." + } + ] + }, + "defaultValue": "'same-hostname'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 102010, + "kind": 32768, + "kindString": "Parameter", + "name": "enqueue_strategy", + "type": { + "name": "EnqueueStrategy", + "type": "reference", + "target": "88", + "ref": { + "id": 99519, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/_types.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 45 + } + ], + "kind": 1024, + "permalink": "https://crawlee.dev/python/api#EnqueueStrategy" + } + }, + "parentId": 2573 }, { "comment": { @@ -71822,7 +72461,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97881, + "id": 102011, "kind": 32768, "kindString": "Parameter", "name": "max_buffer_size", @@ -71832,7 +72471,7 @@ "target": 0, "ref": {} }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71848,7 +72487,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97882, + "id": 102012, "kind": 32768, "kindString": "Parameter", "name": "persist_state_key", @@ -71868,7 +72507,7 @@ } ] }, - "parentId": 2304 + "parentId": 2573 }, { "comment": { @@ -71884,7 +72523,7 @@ "isOptional": true, "keyword-only": true }, - "id": 97883, + "id": 102013, "kind": 32768, "kindString": "Parameter", "name": "transform_request_function", @@ -71908,14 +72547,14 @@ { "type": "reference", "name": "RequestOptions", - "target": "134", + "target": "492", "ref": { - "id": 95705, + "id": 99923, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 121 } ], @@ -71926,15 +72565,15 @@ { "type": "reference", "name": "RequestTransformAction", - "target": "302", + "target": "87", "ref": { - "id": 95873, + "id": 99518, "sources": [ { "character": 1, "fileName": "/src/crawlee/_types.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 42 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 43 } ], "kind": 1024, @@ -71953,7 +72592,7 @@ } ] }, - "parentId": 2304 + "parentId": 2573 } ], "type": { @@ -71961,11 +72600,258 @@ "type": "literal", "value": {} }, - "parentId": 2303 + "parentId": 2572 } ], "permalink": "/python/api/class/SitemapRequestLoader#__init__", - "parentId": 2302 + "parentId": 2571 + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enter the context manager." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 102014, + "module": "request_loaders._sitemap_request_loader", + "name": "__aenter__", + "parsedDocstring": { + "text": "Enter the context manager." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 171, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L171" + } + ], + "type": { + "name": "Undefined", + "type": "reference", + "target": 0, + "ref": {} + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enter the context manager." + } + ] + }, + "flags": {}, + "id": 102015, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aenter__", + "parameters": [], + "type": { + "name": "SitemapRequestLoader", + "type": "reference", + "target": "2571", + "ref": { + "id": 102002, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94 + } + ], + "kind": 128, + "permalink": "https://crawlee.dev/python/api/class/SitemapRequestLoader" + } + }, + "parentId": 2583 + } + ], + "permalink": "/python/api/class/SitemapRequestLoader#__aenter__", + "parentId": 2571 + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Exit the context manager." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 102016, + "module": "request_loaders._sitemap_request_loader", + "name": "__aexit__", + "parsedDocstring": { + "text": "Exit the context manager." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 176, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L176" + } + ], + "type": { + "name": "Undefined", + "type": "reference", + "target": 0, + "ref": {} + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Exit the context manager." + } + ] + }, + "flags": {}, + "id": 102017, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aexit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 102018, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException", + "target": 0, + "ref": {} + } + ], + "target": "3727", + "ref": { + "id": 103158, + "sources": [ + { + "character": 1, + "fileName": "/src/crawlee/_utils/sitemap.py", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 62 + } + ], + "kind": 1024, + "permalink": "https://crawlee.dev/python/api/class/SitemapSource#type" + } + }, + { + "type": "literal", + "value": {} + } + ] + }, + "parentId": 2586 + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 102019, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_value", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException", + "target": 0, + "ref": {} + }, + { + "type": "literal", + "value": {} + } + ] + }, + "parentId": 2586 + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 102020, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_traceback", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType", + "target": 0, + "ref": {} + }, + { + "type": "literal", + "value": {} + } + ] + }, + "parentId": 2586 + } + ], + "type": { + "name": "None", + "type": "literal", + "value": {} + }, + "parentId": 2585 + } + ], + "permalink": "/python/api/class/SitemapRequestLoader#__aexit__", + "parentId": 2571 }, { "kind": 2048, @@ -71986,7 +72872,7 @@ ], "flags": {}, "groups": [], - "id": 97884, + "id": 102021, "module": "request_loaders._sitemap_request_loader", "name": "get_total_count", "parsedDocstring": { @@ -71996,9 +72882,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 288, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L288" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 186, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L186" } ], "type": { @@ -72018,7 +72904,7 @@ ] }, "flags": {}, - "id": 97885, + "id": 102022, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72034,15 +72920,15 @@ }, "overwrites": { "name": "RequestLoader.get_total_count", - "target": 2276, + "target": 2508, "type": "reference", "ref": { - "id": 97847, + "id": 101939, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -72050,20 +72936,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#get_total_count" } }, - "parentId": 2313 + "parentId": 2590 } ], "overwrites": { "name": "RequestLoader.get_total_count", - "target": 2276, + "target": 2508, "type": "reference", "ref": { - "id": 97847, + "id": 101939, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 33 } ], @@ -72072,7 +72958,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#get_total_count", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72093,7 +72979,7 @@ ], "flags": {}, "groups": [], - "id": 97886, + "id": 102023, "module": "request_loaders._sitemap_request_loader", "name": "get_handled_count", "parsedDocstring": { @@ -72103,9 +72989,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 294, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L294" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 192, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L192" } ], "type": { @@ -72125,7 +73011,7 @@ ] }, "flags": {}, - "id": 97887, + "id": 102024, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72141,15 +73027,15 @@ }, "overwrites": { "name": "RequestLoader.get_handled_count", - "target": 2274, + "target": 2506, "type": "reference", "ref": { - "id": 97845, + "id": 101937, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -72157,20 +73043,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#get_handled_count" } }, - "parentId": 2315 + "parentId": 2592 } ], "overwrites": { "name": "RequestLoader.get_handled_count", - "target": 2274, + "target": 2506, "type": "reference", "ref": { - "id": 97845, + "id": 101937, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 29 } ], @@ -72179,7 +73065,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#get_handled_count", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72200,7 +73086,7 @@ ], "flags": {}, "groups": [], - "id": 97888, + "id": 102025, "module": "request_loaders._sitemap_request_loader", "name": "is_empty", "parsedDocstring": { @@ -72210,9 +73096,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 300, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L300" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 198, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L198" } ], "type": { @@ -72232,7 +73118,7 @@ ] }, "flags": {}, - "id": 97889, + "id": 102026, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72248,15 +73134,15 @@ }, "overwrites": { "name": "RequestLoader.is_empty", - "target": 2278, + "target": 2510, "type": "reference", "ref": { - "id": 97849, + "id": 101941, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -72264,20 +73150,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#is_empty" } }, - "parentId": 2317 + "parentId": 2594 } ], "overwrites": { "name": "RequestLoader.is_empty", - "target": 2278, + "target": 2510, "type": "reference", "ref": { - "id": 97849, + "id": 101941, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 37 } ], @@ -72286,7 +73172,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#is_empty", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72307,7 +73193,7 @@ ], "flags": {}, "groups": [], - "id": 97890, + "id": 102027, "module": "request_loaders._sitemap_request_loader", "name": "is_finished", "parsedDocstring": { @@ -72317,9 +73203,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 306, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L306" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 204, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L204" } ], "type": { @@ -72339,7 +73225,7 @@ ] }, "flags": {}, - "id": 97891, + "id": 102028, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72355,15 +73241,15 @@ }, "overwrites": { "name": "RequestLoader.is_finished", - "target": 2280, + "target": 2512, "type": "reference", "ref": { - "id": 97851, + "id": 101943, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -72371,20 +73257,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#is_finished" } }, - "parentId": 2319 + "parentId": 2596 } ], "overwrites": { "name": "RequestLoader.is_finished", - "target": 2280, + "target": 2512, "type": "reference", "ref": { - "id": 97851, + "id": 101943, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 41 } ], @@ -72393,7 +73279,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#is_finished", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72414,7 +73300,7 @@ ], "flags": {}, "groups": [], - "id": 97892, + "id": 102029, "module": "request_loaders._sitemap_request_loader", "name": "fetch_next_request", "parsedDocstring": { @@ -72424,9 +73310,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 312, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L312" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 210, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L210" } ], "type": { @@ -72446,7 +73332,7 @@ ] }, "flags": {}, - "id": 97893, + "id": 102030, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72461,14 +73347,14 @@ { "type": "reference", "name": "Request", - "target": "150", + "target": "508", "ref": { - "id": 95721, + "id": 99939, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -72484,15 +73370,15 @@ }, "overwrites": { "name": "RequestLoader.fetch_next_request", - "target": 2282, + "target": 2514, "type": "reference", "ref": { - "id": 97853, + "id": 101945, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -72500,20 +73386,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#fetch_next_request" } }, - "parentId": 2321 + "parentId": 2598 } ], "overwrites": { "name": "RequestLoader.fetch_next_request", - "target": 2282, + "target": 2514, "type": "reference", "ref": { - "id": 97853, + "id": 101945, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 45 } ], @@ -72522,7 +73408,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#fetch_next_request", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72543,7 +73429,7 @@ ], "flags": {}, "groups": [], - "id": 97894, + "id": 102031, "module": "request_loaders._sitemap_request_loader", "name": "mark_request_as_handled", "parsedDocstring": { @@ -72553,9 +73439,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 340, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L340" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 245, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L245" } ], "type": { @@ -72575,7 +73461,7 @@ ] }, "flags": {}, - "id": 97895, + "id": 102032, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72588,21 +73474,21 @@ "isOptional": false, "keyword-only": false }, - "id": 97896, + "id": 102033, "kind": 32768, "kindString": "Parameter", "name": "request", "type": { "name": "Request", "type": "reference", - "target": "150", + "target": "508", "ref": { - "id": 95721, + "id": 99939, "sources": [ { "character": 1, "fileName": "/src/crawlee/_request.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 145 } ], @@ -72610,7 +73496,7 @@ "permalink": "https://crawlee.dev/python/api/class/Request" } }, - "parentId": 2324 + "parentId": 2601 } ], "type": { @@ -72620,15 +73506,15 @@ { "type": "reference", "name": "ProcessedRequest", - "target": "3665", + "target": "1735", "ref": { - "id": 99236, + "id": 101166, "sources": [ { "character": 1, "fileName": "/src/crawlee/storage_clients/models.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 140 + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 143 } ], "kind": 128, @@ -72643,15 +73529,15 @@ }, "overwrites": { "name": "RequestLoader.mark_request_as_handled", - "target": 2284, + "target": 2516, "type": "reference", "ref": { - "id": 97855, + "id": 101947, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -72659,20 +73545,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#mark_request_as_handled" } }, - "parentId": 2323 + "parentId": 2600 } ], "overwrites": { "name": "RequestLoader.mark_request_as_handled", - "target": 2284, + "target": 2516, "type": "reference", "ref": { - "id": 97855, + "id": 101947, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 53 } ], @@ -72681,73 +73567,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#mark_request_as_handled", - "parentId": 2302 - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the sitemap loading process." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 97897, - "module": "request_loaders._sitemap_request_loader", - "name": "abort_loading", - "parsedDocstring": { - "text": "Abort the sitemap loading process." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 348, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L348" - } - ], - "type": { - "name": "Undefined", - "type": "reference", - "target": 0, - "ref": {} - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the sitemap loading process." - } - ] - }, - "flags": {}, - "id": 97898, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "abort_loading", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": {} - }, - "parentId": 2326 - } - ], - "permalink": "/python/api/class/SitemapRequestLoader#abort_loading", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72764,7 +73584,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 97899, + "id": 102034, "module": "request_loaders._sitemap_request_loader", "name": "start", "parsedDocstring": { @@ -72774,9 +73594,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 355, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L355" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 253, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L253" } ], "type": { @@ -72796,7 +73616,7 @@ ] }, "flags": {}, - "id": 97900, + "id": 102035, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -72809,11 +73629,11 @@ "type": "literal", "value": {} }, - "parentId": 2328 + "parentId": 2603 } ], "permalink": "/python/api/class/SitemapRequestLoader#start", - "parentId": 2302 + "parentId": 2571 }, { "kind": 2048, @@ -72823,26 +73643,26 @@ "summary": [ { "kind": "text", - "text": "Close the request loader." + "text": "Abort the sitemap loading process." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 97901, + "id": 102036, "module": "request_loaders._sitemap_request_loader", - "name": "close", + "name": "abort_loading", "parsedDocstring": { - "text": "Close the request loader." + "text": "Abort the sitemap loading process." }, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 361, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L361" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 259, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L259" } ], "type": { @@ -72857,29 +73677,29 @@ "summary": [ { "kind": "text", - "text": "Close the request loader." + "text": "Abort the sitemap loading process." } ] }, "flags": {}, - "id": 97902, + "id": 102037, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "close", + "name": "abort_loading", "parameters": [], "type": { "name": "None", "type": "literal", "value": {} }, - "parentId": 2330 + "parentId": 2605 } ], - "permalink": "/python/api/class/SitemapRequestLoader#close", - "parentId": 2302 + "permalink": "/python/api/class/SitemapRequestLoader#abort_loading", + "parentId": 2571 }, { "kind": 2048, @@ -72889,26 +73709,26 @@ "summary": [ { "kind": "text", - "text": "Enter the context manager." + "text": "Close the request loader." } ] }, "decorations": [], "flags": {}, "groups": [], - "id": 97903, + "id": 102038, "module": "request_loaders._sitemap_request_loader", - "name": "__aenter__", + "name": "close", "parsedDocstring": { - "text": "Enter the context manager." + "text": "Close the request loader." }, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 366, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L366" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 266, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L266" } ], "type": { @@ -72923,210 +73743,29 @@ "summary": [ { "kind": "text", - "text": "Enter the context manager." + "text": "Close the request loader." } ] }, "flags": {}, - "id": 97904, + "id": 102039, "kind": 4096, "kindString": "Call signature", "modifiers": [ "async" ], - "name": "__aenter__", + "name": "close", "parameters": [], - "type": { - "name": "SitemapRequestLoader", - "type": "reference", - "target": "2302", - "ref": { - "id": 97873, - "sources": [ - { - "character": 1, - "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91 - } - ], - "kind": 128, - "permalink": "https://crawlee.dev/python/api/class/SitemapRequestLoader" - } - }, - "parentId": 2332 - } - ], - "permalink": "/python/api/class/SitemapRequestLoader#__aenter__", - "parentId": 2302 - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exit the context manager." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 97905, - "module": "request_loaders._sitemap_request_loader", - "name": "__aexit__", - "parsedDocstring": { - "text": "Exit the context manager." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 371, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L371" - } - ], - "type": { - "name": "Undefined", - "type": "reference", - "target": 0, - "ref": {} - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exit the context manager." - } - ] - }, - "flags": {}, - "id": 97906, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aexit__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 97907, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_type", - "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException", - "target": 0, - "ref": {} - } - ], - "target": "981", - "ref": { - "id": 96552, - "sources": [ - { - "character": 1, - "fileName": "/src/crawlee/_utils/sitemap.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 62 - } - ], - "kind": 1024, - "permalink": "https://crawlee.dev/python/api/class/SitemapSource#type" - } - }, - { - "type": "literal", - "value": {} - } - ] - }, - "parentId": 2335 - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 97908, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_value", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException", - "target": 0, - "ref": {} - }, - { - "type": "literal", - "value": {} - } - ] - }, - "parentId": 2335 - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 97909, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_traceback", - "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType", - "target": 0, - "ref": {} - }, - { - "type": "literal", - "value": {} - } - ] - }, - "parentId": 2335 - } - ], "type": { "name": "None", "type": "literal", "value": {} }, - "parentId": 2334 + "parentId": 2607 } ], - "permalink": "/python/api/class/SitemapRequestLoader#__aexit__", - "parentId": 2302 + "permalink": "/python/api/class/SitemapRequestLoader#close", + "parentId": 2571 }, { "kind": 2048, @@ -73143,7 +73782,7 @@ "decorations": [], "flags": {}, "groups": [], - "id": 99565, + "id": 103577, "module": "request_loaders._request_loader", "name": "to_tandem", "parsedDocstring": { @@ -73156,9 +73795,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_request_loader.py#L56" + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_request_loader.py#L56" } ], "type": { @@ -73178,7 +73817,7 @@ ] }, "flags": {}, - "id": 97859, + "id": 101951, "kind": 4096, "kindString": "Call signature", "modifiers": [ @@ -73200,7 +73839,7 @@ "isOptional": true, "keyword-only": false }, - "id": 97860, + "id": 101952, "kind": 32768, "kindString": "Parameter", "name": "request_manager", @@ -73210,20 +73849,20 @@ "target": 0, "ref": {} }, - "parentId": 2288 + "parentId": 2520 } ], "type": { "name": "RequestManagerTandem", "type": "reference", - "target": "2359", + "target": "2523", "ref": { - "id": 97930, + "id": 101954, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_manager_tandem.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 24 } ], @@ -73233,15 +73872,15 @@ }, "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 97858, + "id": 101950, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -73249,20 +73888,20 @@ "permalink": "https://crawlee.dev/python/api/class/RequestLoader#to_tandem" } }, - "parentId": 3994 + "parentId": 4146 } ], "inheritedFrom": { "name": "RequestLoader.to_tandem", - "target": 2287, + "target": 2519, "type": "reference", "ref": { - "id": 97858, + "id": 101950, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 56 } ], @@ -73271,7 +73910,7 @@ } }, "permalink": "/python/api/class/SitemapRequestLoader#to_tandem", - "parentId": 2302 + "parentId": 2571 } ], "comment": { @@ -73292,24 +73931,24 @@ "groups": [ { "children": [ - 97903, - 97905, - 97874, - 97897, - 97901, - 97892, - 97886, - 97884, - 97888, - 97890, - 97894, - 97899, - 99565 + 102014, + 102016, + 102003, + 102036, + 102038, + 102029, + 102023, + 102021, + 102025, + 102027, + 102031, + 102034, + 103577 ], "title": "Methods" } ], - "id": 97873, + "id": 102002, "module": "request_loaders._sitemap_request_loader", "name": "SitemapRequestLoader", "parsedDocstring": { @@ -73319,9 +73958,9 @@ { "character": 1, "fileName": "/src/crawlee/request_loaders/_sitemap_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", - "line": 91, - "url": "https://github.com/apify/crawlee-python/blob/02a18ea618daf8c55d9ca272249b58aa45caa4ea//src/crawlee/request_loaders/_sitemap_request_loader.py#L91" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", + "line": 94, + "url": "https://github.com/apify/crawlee-python/blob/e7e0364ffc322bcd0d7c603e9fb5814f2a9e8ab3//src/crawlee/request_loaders/_sitemap_request_loader.py#L94" } ], "type": { @@ -73333,15 +73972,15 @@ "extendedTypes": [ { "name": "RequestLoader", - "target": "2273", + "target": "2505", "type": "reference", "ref": { - "id": 97844, + "id": 101936, "sources": [ { "character": 1, "fileName": "/src/crawlee/request_loaders/_request_loader.py", - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9", + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a", "line": 17 } ], @@ -73358,112 +73997,112 @@ "groups": [ { "children": [ - 398, - 226, - 128, - 154, - 135, - 162, - 176, - 110 + 3, + 547, + 449, + 475, + 456, + 483, + 497, + 431 ], "title": "Actor" }, { "children": [ - 41, - 37, - 9 + 269, + 265, + 237 ], "title": "Charging" }, { "children": [ - 319, - 296, - 293 + 328, + 588, + 584 ], "title": "Configuration" }, { "children": [ - 997, - 60787, - 62681, - 64570, - 66453, - 68339 + 643, + 57267, + 61308, + 65344, + 69374, + 73407 ], "title": "Event data" }, { "children": [ - 985, - 52938, - 54860 + 631, + 44989, + 49109 ], "title": "Event managers" }, { "children": [ - 1018, - 1027, - 1024, - 1021, - 1015, - 1009, - 1012, - 1030, - 58884 + 664, + 673, + 670, + 667, + 661, + 655, + 658, + 676, + 53217 ], "title": "Events" }, { "children": [ - 1045, - 86175, - 89906, - 93927, - 97873 + 694, + 90987, + 93758, + 97797, + 102002 ], "title": "Request loaders" }, { "children": [ - 928, - 953, - 71126, - 75041, - 78792, - 83500 + 1056, + 1139, + 75825, + 77711, + 82077, + 86545 ], "title": "Storage clients" }, { "children": [ - 738, - 740, - 743, - 20335, - 23996, - 27641, - 31580, - 35534, - 39460, - 43130, - 43285, - 47085, - 51019 + 928, + 930, + 933, + 16643, + 18374, + 20089, + 24288, + 28502, + 32688, + 34428, + 34941, + 36713, + 40907 ], "title": "Storage data" }, { "title": "Storages", "children": [ - 4875, - 8813, - 12595, - 16507 + 4094, + 6913, + 10499, + 13465 ] } ], @@ -73476,1834 +74115,1858 @@ "character": 0, "fileName": "src/index.ts", "line": 1, - "gitRevision": "a24b56fd36a210033dd3664a6de62fd1f1b8e8a9" + "gitRevision": "22eee8c5644511292904e4d21fd3ee8c2e83e21a" } ], "symbolIdMap": { "1": { - "qualifiedName": "EVENT_LISTENERS_TIMEOUT", - "sourceFileName": "/src/apify/_consts.py" + "qualifiedName": "__version__", + "sourceFileName": "/src/apify/__init__.py" }, "2": { - "qualifiedName": "BASE64_REGEXP", - "sourceFileName": "/src/apify/_consts.py" + "qualifiedName": "MainReturnType", + "sourceFileName": "/src/apify/_actor.py" }, "3": { - "qualifiedName": "ENCRYPTED_STRING_VALUE_PREFIX", - "sourceFileName": "/src/apify/_consts.py" + "qualifiedName": "Actor", + "sourceFileName": "/src/apify/_actor.py" }, "4": { - "qualifiedName": "ENCRYPTED_JSON_VALUE_PREFIX", - "sourceFileName": "/src/apify/_consts.py" + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/_actor.py" }, - "5": { - "qualifiedName": "ENCRYPTED_INPUT_VALUE_REGEXP", - "sourceFileName": "/src/apify/_consts.py" + "13": { + "qualifiedName": "__aenter__", + "sourceFileName": "/src/apify/_actor.py" + }, + "15": { + "qualifiedName": "__aexit__", + "sourceFileName": "/src/apify/_actor.py" + }, + "20": { + "qualifiedName": "__repr__", + "sourceFileName": "/src/apify/_actor.py" + }, + "22": { + "qualifiedName": "__call__", + "sourceFileName": "/src/apify/_actor.py" + }, + "31": { + "qualifiedName": "log", + "sourceFileName": "/src/apify/_actor.py" + }, + "32": { + "qualifiedName": "exit_code", + "sourceFileName": "/src/apify/_actor.py" + }, + "33": { + "qualifiedName": "exit_code", + "sourceFileName": "/src/apify/_actor.py" + }, + "36": { + "qualifiedName": "status_message", + "sourceFileName": "/src/apify/_actor.py" + }, + "37": { + "qualifiedName": "status_message", + "sourceFileName": "/src/apify/_actor.py" + }, + "40": { + "qualifiedName": "apify_client", + "sourceFileName": "/src/apify/_actor.py" + }, + "41": { + "qualifiedName": "configuration", + "sourceFileName": "/src/apify/_actor.py" + }, + "43": { + "qualifiedName": "event_manager", + "sourceFileName": "/src/apify/_actor.py" + }, + "45": { + "qualifiedName": "init", + "sourceFileName": "/src/apify/_actor.py" + }, + "47": { + "qualifiedName": "exit", + "sourceFileName": "/src/apify/_actor.py" + }, + "53": { + "qualifiedName": "fail", + "sourceFileName": "/src/apify/_actor.py" + }, + "58": { + "qualifiedName": "new_client", + "sourceFileName": "/src/apify/_actor.py" + }, + "65": { + "qualifiedName": "open_dataset", + "sourceFileName": "/src/apify/_actor.py" + }, + "71": { + "qualifiedName": "open_key_value_store", + "sourceFileName": "/src/apify/_actor.py" + }, + "77": { + "qualifiedName": "open_request_queue", + "sourceFileName": "/src/apify/_actor.py" + }, + "83": { + "qualifiedName": "push_data", + "sourceFileName": "/src/apify/_actor.py" + }, + "87": { + "qualifiedName": "get_input", + "sourceFileName": "/src/apify/_actor.py" + }, + "89": { + "qualifiedName": "get_value", + "sourceFileName": "/src/apify/_actor.py" + }, + "93": { + "qualifiedName": "set_value", + "sourceFileName": "/src/apify/_actor.py" + }, + "98": { + "qualifiedName": "get_charging_manager", + "sourceFileName": "/src/apify/_actor.py" + }, + "100": { + "qualifiedName": "charge", + "sourceFileName": "/src/apify/_actor.py" + }, + "104": { + "qualifiedName": "on", + "sourceFileName": "/src/apify/_actor.py" + }, + "108": { + "qualifiedName": "off", + "sourceFileName": "/src/apify/_actor.py" + }, + "112": { + "qualifiedName": "is_at_home", + "sourceFileName": "/src/apify/_actor.py" + }, + "114": { + "qualifiedName": "get_env", + "sourceFileName": "/src/apify/_actor.py" + }, + "116": { + "qualifiedName": "start", + "sourceFileName": "/src/apify/_actor.py" + }, + "130": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify/_actor.py" + }, + "136": { + "qualifiedName": "call", + "sourceFileName": "/src/apify/_actor.py" + }, + "151": { + "qualifiedName": "call_task", + "sourceFileName": "/src/apify/_actor.py" + }, + "162": { + "qualifiedName": "metamorph", + "sourceFileName": "/src/apify/_actor.py" + }, + "169": { + "qualifiedName": "reboot", + "sourceFileName": "/src/apify/_actor.py" + }, + "173": { + "qualifiedName": "add_webhook", + "sourceFileName": "/src/apify/_actor.py" + }, + "179": { + "qualifiedName": "set_status_message", + "sourceFileName": "/src/apify/_actor.py" + }, + "183": { + "qualifiedName": "create_proxy_configuration", + "sourceFileName": "/src/apify/_actor.py" + }, + "192": { + "qualifiedName": "use_state", + "sourceFileName": "/src/apify/_actor.py" + }, + "233": { + "qualifiedName": "Actor", + "sourceFileName": "/src/apify/_actor.py" }, - "6": { + "234": { "qualifiedName": "run_validator", "sourceFileName": "/src/apify/_charging.py" }, - "7": { + "235": { "qualifiedName": "DEFAULT_DATASET_ITEM_EVENT", "sourceFileName": "/src/apify/_charging.py" }, - "8": { + "236": { "qualifiedName": "charging_manager_ctx", "sourceFileName": "/src/apify/_charging.py" }, - "9": { + "237": { "qualifiedName": "ChargingManager", "sourceFileName": "/src/apify/_charging.py" }, - "10": { + "238": { "qualifiedName": "charge_lock", "sourceFileName": "/src/apify/_charging.py" }, - "11": { + "239": { "qualifiedName": "charge", "sourceFileName": "/src/apify/_charging.py" }, - "15": { + "243": { "qualifiedName": "calculate_total_charged_amount", "sourceFileName": "/src/apify/_charging.py" }, - "17": { + "245": { "qualifiedName": "calculate_max_event_charge_count_within_limit", "sourceFileName": "/src/apify/_charging.py" }, - "20": { + "248": { "qualifiedName": "get_pricing_info", "sourceFileName": "/src/apify/_charging.py" }, - "22": { + "250": { "qualifiedName": "get_charged_event_count", "sourceFileName": "/src/apify/_charging.py" }, - "25": { + "253": { "qualifiedName": "get_max_total_charge_usd", "sourceFileName": "/src/apify/_charging.py" }, - "27": { + "255": { "qualifiedName": "compute_push_data_limit", "sourceFileName": "/src/apify/_charging.py" }, - "32": { + "260": { "qualifiedName": "is_event_charge_limit_reached", "sourceFileName": "/src/apify/_charging.py" }, - "35": { + "263": { "qualifiedName": "compute_chargeable", "sourceFileName": "/src/apify/_charging.py" }, - "37": { + "265": { "qualifiedName": "ChargeResult", "sourceFileName": "/src/apify/_charging.py" }, - "38": { + "266": { "qualifiedName": "event_charge_limit_reached", "sourceFileName": "/src/apify/_charging.py" }, - "39": { + "267": { "qualifiedName": "charged_count", "sourceFileName": "/src/apify/_charging.py" }, - "40": { + "268": { "qualifiedName": "chargeable_within_limit", "sourceFileName": "/src/apify/_charging.py" }, - "41": { + "269": { "qualifiedName": "ActorPricingInfo", "sourceFileName": "/src/apify/_charging.py" }, - "42": { + "270": { "qualifiedName": "pricing_model", "sourceFileName": "/src/apify/_charging.py" }, - "43": { + "271": { "qualifiedName": "max_total_charge_usd", "sourceFileName": "/src/apify/_charging.py" }, - "44": { + "272": { "qualifiedName": "is_pay_per_event", "sourceFileName": "/src/apify/_charging.py" }, - "45": { + "273": { "qualifiedName": "per_event_prices", "sourceFileName": "/src/apify/_charging.py" }, - "46": { + "274": { "qualifiedName": "ChargingManagerImplementation", "sourceFileName": "/src/apify/_charging.py" }, - "47": { + "275": { "qualifiedName": "LOCAL_CHARGING_LOG_DATASET_NAME", "sourceFileName": "/src/apify/_charging.py" }, - "48": { + "276": { "qualifiedName": "__init__", "sourceFileName": "/src/apify/_charging.py" }, - "52": { + "280": { "qualifiedName": "__aenter__", "sourceFileName": "/src/apify/_charging.py" }, - "54": { + "282": { "qualifiedName": "__aexit__", "sourceFileName": "/src/apify/_charging.py" }, - "59": { + "287": { "qualifiedName": "charge", "sourceFileName": "/src/apify/_charging.py" }, - "63": { + "291": { "qualifiedName": "calculate_total_charged_amount", "sourceFileName": "/src/apify/_charging.py" }, - "65": { + "293": { "qualifiedName": "calculate_max_event_charge_count_within_limit", "sourceFileName": "/src/apify/_charging.py" }, - "68": { + "296": { "qualifiedName": "get_pricing_info", "sourceFileName": "/src/apify/_charging.py" }, - "70": { + "298": { "qualifiedName": "get_charged_event_count", "sourceFileName": "/src/apify/_charging.py" }, - "73": { + "301": { "qualifiedName": "get_max_total_charge_usd", "sourceFileName": "/src/apify/_charging.py" }, - "75": { + "303": { "qualifiedName": "compute_push_data_limit", "sourceFileName": "/src/apify/_charging.py" }, - "80": { + "308": { "qualifiedName": "is_event_charge_limit_reached", "sourceFileName": "/src/apify/_charging.py" }, - "83": { + "311": { "qualifiedName": "compute_chargeable", "sourceFileName": "/src/apify/_charging.py" }, - "85": { + "313": { "qualifiedName": "ChargingStateItem", "sourceFileName": "/src/apify/_charging.py" }, - "86": { + "314": { "qualifiedName": "charge_count", "sourceFileName": "/src/apify/_charging.py" }, - "87": { + "315": { "qualifiedName": "total_charged_amount", "sourceFileName": "/src/apify/_charging.py" }, - "88": { + "316": { "qualifiedName": "PricingInfoItem", "sourceFileName": "/src/apify/_charging.py" }, - "89": { + "317": { "qualifiedName": "price", "sourceFileName": "/src/apify/_charging.py" }, - "90": { + "318": { "qualifiedName": "title", "sourceFileName": "/src/apify/_charging.py" }, - "91": { + "319": { "qualifiedName": "_FetchedPricingInfoDict", "sourceFileName": "/src/apify/_charging.py" }, - "92": { + "320": { "qualifiedName": "pricing_info", "sourceFileName": "/src/apify/_charging.py" }, - "93": { + "321": { "qualifiedName": "charged_event_counts", "sourceFileName": "/src/apify/_charging.py" }, - "94": { + "322": { "qualifiedName": "max_total_charge_usd", "sourceFileName": "/src/apify/_charging.py" }, - "95": { + "323": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/_configuration.py" + }, + "324": { + "qualifiedName": "ActorStorages", + "sourceFileName": "/src/apify/_configuration.py" + }, + "325": { + "qualifiedName": "key_value_stores", + "sourceFileName": "/src/apify/_configuration.py" + }, + "326": { + "qualifiedName": "datasets", + "sourceFileName": "/src/apify/_configuration.py" + }, + "327": { + "qualifiedName": "request_queues", + "sourceFileName": "/src/apify/_configuration.py" + }, + "328": { + "qualifiedName": "Configuration", + "sourceFileName": "/src/apify/_configuration.py" + }, + "329": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "330": { + "qualifiedName": "actor_full_name", + "sourceFileName": "/src/apify/_configuration.py" + }, + "331": { + "qualifiedName": "actor_permission_level", + "sourceFileName": "/src/apify/_configuration.py" + }, + "332": { + "qualifiedName": "actor_run_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "333": { + "qualifiedName": "actor_build_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "334": { + "qualifiedName": "actor_build_number", + "sourceFileName": "/src/apify/_configuration.py" + }, + "335": { + "qualifiedName": "actor_build_tags", + "sourceFileName": "/src/apify/_configuration.py" + }, + "336": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "337": { + "qualifiedName": "actor_events_ws_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "338": { + "qualifiedName": "api_base_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "339": { + "qualifiedName": "api_public_base_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "340": { + "qualifiedName": "dedicated_cpus", + "sourceFileName": "/src/apify/_configuration.py" + }, + "341": { + "qualifiedName": "default_dataset_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "342": { + "qualifiedName": "default_key_value_store_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "343": { + "qualifiedName": "default_request_queue_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "344": { + "qualifiedName": "disable_outdated_warning", + "sourceFileName": "/src/apify/_configuration.py" + }, + "345": { + "qualifiedName": "fact", + "sourceFileName": "/src/apify/_configuration.py" + }, + "346": { + "qualifiedName": "input_key", + "sourceFileName": "/src/apify/_configuration.py" + }, + "347": { + "qualifiedName": "input_secrets_private_key_file", + "sourceFileName": "/src/apify/_configuration.py" + }, + "348": { + "qualifiedName": "input_secrets_private_key_passphrase", + "sourceFileName": "/src/apify/_configuration.py" + }, + "349": { + "qualifiedName": "is_at_home", + "sourceFileName": "/src/apify/_configuration.py" + }, + "350": { + "qualifiedName": "latest_sdk_version", + "sourceFileName": "/src/apify/_configuration.py" + }, + "351": { + "qualifiedName": "log_format", + "sourceFileName": "/src/apify/_configuration.py" + }, + "352": { + "qualifiedName": "max_paid_dataset_items", + "sourceFileName": "/src/apify/_configuration.py" + }, + "353": { + "qualifiedName": "max_total_charge_usd", + "sourceFileName": "/src/apify/_configuration.py" + }, + "354": { + "qualifiedName": "test_pay_per_event", + "sourceFileName": "/src/apify/_configuration.py" + }, + "355": { + "qualifiedName": "meta_origin", + "sourceFileName": "/src/apify/_configuration.py" + }, + "356": { + "qualifiedName": "metamorph_after_sleep", + "sourceFileName": "/src/apify/_configuration.py" + }, + "357": { + "qualifiedName": "proxy_hostname", + "sourceFileName": "/src/apify/_configuration.py" + }, + "358": { + "qualifiedName": "proxy_password", + "sourceFileName": "/src/apify/_configuration.py" + }, + "359": { + "qualifiedName": "proxy_port", + "sourceFileName": "/src/apify/_configuration.py" + }, + "360": { + "qualifiedName": "proxy_status_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "361": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify/_configuration.py" + }, + "362": { + "qualifiedName": "timeout_at", + "sourceFileName": "/src/apify/_configuration.py" + }, + "363": { + "qualifiedName": "standby_port", + "sourceFileName": "/src/apify/_configuration.py" + }, + "364": { + "qualifiedName": "standby_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "365": { + "qualifiedName": "token", + "sourceFileName": "/src/apify/_configuration.py" + }, + "366": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify/_configuration.py" + }, + "367": { + "qualifiedName": "user_is_paying", + "sourceFileName": "/src/apify/_configuration.py" + }, + "368": { + "qualifiedName": "web_server_port", + "sourceFileName": "/src/apify/_configuration.py" + }, + "369": { + "qualifiedName": "web_server_url", + "sourceFileName": "/src/apify/_configuration.py" + }, + "370": { + "qualifiedName": "workflow_key", + "sourceFileName": "/src/apify/_configuration.py" + }, + "371": { + "qualifiedName": "actor_pricing_info", + "sourceFileName": "/src/apify/_configuration.py" + }, + "372": { + "qualifiedName": "charged_event_counts", + "sourceFileName": "/src/apify/_configuration.py" + }, + "373": { + "qualifiedName": "actor_storages", + "sourceFileName": "/src/apify/_configuration.py" + }, + "374": { + "qualifiedName": "disable_browser_sandbox_on_platform", + "sourceFileName": "/src/apify/_configuration.py" + }, + "376": { + "qualifiedName": "canonical_input_key", + "sourceFileName": "/src/apify/_configuration.py" + }, + "377": { + "qualifiedName": "input_key_candidates", + "sourceFileName": "/src/apify/_configuration.py" + }, + "378": { + "qualifiedName": "get_global_configuration", + "sourceFileName": "/src/apify/_configuration.py" + }, + "380": { + "qualifiedName": "from_configuration", + "sourceFileName": "/src/apify/_configuration.py" + }, + "383": { + "qualifiedName": "EVENT_LISTENERS_TIMEOUT", + "sourceFileName": "/src/apify/_consts.py" + }, + "384": { + "qualifiedName": "BASE64_REGEXP", + "sourceFileName": "/src/apify/_consts.py" + }, + "385": { + "qualifiedName": "ENCRYPTED_STRING_VALUE_PREFIX", + "sourceFileName": "/src/apify/_consts.py" + }, + "386": { + "qualifiedName": "ENCRYPTED_JSON_VALUE_PREFIX", + "sourceFileName": "/src/apify/_consts.py" + }, + "387": { + "qualifiedName": "ENCRYPTED_INPUT_VALUE_REGEXP", + "sourceFileName": "/src/apify/_consts.py" + }, + "388": { + "qualifiedName": "ENCRYPTION_KEY_LENGTH", + "sourceFileName": "/src/apify/_crypto.py" + }, + "389": { + "qualifiedName": "ENCRYPTION_IV_LENGTH", + "sourceFileName": "/src/apify/_crypto.py" + }, + "390": { + "qualifiedName": "ENCRYPTION_AUTH_TAG_LENGTH", + "sourceFileName": "/src/apify/_crypto.py" + }, + "391": { + "qualifiedName": "public_encrypt", + "sourceFileName": "/src/apify/_crypto.py" + }, + "395": { + "qualifiedName": "private_decrypt", + "sourceFileName": "/src/apify/_crypto.py" + }, + "400": { + "qualifiedName": "load_private_key", + "sourceFileName": "/src/apify/_crypto.py" + }, + "404": { + "qualifiedName": "decrypt_input_secrets", + "sourceFileName": "/src/apify/_crypto.py" + }, + "408": { + "qualifiedName": "CHARSET", + "sourceFileName": "/src/apify/_crypto.py" + }, + "409": { + "qualifiedName": "encode_base62", + "sourceFileName": "/src/apify/_crypto.py" + }, + "412": { + "qualifiedName": "create_hmac_signature", + "sourceFileName": "/src/apify/_crypto.py" + }, + "416": { "qualifiedName": "PricingModel", "sourceFileName": "/src/apify/_models.py" }, - "96": { + "417": { "qualifiedName": "GeneralAccess", "sourceFileName": "/src/apify/_models.py" }, - "97": { + "418": { "qualifiedName": "WebhookCondition", "sourceFileName": "/src/apify/_models.py" }, - "98": { + "419": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "99": { + "420": { "qualifiedName": "actor_id", "sourceFileName": "/src/apify/_models.py" }, - "100": { + "421": { "qualifiedName": "actor_task_id", "sourceFileName": "/src/apify/_models.py" }, - "101": { + "422": { "qualifiedName": "actor_run_id", "sourceFileName": "/src/apify/_models.py" }, - "102": { + "423": { "qualifiedName": "WebhookDispatchStatus", "sourceFileName": "/src/apify/_models.py" }, - "103": { + "424": { "qualifiedName": "ExampleWebhookDispatch", "sourceFileName": "/src/apify/_models.py" }, - "104": { + "425": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "105": { + "426": { "qualifiedName": "status", "sourceFileName": "/src/apify/_models.py" }, - "106": { + "427": { "qualifiedName": "finished_at", "sourceFileName": "/src/apify/_models.py" }, - "107": { + "428": { "qualifiedName": "WebhookStats", "sourceFileName": "/src/apify/_models.py" }, - "108": { + "429": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "109": { + "430": { "qualifiedName": "total_dispatches", "sourceFileName": "/src/apify/_models.py" }, - "110": { + "431": { "qualifiedName": "Webhook", "sourceFileName": "/src/apify/_models.py" }, - "111": { + "432": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "112": { + "433": { "qualifiedName": "event_types", "sourceFileName": "/src/apify/_models.py" }, - "113": { + "434": { "qualifiedName": "request_url", "sourceFileName": "/src/apify/_models.py" }, - "114": { + "435": { "qualifiedName": "id", "sourceFileName": "/src/apify/_models.py" }, - "115": { + "436": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "116": { + "437": { "qualifiedName": "modified_at", "sourceFileName": "/src/apify/_models.py" }, - "117": { + "438": { "qualifiedName": "user_id", "sourceFileName": "/src/apify/_models.py" }, - "118": { + "439": { "qualifiedName": "is_ad_hoc", "sourceFileName": "/src/apify/_models.py" }, - "119": { + "440": { "qualifiedName": "should_interpolate_strings", "sourceFileName": "/src/apify/_models.py" }, - "120": { + "441": { "qualifiedName": "condition", "sourceFileName": "/src/apify/_models.py" }, - "121": { + "442": { "qualifiedName": "ignore_ssl_errors", "sourceFileName": "/src/apify/_models.py" }, - "122": { + "443": { "qualifiedName": "do_not_retry", "sourceFileName": "/src/apify/_models.py" }, - "123": { + "444": { "qualifiedName": "payload_template", "sourceFileName": "/src/apify/_models.py" }, - "124": { + "445": { "qualifiedName": "headers_template", "sourceFileName": "/src/apify/_models.py" }, - "125": { + "446": { "qualifiedName": "description", "sourceFileName": "/src/apify/_models.py" }, - "126": { + "447": { "qualifiedName": "last_dispatch", "sourceFileName": "/src/apify/_models.py" }, - "127": { + "448": { "qualifiedName": "stats", "sourceFileName": "/src/apify/_models.py" }, - "128": { + "449": { "qualifiedName": "ActorRunMeta", "sourceFileName": "/src/apify/_models.py" }, - "129": { + "450": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "130": { + "451": { "qualifiedName": "origin", "sourceFileName": "/src/apify/_models.py" }, - "131": { + "452": { "qualifiedName": "client_ip", "sourceFileName": "/src/apify/_models.py" }, - "132": { + "453": { "qualifiedName": "user_agent", "sourceFileName": "/src/apify/_models.py" }, - "133": { + "454": { "qualifiedName": "schedule_id", "sourceFileName": "/src/apify/_models.py" }, - "134": { + "455": { "qualifiedName": "scheduled_at", "sourceFileName": "/src/apify/_models.py" }, - "135": { + "456": { "qualifiedName": "ActorRunStats", "sourceFileName": "/src/apify/_models.py" }, - "136": { + "457": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "137": { + "458": { "qualifiedName": "input_body_len", "sourceFileName": "/src/apify/_models.py" }, - "138": { + "459": { "qualifiedName": "migration_count", "sourceFileName": "/src/apify/_models.py" }, - "139": { + "460": { "qualifiedName": "reboot_count", "sourceFileName": "/src/apify/_models.py" }, - "140": { + "461": { "qualifiedName": "restart_count", "sourceFileName": "/src/apify/_models.py" }, - "141": { + "462": { "qualifiedName": "resurrect_count", "sourceFileName": "/src/apify/_models.py" }, - "142": { + "463": { "qualifiedName": "mem_avg_bytes", "sourceFileName": "/src/apify/_models.py" }, - "143": { + "464": { "qualifiedName": "mem_max_bytes", "sourceFileName": "/src/apify/_models.py" }, - "144": { + "465": { "qualifiedName": "mem_current_bytes", "sourceFileName": "/src/apify/_models.py" }, - "145": { + "466": { "qualifiedName": "cpu_avg_usage", "sourceFileName": "/src/apify/_models.py" }, - "146": { + "467": { "qualifiedName": "cpu_max_usage", "sourceFileName": "/src/apify/_models.py" }, - "147": { + "468": { "qualifiedName": "cpu_current_usage", "sourceFileName": "/src/apify/_models.py" }, - "148": { + "469": { "qualifiedName": "net_rx_bytes", "sourceFileName": "/src/apify/_models.py" }, - "149": { + "470": { "qualifiedName": "net_tx_bytes", "sourceFileName": "/src/apify/_models.py" }, - "150": { + "471": { "qualifiedName": "duration_millis", "sourceFileName": "/src/apify/_models.py" }, - "151": { + "472": { "qualifiedName": "run_time_secs", "sourceFileName": "/src/apify/_models.py" }, - "152": { + "473": { "qualifiedName": "metamorph", "sourceFileName": "/src/apify/_models.py" }, - "153": { + "474": { "qualifiedName": "compute_units", "sourceFileName": "/src/apify/_models.py" }, - "154": { + "475": { "qualifiedName": "ActorRunOptions", "sourceFileName": "/src/apify/_models.py" }, - "155": { + "476": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "156": { + "477": { "qualifiedName": "build", "sourceFileName": "/src/apify/_models.py" }, - "157": { + "478": { "qualifiedName": "timeout_secs", "sourceFileName": "/src/apify/_models.py" }, - "158": { + "479": { "qualifiedName": "memory_mbytes", "sourceFileName": "/src/apify/_models.py" }, - "159": { + "480": { "qualifiedName": "disk_mbytes", "sourceFileName": "/src/apify/_models.py" }, - "160": { + "481": { "qualifiedName": "max_items", "sourceFileName": "/src/apify/_models.py" }, - "161": { + "482": { "qualifiedName": "max_total_charge_usd", "sourceFileName": "/src/apify/_models.py" }, - "162": { + "483": { "qualifiedName": "ActorRunUsage", "sourceFileName": "/src/apify/_models.py" }, - "163": { + "484": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "164": { + "485": { "qualifiedName": "actor_compute_units", "sourceFileName": "/src/apify/_models.py" }, - "165": { + "486": { "qualifiedName": "dataset_reads", "sourceFileName": "/src/apify/_models.py" }, - "166": { + "487": { "qualifiedName": "dataset_writes", "sourceFileName": "/src/apify/_models.py" }, - "167": { + "488": { "qualifiedName": "key_value_store_reads", "sourceFileName": "/src/apify/_models.py" }, - "168": { + "489": { "qualifiedName": "key_value_store_writes", "sourceFileName": "/src/apify/_models.py" }, - "169": { + "490": { "qualifiedName": "key_value_store_lists", "sourceFileName": "/src/apify/_models.py" }, - "170": { + "491": { "qualifiedName": "request_queue_reads", "sourceFileName": "/src/apify/_models.py" }, - "171": { + "492": { "qualifiedName": "request_queue_writes", "sourceFileName": "/src/apify/_models.py" }, - "172": { + "493": { "qualifiedName": "data_transfer_internal_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "173": { + "494": { "qualifiedName": "data_transfer_external_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "174": { + "495": { "qualifiedName": "proxy_residential_transfer_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "175": { + "496": { "qualifiedName": "proxy_serps", "sourceFileName": "/src/apify/_models.py" }, - "176": { + "497": { "qualifiedName": "ActorRunUsageUsd", "sourceFileName": "/src/apify/_models.py" }, - "177": { + "498": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "178": { + "499": { "qualifiedName": "actor_compute_units", "sourceFileName": "/src/apify/_models.py" }, - "179": { + "500": { "qualifiedName": "dataset_reads", "sourceFileName": "/src/apify/_models.py" }, - "180": { + "501": { "qualifiedName": "dataset_writes", "sourceFileName": "/src/apify/_models.py" }, - "181": { + "502": { "qualifiedName": "key_value_store_reads", "sourceFileName": "/src/apify/_models.py" }, - "182": { + "503": { "qualifiedName": "key_value_store_writes", "sourceFileName": "/src/apify/_models.py" }, - "183": { + "504": { "qualifiedName": "key_value_store_lists", "sourceFileName": "/src/apify/_models.py" }, - "184": { + "505": { "qualifiedName": "request_queue_reads", "sourceFileName": "/src/apify/_models.py" }, - "185": { + "506": { "qualifiedName": "request_queue_writes", "sourceFileName": "/src/apify/_models.py" }, - "186": { + "507": { "qualifiedName": "data_transfer_internal_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "187": { + "508": { "qualifiedName": "data_transfer_external_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "188": { + "509": { "qualifiedName": "proxy_residential_transfer_gbytes", "sourceFileName": "/src/apify/_models.py" }, - "189": { + "510": { "qualifiedName": "proxy_serps", "sourceFileName": "/src/apify/_models.py" }, - "190": { + "511": { "qualifiedName": "Metamorph", "sourceFileName": "/src/apify/_models.py" }, - "191": { + "512": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "192": { + "513": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "193": { + "514": { "qualifiedName": "actor_id", "sourceFileName": "/src/apify/_models.py" }, - "194": { + "515": { "qualifiedName": "build_id", "sourceFileName": "/src/apify/_models.py" }, - "195": { + "516": { "qualifiedName": "input_key", "sourceFileName": "/src/apify/_models.py" }, - "196": { + "517": { "qualifiedName": "CommonActorPricingInfo", "sourceFileName": "/src/apify/_models.py" }, - "197": { + "518": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "198": { + "519": { "qualifiedName": "apify_margin_percentage", "sourceFileName": "/src/apify/_models.py" }, - "199": { + "520": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "200": { + "521": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "201": { + "522": { "qualifiedName": "notified_about_future_change_at", "sourceFileName": "/src/apify/_models.py" }, - "202": { + "523": { "qualifiedName": "notified_about_change_at", "sourceFileName": "/src/apify/_models.py" }, - "203": { + "524": { "qualifiedName": "reason_for_change", "sourceFileName": "/src/apify/_models.py" }, - "204": { + "525": { "qualifiedName": "FreeActorPricingInfo", "sourceFileName": "/src/apify/_models.py" }, - "205": { + "526": { "qualifiedName": "pricing_model", "sourceFileName": "/src/apify/_models.py" }, - "206": { + "527": { "qualifiedName": "FlatPricePerMonthActorPricingInfo", "sourceFileName": "/src/apify/_models.py" }, - "207": { + "528": { "qualifiedName": "pricing_model", "sourceFileName": "/src/apify/_models.py" }, - "208": { + "529": { "qualifiedName": "trial_minutes", "sourceFileName": "/src/apify/_models.py" }, - "209": { + "530": { "qualifiedName": "price_per_unit_usd", "sourceFileName": "/src/apify/_models.py" }, - "210": { + "531": { "qualifiedName": "PricePerDatasetItemActorPricingInfo", "sourceFileName": "/src/apify/_models.py" }, - "211": { + "532": { "qualifiedName": "pricing_model", "sourceFileName": "/src/apify/_models.py" }, - "212": { + "533": { "qualifiedName": "unit_name", "sourceFileName": "/src/apify/_models.py" }, - "213": { + "534": { "qualifiedName": "price_per_unit_usd", "sourceFileName": "/src/apify/_models.py" }, - "214": { + "535": { "qualifiedName": "ActorChargeEvent", "sourceFileName": "/src/apify/_models.py" }, - "215": { + "536": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "216": { + "537": { "qualifiedName": "event_price_usd", "sourceFileName": "/src/apify/_models.py" }, - "217": { + "538": { "qualifiedName": "event_title", "sourceFileName": "/src/apify/_models.py" }, - "218": { + "539": { "qualifiedName": "event_description", "sourceFileName": "/src/apify/_models.py" }, - "219": { + "540": { "qualifiedName": "PricingPerEvent", "sourceFileName": "/src/apify/_models.py" }, - "220": { + "541": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "221": { + "542": { "qualifiedName": "actor_charge_events", "sourceFileName": "/src/apify/_models.py" }, - "222": { + "543": { "qualifiedName": "PayPerEventActorPricingInfo", "sourceFileName": "/src/apify/_models.py" }, - "223": { + "544": { "qualifiedName": "pricing_model", "sourceFileName": "/src/apify/_models.py" }, - "224": { + "545": { "qualifiedName": "pricing_per_event", "sourceFileName": "/src/apify/_models.py" }, - "225": { + "546": { "qualifiedName": "minimal_max_total_charge_usd", "sourceFileName": "/src/apify/_models.py" }, - "226": { + "547": { "qualifiedName": "ActorRun", "sourceFileName": "/src/apify/_models.py" }, - "227": { + "548": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "228": { + "549": { "qualifiedName": "id", "sourceFileName": "/src/apify/_models.py" }, - "229": { + "550": { "qualifiedName": "act_id", "sourceFileName": "/src/apify/_models.py" }, - "230": { + "551": { "qualifiedName": "user_id", "sourceFileName": "/src/apify/_models.py" }, - "231": { + "552": { "qualifiedName": "actor_task_id", "sourceFileName": "/src/apify/_models.py" }, - "232": { + "553": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "233": { + "554": { "qualifiedName": "finished_at", "sourceFileName": "/src/apify/_models.py" }, - "234": { + "555": { "qualifiedName": "status", "sourceFileName": "/src/apify/_models.py" }, - "235": { + "556": { "qualifiedName": "status_message", "sourceFileName": "/src/apify/_models.py" }, - "236": { + "557": { "qualifiedName": "is_status_message_terminal", "sourceFileName": "/src/apify/_models.py" }, - "237": { + "558": { "qualifiedName": "meta", "sourceFileName": "/src/apify/_models.py" }, - "238": { + "559": { "qualifiedName": "stats", "sourceFileName": "/src/apify/_models.py" }, - "239": { + "560": { "qualifiedName": "options", "sourceFileName": "/src/apify/_models.py" }, - "240": { + "561": { "qualifiedName": "build_id", "sourceFileName": "/src/apify/_models.py" }, - "241": { + "562": { "qualifiedName": "exit_code", "sourceFileName": "/src/apify/_models.py" }, - "242": { + "563": { "qualifiedName": "general_access", "sourceFileName": "/src/apify/_models.py" }, - "243": { + "564": { "qualifiedName": "default_key_value_store_id", "sourceFileName": "/src/apify/_models.py" }, - "244": { + "565": { "qualifiedName": "default_dataset_id", "sourceFileName": "/src/apify/_models.py" }, - "245": { + "566": { "qualifiedName": "default_request_queue_id", "sourceFileName": "/src/apify/_models.py" }, - "246": { + "567": { "qualifiedName": "build_number", "sourceFileName": "/src/apify/_models.py" }, - "247": { + "568": { "qualifiedName": "container_url", "sourceFileName": "/src/apify/_models.py" }, - "248": { + "569": { "qualifiedName": "is_container_server_ready", "sourceFileName": "/src/apify/_models.py" }, - "249": { + "570": { "qualifiedName": "git_branch_name", "sourceFileName": "/src/apify/_models.py" }, - "250": { + "571": { "qualifiedName": "usage", "sourceFileName": "/src/apify/_models.py" }, - "251": { + "572": { "qualifiedName": "usage_total_usd", "sourceFileName": "/src/apify/_models.py" }, - "252": { + "573": { "qualifiedName": "usage_usd", "sourceFileName": "/src/apify/_models.py" }, - "253": { + "574": { "qualifiedName": "pricing_info", "sourceFileName": "/src/apify/_models.py" }, - "254": { + "575": { "qualifiedName": "charged_event_counts", "sourceFileName": "/src/apify/_models.py" }, - "255": { + "576": { "qualifiedName": "metamorphs", "sourceFileName": "/src/apify/_models.py" }, - "256": { - "qualifiedName": "ENCRYPTION_KEY_LENGTH", - "sourceFileName": "/src/apify/_crypto.py" - }, - "257": { - "qualifiedName": "ENCRYPTION_IV_LENGTH", - "sourceFileName": "/src/apify/_crypto.py" - }, - "258": { - "qualifiedName": "ENCRYPTION_AUTH_TAG_LENGTH", - "sourceFileName": "/src/apify/_crypto.py" - }, - "259": { - "qualifiedName": "public_encrypt", - "sourceFileName": "/src/apify/_crypto.py" - }, - "263": { - "qualifiedName": "private_decrypt", - "sourceFileName": "/src/apify/_crypto.py" - }, - "268": { - "qualifiedName": "load_private_key", - "sourceFileName": "/src/apify/_crypto.py" - }, - "272": { - "qualifiedName": "decrypt_input_secrets", - "sourceFileName": "/src/apify/_crypto.py" - }, - "276": { - "qualifiedName": "CHARSET", - "sourceFileName": "/src/apify/_crypto.py" - }, - "277": { - "qualifiedName": "encode_base62", - "sourceFileName": "/src/apify/_crypto.py" - }, - "280": { - "qualifiedName": "create_hmac_signature", - "sourceFileName": "/src/apify/_crypto.py" - }, - "284": { - "qualifiedName": "logger_name", - "sourceFileName": "/src/apify/log.py" - }, - "285": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/log.py" - }, - "286": { - "qualifiedName": "ActorLogFormatter", - "sourceFileName": "/src/apify/log.py" - }, - "287": { + "577": { "qualifiedName": "APIFY_PROXY_VALUE_REGEX", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "288": { + "578": { "qualifiedName": "COUNTRY_CODE_REGEX", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "289": { + "579": { + "qualifiedName": "SUBDIVISION_CODE_REGEX", + "sourceFileName": "/src/apify/_proxy_configuration.py" + }, + "580": { "qualifiedName": "SESSION_ID_MAX_LENGTH", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "290": { + "581": { "qualifiedName": "is_url", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "293": { + "584": { "qualifiedName": "ProxyInfo", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "294": { + "585": { "qualifiedName": "groups", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "295": { + "586": { "qualifiedName": "country_code", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "296": { + "587": { + "qualifiedName": "subdivision_code", + "sourceFileName": "/src/apify/_proxy_configuration.py" + }, + "588": { "qualifiedName": "ProxyConfiguration", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "297": { + "589": { "qualifiedName": "__init__", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "307": { + "600": { "qualifiedName": "initialize", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "309": { + "602": { "qualifiedName": "new_proxy_info", "sourceFileName": "/src/apify/_proxy_configuration.py" }, - "314": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/_configuration.py" - }, - "315": { - "qualifiedName": "ActorStorages", - "sourceFileName": "/src/apify/_configuration.py" - }, - "316": { - "qualifiedName": "key_value_stores", - "sourceFileName": "/src/apify/_configuration.py" - }, - "317": { - "qualifiedName": "datasets", - "sourceFileName": "/src/apify/_configuration.py" - }, - "318": { - "qualifiedName": "request_queues", - "sourceFileName": "/src/apify/_configuration.py" - }, - "319": { - "qualifiedName": "Configuration", - "sourceFileName": "/src/apify/_configuration.py" - }, - "320": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "321": { - "qualifiedName": "actor_full_name", - "sourceFileName": "/src/apify/_configuration.py" - }, - "322": { - "qualifiedName": "actor_permission_level", - "sourceFileName": "/src/apify/_configuration.py" - }, - "323": { - "qualifiedName": "actor_run_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "324": { - "qualifiedName": "actor_build_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "325": { - "qualifiedName": "actor_build_number", - "sourceFileName": "/src/apify/_configuration.py" - }, - "326": { - "qualifiedName": "actor_build_tags", - "sourceFileName": "/src/apify/_configuration.py" - }, - "327": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "328": { - "qualifiedName": "actor_events_ws_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "329": { - "qualifiedName": "api_base_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "330": { - "qualifiedName": "api_public_base_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "331": { - "qualifiedName": "dedicated_cpus", - "sourceFileName": "/src/apify/_configuration.py" - }, - "332": { - "qualifiedName": "default_dataset_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "333": { - "qualifiedName": "default_key_value_store_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "334": { - "qualifiedName": "default_request_queue_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "335": { - "qualifiedName": "disable_outdated_warning", - "sourceFileName": "/src/apify/_configuration.py" - }, - "336": { - "qualifiedName": "fact", - "sourceFileName": "/src/apify/_configuration.py" - }, - "337": { - "qualifiedName": "input_key", - "sourceFileName": "/src/apify/_configuration.py" - }, - "338": { - "qualifiedName": "input_secrets_private_key_file", - "sourceFileName": "/src/apify/_configuration.py" - }, - "339": { - "qualifiedName": "input_secrets_private_key_passphrase", - "sourceFileName": "/src/apify/_configuration.py" - }, - "340": { - "qualifiedName": "is_at_home", - "sourceFileName": "/src/apify/_configuration.py" - }, - "341": { - "qualifiedName": "latest_sdk_version", - "sourceFileName": "/src/apify/_configuration.py" - }, - "342": { - "qualifiedName": "log_format", - "sourceFileName": "/src/apify/_configuration.py" - }, - "343": { - "qualifiedName": "max_paid_dataset_items", - "sourceFileName": "/src/apify/_configuration.py" - }, - "344": { - "qualifiedName": "max_total_charge_usd", - "sourceFileName": "/src/apify/_configuration.py" - }, - "345": { - "qualifiedName": "test_pay_per_event", - "sourceFileName": "/src/apify/_configuration.py" - }, - "346": { - "qualifiedName": "meta_origin", - "sourceFileName": "/src/apify/_configuration.py" - }, - "347": { - "qualifiedName": "metamorph_after_sleep", - "sourceFileName": "/src/apify/_configuration.py" - }, - "348": { - "qualifiedName": "proxy_hostname", - "sourceFileName": "/src/apify/_configuration.py" - }, - "349": { - "qualifiedName": "proxy_password", - "sourceFileName": "/src/apify/_configuration.py" - }, - "350": { - "qualifiedName": "proxy_port", - "sourceFileName": "/src/apify/_configuration.py" - }, - "351": { - "qualifiedName": "proxy_status_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "352": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify/_configuration.py" - }, - "353": { - "qualifiedName": "timeout_at", - "sourceFileName": "/src/apify/_configuration.py" - }, - "354": { - "qualifiedName": "standby_port", - "sourceFileName": "/src/apify/_configuration.py" - }, - "355": { - "qualifiedName": "standby_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "356": { - "qualifiedName": "token", - "sourceFileName": "/src/apify/_configuration.py" - }, - "357": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify/_configuration.py" - }, - "358": { - "qualifiedName": "user_is_paying", - "sourceFileName": "/src/apify/_configuration.py" - }, - "359": { - "qualifiedName": "web_server_port", - "sourceFileName": "/src/apify/_configuration.py" - }, - "360": { - "qualifiedName": "web_server_url", - "sourceFileName": "/src/apify/_configuration.py" - }, - "361": { - "qualifiedName": "workflow_key", - "sourceFileName": "/src/apify/_configuration.py" - }, - "362": { - "qualifiedName": "actor_pricing_info", - "sourceFileName": "/src/apify/_configuration.py" - }, - "363": { - "qualifiedName": "charged_event_counts", - "sourceFileName": "/src/apify/_configuration.py" - }, - "364": { - "qualifiedName": "actor_storages", - "sourceFileName": "/src/apify/_configuration.py" - }, - "365": { - "qualifiedName": "disable_browser_sandbox_on_platform", - "sourceFileName": "/src/apify/_configuration.py" - }, - "367": { - "qualifiedName": "canonical_input_key", - "sourceFileName": "/src/apify/_configuration.py" - }, - "368": { - "qualifiedName": "input_key_candidates", - "sourceFileName": "/src/apify/_configuration.py" - }, - "369": { - "qualifiedName": "get_global_configuration", - "sourceFileName": "/src/apify/_configuration.py" - }, - "371": { - "qualifiedName": "from_configuration", - "sourceFileName": "/src/apify/_configuration.py" - }, - "374": { + "607": { "qualifiedName": "T", "sourceFileName": "/src/apify/_utils.py" }, - "375": { + "608": { "qualifiedName": "ensure_context", "sourceFileName": "/src/apify/_utils.py" }, - "378": { + "611": { "qualifiedName": "get_system_info", "sourceFileName": "/src/apify/_utils.py" }, - "380": { + "613": { "qualifiedName": "is_running_in_ipython", "sourceFileName": "/src/apify/_utils.py" }, - "382": { + "615": { "qualifiedName": "GroupName", "sourceFileName": "/src/apify/_utils.py" }, - "383": { + "616": { "qualifiedName": "docs_group", "sourceFileName": "/src/apify/_utils.py" }, - "386": { + "619": { "qualifiedName": "docs_name", "sourceFileName": "/src/apify/_utils.py" }, - "389": { + "622": { "qualifiedName": "maybe_extract_enum_member_value", "sourceFileName": "/src/apify/_utils.py" }, - "392": { + "625": { "qualifiedName": "ReentrantLock", "sourceFileName": "/src/apify/_utils.py" }, - "393": { + "626": { "qualifiedName": "__init__", "sourceFileName": "/src/apify/_utils.py" }, - "395": { + "628": { "qualifiedName": "__call__", "sourceFileName": "/src/apify/_utils.py" }, - "397": { - "qualifiedName": "MainReturnType", - "sourceFileName": "/src/apify/_actor.py" + "630": { + "qualifiedName": "event_data_adapter", + "sourceFileName": "/src/apify/events/_apify_event_manager.py" }, - "398": { - "qualifiedName": "Actor", - "sourceFileName": "/src/apify/_actor.py" + "631": { + "qualifiedName": "ApifyEventManager", + "sourceFileName": "/src/apify/events/_apify_event_manager.py" }, - "399": { + "632": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/_actor.py" + "sourceFileName": "/src/apify/events/_apify_event_manager.py" }, - "408": { + "636": { "qualifiedName": "__aenter__", - "sourceFileName": "/src/apify/_actor.py" + "sourceFileName": "/src/apify/events/_apify_event_manager.py" }, - "410": { + "638": { "qualifiedName": "__aexit__", - "sourceFileName": "/src/apify/_actor.py" - }, - "415": { - "qualifiedName": "__repr__", - "sourceFileName": "/src/apify/_actor.py" - }, - "417": { - "qualifiedName": "__call__", - "sourceFileName": "/src/apify/_actor.py" - }, - "426": { - "qualifiedName": "log", - "sourceFileName": "/src/apify/_actor.py" - }, - "427": { - "qualifiedName": "exit_code", - "sourceFileName": "/src/apify/_actor.py" - }, - "428": { - "qualifiedName": "exit_code", - "sourceFileName": "/src/apify/_actor.py" - }, - "431": { - "qualifiedName": "status_message", - "sourceFileName": "/src/apify/_actor.py" - }, - "432": { - "qualifiedName": "status_message", - "sourceFileName": "/src/apify/_actor.py" - }, - "435": { - "qualifiedName": "apify_client", - "sourceFileName": "/src/apify/_actor.py" - }, - "436": { - "qualifiedName": "configuration", - "sourceFileName": "/src/apify/_actor.py" - }, - "438": { - "qualifiedName": "event_manager", - "sourceFileName": "/src/apify/_actor.py" - }, - "440": { - "qualifiedName": "init", - "sourceFileName": "/src/apify/_actor.py" - }, - "442": { - "qualifiedName": "exit", - "sourceFileName": "/src/apify/_actor.py" - }, - "448": { - "qualifiedName": "fail", - "sourceFileName": "/src/apify/_actor.py" - }, - "453": { - "qualifiedName": "new_client", - "sourceFileName": "/src/apify/_actor.py" - }, - "460": { - "qualifiedName": "open_dataset", - "sourceFileName": "/src/apify/_actor.py" - }, - "466": { - "qualifiedName": "open_key_value_store", - "sourceFileName": "/src/apify/_actor.py" - }, - "472": { - "qualifiedName": "open_request_queue", - "sourceFileName": "/src/apify/_actor.py" - }, - "478": { - "qualifiedName": "push_data", - "sourceFileName": "/src/apify/_actor.py" - }, - "482": { - "qualifiedName": "get_input", - "sourceFileName": "/src/apify/_actor.py" - }, - "484": { - "qualifiedName": "get_value", - "sourceFileName": "/src/apify/_actor.py" - }, - "488": { - "qualifiedName": "set_value", - "sourceFileName": "/src/apify/_actor.py" - }, - "493": { - "qualifiedName": "get_charging_manager", - "sourceFileName": "/src/apify/_actor.py" - }, - "495": { - "qualifiedName": "charge", - "sourceFileName": "/src/apify/_actor.py" - }, - "499": { - "qualifiedName": "on", - "sourceFileName": "/src/apify/_actor.py" - }, - "503": { - "qualifiedName": "off", - "sourceFileName": "/src/apify/_actor.py" - }, - "507": { - "qualifiedName": "is_at_home", - "sourceFileName": "/src/apify/_actor.py" - }, - "509": { - "qualifiedName": "get_env", - "sourceFileName": "/src/apify/_actor.py" + "sourceFileName": "/src/apify/events/_apify_event_manager.py" }, - "511": { - "qualifiedName": "start", - "sourceFileName": "/src/apify/_actor.py" + "643": { + "qualifiedName": "SystemInfoEventData", + "sourceFileName": "/src/apify/events/_types.py" }, - "522": { - "qualifiedName": "abort", - "sourceFileName": "/src/apify/_actor.py" + "644": { + "qualifiedName": "mem_avg_bytes", + "sourceFileName": "/src/apify/events/_types.py" }, - "528": { - "qualifiedName": "call", - "sourceFileName": "/src/apify/_actor.py" + "645": { + "qualifiedName": "mem_current_bytes", + "sourceFileName": "/src/apify/events/_types.py" }, - "540": { - "qualifiedName": "call_task", - "sourceFileName": "/src/apify/_actor.py" + "646": { + "qualifiedName": "mem_max_bytes", + "sourceFileName": "/src/apify/events/_types.py" }, - "550": { - "qualifiedName": "metamorph", - "sourceFileName": "/src/apify/_actor.py" + "647": { + "qualifiedName": "cpu_avg_usage", + "sourceFileName": "/src/apify/events/_types.py" }, - "557": { - "qualifiedName": "reboot", - "sourceFileName": "/src/apify/_actor.py" + "648": { + "qualifiedName": "cpu_max_usage", + "sourceFileName": "/src/apify/events/_types.py" }, - "561": { - "qualifiedName": "add_webhook", - "sourceFileName": "/src/apify/_actor.py" + "649": { + "qualifiedName": "cpu_current_usage", + "sourceFileName": "/src/apify/events/_types.py" }, - "567": { - "qualifiedName": "set_status_message", - "sourceFileName": "/src/apify/_actor.py" + "650": { + "qualifiedName": "is_cpu_overloaded", + "sourceFileName": "/src/apify/events/_types.py" }, - "571": { - "qualifiedName": "create_proxy_configuration", - "sourceFileName": "/src/apify/_actor.py" + "651": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify/events/_types.py" }, - "579": { - "qualifiedName": "use_state", - "sourceFileName": "/src/apify/_actor.py" + "652": { + "qualifiedName": "to_crawlee_format", + "sourceFileName": "/src/apify/events/_types.py" }, - "620": { - "qualifiedName": "Actor", - "sourceFileName": "/src/apify/_actor.py" + "655": { + "qualifiedName": "PersistStateEvent", + "sourceFileName": "/src/apify/events/_types.py" }, - "621": { - "qualifiedName": "__version__", - "sourceFileName": "/src/apify/__init__.py" + "656": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "622": { - "qualifiedName": "DatasetClientPpeMixin", - "sourceFileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py" + "657": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, - "623": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py" + "658": { + "qualifiedName": "SystemInfoEvent", + "sourceFileName": "/src/apify/events/_types.py" }, - "625": { - "qualifiedName": "ApifyFileSystemDatasetClient", - "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" + "659": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "626": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" + "660": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, - "630": { - "qualifiedName": "open", - "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" + "661": { + "qualifiedName": "MigratingEvent", + "sourceFileName": "/src/apify/events/_types.py" }, - "636": { - "qualifiedName": "push_data", - "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" + "662": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "639": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "663": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, - "640": { - "qualifiedName": "ApifyFileSystemKeyValueStoreClient", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "664": { + "qualifiedName": "AbortingEvent", + "sourceFileName": "/src/apify/events/_types.py" }, - "641": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "665": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "646": { - "qualifiedName": "open", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "666": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, - "652": { - "qualifiedName": "purge", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "667": { + "qualifiedName": "ExitEvent", + "sourceFileName": "/src/apify/events/_types.py" }, - "654": { - "qualifiedName": "get_value", - "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + "668": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "657": { - "qualifiedName": "ApifyFileSystemStorageClient", - "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" + "669": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, - "658": { - "qualifiedName": "get_storage_client_cache_key", - "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" + "670": { + "qualifiedName": "EventWithoutData", + "sourceFileName": "/src/apify/events/_types.py" }, - "661": { - "qualifiedName": "create_kvs_client", - "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" + "671": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, - "667": { - "qualifiedName": "create_dataset_client", - "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" + "672": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" }, "673": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "DeprecatedEvent", + "sourceFileName": "/src/apify/events/_types.py" }, "674": { - "qualifiedName": "ApifyRequestQueueClient", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" }, "675": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" + }, + "676": { + "qualifiedName": "UnknownEvent", + "sourceFileName": "/src/apify/events/_types.py" + }, + "677": { + "qualifiedName": "name", + "sourceFileName": "/src/apify/events/_types.py" + }, + "678": { + "qualifiedName": "data", + "sourceFileName": "/src/apify/events/_types.py" + }, + "679": { + "qualifiedName": "EventMessage", + "sourceFileName": "/src/apify/events/_types.py" }, "680": { - "qualifiedName": "get_metadata", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "logger_name", + "sourceFileName": "/src/apify/log.py" + }, + "681": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/log.py" }, "682": { - "qualifiedName": "open", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "ActorLogFormatter", + "sourceFileName": "/src/apify/log.py" + }, + "683": { + "qualifiedName": "URL_NO_COMMAS_REGEX", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "684": { + "qualifiedName": "_RequestDetails", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "685": { + "qualifiedName": "method", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "686": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "687": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "688": { + "qualifiedName": "user_data", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, "689": { - "qualifiedName": "purge", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "_RequestsFromUrlInput", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "690": { + "qualifiedName": "requests_from_url", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, "691": { - "qualifiedName": "drop", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "_SimpleUrlInput", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + }, + "692": { + "qualifiedName": "url", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, "693": { - "qualifiedName": "add_batch_of_requests", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "url_input_adapter", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "697": { - "qualifiedName": "fetch_next_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "694": { + "qualifiedName": "ApifyRequestList", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "699": { - "qualifiedName": "mark_request_as_handled", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "695": { + "qualifiedName": "open", + "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "702": { - "qualifiedName": "get_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "700": { + "qualifiedName": "run_scrapy_actor", + "sourceFileName": "/src/apify/scrapy/_actor_runner.py" + }, + "703": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/scrapy/_async_thread.py" + }, + "704": { + "qualifiedName": "AsyncThread", + "sourceFileName": "/src/apify/scrapy/_async_thread.py" }, "705": { - "qualifiedName": "reclaim_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/scrapy/_async_thread.py" }, - "709": { - "qualifiedName": "is_empty", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" + "707": { + "qualifiedName": "run_coro", + "sourceFileName": "/src/apify/scrapy/_async_thread.py" }, "711": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "qualifiedName": "close", + "sourceFileName": "/src/apify/scrapy/_async_thread.py" }, - "712": { - "qualifiedName": "open_by_alias", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "714": { + "qualifiedName": "initialize_logging", + "sourceFileName": "/src/apify/scrapy/_logging_config.py" }, - "719": { - "qualifiedName": "AliasResolver", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "716": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, - "720": { - "qualifiedName": "default_storage_key", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "717": { + "qualifiedName": "ApifyCacheStorage", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, - "721": { + "718": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, - "726": { - "qualifiedName": "__aenter__", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "721": { + "qualifiedName": "open_spider", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + }, + "724": { + "qualifiedName": "close_spider", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "728": { - "qualifiedName": "__aexit__", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "qualifiedName": "retrieve_response", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "733": { - "qualifiedName": "resolve_id", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" - }, - "735": { - "qualifiedName": "store_mapping", - "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + "qualifiedName": "store_response", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "738": { - "qualifiedName": "ApifyKeyValueStoreMetadata", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "739": { - "qualifiedName": "url_signing_secret_key", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "740": { - "qualifiedName": "ProlongRequestLockResponse", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "741": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "to_gzip", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "742": { - "qualifiedName": "lock_expires_at", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "743": { - "qualifiedName": "RequestQueueHead", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "744": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "from_gzip", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "745": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "746": { - "qualifiedName": "had_multiple_clients", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "747": { - "qualifiedName": "queue_modified_at", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "read_gzip_time", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "748": { - "qualifiedName": "lock_time", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "749": { - "qualifiedName": "queue_has_locked_requests", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "750": { - "qualifiedName": "items", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "751": { - "qualifiedName": "KeyValueStoreKeyInfo", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "get_kvs_name", + "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" }, "752": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "ApifyHttpProxyMiddleware", + "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" }, "753": { - "qualifiedName": "key", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "754": { - "qualifiedName": "size", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "755": { - "qualifiedName": "KeyValueStoreListKeysPage", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" }, "756": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "757": { - "qualifiedName": "count", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "758": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "from_crawler", + "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" }, "759": { - "qualifiedName": "is_truncated", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "760": { - "qualifiedName": "items", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "761": { - "qualifiedName": "exclusive_start_key", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "762": { - "qualifiedName": "next_exclusive_start_key", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "process_request", + "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" }, "763": { - "qualifiedName": "CachedRequest", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "764": { - "qualifiedName": "id", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "765": { - "qualifiedName": "was_already_handled", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "766": { - "qualifiedName": "hydrated", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "767": { - "qualifiedName": "lock_expires_at", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "process_exception", + "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" }, "768": { - "qualifiedName": "RequestQueueStats", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "logger", + "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" }, "769": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "ActorDatasetPushPipeline", + "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" }, "770": { - "qualifiedName": "delete_count", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "771": { - "qualifiedName": "head_item_read_count", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "772": { - "qualifiedName": "read_count", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "process_item", + "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" }, "773": { - "qualifiedName": "storage_bytes", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "logger", + "sourceFileName": "/src/apify/scrapy/requests.py" }, "774": { - "qualifiedName": "write_count", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" - }, - "775": { - "qualifiedName": "ApifyRequestQueueMetadata", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "qualifiedName": "to_apify_request", + "sourceFileName": "/src/apify/scrapy/requests.py" }, - "776": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + "778": { + "qualifiedName": "to_scrapy_request", + "sourceFileName": "/src/apify/scrapy/requests.py" }, - "777": { + "782": { "qualifiedName": "logger", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, - "778": { - "qualifiedName": "ApifyRequestQueueSharedClient", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "783": { + "qualifiedName": "ApifyScheduler", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, - "779": { + "784": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, - "785": { - "qualifiedName": "add_batch_of_requests", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "786": { + "qualifiedName": "open", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, "789": { - "qualifiedName": "get_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "qualifiedName": "close", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, "792": { - "qualifiedName": "fetch_next_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "qualifiedName": "has_pending_requests", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, "794": { - "qualifiedName": "mark_request_as_handled", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "qualifiedName": "enqueue_request", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, "797": { - "qualifiedName": "reclaim_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "qualifiedName": "next_request", + "sourceFileName": "/src/apify/scrapy/scheduler.py" }, - "801": { - "qualifiedName": "is_empty", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" + "799": { + "qualifiedName": "get_basic_auth_header", + "sourceFileName": "/src/apify/scrapy/utils.py" + }, + "804": { + "qualifiedName": "apply_apify_settings", + "sourceFileName": "/src/apify/scrapy/utils.py" + }, + "808": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "809": { + "qualifiedName": "open_by_alias", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "816": { + "qualifiedName": "AliasResolver", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "817": { + "qualifiedName": "default_storage_key", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "818": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "823": { + "qualifiedName": "__aenter__", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "825": { + "qualifiedName": "__aexit__", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "830": { + "qualifiedName": "resolve_id", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" + }, + "832": { + "qualifiedName": "store_mapping", + "sourceFileName": "/src/apify/storage_clients/_apify/_alias_resolving.py" }, - "803": { + "835": { + "qualifiedName": "create_storage_api_client", + "sourceFileName": "/src/apify/storage_clients/_apify/_api_client_creation.py" + }, + "842": { "qualifiedName": "logger", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "804": { + "843": { "qualifiedName": "ApifyDatasetClient", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "805": { + "844": { "qualifiedName": "__init__", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "810": { + "849": { "qualifiedName": "get_metadata", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "812": { + "851": { "qualifiedName": "open", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "818": { + "857": { "qualifiedName": "purge", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "820": { + "859": { "qualifiedName": "drop", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "822": { + "861": { "qualifiedName": "push_data", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "825": { + "864": { "qualifiedName": "get_data", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "838": { + "877": { "qualifiedName": "iterate_items", "sourceFileName": "/src/apify/storage_clients/_apify/_dataset_client.py" }, - "849": { - "qualifiedName": "create_storage_api_client", - "sourceFileName": "/src/apify/storage_clients/_apify/_api_client_creation.py" - }, - "856": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "857": { - "qualifiedName": "ApifyRequestQueueSingleClient", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "858": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "863": { - "qualifiedName": "add_batch_of_requests", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "867": { - "qualifiedName": "get_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "870": { - "qualifiedName": "fetch_next_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "872": { - "qualifiedName": "mark_request_as_handled", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "875": { - "qualifiedName": "reclaim_request", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "879": { - "qualifiedName": "is_empty", - "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" - }, - "881": { - "qualifiedName": "unique_key_to_request_id", - "sourceFileName": "/src/apify/storage_clients/_apify/_utils.py" - }, - "885": { - "qualifiedName": "hash_api_base_url_and_token", - "sourceFileName": "/src/apify/storage_clients/_apify/_utils.py" - }, "888": { "qualifiedName": "logger", "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" @@ -75340,591 +76003,575 @@ "qualifiedName": "set_value", "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" }, - "915": { - "qualifiedName": "delete_value", - "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + "915": { + "qualifiedName": "delete_value", + "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + }, + "918": { + "qualifiedName": "iterate_keys", + "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + }, + "922": { + "qualifiedName": "record_exists", + "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + }, + "925": { + "qualifiedName": "get_public_url", + "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + }, + "928": { + "qualifiedName": "ApifyKeyValueStoreMetadata", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "929": { + "qualifiedName": "url_signing_secret_key", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "930": { + "qualifiedName": "ProlongRequestLockResponse", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "931": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "932": { + "qualifiedName": "lock_expires_at", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "933": { + "qualifiedName": "RequestQueueHead", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "934": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "935": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "936": { + "qualifiedName": "had_multiple_clients", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "937": { + "qualifiedName": "queue_modified_at", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "938": { + "qualifiedName": "lock_time", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "939": { + "qualifiedName": "queue_has_locked_requests", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "940": { + "qualifiedName": "items", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "941": { + "qualifiedName": "KeyValueStoreKeyInfo", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "918": { - "qualifiedName": "iterate_keys", - "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + "942": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "922": { - "qualifiedName": "record_exists", - "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + "943": { + "qualifiedName": "key", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "925": { - "qualifiedName": "get_public_url", - "sourceFileName": "/src/apify/storage_clients/_apify/_key_value_store_client.py" + "944": { + "qualifiedName": "size", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "928": { - "qualifiedName": "ApifyStorageClient", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "945": { + "qualifiedName": "KeyValueStoreListKeysPage", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "929": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "946": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "932": { - "qualifiedName": "create_dataset_client", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "947": { + "qualifiedName": "count", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "938": { - "qualifiedName": "create_kvs_client", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "948": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "944": { - "qualifiedName": "create_rq_client", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "949": { + "qualifiedName": "is_truncated", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "950": { - "qualifiedName": "get_storage_client_cache_key", - "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" + "qualifiedName": "items", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "951": { + "qualifiedName": "exclusive_start_key", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "952": { + "qualifiedName": "next_exclusive_start_key", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "953": { - "qualifiedName": "SmartApifyStorageClient", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "qualifiedName": "CachedRequest", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "954": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "qualifiedName": "id", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "955": { + "qualifiedName": "was_already_handled", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "956": { + "qualifiedName": "hydrated", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "957": { + "qualifiedName": "lock_expires_at", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "958": { - "qualifiedName": "__str__", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "qualifiedName": "RequestQueueStats", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "959": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "960": { - "qualifiedName": "get_storage_client_cache_key", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "qualifiedName": "delete_count", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "961": { + "qualifiedName": "head_item_read_count", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" + }, + "962": { + "qualifiedName": "read_count", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, "963": { - "qualifiedName": "create_dataset_client", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "qualifiedName": "storage_bytes", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "969": { - "qualifiedName": "create_kvs_client", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "964": { + "qualifiedName": "write_count", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "975": { - "qualifiedName": "create_rq_client", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "965": { + "qualifiedName": "ApifyRequestQueueMetadata", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "981": { - "qualifiedName": "get_suitable_storage_client", - "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + "966": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify/storage_clients/_apify/_models.py" }, - "984": { - "qualifiedName": "event_data_adapter", - "sourceFileName": "/src/apify/events/_apify_event_manager.py" + "967": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "985": { - "qualifiedName": "ApifyEventManager", - "sourceFileName": "/src/apify/events/_apify_event_manager.py" + "968": { + "qualifiedName": "ApifyRequestQueueClient", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "986": { + "969": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/events/_apify_event_manager.py" + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "990": { - "qualifiedName": "__aenter__", - "sourceFileName": "/src/apify/events/_apify_event_manager.py" + "974": { + "qualifiedName": "get_metadata", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "992": { - "qualifiedName": "__aexit__", - "sourceFileName": "/src/apify/events/_apify_event_manager.py" + "976": { + "qualifiedName": "open", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "997": { - "qualifiedName": "SystemInfoEventData", - "sourceFileName": "/src/apify/events/_types.py" + "983": { + "qualifiedName": "purge", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "998": { - "qualifiedName": "mem_avg_bytes", - "sourceFileName": "/src/apify/events/_types.py" + "985": { + "qualifiedName": "drop", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "999": { - "qualifiedName": "mem_current_bytes", - "sourceFileName": "/src/apify/events/_types.py" + "987": { + "qualifiedName": "add_batch_of_requests", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "1000": { - "qualifiedName": "mem_max_bytes", - "sourceFileName": "/src/apify/events/_types.py" + "991": { + "qualifiedName": "fetch_next_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "1001": { - "qualifiedName": "cpu_avg_usage", - "sourceFileName": "/src/apify/events/_types.py" + "993": { + "qualifiedName": "mark_request_as_handled", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "1002": { - "qualifiedName": "cpu_max_usage", - "sourceFileName": "/src/apify/events/_types.py" + "996": { + "qualifiedName": "get_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "1003": { - "qualifiedName": "cpu_current_usage", - "sourceFileName": "/src/apify/events/_types.py" + "999": { + "qualifiedName": "reclaim_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, - "1004": { - "qualifiedName": "is_cpu_overloaded", - "sourceFileName": "/src/apify/events/_types.py" + "1003": { + "qualifiedName": "is_empty", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_client.py" }, "1005": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "logger", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1006": { - "qualifiedName": "to_crawlee_format", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1009": { - "qualifiedName": "PersistStateEvent", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1010": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1011": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "ApifyRequestQueueSharedClient", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, - "1012": { - "qualifiedName": "SystemInfoEvent", - "sourceFileName": "/src/apify/events/_types.py" + "1007": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1013": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1014": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1015": { - "qualifiedName": "MigratingEvent", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1016": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "add_batch_of_requests", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1017": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1018": { - "qualifiedName": "AbortingEvent", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1019": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "get_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1020": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1021": { - "qualifiedName": "ExitEvent", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "fetch_next_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1022": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1023": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1024": { - "qualifiedName": "EventWithoutData", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "mark_request_as_handled", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1025": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1026": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1027": { - "qualifiedName": "DeprecatedEvent", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1028": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "reclaim_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1029": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1030": { - "qualifiedName": "UnknownEvent", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "is_empty", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_shared_client.py" }, "1031": { - "qualifiedName": "name", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "logger", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, "1032": { - "qualifiedName": "data", - "sourceFileName": "/src/apify/events/_types.py" + "qualifiedName": "ApifyRequestQueueSingleClient", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, "1033": { - "qualifiedName": "EventMessage", - "sourceFileName": "/src/apify/events/_types.py" - }, - "1034": { - "qualifiedName": "URL_NO_COMMAS_REGEX", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1035": { - "qualifiedName": "_RequestDetails", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1036": { - "qualifiedName": "method", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1037": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, "1038": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1039": { - "qualifiedName": "user_data", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1040": { - "qualifiedName": "_RequestsFromUrlInput", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1041": { - "qualifiedName": "requests_from_url", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + "qualifiedName": "add_batch_of_requests", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, "1042": { - "qualifiedName": "_SimpleUrlInput", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1043": { - "qualifiedName": "url", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1044": { - "qualifiedName": "url_input_adapter", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + "qualifiedName": "get_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, "1045": { - "qualifiedName": "ApifyRequestList", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" - }, - "1046": { - "qualifiedName": "open", - "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" + "qualifiedName": "fetch_next_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, - "1051": { - "qualifiedName": "get_basic_auth_header", - "sourceFileName": "/src/apify/scrapy/utils.py" + "1047": { + "qualifiedName": "mark_request_as_handled", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, - "1056": { - "qualifiedName": "apply_apify_settings", - "sourceFileName": "/src/apify/scrapy/utils.py" + "1050": { + "qualifiedName": "reclaim_request", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, - "1060": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/scrapy/scheduler.py" + "1054": { + "qualifiedName": "is_empty", + "sourceFileName": "/src/apify/storage_clients/_apify/_request_queue_single_client.py" }, - "1061": { - "qualifiedName": "ApifyScheduler", - "sourceFileName": "/src/apify/scrapy/scheduler.py" + "1056": { + "qualifiedName": "ApifyStorageClient", + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, - "1062": { + "1057": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/scrapy/scheduler.py" - }, - "1064": { - "qualifiedName": "open", - "sourceFileName": "/src/apify/scrapy/scheduler.py" + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, - "1067": { - "qualifiedName": "close", - "sourceFileName": "/src/apify/scrapy/scheduler.py" + "1060": { + "qualifiedName": "create_dataset_client", + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, - "1070": { - "qualifiedName": "has_pending_requests", - "sourceFileName": "/src/apify/scrapy/scheduler.py" + "1066": { + "qualifiedName": "create_kvs_client", + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, "1072": { - "qualifiedName": "enqueue_request", - "sourceFileName": "/src/apify/scrapy/scheduler.py" - }, - "1075": { - "qualifiedName": "next_request", - "sourceFileName": "/src/apify/scrapy/scheduler.py" - }, - "1077": { - "qualifiedName": "run_scrapy_actor", - "sourceFileName": "/src/apify/scrapy/_actor_runner.py" + "qualifiedName": "create_rq_client", + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, - "1080": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/scrapy/_async_thread.py" + "1078": { + "qualifiedName": "get_storage_client_cache_key", + "sourceFileName": "/src/apify/storage_clients/_apify/_storage_client.py" }, "1081": { - "qualifiedName": "AsyncThread", - "sourceFileName": "/src/apify/scrapy/_async_thread.py" - }, - "1082": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/scrapy/_async_thread.py" + "qualifiedName": "unique_key_to_request_id", + "sourceFileName": "/src/apify/storage_clients/_apify/_utils.py" }, - "1084": { - "qualifiedName": "run_coro", - "sourceFileName": "/src/apify/scrapy/_async_thread.py" + "1085": { + "qualifiedName": "hash_api_base_url_and_token", + "sourceFileName": "/src/apify/storage_clients/_apify/_utils.py" }, "1088": { - "qualifiedName": "close", - "sourceFileName": "/src/apify/scrapy/_async_thread.py" - }, - "1091": { - "qualifiedName": "ApifyHttpProxyMiddleware", - "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" + "qualifiedName": "ApifyFileSystemDatasetClient", + "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" }, - "1092": { + "1089": { "qualifiedName": "__init__", - "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" + "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" }, - "1095": { - "qualifiedName": "from_crawler", - "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" + "1093": { + "qualifiedName": "open", + "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" }, - "1098": { - "qualifiedName": "process_request", - "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" + "1099": { + "qualifiedName": "push_data", + "sourceFileName": "/src/apify/storage_clients/_file_system/_dataset_client.py" }, "1102": { - "qualifiedName": "process_exception", - "sourceFileName": "/src/apify/scrapy/middlewares/apify_proxy.py" - }, - "1107": { "qualifiedName": "logger", - "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" }, - "1108": { - "qualifiedName": "ActorDatasetPushPipeline", - "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" + "1103": { + "qualifiedName": "ApifyFileSystemKeyValueStoreClient", + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" }, - "1109": { - "qualifiedName": "process_item", - "sourceFileName": "/src/apify/scrapy/pipelines/actor_dataset_push.py" + "1104": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" }, - "1112": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/scrapy/requests.py" + "1109": { + "qualifiedName": "open", + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" }, - "1113": { - "qualifiedName": "to_apify_request", - "sourceFileName": "/src/apify/scrapy/requests.py" + "1115": { + "qualifiedName": "purge", + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" }, "1117": { - "qualifiedName": "to_scrapy_request", - "sourceFileName": "/src/apify/scrapy/requests.py" + "qualifiedName": "get_value", + "sourceFileName": "/src/apify/storage_clients/_file_system/_key_value_store_client.py" + }, + "1120": { + "qualifiedName": "ApifyFileSystemStorageClient", + "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" }, "1121": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "qualifiedName": "get_storage_client_cache_key", + "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" }, - "1122": { - "qualifiedName": "ApifyCacheStorage", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1124": { + "qualifiedName": "create_kvs_client", + "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" }, - "1123": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1130": { + "qualifiedName": "create_dataset_client", + "sourceFileName": "/src/apify/storage_clients/_file_system/_storage_client.py" }, - "1126": { - "qualifiedName": "open_spider", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1136": { + "qualifiedName": "DatasetClientPpeMixin", + "sourceFileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py" }, - "1129": { - "qualifiedName": "close_spider", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1137": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_ppe_dataset_mixin.py" }, - "1133": { - "qualifiedName": "retrieve_response", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1139": { + "qualifiedName": "SmartApifyStorageClient", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1138": { - "qualifiedName": "store_response", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1140": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1143": { - "qualifiedName": "to_gzip", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1144": { + "qualifiedName": "__str__", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1147": { - "qualifiedName": "from_gzip", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1146": { + "qualifiedName": "get_storage_client_cache_key", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1150": { - "qualifiedName": "read_gzip_time", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1149": { + "qualifiedName": "create_dataset_client", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1153": { - "qualifiedName": "get_kvs_name", - "sourceFileName": "/src/apify/scrapy/extensions/_httpcache.py" + "1155": { + "qualifiedName": "create_kvs_client", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1157": { - "qualifiedName": "initialize_logging", - "sourceFileName": "/src/apify/scrapy/_logging_config.py" + "1161": { + "qualifiedName": "create_rq_client", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" + }, + "1167": { + "qualifiedName": "get_suitable_storage_client", + "sourceFileName": "/src/apify/storage_clients/_smart_apify/_storage_client.py" }, - "1159": { + "1170": { "qualifiedName": "method", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1160": { + "1171": { "qualifiedName": "payload", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1161": { + "1172": { "qualifiedName": "headers", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1162": { + "1173": { "qualifiedName": "user_data", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1163": { + "1174": { "qualifiedName": "method", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1164": { + "1175": { "qualifiedName": "payload", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1165": { + "1176": { "qualifiedName": "headers", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1166": { + "1177": { "qualifiedName": "user_data", "sourceFileName": "/src/apify/request_loaders/_apify_request_list.py" }, - "1167": { + "1178": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "1168": { + "1179": { "qualifiedName": "apify_margin_percentage", "sourceFileName": "/src/apify/_models.py" }, - "1169": { + "1180": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "1170": { + "1181": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "1171": { + "1182": { "qualifiedName": "notified_about_future_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1172": { + "1183": { "qualifiedName": "notified_about_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1173": { + "1184": { "qualifiedName": "reason_for_change", "sourceFileName": "/src/apify/_models.py" }, - "1174": { + "1185": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "1175": { + "1186": { "qualifiedName": "apify_margin_percentage", "sourceFileName": "/src/apify/_models.py" }, - "1176": { + "1187": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "1177": { + "1188": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "1178": { + "1189": { "qualifiedName": "notified_about_future_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1179": { + "1190": { "qualifiedName": "notified_about_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1180": { + "1191": { "qualifiedName": "reason_for_change", "sourceFileName": "/src/apify/_models.py" }, - "1181": { + "1192": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "1182": { + "1193": { "qualifiedName": "apify_margin_percentage", "sourceFileName": "/src/apify/_models.py" }, - "1183": { + "1194": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "1184": { + "1195": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "1185": { + "1196": { "qualifiedName": "notified_about_future_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1186": { + "1197": { "qualifiedName": "notified_about_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1187": { + "1198": { "qualifiedName": "reason_for_change", "sourceFileName": "/src/apify/_models.py" }, - "1188": { + "1199": { "qualifiedName": "model_config", "sourceFileName": "/src/apify/_models.py" }, - "1189": { + "1200": { "qualifiedName": "apify_margin_percentage", "sourceFileName": "/src/apify/_models.py" }, - "1190": { + "1201": { "qualifiedName": "created_at", "sourceFileName": "/src/apify/_models.py" }, - "1191": { + "1202": { "qualifiedName": "started_at", "sourceFileName": "/src/apify/_models.py" }, - "1192": { + "1203": { "qualifiedName": "notified_about_future_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1193": { + "1204": { "qualifiedName": "notified_about_change_at", "sourceFileName": "/src/apify/_models.py" }, - "1194": { + "1205": { "qualifiedName": "reason_for_change", "sourceFileName": "/src/apify/_models.py" }, - "1195": { + "1206": { "qualifiedName": "charge_lock", "sourceFileName": "/src/apify/_charging.py" } diff --git a/website/versioned_sidebars/version-3.3-sidebars.json b/website/versioned_sidebars/version-3.3-sidebars.json deleted file mode 100644 index b666640d..00000000 --- a/website/versioned_sidebars/version-3.3-sidebars.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "sidebar": [ - { - "type": "doc", - "id": "introduction/introduction" - }, - { - "type": "doc", - "id": "introduction/quick-start" - }, - { - "type": "category", - "label": "Concepts", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "02_concepts" - } - ] - }, - { - "type": "category", - "label": "Guides", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "03_guides" - } - ] - }, - { - "type": "category", - "label": "Upgrading", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "04_upgrading" - } - ] - } - ] -} diff --git a/website/versioned_sidebars/version-3.4-sidebars.json b/website/versioned_sidebars/version-3.4-sidebars.json new file mode 100644 index 00000000..b90b80de --- /dev/null +++ b/website/versioned_sidebars/version-3.4-sidebars.json @@ -0,0 +1,45 @@ +{ + "sidebar": [ + { + "type": "doc", + "id": "introduction/introduction" + }, + { + "type": "doc", + "id": "introduction/quick-start" + }, + { + "type": "category", + "label": "Concepts", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "02_concepts" + } + ] + }, + { + "type": "category", + "label": "Guides", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "03_guides" + } + ] + }, + { + "type": "category", + "label": "Upgrading", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "04_upgrading" + } + ] + } + ] +} diff --git a/website/versions.json b/website/versions.json index 14b58892..b51ce1c1 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,5 +1,5 @@ [ - "3.3", + "3.4", "2.7", "1.7", "0.2"