Skip to content

Commit 5f46e3f

Browse files
vdusekclaude
andcommitted
Remove apify-shared dependency, define constants locally
Move ActorEnvVars, ApifyEnvVars, ActorExitCodes, ActorEventTypes, and env var type classification lists from apify-shared into apify._consts. Update all imports across src/ and tests/. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 56c6514 commit 5f46e3f

21 files changed

Lines changed: 192 additions & 42 deletions

‎pyproject.toml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ keywords = [
3535
]
3636
dependencies = [
3737
"apify-client @ git+https://github.com/apify/apify-client-python.git@master",
38-
"apify-shared>=2.0.0,<3.0.0",
3938
"crawlee>=1.0.4,<2.0.0",
4039
"cachetools>=5.5.0",
4140
"cryptography>=42.0.0",
@@ -187,7 +186,7 @@ builtins-ignorelist = ["id"]
187186

188187
[tool.ruff.lint.isort]
189188
known-local-folder = ["apify"]
190-
known-first-party = ["apify_client", "apify_shared", "crawlee"]
189+
known-first-party = ["apify_client", "crawlee"]
191190

192191
[tool.ruff.lint.pylint]
193192
max-branches = 18

‎src/apify/_actor.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
from pydantic import AliasChoices
1414

1515
from apify_client import ApifyClientAsync
16-
from apify_shared.consts import ActorEnvVars, ActorExitCodes, ApifyEnvVars
1716
from crawlee import service_locator
1817
from crawlee.errors import ServiceConflictError
1918
from crawlee.events import (
@@ -28,7 +27,7 @@
2827

2928
from apify._charging import DEFAULT_DATASET_ITEM_EVENT, ChargeResult, ChargingManager, ChargingManagerImplementation
3029
from apify._configuration import Configuration
31-
from apify._consts import EVENT_LISTENERS_TIMEOUT
30+
from apify._consts import EVENT_LISTENERS_TIMEOUT, ActorEnvVars, ActorExitCodes, ApifyEnvVars
3231
from apify._crypto import decrypt_input_secrets, load_private_key
3332
from apify._models import ActorRun
3433
from apify._proxy_configuration import ProxyConfiguration

‎src/apify/_consts.py‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
import re
44
from datetime import timedelta
5+
from enum import Enum, StrEnum
6+
from typing import Literal, get_args
57

68
EVENT_LISTENERS_TIMEOUT = timedelta(seconds=5)
79

@@ -11,3 +13,166 @@
1113
ENCRYPTED_INPUT_VALUE_REGEXP = re.compile(
1214
f'^({ENCRYPTED_STRING_VALUE_PREFIX}|{ENCRYPTED_JSON_VALUE_PREFIX}):(?:({BASE64_REGEXP}):)?({BASE64_REGEXP}):({BASE64_REGEXP})$'
1315
)
16+
17+
18+
class ActorEventTypes(StrEnum):
19+
"""Event types that can be sent to Actors during execution."""
20+
21+
SYSTEM_INFO = 'systemInfo'
22+
MIGRATING = 'migrating'
23+
PERSIST_STATE = 'persistState'
24+
ABORTING = 'aborting'
25+
26+
27+
class ActorEnvVars(StrEnum):
28+
"""Environment variables with ACTOR_ prefix set by the Apify platform."""
29+
30+
BUILD_ID = 'ACTOR_BUILD_ID'
31+
BUILD_NUMBER = 'ACTOR_BUILD_NUMBER'
32+
BUILD_TAGS = 'ACTOR_BUILD_TAGS'
33+
DEFAULT_DATASET_ID = 'ACTOR_DEFAULT_DATASET_ID'
34+
DEFAULT_KEY_VALUE_STORE_ID = 'ACTOR_DEFAULT_KEY_VALUE_STORE_ID'
35+
DEFAULT_REQUEST_QUEUE_ID = 'ACTOR_DEFAULT_REQUEST_QUEUE_ID'
36+
EVENTS_WEBSOCKET_URL = 'ACTOR_EVENTS_WEBSOCKET_URL'
37+
FULL_NAME = 'ACTOR_FULL_NAME'
38+
ID = 'ACTOR_ID'
39+
INPUT_KEY = 'ACTOR_INPUT_KEY'
40+
MAX_PAID_DATASET_ITEMS = 'ACTOR_MAX_PAID_DATASET_ITEMS'
41+
MAX_TOTAL_CHARGE_USD = 'ACTOR_MAX_TOTAL_CHARGE_USD'
42+
MEMORY_MBYTES = 'ACTOR_MEMORY_MBYTES'
43+
PERMISSION_LEVEL = 'ACTOR_PERMISSION_LEVEL'
44+
RUN_ID = 'ACTOR_RUN_ID'
45+
STANDBY_PORT = 'ACTOR_STANDBY_PORT'
46+
STANDBY_URL = 'ACTOR_STANDBY_URL'
47+
STARTED_AT = 'ACTOR_STARTED_AT'
48+
TASK_ID = 'ACTOR_TASK_ID'
49+
TIMEOUT_AT = 'ACTOR_TIMEOUT_AT'
50+
WEB_SERVER_PORT = 'ACTOR_WEB_SERVER_PORT'
51+
WEB_SERVER_URL = 'ACTOR_WEB_SERVER_URL'
52+
53+
54+
class ApifyEnvVars(StrEnum):
55+
"""Environment variables with APIFY_ prefix set by the Apify platform."""
56+
57+
API_BASE_URL = 'APIFY_API_BASE_URL'
58+
API_PUBLIC_BASE_URL = 'APIFY_API_PUBLIC_BASE_URL'
59+
DEDICATED_CPUS = 'APIFY_DEDICATED_CPUS'
60+
DEFAULT_BROWSER_PATH = 'APIFY_DEFAULT_BROWSER_PATH'
61+
DISABLE_BROWSER_SANDBOX = 'APIFY_DISABLE_BROWSER_SANDBOX'
62+
DISABLE_OUTDATED_WARNING = 'APIFY_DISABLE_OUTDATED_WARNING'
63+
FACT = 'APIFY_FACT'
64+
HEADLESS = 'APIFY_HEADLESS'
65+
INPUT_SECRETS_PRIVATE_KEY_FILE = 'APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE'
66+
INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE = 'APIFY_INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE'
67+
IS_AT_HOME = 'APIFY_IS_AT_HOME'
68+
LOCAL_STORAGE_DIR = 'APIFY_LOCAL_STORAGE_DIR'
69+
LOG_FORMAT = 'APIFY_LOG_FORMAT'
70+
LOG_LEVEL = 'APIFY_LOG_LEVEL'
71+
MAX_USED_CPU_RATIO = 'APIFY_MAX_USED_CPU_RATIO'
72+
META_ORIGIN = 'APIFY_META_ORIGIN'
73+
METAMORPH_AFTER_SLEEP_MILLIS = 'APIFY_METAMORPH_AFTER_SLEEP_MILLIS'
74+
PERSIST_STATE_INTERVAL_MILLIS = 'APIFY_PERSIST_STATE_INTERVAL_MILLIS'
75+
PERSIST_STORAGE = 'APIFY_PERSIST_STORAGE'
76+
PROXY_HOSTNAME = 'APIFY_PROXY_HOSTNAME'
77+
PROXY_PASSWORD = 'APIFY_PROXY_PASSWORD'
78+
PROXY_PORT = 'APIFY_PROXY_PORT'
79+
PROXY_STATUS_URL = 'APIFY_PROXY_STATUS_URL'
80+
PURGE_ON_START = 'APIFY_PURGE_ON_START'
81+
SDK_LATEST_VERSION = 'APIFY_SDK_LATEST_VERSION'
82+
SYSTEM_INFO_INTERVAL_MILLIS = 'APIFY_SYSTEM_INFO_INTERVAL_MILLIS'
83+
TOKEN = 'APIFY_TOKEN'
84+
USER_ID = 'APIFY_USER_ID'
85+
USER_IS_PAYING = 'APIFY_USER_IS_PAYING'
86+
WORKFLOW_KEY = 'APIFY_WORKFLOW_KEY'
87+
88+
89+
class ActorExitCodes(int, Enum):
90+
"""Standard exit codes used by Actors to indicate run completion status."""
91+
92+
SUCCESS = 0
93+
ERROR_USER_FUNCTION_THREW = 91
94+
95+
96+
# Environment variable type classification lists.
97+
98+
INTEGER_ENV_VARS_TYPE = Literal[
99+
ActorEnvVars.MAX_PAID_DATASET_ITEMS,
100+
ActorEnvVars.MEMORY_MBYTES,
101+
ActorEnvVars.STANDBY_PORT,
102+
ActorEnvVars.WEB_SERVER_PORT,
103+
ApifyEnvVars.DEDICATED_CPUS,
104+
ApifyEnvVars.LOG_LEVEL,
105+
ApifyEnvVars.METAMORPH_AFTER_SLEEP_MILLIS,
106+
ApifyEnvVars.PERSIST_STATE_INTERVAL_MILLIS,
107+
ApifyEnvVars.PROXY_PORT,
108+
ApifyEnvVars.SYSTEM_INFO_INTERVAL_MILLIS,
109+
]
110+
111+
INTEGER_ENV_VARS: list[INTEGER_ENV_VARS_TYPE] = list(get_args(INTEGER_ENV_VARS_TYPE))
112+
113+
FLOAT_ENV_VARS_TYPE = Literal[
114+
ActorEnvVars.MAX_TOTAL_CHARGE_USD,
115+
ApifyEnvVars.MAX_USED_CPU_RATIO,
116+
]
117+
118+
FLOAT_ENV_VARS: list[FLOAT_ENV_VARS_TYPE] = list(get_args(FLOAT_ENV_VARS_TYPE))
119+
120+
BOOL_ENV_VARS_TYPE = Literal[
121+
ApifyEnvVars.DISABLE_BROWSER_SANDBOX,
122+
ApifyEnvVars.DISABLE_OUTDATED_WARNING,
123+
ApifyEnvVars.HEADLESS,
124+
ApifyEnvVars.IS_AT_HOME,
125+
ApifyEnvVars.PERSIST_STORAGE,
126+
ApifyEnvVars.PURGE_ON_START,
127+
ApifyEnvVars.USER_IS_PAYING,
128+
]
129+
130+
BOOL_ENV_VARS: list[BOOL_ENV_VARS_TYPE] = list(get_args(BOOL_ENV_VARS_TYPE))
131+
132+
DATETIME_ENV_VARS_TYPE = Literal[
133+
ActorEnvVars.STARTED_AT,
134+
ActorEnvVars.TIMEOUT_AT,
135+
]
136+
137+
DATETIME_ENV_VARS: list[DATETIME_ENV_VARS_TYPE] = list(get_args(DATETIME_ENV_VARS_TYPE))
138+
139+
STRING_ENV_VARS_TYPE = Literal[
140+
ActorEnvVars.BUILD_ID,
141+
ActorEnvVars.BUILD_NUMBER,
142+
ActorEnvVars.DEFAULT_DATASET_ID,
143+
ActorEnvVars.DEFAULT_KEY_VALUE_STORE_ID,
144+
ActorEnvVars.DEFAULT_REQUEST_QUEUE_ID,
145+
ActorEnvVars.EVENTS_WEBSOCKET_URL,
146+
ActorEnvVars.FULL_NAME,
147+
ActorEnvVars.ID,
148+
ActorEnvVars.INPUT_KEY,
149+
ActorEnvVars.PERMISSION_LEVEL,
150+
ActorEnvVars.RUN_ID,
151+
ActorEnvVars.STANDBY_URL,
152+
ActorEnvVars.TASK_ID,
153+
ActorEnvVars.WEB_SERVER_URL,
154+
ApifyEnvVars.API_BASE_URL,
155+
ApifyEnvVars.API_PUBLIC_BASE_URL,
156+
ApifyEnvVars.DEFAULT_BROWSER_PATH,
157+
ApifyEnvVars.FACT,
158+
ApifyEnvVars.INPUT_SECRETS_PRIVATE_KEY_FILE,
159+
ApifyEnvVars.INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE,
160+
ApifyEnvVars.LOCAL_STORAGE_DIR,
161+
ApifyEnvVars.LOG_FORMAT,
162+
ApifyEnvVars.META_ORIGIN,
163+
ApifyEnvVars.PROXY_HOSTNAME,
164+
ApifyEnvVars.PROXY_PASSWORD,
165+
ApifyEnvVars.PROXY_STATUS_URL,
166+
ApifyEnvVars.SDK_LATEST_VERSION,
167+
ApifyEnvVars.TOKEN,
168+
ApifyEnvVars.USER_ID,
169+
ApifyEnvVars.WORKFLOW_KEY,
170+
]
171+
172+
STRING_ENV_VARS: list[STRING_ENV_VARS_TYPE] = list(get_args(STRING_ENV_VARS_TYPE))
173+
174+
COMMA_SEPARATED_LIST_ENV_VARS_TYPE = Literal[ActorEnvVars.BUILD_TAGS]
175+
176+
COMMA_SEPARATED_LIST_ENV_VARS: list[COMMA_SEPARATED_LIST_ENV_VARS_TYPE] = list(
177+
get_args(COMMA_SEPARATED_LIST_ENV_VARS_TYPE)
178+
)

‎src/apify/_proxy_configuration.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
import impit
1212
from yarl import URL
1313

14-
from apify_shared.consts import ApifyEnvVars
1514
from crawlee.proxy_configuration import ProxyConfiguration as CrawleeProxyConfiguration
1615
from crawlee.proxy_configuration import ProxyInfo as CrawleeProxyInfo
1716
from crawlee.proxy_configuration import _NewUrlFunction
1817

1918
from apify._configuration import Configuration
19+
from apify._consts import ApifyEnvVars
2020
from apify._utils import docs_group
2121
from apify.log import logger
2222

‎tests/e2e/conftest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515

1616
from apify_client import ApifyClient, ApifyClientAsync
1717
from apify_client._models import ActorPermissionLevel, VersionSourceType
18-
from apify_shared.consts import ApifyEnvVars
1918
from crawlee import service_locator
2019

2120
import apify._actor
2221
from ._utils import generate_unique_resource_name
22+
from apify._consts import ApifyEnvVars
2323
from apify._models import ActorRun
2424
from apify.storage_clients._apify._alias_resolving import AliasResolver
2525

‎tests/e2e/test_actor_api_helpers.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ async def test_actor_creates_new_client_instance(
6363
async def main() -> None:
6464
import os
6565

66-
from apify_shared.consts import ActorEnvVars
66+
from apify._consts import ActorEnvVars
6767

6868
async with Actor:
6969
new_client = Actor.new_client()
@@ -316,7 +316,7 @@ async def test_actor_metamorphs_into_another_actor(
316316
async def main_inner() -> None:
317317
import os
318318

319-
from apify_shared.consts import ActorEnvVars
319+
from apify._consts import ActorEnvVars
320320

321321
async with Actor:
322322
assert os.getenv(ActorEnvVars.INPUT_KEY) is not None
@@ -414,7 +414,7 @@ async def main_server() -> None:
414414
import os
415415
from http.server import BaseHTTPRequestHandler, HTTPServer
416416

417-
from apify_shared.consts import ActorEnvVars
417+
from apify._consts import ActorEnvVars
418418

419419
webhook_body = ''
420420

‎tests/e2e/test_actor_events.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
import asyncio
44
from typing import TYPE_CHECKING
55

6-
from apify_shared.consts import ActorEventTypes
7-
86
from apify import Actor
7+
from apify._consts import ActorEventTypes
98

109
if TYPE_CHECKING:
1110
from .conftest import MakeActorFunction, RunActorFunction
@@ -22,9 +21,10 @@ async def main() -> None:
2221
from datetime import datetime
2322
from typing import Any
2423

25-
from apify_shared.consts import ActorEventTypes, ApifyEnvVars
2624
from crawlee.events._types import Event, EventSystemInfoData
2725

26+
from apify._consts import ActorEventTypes, ApifyEnvVars
27+
2828
os.environ[ApifyEnvVars.PERSIST_STATE_INTERVAL_MILLIS] = '900'
2929

3030
was_system_info_emitted = False
@@ -81,9 +81,10 @@ async def main() -> None:
8181
import os
8282
from typing import Any
8383

84-
from apify_shared.consts import ApifyEnvVars
8584
from crawlee.events._types import Event
8685

86+
from apify._consts import ApifyEnvVars
87+
8788
os.environ[ApifyEnvVars.PERSIST_STATE_INTERVAL_MILLIS] = '100'
8889

8990
counter = 0

‎tests/e2e/test_fixtures.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ async def test_actor_from_main_func(
2020
async def main() -> None:
2121
import os
2222

23-
from apify_shared.consts import ActorEnvVars
23+
from apify._consts import ActorEnvVars
2424

2525
async with Actor:
2626
await Actor.set_value('OUTPUT', os.getenv(ActorEnvVars.ID))

‎tests/integration/conftest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
import pytest
77

88
from apify_client import ApifyClientAsync
9-
from apify_shared.consts import ApifyEnvVars
109
from crawlee import service_locator
1110

1211
import apify._actor
1312
from apify import Actor
13+
from apify._consts import ApifyEnvVars
1414
from apify.storage_clients import ApifyStorageClient
1515
from apify.storage_clients._apify._alias_resolving import AliasResolver
1616
from apify.storages import RequestQueue

‎tests/integration/test_dataset.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@
44

55
import pytest
66

7-
from apify_shared.consts import ApifyEnvVars
8-
97
from ._utils import generate_unique_resource_name
108
from apify import Actor
9+
from apify._consts import ApifyEnvVars
1110
from apify.storage_clients import ApifyStorageClient
1211
from apify.storages import Dataset
1312

0 commit comments

Comments
 (0)