Repository navigation
refactor!: mark secondary arguments as keyword-only - #2318
Merged
Merged
Conversation
BREAKING CHANGE: Secondary arguments of the public API are keyword-only. The v2 upgrade guide lists the affected signatures.
vdusek
added
the
t-tooling
vdusek
marked this pull request as ready for review
October 13, 2026 12:17
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## v2 #2318 +/- ##
=====================================
Coverage ? 94.12%
=====================================
Files ? 183
Lines ? 13561
Branches ? 0
=====================================
Hits ? 12764
Misses ? 797
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
added a commit
that referenced
this pull request
Oct 16, 2026
Secondary arguments across the public API are now keyword-only, the same way as in apify/apify-client-python#766. The main argument of each call (key, value, data, selector, path) stays positional. Named call sites read better, and new options can go anywhere in a signature without breaking existing callers. The full list is in the v2 upgrade guide. It covers the context helpers (`push_data`, `add_requests`, `block_requests`), `BasicCrawler.get_data`/`export_data`, `KeyValueStore.set_value` and the key iterators, `Dataset.export_to`, `ConcurrencySettings`, `RequestList`, `ProxyConfiguration.new_url`/`new_proxy_info`, the adaptive crawler factories and selector helpers, `HeaderGenerator.get_specific_headers`, `BrowserController.new_page`, `PlaywrightPersistentBrowser` and `find_links` on the parsers. `KeyValueStore.get_value` keeps `default_value` positional to match Crawlee JS. The three arguments of `new_proxy_info` now default to `None`, as on `new_url`. Closes: #1863 *✍️ Drafted by Claude Code*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Secondary arguments across the public API are now keyword-only, the same way as in apify/apify-client-python#766. The main argument of each call (key, value, data, selector, path) stays positional. Named call sites read better, and new options can go anywhere in a signature without breaking existing callers.
The full list is in the v2 upgrade guide. It covers the context helpers (
push_data,add_requests,block_requests),BasicCrawler.get_data/export_data,KeyValueStore.set_valueand the key iterators,Dataset.export_to,ConcurrencySettings,RequestList,ProxyConfiguration.new_url/new_proxy_info, the adaptive crawler factories and selector helpers,HeaderGenerator.get_specific_headers,BrowserController.new_page,PlaywrightPersistentBrowserandfind_linkson the parsers.KeyValueStore.get_valuekeepsdefault_valuepositional to match Crawlee JS. The three arguments ofnew_proxy_infonow default toNone, as onnew_url.Closes: #1863
✍️ Drafted by Claude Code