Skip to content

Commit 8ee271c

Browse files
vdusekvdusek
committed
Define public interface of the package
1 parent 96be311 commit 8ee271c

40 files changed

Lines changed: 130 additions & 266 deletions

‎src/apify_client/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from importlib import metadata
22

3-
from .client import ApifyClient, ApifyClientAsync
3+
from ._client import ApifyClient, ApifyClientAsync
44

55
__version__ = metadata.version('apify-client')
66

src/apify_client/client.py renamed to src/apify_client/_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
from __future__ import annotations
22

33
from apify_client._http_client import HTTPClient, HTTPClientAsync
4-
from apify_client._statistics import Statistics
5-
from apify_client.clients import (
4+
from apify_client._resource_clients import (
65
ActorClient,
76
ActorClientAsync,
87
ActorCollectionClient,
@@ -50,6 +49,7 @@
5049
WebhookDispatchCollectionClient,
5150
WebhookDispatchCollectionClientAsync,
5251
)
52+
from apify_client._types import Statistics
5353

5454
DEFAULT_API_URL = 'https://api.apify.com'
5555
DEFAULT_TIMEOUT = 360

‎src/apify_client/_http_client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
import impit
1515

1616
from apify_client._logging import log_context, logger_name
17-
from apify_client._statistics import Statistics
17+
from apify_client._types import Statistics
1818
from apify_client._utils import is_retryable_error, retry_with_exp_backoff, retry_with_exp_backoff_async
1919
from apify_client.errors import ApifyApiError
2020

2121
if TYPE_CHECKING:
2222
from collections.abc import Callable
2323

24-
from apify_client._types import JSONSerializable
24+
from apify_client._types import JsonSerializable
2525

2626
DEFAULT_BACKOFF_EXPONENTIAL_FACTOR = 2
2727
DEFAULT_BACKOFF_RANDOM_FACTOR = 1
@@ -96,7 +96,7 @@ def _prepare_request_call(
9696
headers: dict | None = None,
9797
params: dict | None = None,
9898
data: Any = None,
99-
json: JSONSerializable | None = None,
99+
json: JsonSerializable | None = None,
100100
) -> tuple[dict, dict | None, Any]:
101101
if json and data:
102102
raise ValueError('Cannot pass both "json" and "data" parameters at the same time!')
@@ -146,7 +146,7 @@ def call(
146146
headers: dict | None = None,
147147
params: dict | None = None,
148148
data: Any = None,
149-
json: JSONSerializable | None = None,
149+
json: JsonSerializable | None = None,
150150
stream: bool | None = None,
151151
timeout_secs: int | None = None,
152152
) -> impit.Response:
@@ -225,7 +225,7 @@ async def call(
225225
headers: dict | None = None,
226226
params: dict | None = None,
227227
data: Any = None,
228-
json: JSONSerializable | None = None,
228+
json: JsonSerializable | None = None,
229229
stream: bool | None = None,
230230
timeout_secs: int | None = None,
231231
) -> impit.Response:

‎src/apify_client/_logging.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
if TYPE_CHECKING:
1212
from collections.abc import Callable
1313

14-
from apify_client.clients.base.base_client import _BaseBaseClient
14+
from apify_client._resource_clients.base import BaseBaseClient
1515

1616

1717
logger_name = __name__.split('.')[0]
@@ -111,7 +111,7 @@ def _injects_client_details_to_log_context(fun: Callable) -> Callable:
111111
if inspect.iscoroutinefunction(fun):
112112

113113
@functools.wraps(fun)
114-
async def async_wrapper(resource_client: _BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
114+
async def async_wrapper(resource_client: BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
115115
log_context.client_method.set(fun.__qualname__)
116116
log_context.resource_id.set(resource_client.resource_id)
117117

@@ -122,7 +122,7 @@ async def async_wrapper(resource_client: _BaseBaseClient, *args: Any, **kwargs:
122122
if inspect.isasyncgenfunction(fun):
123123

124124
@functools.wraps(fun)
125-
async def async_generator_wrapper(resource_client: _BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
125+
async def async_generator_wrapper(resource_client: BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
126126
log_context.client_method.set(fun.__qualname__)
127127
log_context.resource_id.set(resource_client.resource_id)
128128

@@ -132,7 +132,7 @@ async def async_generator_wrapper(resource_client: _BaseBaseClient, *args: Any,
132132
return async_generator_wrapper
133133

134134
@functools.wraps(fun)
135-
def wrapper(resource_client: _BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
135+
def wrapper(resource_client: BaseBaseClient, *args: Any, **kwargs: Any) -> Any:
136136
log_context.client_method.set(fun.__qualname__)
137137
log_context.resource_id.set(resource_client.resource_id)
138138

src/apify_client/clients/resource_clients/__init__.py renamed to src/apify_client/_resource_clients/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
from .actor_env_var_collection import ActorEnvVarCollectionClient, ActorEnvVarCollectionClientAsync
55
from .actor_version import ActorVersionClient, ActorVersionClientAsync
66
from .actor_version_collection import ActorVersionCollectionClient, ActorVersionCollectionClientAsync
7+
from .base import ActorJobBaseClient, ActorJobBaseClientAsync
78
from .build import BuildClient, BuildClientAsync
89
from .build_collection import BuildCollectionClient, BuildCollectionClientAsync
910
from .dataset import DatasetClient, DatasetClientAsync
@@ -35,6 +36,8 @@
3536
'ActorEnvVarClientAsync',
3637
'ActorEnvVarCollectionClient',
3738
'ActorEnvVarCollectionClientAsync',
39+
'ActorJobBaseClient',
40+
'ActorJobBaseClientAsync',
3841
'ActorVersionClient',
3942
'ActorVersionClientAsync',
4043
'ActorVersionCollectionClient',

src/apify_client/clients/resource_clients/actor.py renamed to src/apify_client/_resource_clients/actor.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,30 @@
33
from typing import TYPE_CHECKING, Any, Literal
44

55
from apify_client._models import Actor, Build, Run
6+
from apify_client._resource_clients.actor_version import ActorVersionClient, ActorVersionClientAsync
7+
from apify_client._resource_clients.actor_version_collection import (
8+
ActorVersionCollectionClient,
9+
ActorVersionCollectionClientAsync,
10+
)
11+
from apify_client._resource_clients.base import ResourceClient, ResourceClientAsync
12+
from apify_client._resource_clients.build import BuildClient, BuildClientAsync
13+
from apify_client._resource_clients.build_collection import (
14+
BuildCollectionClient,
15+
BuildCollectionClientAsync,
16+
)
17+
from apify_client._resource_clients.run import RunClient, RunClientAsync
18+
from apify_client._resource_clients.run_collection import RunCollectionClient, RunCollectionClientAsync
19+
from apify_client._resource_clients.webhook_collection import (
20+
WebhookCollectionClient,
21+
WebhookCollectionClientAsync,
22+
)
623
from apify_client._utils import (
724
encode_key_value_store_record_value,
825
encode_webhook_list_to_base64,
926
filter_out_none_values_recursively,
1027
maybe_extract_enum_member_value,
1128
pluck_data,
1229
)
13-
from apify_client.clients.base import ResourceClient, ResourceClientAsync
14-
from apify_client.clients.resource_clients.actor_version import ActorVersionClient, ActorVersionClientAsync
15-
from apify_client.clients.resource_clients.actor_version_collection import (
16-
ActorVersionCollectionClient,
17-
ActorVersionCollectionClientAsync,
18-
)
19-
from apify_client.clients.resource_clients.build import BuildClient, BuildClientAsync
20-
from apify_client.clients.resource_clients.build_collection import BuildCollectionClient, BuildCollectionClientAsync
21-
from apify_client.clients.resource_clients.run import RunClient, RunClientAsync
22-
from apify_client.clients.resource_clients.run_collection import RunCollectionClient, RunCollectionClientAsync
23-
from apify_client.clients.resource_clients.webhook_collection import (
24-
WebhookCollectionClient,
25-
WebhookCollectionClientAsync,
26-
)
2730

2831
if TYPE_CHECKING:
2932
from decimal import Decimal

src/apify_client/clients/resource_clients/actor_collection.py renamed to src/apify_client/_resource_clients/actor_collection.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
from typing import TYPE_CHECKING, Any, Literal
44

55
from apify_client._models import Actor, ActorShort
6+
from apify_client._resource_clients.actor import get_actor_representation
7+
from apify_client._resource_clients.base import ResourceCollectionClient, ResourceCollectionClientAsync
68
from apify_client._utils import filter_out_none_values_recursively
7-
from apify_client.clients.base import ResourceCollectionClient, ResourceCollectionClientAsync
8-
from apify_client.clients.resource_clients.actor import get_actor_representation
99

1010
if TYPE_CHECKING:
1111
from apify_client._types import ListPage

src/apify_client/clients/resource_clients/actor_env_var.py renamed to src/apify_client/_resource_clients/actor_env_var.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
from typing import Any
44

55
from apify_client._models import EnvVar
6+
from apify_client._resource_clients.base import ResourceClient, ResourceClientAsync
67
from apify_client._utils import filter_out_none_values_recursively
7-
from apify_client.clients.base import ResourceClient, ResourceClientAsync
88

99

1010
def get_actor_env_var_representation(

src/apify_client/clients/resource_clients/actor_env_var_collection.py renamed to src/apify_client/_resource_clients/actor_env_var_collection.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
from typing import TYPE_CHECKING, Any
44

55
from apify_client._models import EnvVar
6+
from apify_client._resource_clients.actor_env_var import get_actor_env_var_representation
7+
from apify_client._resource_clients.base import ResourceCollectionClient, ResourceCollectionClientAsync
68
from apify_client._utils import filter_out_none_values_recursively
7-
from apify_client.clients.base import ResourceCollectionClient, ResourceCollectionClientAsync
8-
from apify_client.clients.resource_clients.actor_env_var import get_actor_env_var_representation
99

1010
if TYPE_CHECKING:
1111
from apify_client._types import ListPage

src/apify_client/clients/resource_clients/actor_version.py renamed to src/apify_client/_resource_clients/actor_version.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
from typing import TYPE_CHECKING, Any
44

55
from apify_client._models import Version
6-
from apify_client._utils import filter_out_none_values_recursively, maybe_extract_enum_member_value
7-
from apify_client.clients.base import ResourceClient, ResourceClientAsync
8-
from apify_client.clients.resource_clients.actor_env_var import ActorEnvVarClient, ActorEnvVarClientAsync
9-
from apify_client.clients.resource_clients.actor_env_var_collection import (
6+
from apify_client._resource_clients.actor_env_var import ActorEnvVarClient, ActorEnvVarClientAsync
7+
from apify_client._resource_clients.actor_env_var_collection import (
108
ActorEnvVarCollectionClient,
119
ActorEnvVarCollectionClientAsync,
1210
)
11+
from apify_client._resource_clients.base import ResourceClient, ResourceClientAsync
12+
from apify_client._utils import filter_out_none_values_recursively, maybe_extract_enum_member_value
1313

1414
if TYPE_CHECKING:
1515
from apify_shared.consts import ActorSourceType

0 commit comments

Comments
 (0)