Rename with_custom_client to with_custom_http_client

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: vdusek

scripts/check_async_docstrings.py

@@ -14,7 +14,7 @@
 # Methods where the async docstring is intentionally different from the sync one
 # (e.g. because they accept different parameter types).
 SKIPPED_METHODS = {
-    'with_custom_client',
+    'with_custom_http_client',
 }
 
 # Get the directory of the source files

scripts/fix_async_docstrings.py

@@ -9,7 +9,7 @@
 # Methods where the async docstring is intentionally different from the sync one
 # (e.g. because they accept different parameter types).
 SKIPPED_METHODS = {
-    'with_custom_client',
+    'with_custom_http_client',
 }
 
 # Get the directory of the source files

src/apify_client/_apify_client.py

@@ -119,7 +119,7 @@ def __init__(
     ) -> None:
         """Initialize the Apify API client.
 
-        To use a custom HTTP client, use the `with_custom_client` class method instead.
+        To use a custom HTTP client, use the `with_custom_http_client` class method instead.
 
         Args:
             token: The Apify API token. You can find your token on the
@@ -195,7 +195,7 @@ def __init__(
         self._headers = headers
 
     @classmethod
-    def with_custom_client(
+    def with_custom_http_client(
         cls,
         token: str | None = None,
         *,
@@ -218,7 +218,7 @@ class MyHttpClient(HttpClient):
             def call(self, *, method, url, **kwargs) -> HttpResponse:
                 ...
 
-        client = ApifyClient.with_custom_client(
+        client = ApifyClient.with_custom_http_client(
             token='MY-APIFY-TOKEN',
             http_client=MyHttpClient(),
         )
@@ -243,7 +243,7 @@ def token(self) -> str | None:
     def http_client(self) -> HttpClient:
         """The HTTP client instance used for API communication.
 
-        Returns the custom HTTP client if one was provided via `with_custom_client`,
+        Returns the custom HTTP client if one was provided via `with_custom_http_client`,
         or the default `ImpitHttpClient` otherwise (lazily created on first access).
         """
         if self._http_client is None:
@@ -460,7 +460,7 @@ def __init__(
     ) -> None:
         """Initialize the Apify API client.
 
-        To use a custom HTTP client, use the `with_custom_client` class method instead.
+        To use a custom HTTP client, use the `with_custom_http_client` class method instead.
 
         Args:
             token: The Apify API token. You can find your token on the
