refactor!: Introduce fully typed clients #604

vdusek · 2026-02-05T12:10:02Z

Summary

This is a major refactoring that introduces fully typed Pydantic models throughout the client library. The models are generated from the OpenAPI specifications. All API responses now return typed objects instead of raw dictionaries.

This follows up on apify/apify-docs#2182.

Issues

Closes: Write integration tests #21
Closes: Introduce fully typed Python API client #481

Packages

Add direct dependency on Pydantic.
Removes the dependency on apify-shared.
Add dev dependency datamodel-code-generator for model generation.

Key changes

Uses datamodel-code-generator tool configured via pyproject.toml to generate Pydantic models based on the OpenAPI specs.
Refactors the whole codebase to adopt the new generated models.
All resource clients now return typed Pydantic models (Actor, Task, Run, etc.).
Adds response wrappers for validating and extracting API response data.
Updates list methods to return typed pagination models.
Documentation examples now use typed attribute access.
Updates the SDK to use the new typed client.
- See the corresponding PR in apify/apify-sdk-python for details - chore: Adapt to apify-client v3 [WIP] apify-sdk-python#719.
- It will be merged later.

Architecture

Get rid of 3/4/5 levels of inheritance.
Get rid of inline imports because of circular dependencies.
- I had to utilize ClientRegistry to be able to achieve that (because of resource clients-siblings imports).

Breaking changes

Client methods now return Pydantic models instead of dicts.
- Access patterns change from dict-style (result['key']) to attribute-style (result.key).

Test plan

Updated test concurrency to 16 workers.
A lot of new tests were implemented - coverage ~95%.
- Unit tests - do not call production API, only for testing utils or other functionality using mocks.
- Integration tests - call production API.
Thanks to the new tests, I was able to do a lot of fixes in the OpenAPI specs.

Next steps

Explore the generation of resource clients using openapi-python-client.
Fully automate model updates based on changes in apify-api/openapi.
This will be released as part of the Apify client v3.0.

codecov · 2026-02-05T12:10:58Z

Codecov Report

❌ Patch coverage is 94.01914% with 125 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.16%. Comparing base (aece206) to head (a745fa3).

Files with missing lines	Patch %	Lines
...apify_client/_resource_clients/_resource_client.py	83.33%	24 Missing ⚠️
src/apify_client/_resource_clients/run.py	91.60%	11 Missing ⚠️
src/apify_client/_resource_clients/user.py	80.39%	10 Missing ⚠️
src/apify_client/_resource_clients/dataset.py	91.39%	8 Missing ⚠️
.../apify_client/_resource_clients/key_value_store.py	93.54%	8 Missing ⚠️
src/apify_client/_resource_clients/actor.py	93.18%	6 Missing ⚠️
src/apify_client/_resource_clients/schedule.py	88.00%	6 Missing ⚠️
...apify_client/_resource_clients/webhook_dispatch.py	70.00%	6 Missing ⚠️
src/apify_client/_apify_client.py	95.78%	4 Missing ⚠️
...rc/apify_client/_resource_clients/actor_env_var.py	88.88%	4 Missing ⚠️
... and 15 more

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #604       +/-   ##
===========================================
+ Coverage   76.02%   95.16%   +19.13%     
===========================================
  Files          42       44        +2     
  Lines        2482     4588     +2106     
===========================================
+ Hits         1887     4366     +2479     
+ Misses        595      222      -373

Flag	Coverage Δ
integration	`93.63% <91.86%> (+24.86%)`	⬆️
unit	`70.61% <50.86%> (+5.95%)`	⬆️

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.

Pijukatel · 2026-02-09T13:25:45Z

tests/integration/conftest.py

+    keys_signature: dict[str, str]
+

-def crypto_random_object_id(length: int = 17) -> str:


I would suggest moving test utils to a standalone file to avoid importing from conftest, so that on one(including IDE helpers and AI) is tempted to import fixtures from conftest

