|
2 | 2 |
|
3 | 3 | import re |
4 | 4 | from datetime import timedelta |
| 5 | +from enum import Enum, StrEnum |
| 6 | +from typing import Literal, get_args |
5 | 7 |
|
6 | 8 | EVENT_LISTENERS_TIMEOUT = timedelta(seconds=5) |
7 | 9 |
|
|
11 | 13 | ENCRYPTED_INPUT_VALUE_REGEXP = re.compile( |
12 | 14 | f'^({ENCRYPTED_STRING_VALUE_PREFIX}|{ENCRYPTED_JSON_VALUE_PREFIX}):(?:({BASE64_REGEXP}):)?({BASE64_REGEXP}):({BASE64_REGEXP})$' |
13 | 15 | ) |
| 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 | +) |
0 commit comments