@@ -536,7 +536,7 @@ def __init__(
         self._headers = headers
 
     @classmethod
-    def with_custom_client(
+    def with_custom_http_client(
         cls,
         token: str | None = None,
         *,
@@ -559,7 +559,7 @@ class MyHttpClient(HttpClientAsync):
             async def call(self, *, method, url, **kwargs) -> HttpResponse:
                 ...
 
-        client = ApifyClientAsync.with_custom_client(
+        client = ApifyClientAsync.with_custom_http_client(
             token='MY-APIFY-TOKEN',
             http_client=MyHttpClient(),
         )
@@ -584,7 +584,7 @@ def token(self) -> str | None:
     def http_client(self) -> HttpClientAsync:
         """The HTTP client instance used for API communication.
 
-        Returns the custom HTTP client if one was provided via `with_custom_client`,
+        Returns the custom HTTP client if one was provided via `with_custom_http_client`,
         or the default `ImpitHttpClientAsync` otherwise (lazily created on first access).
         """
         if self._http_client is None:

tests/unit/test_pluggable_http_client.py

@@ -194,10 +194,10 @@ def test_http_client_async_abc_not_instantiable() -> None:
 # -- ApifyClient with custom http_client via classmethod --
 
 
-def test_apify_client_with_custom_client() -> None:
-    """Test that ApifyClient.with_custom_client accepts a custom http_client."""
+def test_apify_client_with_custom_http_client() -> None:
+    """Test that ApifyClient.with_custom_http_client accepts a custom http_client."""
     fake_client = FakeHttpClient()
-    client = ApifyClient.with_custom_client(token='test_token', http_client=fake_client)
+    client = ApifyClient.with_custom_http_client(token='test_token', http_client=fake_client)
 
     assert client.http_client is fake_client
 
@@ -212,7 +212,7 @@ def test_apify_client_uses_default_http_client_when_none_provided() -> None:
 def test_apify_client_custom_http_client_receives_requests() -> None:
     """Test that requests flow through the custom HTTP client."""
     fake_client = FakeHttpClient()
-    client = ApifyClient.with_custom_client(token='test_token', http_client=fake_client)
+    client = ApifyClient.with_custom_http_client(token='test_token', http_client=fake_client)
 
     # Use _get() via the dataset client to avoid Pydantic model validation
     # (actor.get() would try to validate against ActorResponse model)
@@ -225,10 +225,10 @@ def test_apify_client_custom_http_client_receives_requests() -> None:
     assert result == {'data': {'id': 'test123'}}
 
 
-def test_apify_client_with_custom_client_accepts_url_params() -> None:
-    """Test that with_custom_client can be combined with token, api_url, and api_public_url."""
+def test_apify_client_with_custom_http_client_accepts_url_params() -> None:
+    """Test that with_custom_http_client can be combined with token, api_url, and api_public_url."""
     fake_client = FakeHttpClient()
-    client = ApifyClient.with_custom_client(
+    client = ApifyClient.with_custom_http_client(
         token='test_token',
         api_url='https://custom.api.example.com',
         api_public_url='https://public.api.example.com',
@@ -240,10 +240,10 @@ def test_apify_client_with_custom_client_accepts_url_params() -> None:
 # -- ApifyClientAsync with custom http_client via classmethod --
 
 
-async def test_apify_client_async_with_custom_client() -> None:
-    """Test that ApifyClientAsync.with_custom_client accepts a custom http_client."""
+async def test_apify_client_async_with_custom_http_client() -> None:
+    """Test that ApifyClientAsync.with_custom_http_client accepts a custom http_client."""
     fake_client = FakeHttpClientAsync()
-    client = ApifyClientAsync.with_custom_client(token='test_token', http_client=fake_client)
+    client = ApifyClientAsync.with_custom_http_client(token='test_token', http_client=fake_client)
 
     assert client.http_client is fake_client
 
@@ -258,7 +258,7 @@ async def test_apify_client_async_uses_default_http_client_when_none_provided()
 async def test_apify_client_async_custom_http_client_receives_requests() -> None:
     """Test that async requests flow through the custom HTTP client."""
     fake_client = FakeHttpClientAsync()
-    client = ApifyClientAsync.with_custom_client(token='test_token', http_client=fake_client)
+    client = ApifyClientAsync.with_custom_http_client(token='test_token', http_client=fake_client)
 
     # Use _get() via the dataset client to avoid Pydantic model validation
     result = await client.dataset('test-dataset')._get()
@@ -270,10 +270,10 @@ async def test_apify_client_async_custom_http_client_receives_requests() -> None
     assert result == {'data': {'id': 'test123'}}
 
 
-async def test_apify_client_async_with_custom_client_accepts_url_params() -> None:
-    """Test that async with_custom_client can be combined with token, api_url, and api_public_url."""
+async def test_apify_client_async_with_custom_http_client_accepts_url_params() -> None:
+    """Test that async with_custom_http_client can be combined with token, api_url, and api_public_url."""
     fake_client = FakeHttpClientAsync()
-    client = ApifyClientAsync.with_custom_client(
+    client = ApifyClientAsync.with_custom_http_client(
         token='test_token',
         api_url='https://custom.api.example.com',
         api_public_url='https://public.api.example.com',
@@ -305,7 +305,7 @@ def test_apify_client_http_client_property_returns_correct_type() -> None:
 
     # With custom
     fake = FakeHttpClient()
-    client2 = ApifyClient.with_custom_client(token='test', http_client=fake)
+    client2 = ApifyClient.with_custom_http_client(token='test', http_client=fake)
     assert client2.http_client is fake
 
 
@@ -317,7 +317,7 @@ async def test_apify_client_async_http_client_property_returns_correct_type() ->
 
     # With custom
     fake = FakeHttpClientAsync()
-    client2 = ApifyClientAsync.with_custom_client(token='test', http_client=fake)
+    client2 = ApifyClientAsync.with_custom_http_client(token='test', http_client=fake)
     assert client2.http_client is fake
 
 
@@ -339,7 +339,7 @@ def call(self, *, method: str, **_kwargs: Any) -> FakeResponse:
 def test_custom_http_client_error_handling() -> None:
     """Test that ApifyApiError from custom client is handled correctly by resource clients."""
     error_client = ErrorRaisingHttpClient()
-    client = ApifyClient.with_custom_client(token='test', http_client=error_client)
+    client = ApifyClient.with_custom_http_client(token='test', http_client=error_client)
 
     # _get() should catch 404 record-not-found and return None
     result = client.actor('nonexistent').get()
@@ -361,7 +361,7 @@ async def call(self, *, method: str, **_kwargs: Any) -> FakeResponse:
 async def test_custom_http_client_async_error_handling() -> None:
     """Test that ApifyApiError from async custom client is handled correctly by resource clients."""
     error_client = ErrorRaisingHttpClientAsync()
-    client = ApifyClientAsync.with_custom_client(token='test', http_client=error_client)
+    client = ApifyClientAsync.with_custom_http_client(token='test', http_client=error_client)
 
     # _get() should catch 404 record-not-found and return None
     result = await client.actor('nonexistent').get()
@@ -388,7 +388,7 @@ def call(self, *, method: str, url: str, **kwargs: Any) -> HttpResponse:
             return inner_client.call(method=method, url=url, **kwargs)
 
     api_url = httpserver.url_for('/').removesuffix('/')
-    client = ApifyClient.with_custom_client(token='test_token', api_url=api_url, http_client=WrappingHttpClient())
+    client = ApifyClient.with_custom_http_client(token='test_token', api_url=api_url, http_client=WrappingHttpClient())
 
     # Use _get() to test the raw request flow without Pydantic validation
     result = client.dataset('test-dataset')._get()
@@ -414,7 +414,7 @@ async def call(self, *, method: str, url: str, **kwargs: Any) -> HttpResponse:
             return await inner_client.call(method=method, url=url, **kwargs)
 
     api_url = httpserver.url_for('/').removesuffix('/')
-    client = ApifyClientAsync.with_custom_client(
+    client = ApifyClientAsync.with_custom_http_client(
         token='test_token', api_url=api_url, http_client=WrappingHttpClientAsync()
     )