https://docs.pytest.org/en/7.1.x/how-to/fixtures.html?highlight=has%20minor%20consequences#using-fixtures-from-other-projects

Pijukatel · 2026-02-09T13:27:54Z

docs/02_concepts/code/05_retries_async.py

        max_retries=8,
-        min_delay_between_retries_millis=500,  # 0.5s
-        timeout_secs=360,  # 6 mins
+        min_delay_between_retries=timedelta(milliseconds=500),  # 0.5s


Suggested change

min_delay_between_retries=timedelta(milliseconds=500), # 0.5s

min_delay_between_retries=timedelta(milliseconds=500),

Pijukatel · 2026-02-09T13:28:04Z

docs/02_concepts/code/05_retries_async.py

-        min_delay_between_retries_millis=500,  # 0.5s
-        timeout_secs=360,  # 6 mins
+        min_delay_between_retries=timedelta(milliseconds=500),  # 0.5s
+        timeout=timedelta(seconds=360),  # 6 mins


Suggested change

timeout=timedelta(seconds=360), # 6 mins

timeout=timedelta(seconds=360),

Pijukatel · 2026-02-09T13:28:18Z

docs/02_concepts/code/05_retries_sync.py

        max_retries=8,
-        min_delay_between_retries_millis=500,  # 0.5s
-        timeout_secs=360,  # 6 mins
+        min_delay_between_retries=timedelta(milliseconds=500),  # 0.5s


Suggested change

min_delay_between_retries=timedelta(milliseconds=500), # 0.5s

min_delay_between_retries=timedelta(milliseconds=500),

Pijukatel · 2026-02-09T13:28:28Z

docs/02_concepts/code/05_retries_sync.py

-        min_delay_between_retries_millis=500,  # 0.5s
-        timeout_secs=360,  # 6 mins
+        min_delay_between_retries=timedelta(milliseconds=500),  # 0.5s
+        timeout=timedelta(seconds=360),  # 6 mins


Suggested change

timeout=timedelta(seconds=360), # 6 mins

timeout=timedelta(seconds=360),

Pijukatel · 2026-02-09T13:58:55Z

src/apify_client/_http_clients/_base.py

+    Subclasses should call `super().__init__()` and create their specific impit client using the `_headers` attribute.
+    """
+
+    def __init__(


Maybe this change was lost
#601

Pijukatel · 2026-02-09T14:13:16Z

src/apify_client/_resource_clients/_resource_client.py

+            url = url.replace(self._base_url, self._public_base_url, 1)
+
+        if params:
+            filtered = {k: v for k, v in params.items() if v is not None}


We filter params here and also in _build_params. Shouldn't one reuse the other and filter just in one place?

Pijukatel · 2026-02-09T14:32:10Z

src/apify_client/_resource_clients/_resource_client.py

+        Raises:
+            ApifyApiError: If API returns errors other than 404.
+        """
+        started_at = datetime.now(timezone.utc)


Maybe we can just track the endtime which would be something or None

deadline = datetime.now(timezone.utc) + wait_duration while ((deadline is None) or deadline>datetime.now()):

Pijukatel · 2026-02-09T14:34:40Z

src/apify_client/_resource_clients/_resource_client.py

+                if is_terminal or is_timed_out:
+                    should_repeat = False
+
+                if not should_repeat:
+                    # Early return here so that we avoid the sleep below if not needed
+                    return actor_job


Why not doing this directly?

if is_terminal or is_timed_out: # Early return here so that we avoid the sleep below if not needed break

Pijukatel · 2026-02-09T14:39:21Z

src/apify_client/_resource_clients/_resource_client.py

