Skip to content

refactor!: remove deprecated APIs#918

Merged
vdusek merged 4 commits into
masterfrom
refactor/remove-deprecated-apis
Jun 2, 2026
Merged

refactor!: remove deprecated APIs#918
vdusek merged 4 commits into
masterfrom
refactor/remove-deprecated-apis

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented May 29, 2026

Removes deprecated APIs as part of the v4 major release.

api_public_base_url argument of storage clients (closes #635)

Removed the deprecated api_public_base_url __init__ argument from ApifyDatasetClient and ApifyKeyValueStoreClient (and the open() call sites that passed ''). It had no effect already in v3 — passing it only emitted a DeprecationWarning. The public base URL is taken from Configuration.api_public_base_url, which is unchanged.

RemainingTime timeout literal

Removed the deprecated 'RemainingTime' value of the timeout argument from Actor.start() and Actor.call(). Use 'inherit' instead — the behavior is identical.

Deprecated Configuration fields

Removed the @deprecated config fields latest_sdk_version, log_format, and standby_port (use web_server_port instead).

Also drops the now-unused warnings/deprecated imports and the obsolete deprecation-warning unit tests, and documents all removals in the v4 upgrade guide.

Mirrors apify/apify-client-python#799 for this repository.

Removes deprecated APIs as part of the v4 major release:

- `api_public_base_url` argument of `ApifyDatasetClient.__init__` and
  `ApifyKeyValueStoreClient.__init__` (closes #635). It had no effect already
  and only emitted a `DeprecationWarning`. The public base URL is taken from
  `Configuration.api_public_base_url`, which is unchanged.
- `RemainingTime` value of the `timeout` argument of `Actor.start()` and
  `Actor.call()` — replaced by `inherit`.
- Deprecated `Configuration` fields `latest_sdk_version`, `log_format`, and
  `standby_port` (use `web_server_port` instead).

Also drops the now-unused `warnings` and `deprecated` imports and the
associated unit tests for the removed deprecation warnings.
@vdusek vdusek requested a review from szaganek as a code owner May 29, 2026 14:20
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels May 29, 2026
@vdusek vdusek self-assigned this May 29, 2026
@github-actions github-actions Bot added this to the 141st sprint - Tooling team milestone May 29, 2026
@github-actions github-actions Bot added the tested Temporary label used only programatically for some analytics. label May 29, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.94%. Comparing base (94bdd37) to head (6dd8db3).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #918      +/-   ##
==========================================
- Coverage   87.00%   86.94%   -0.07%     
==========================================
  Files          48       48              
  Lines        2956     2942      -14     
==========================================
- Hits         2572     2558      -14     
  Misses        384      384              
Flag Coverage Δ
e2e 37.55% <20.00%> (-0.03%) ⬇️
integration 58.90% <20.00%> (+<0.01%) ⬆️
unit 75.69% <100.00%> (-0.12%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from janbuchar May 29, 2026 15:11
Comment thread docs/04_upgrading/upgrading_to_v4.md Outdated
Comment thread docs/04_upgrading/upgrading_to_v4.md Outdated
Comment thread docs/04_upgrading/upgrading_to_v4.md Outdated
Comment thread docs/04_upgrading/upgrading_to_v4.md Outdated
Comment thread docs/04_upgrading/upgrading_to_v4.md Outdated
vdusek added 2 commits June 2, 2026 14:17
Combine before/after examples into single code blocks with inline
comments for consistency with the keyword-only arguments section, and
restructure the Configuration fields removal note as a bulleted list.
@vdusek
Copy link
Copy Markdown
Contributor Author

vdusek commented Jun 2, 2026

All suggestions were applied, thanks @szaganek 🙂

@vdusek vdusek merged commit 3e5728d into master Jun 2, 2026
26 checks passed
@vdusek vdusek deleted the refactor/remove-deprecated-apis branch June 2, 2026 12:25
vdusek added a commit that referenced this pull request Jun 3, 2026
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, so
`versions.json` and the version dropdown on the docs website are still
stuck at 3.3.

- Replaces the 3.3 snapshot with 3.4 (the workflow keeps one minor per
major), updating `versioned_docs`, `versioned_sidebars`, and
`versions.json`.
- Generated from the `release-v3` branch (v3.4.1) using the exact
commands the fixed workflow runs (`uv run pnpm exec docusaurus
docs:version 3.4` + `api:version 3.4`), so the API reference documents
the released v3 API rather than the v4-dev code on master. Verified: the
snapshot still contains the `RemainingTime` timeout literal that was
removed on master in #918.

Merging this with the `docs:` prefix triggers a docs deploy from master,
which updates the version dropdown and the "Version: 3.x" badge on the
website.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. tested Temporary label used only programatically for some analytics.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove deprecated api_public_base_url argument from Apify storage clients __init__

4 participants