+    @property
+    def resource_id(self) -> str | None:
+        """Get the resource ID."""
+        return self._resource_id
+
+    @property
+    def _resource_url(self) -> str:
+        """Build the full resource URL from base URL, path, and optional ID."""
+        url = f'{self._base_url}/{self._resource_path}'
+        if self._resource_id is not None:
+            url = f'{url}/{to_safe_id(self._resource_id)}'
+        return url
+
+    @cached_property
+    def _base_client_kwargs(self) -> dict[str, Any]:
+        """Base kwargs for creating nested/child clients.
+
+        Returns dict with base_url, public_base_url, http_client, and client_registry. Caller adds
+        resource_path, resource_id, and params as needed.
+        """
+        return {
+            'base_url': self._resource_url,
+            'public_base_url': self._public_base_url,
+            'http_client': self._http_client,
+            'client_registry': self._client_registry,
+        }
+
+    def _build_url(
+        self,
+        path: str | None = None,
+        *,
+        public: bool = False,
+        params: dict | None = None,
+    ) -> str:
+        """Build complete URL for API request.
+
+        Args:
+            path: Optional path segment to append (e.g., 'runs', 'items').
+            public: Whether to use public CDN URL instead of API URL.
+            params: Optional query parameters to append.
+
+        Returns:
+            Complete URL with optional path and query string.
+        """
+        url = f'{self._resource_url}/{path}' if path else self._resource_url
+
+        if public:
+            if not url.startswith(self._base_url):
+                raise ValueError(f'URL {url} does not start with base URL {self._base_url}')
+            url = url.replace(self._base_url, self._public_base_url, 1)
+
+        if params:
+            filtered = {k: v for k, v in params.items() if v is not None}
+            if filtered:
+                separator = '&' if '?' in url else '?'
+                url += separator + urlencode(filtered)
+
+        return url
+
+    def _build_params(self, **kwargs: Any) -> dict:
+        """Merge default params with method params, filtering out None values.
+
+        Args:
+            **kwargs: Method-specific parameters to merge.
+
+        Returns:
+            Merged parameters with None values removed.
+        """
+        merged = {**self._default_params, **kwargs}
+        return {k: v for k, v in merged.items() if v is not None}


These are the same for sync and async. They should share same implementation

Pijukatel · 2026-02-09T14:54:17Z

src/apify_client/_resource_clients/actor_collection.py

+        response_as_dict = response_to_dict(response)
+        return ListOfActorsResponse.model_validate(response_as_dict).data
+
+    def iterate(


We'd better do this in a standalone change. This is complex on its own.
#556

That change suggests that each list method (sync or async) will be (sync/async)iterable on its own, so there is no need for an explicit iterate method.

# Same as before, potentially not all items list_of_actors_response = ActorCollectionClient().list(...) # New functionality, lazily fetched in chunks, can iterate over all items, doing multiple API calls if needed individual_actors = [item for item in ActorCollectionClient().list(...)]

(Same for all other list like responses)

Pijukatel · 2026-02-09T15:14:34Z

src/apify_client/_resource_clients/actor_env_var.py

+        try:
+            response = self._http_client.call(
+                url=self._build_url(),
+                method='GET',
+                params=self._build_params(),
+            )
+            result = response_to_dict(response)
+            return EnvVarResponse.model_validate(result).data
+        except ApifyApiError as exc:
+            catch_not_found_or_throw(exc)
+            return None


Could we keep the _get, _update and _delete methods on the ResourceClient(Async)?

class ResourceClient(... def _get(self, timeout_secs: int | None = None) -> dict | None: response = self._http_client.call( url=self._build_url(), method='GET', params=self._build_params(), ) return response_to_dict(response) except ApifyApiError as exc: catch_not_found_or_throw(exc) return None

We could reuse most of it and just wrap it in something like this:

ActorEnvVarClient(... def get(self) -> EnvVar | None: return EnvVarResponse.model_validate(self._get()).data

(Same for all other clients)

Pijukatel · 2026-02-09T15:18:05Z

src/apify_client/_resource_clients/actor_env_var.py

+        cleaned = filter_none_values(actor_env_var_representation)

-        return self._update(filter_out_none_values_recursively(actor_env_var_representation))
+        response = self._http_client.call(


Similar to https://github.com/apify/apify-client-python/pull/604/changes#r2783198077

Why not keep generic methods on the base class and just wrap them with the correct model in the children?

_list, _create, _get_or_create

Pijukatel · 2026-02-09T15:26:35Z

src/apify_client/_apify_client.py

+        api_url = DEFAULT_API_URL if api_url is None else api_url
+        api_public_url = DEFAULT_API_URL if api_public_url is None else api_public_url

-    def _check_custom_headers(self, headers: dict) -> None:


Another part of https://github.com/apify/apify-client-python/pull/604/changes#r2782803552 lost

Pijukatel · 2026-02-09T15:28:40Z

src/apify_client/_apify_client.py

        )
+        """HTTP client used to communicate with the Apify API."""
+
+        self._client_registry = ClientRegistry(


Cool. I can imagine this allowing custom hacks way more easily :-)
Maybe useful for testing as well.

Pijukatel · 2026-02-09T15:40:23Z

tests/unit/test_utils.py

+        catch_not_found_or_throw(error_500)
+
+
+def test_filter_none_values() -> None:


Could you please redo these tests with pytest.param. One assertion per simple test like this

@pytest.mark.parametrize( ('in', 'out'), [ pytest.param({'a': 1, 'b': None, 'c': 3}, {'a': 1, 'c': 3}, id='Simple case'), ...

Same comment for other similar tests. Please parametrize where suitable

Mantisus · 2026-02-05T14:05:50Z

src/apify_client/_http_clients/_base.py

+        self,
+        headers: dict[str, str] | None = None,
+        params: dict[str, Any] | None = None,
+        data: Any = None,


Can we narrow down the type of data to str | bytes | bytearray | None?

Based on the method code, this seems valid.

Mantisus · 2026-02-09T15:28:41Z

src/apify_client/_resource_clients/actor.py

+            result = response_to_dict(response)
+            return ActorResponse.model_validate(result).data


Is there a reason why we don't use ActorResponse.model_validate_json(response.json()).data?

Similarly, in all places where response_to_dict is used

Pijukatel · 2026-02-10T10:29:50Z

src/apify_client/_models.py

+    default_run_options: Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')] = None
+
+
+class ActorPermissionLevel(str, Enum):


In the rest of the code we are shifting from Enums to string Literals. Have you experimented with it here?

Pijukatel · 2026-02-10T13:01:04Z

tests/integration/test_build.py

+
+    # OpenAPI definition should be a dict with standard OpenAPI fields
+    # Note: May be None if the actor doesn't have an OpenAPI definition
+    if openapi_def is not None:


We use specific actor that has it, right? so it should rather be:
assert openapi_def is not None

Copilot

Pull request overview

Major refactor that replaces dict-based API responses with generated, fully typed Pydantic models across the client, plus a new impit-based HTTP layer.

Changes:

Introduces new typed resource clients and response wrappers around generated Pydantic models.
Replaces legacy HTTP client with new SyncHttpClient / AsyncHttpClient and updates tests/docs accordingly.
Adds extensive new unit/integration coverage and model generation tooling configuration.

Reviewed changes

Copilot reviewed 100 out of 106 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
tests/unit/test_client_timeouts.py	Updates timeout tests to use new http clients + `timedelta`.
tests/unit/test_client_request_queue.py	Updates request-queue tests for typed responses and explicit API URLs.
tests/unit/test_client_headers.py	Removes legacy header tests (likely superseded by new HTTP layer).
tests/unit/test_client_errors.py	Switches error tests to new http clients and improves assertion naming.
tests/unit/test_actor_start_params.py	Adds unit tests ensuring `timeout` query param is used with typed client.
tests/unit/conftest.py	Removes `patch_basic_url` fixture; keeps `httpserver` fixture.
tests/unit/README.md	Documents unit-test isolation requirements.
tests/integration/test_webhook_dispatch.py	Adds unified sync/async integration coverage for webhook dispatch endpoints.
tests/integration/test_webhook.py	Adds unified sync/async integration coverage for webhooks.
tests/integration/test_user.py	Adds unified sync/async integration coverage for user endpoints (typed).
tests/integration/test_store.py	Reworks store tests into unified sync/async style with typed models.
tests/integration/test_schedule.py	Adds unified sync/async integration coverage for schedules.
tests/integration/test_run_collection.py	Removes legacy run-collection integration tests (dict-based).
tests/integration/test_log.py	Adds unified sync/async integration coverage for logs.
tests/integration/test_build.py	Adds unified sync/async integration coverage for builds.
tests/integration/test_basic.py	Removes legacy basic integration tests (dict-based).
tests/integration/test_apify_client.py	Adds unified basic integration test using typed models.
tests/integration/test_actor_version.py	Adds unified sync/async integration coverage for actor versions.
tests/integration/test_actor_env_var.py	Adds unified sync/async integration coverage for actor env vars.
tests/integration/test_actor.py	Adds unified sync/async integration coverage for actors.
tests/integration/integration_test_utils.py	Removes old integration utilities (now likely in conftest).
tests/integration/README.md	Documents integration tests’ requirement for real API tokens.
src/apify_client/errors.py	Improves error docstrings and hardens JSON error extraction.
src/apify_client/clients/resource_clients/run_collection.py	Removes legacy client implementation (dict-based).
src/apify_client/clients/resource_clients/build.py	Removes legacy build client implementation (dict-based).
src/apify_client/clients/resource_clients/actor_env_var_collection.py	Removes legacy env var collection client (dict-based).
src/apify_client/clients/base/resource_collection_client.py	Removes legacy base list/create abstraction (dict-based).
src/apify_client/clients/base/resource_client.py	Removes legacy base resource client abstraction (dict-based).
src/apify_client/clients/base/base_client.py	Removes legacy base client (replaced by new resource client base).
src/apify_client/clients/base/actor_job_base_client.py	Removes legacy polling/abort base (replaced elsewhere).
src/apify_client/clients/base/init.py	Removes legacy base exports.
src/apify_client/clients/init.py	Removes legacy large re-export module.
src/apify_client/_types.py	Removes old JSON/ListPage types (moved/replaced).
src/apify_client/_statistics.py	Renames Statistics -> ClientStatistics.
src/apify_client/_resource_clients/webhook_dispatch_collection.py	Converts to typed models + new base resource client.
src/apify_client/_resource_clients/webhook_dispatch.py	Converts `get()` to typed models and explicit 404 handling.
src/apify_client/_resource_clients/webhook_collection.py	Converts list/create to typed models and new representation helpers.
src/apify_client/_resource_clients/webhook.py	Converts get/update/delete/test/dispatches to typed models and new base.
src/apify_client/_resource_clients/user.py	Converts user endpoints to typed models and new base.
src/apify_client/_resource_clients/store_collection.py	Converts store listing to typed models and new base.
src/apify_client/_resource_clients/schedule_collection.py	Converts schedule list/create to typed models and new base.
src/apify_client/_resource_clients/schedule.py	Converts schedule get/update/delete/log to typed models and new base.
src/apify_client/_resource_clients/run_collection.py	Adds new typed run collection client with pagination iteration.
src/apify_client/_resource_clients/request_queue_collection.py	Converts list/get_or_create to typed models and new base.
src/apify_client/_resource_clients/log.py	Updates to new base client, typed run usage, and task lifecycle handling.
src/apify_client/_resource_clients/key_value_store_collection.py	Converts list/get_or_create to typed models and new base.
src/apify_client/_resource_clients/dataset_collection.py	Converts list/get_or_create to typed models and new base.
src/apify_client/_resource_clients/build_collection.py	Converts list to typed models and new base.
src/apify_client/_resource_clients/build.py	Adds new typed build client with log + wait_for_finish.
src/apify_client/_resource_clients/actor_version_collection.py	Converts list/create to typed models and new base.
src/apify_client/_resource_clients/actor_env_var_collection.py	Adds new typed actor env var collection client.
src/apify_client/_resource_clients/actor_env_var.py	Converts env var get/update/delete to typed models and new base.
src/apify_client/_resource_clients/init.py	Expands exports for log streaming/status watchers; updates resource exports.
src/apify_client/_logging.py	Refactors logging helpers, adds redirect logger utilities, updates context injection.
src/apify_client/_internal_models.py	Adds internal minimal Pydantic models for polling/validation (non-generated).
src/apify_client/_http_clients/_sync.py	Adds new synchronous impit-based HTTP client with retries/backoff.
src/apify_client/_http_clients/_base.py	Adds shared HTTP base: headers, param conversion, gzip JSON, timeout scaling.
src/apify_client/_http_clients/_async.py	Adds new async impit-based HTTP client with retries/backoff.
src/apify_client/_http_clients/init.py	Adds package entrypoint for new HTTP clients.
src/apify_client/_http_client.py	Removes legacy HTTP client implementation.
src/apify_client/_consts.py	Adds shared constants (timeouts, retries, terminal statuses, API URL).
src/apify_client/_client_registry.py	Adds sync/async registries for DI and avoiding circular imports.
src/apify_client/init.py	Switches public import to new `_apify_client` module.
scripts/utils.py	Improves docstring conversion and typing in scripts.
scripts/fix_async_docstrings.py	Skips `_http_clients` and handles missing sync class/methods.
scripts/check_async_docstrings.py	Skips `_http_clients` and handles missing sync classes.
pyproject.toml	Updates dependencies, adds datamodel-codegen config, fixes ruff ignore for generated models, bumps test concurrency, adds generate-models task.
docs/03_examples/code/03_retrieve_sync.py	Updates examples to attribute access for typed models.
docs/03_examples/code/03_retrieve_async.py	Updates examples to attribute access for typed models.
docs/03_examples/code/02_tasks_sync.py	Updates examples to typed Task/Run + attribute access.
docs/03_examples/code/02_tasks_async.py	Updates examples to typed Task/Run + attribute access.
docs/03_examples/code/01_input_sync.py	Updates timeout usage to `timedelta`.
docs/03_examples/code/01_input_async.py	Updates timeout usage to `timedelta`.
docs/02_concepts/code/05_retries_sync.py	Updates retry/timeout params to `timedelta`.
docs/02_concepts/code/05_retries_async.py	Updates retry/timeout params to `timedelta`.
docs/02_concepts/code/01_async_support.py	Updates example to attribute access for typed run id.
docs/01_overview/code/01_usage_sync.py	Updates example to attribute access for typed dataset id.
docs/01_overview/code/01_usage_async.py	Updates example to attribute access for typed dataset id.
.github/workflows/_tests.yaml	Increases CI test concurrency default to 16.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-10T19:51:45Z

src/apify_client/_http_clients/__init__.py

+from ._async import AsyncHttpClient
+from ._sync import SyncHttpClient
+
+__all__ = [
+    'HttpClient',
+    'HttpClientAsync',
+]


__all__ exports names that are not defined in this module (HttpClient, HttpClientAsync). This breaks star-imports and is misleading for public API. Export the actual symbols (SyncHttpClient, AsyncHttpClient) and/or add explicit aliases if HttpClient / HttpClientAsync are intended public names.

Copilot · 2026-02-10T19:51:46Z

src/apify_client/_http_clients/_sync.py

+        for attempt in range(1, max_retries + 1):
+            try:
+                return func(stop_retrying, attempt)
+            except Exception:
+                if not swallow:
+                    raise
+
+            random_sleep_factor = random.uniform(1, 1 + random_factor)
+            backoff_base_secs = to_seconds(backoff_base)
+            backoff_exp_factor = backoff_factor ** (attempt - 1)
+
+            sleep_time_secs = random_sleep_factor * backoff_base_secs * backoff_exp_factor
+            time.sleep(sleep_time_secs)
+
+        return func(stop_retrying, max_retries + 1)


_retry_with_exp_backoff() performs an extra attempt after the retry loop (max_retries + 1), so the total number of attempts becomes max_retries + 1, contradicting the max_retries contract/docstring. Remove the final call and instead re-raise the last exception (or track it) after the loop if all attempts fail.

Copilot · 2026-02-10T19:51:46Z

src/apify_client/_http_clients/_async.py

+        for attempt in range(1, max_retries + 1):
+            try:
+                return await func(stop_retrying, attempt)
+            except Exception:
+                if not swallow:
+                    raise
+
+            random_sleep_factor = random.uniform(1, 1 + random_factor)
+            backoff_base_secs = to_seconds(backoff_base)
+            backoff_exp_factor = backoff_factor ** (attempt - 1)
+
+            sleep_time_secs = random_sleep_factor * backoff_base_secs * backoff_exp_factor
+            await asyncio.sleep(sleep_time_secs)
+
+        return await func(stop_retrying, max_retries + 1)


Same issue as sync version: this does an extra attempt after exhausting max_retries, making total attempts max_retries + 1. Remove the final attempt and re-raise the last failure once the loop completes.

Copilot · 2026-02-10T19:51:46Z

src/apify_client/_logging.py

+            Formatted log message with colored logger name prefix.
+        """
+        formatted_logger_name = f'{Fore.CYAN}[{record.name}]{Style.RESET_ALL}'
+        return f'{formatted_logger_name} -> {record.msg}'


Using record.msg drops %-style formatting and {}-style formatting that relies on record.args, so redirected logs can lose important details. Use record.getMessage() (or delegate to logging.Formatter.format(...)) so arguments are interpolated correctly.

Suggested change

return f'{formatted_logger_name} -> {record.msg}'

message = record.getMessage()

return f'{formatted_logger_name} -> {message}'

Copilot · 2026-02-10T19:51:47Z

src/apify_client/_logging.py

+    for handler in to_logger.handlers:
+        to_logger.removeHandler(handler)
+    for log_filter in to_logger.filters:


This mutates to_logger.handlers / to_logger.filters while iterating them, which can skip elements depending on list behavior. Iterate over a copy (e.g., for handler in list(to_logger.handlers): ...) or clear them via a while-loop to ensure all handlers/filters are removed.

Suggested change

for handler in to_logger.handlers:

to_logger.removeHandler(handler)

for log_filter in to_logger.filters:

for handler in list(to_logger.handlers):

to_logger.removeHandler(handler)

for log_filter in list(to_logger.filters):

Copilot · 2026-02-10T19:51:47Z

src/apify_client/_resource_clients/user.py

+            # Try to parse as UserPrivateInfo first (has more fields), fall back to UserPublicInfo
+            try:
+                return PrivateUserDataResponse.model_validate(result).data
+            except Exception:
+                return PublicUserDataResponse.model_validate(result).data


Catching Exception here is too broad and can hide unrelated bugs (e.g., unexpected runtime errors). Catch the specific Pydantic validation exception (typically pydantic.ValidationError) when falling back from private to public parsing.

Copilot · 2026-02-10T19:51:47Z

src/apify_client/_resource_clients/__init__.py

+    'LogClient',
+    'LogClientAsync',
    'LogClientAsync',


__all__ contains duplicate entries (LogClient, LogClientAsync). This is noisy and can confuse tooling/readers. Remove duplicates so each symbol appears exactly once.

Suggested change

'LogClient',

'LogClientAsync',

'LogClientAsync',

'LogClientAsync',

Copilot · 2026-02-10T19:51:48Z

tests/unit/README.md

+- production or test API tokens
+- network access at all
+
+Any test that calls the Apify API belong to integration tests.


Grammatical fix: change 'belong' to 'belongs' (subject-verb agreement).

Suggested change

Any test that calls the Apify API belong to integration tests.

Any test that calls the Apify API belongs to integration tests.

Copilot · 2026-02-10T19:51:48Z

tests/unit/test_actor_start_params.py

+    api_url = httpserver.url_for('/').removesuffix('/')
+    client = ApifyClient(token='test_token', api_url=api_url)
+
+    # Call start with timeout_secs


The comment says timeout_secs, but the call uses the new timeout parameter (timedelta). Update the comment to avoid confusion (same applies to the analogous async test comment).

Suggested change

# Call start with timeout_secs

# Call start with timeout (timedelta) parameter

Copilot · 2026-02-10T19:51:49Z

tests/unit/test_client_request_queue.py

 async def test_batch_processed_partially_sync(httpserver: HTTPServer) -> None:
-    client = ApifyClient(token='placeholder_token')
+    server_url = httpserver.url_for('/').removesuffix('/')
+    client = ApifyClient(
+        token='placeholder_token',
+        api_url=server_url,
+        api_public_url=server_url,
+    )


This test is declared async def but only exercises the sync client and contains no await. Consider making it a regular def test (or switch to ApifyClientAsync) so the test type matches the behavior and avoids unnecessary async test overhead.

refactor!: Introduce fully typed clients

1b1a494

vdusek requested a review from Pijukatel February 5, 2026 12:10

github-actions bot assigned vdusek Feb 5, 2026

vdusek requested a review from Mantisus February 5, 2026 12:10

github-actions bot added this to the 133rd sprint - Tooling team milestone Feb 5, 2026

github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Feb 5, 2026

vdusek requested a review from janbuchar February 5, 2026 12:10

vdusek mentioned this pull request Feb 5, 2026

refactor!: Introduce fully typed clients [WIP] #554

Closed

vdusek added the adhoc Ad-hoc unplanned task added during the sprint. label Feb 5, 2026

Regenerate models

a745fa3

Pijukatel reviewed Feb 9, 2026

View reviewed changes

Pijukatel self-requested a review February 9, 2026 14:41

Pijukatel reviewed Feb 9, 2026

View reviewed changes

Mantisus suggested changes Feb 9, 2026

View reviewed changes

Pijukatel reviewed Feb 10, 2026

View reviewed changes

vdusek requested a review from Copilot February 10, 2026 19:48

Copilot AI reviewed Feb 10, 2026

View reviewed changes

		keys_signature: dict[str, str]


		def crypto_random_object_id(length: int = 17) -> str:

	min_delay_between_retries=timedelta(milliseconds=500), # 0.5s
	min_delay_between_retries=timedelta(milliseconds=500),

	timeout=timedelta(seconds=360), # 6 mins
	timeout=timedelta(seconds=360),

		catch_not_found_or_throw(error_500)


		def test_filter_none_values() -> None:

		result = response_to_dict(response)
		return ActorResponse.model_validate(result).data

		default_run_options: Annotated[DefaultRunOptions \| None, Field(alias='defaultRunOptions')] = None


		class ActorPermissionLevel(str, Enum):

	return f'{formatted_logger_name} -> {record.msg}'
	message = record.getMessage()
	return f'{formatted_logger_name} -> {message}'

	Any test that calls the Apify API belong to integration tests.
	Any test that calls the Apify API belongs to integration tests.

	# Call start with timeout_secs
	# Call start with timeout (timedelta) parameter

refactor!: Introduce fully typed clients #604

Are you sure you want to change the base?

refactor!: Introduce fully typed clients #604

Conversation

vdusek commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Issues

Packages

Key changes

Architecture

Breaking changes

Test plan

Next steps

Uh oh!

codecov bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

vdusek commented Feb 5, 2026 •

edited

Loading

codecov bot commented Feb 5, 2026 •

edited

Loading