Base Worker¶
arkindex_worker.worker.base ¶
The base class for all Arkindex workers.
Classes¶
BaseWorker ¶
BaseWorker(
description="Arkindex Base Worker", support_cache=False
)
Bases: object
Base class for Arkindex workers.
Initialize the worker.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
description |
Optional[str]
|
Description shown in the |
'Arkindex Base Worker'
|
support_cache |
Optional[bool]
|
Whether or not this worker supports the cache database. Override the constructor and set this parameter to start using the cache database. |
False
|
Source code in arkindex_worker/worker/base.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
|
Attributes¶
is_read_only
property
¶
is_read_only: bool
Whether or not the worker can publish data.
False when dev mode is enabled with the --dev
CLI argument,
when no worker run ID is provided
Functions¶
setup_api_client ¶
setup_api_client()
Create an ArkindexClient to make API requests towards Arkindex instances.
Source code in arkindex_worker/worker/base.py
168 169 170 171 172 173 174 |
|
configure_for_developers ¶
configure_for_developers()
Setup the necessary configuration needed when working in read_only
mode.
This is the method called when running a worker locally.
Source code in arkindex_worker/worker/base.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
|
configure ¶
configure()
Setup the necessary configuration needed using CLI args and environment variables. This is the method called when running a worker on Arkindex.
Source code in arkindex_worker/worker/base.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
|
configure_cache ¶
configure_cache()
Setup the necessary attribute when using the cache system of Base-Worker
.
Source code in arkindex_worker/worker/base.py
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
|
load_secret ¶
load_secret(name)
Load a Ponos secret by name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
Path
|
Name of the Ponos secret. |
required |
Raises:
Type | Description |
---|---|
Exception
|
When the secret cannot be loaded from the API nor the local secrets directory. |
Source code in arkindex_worker/worker/base.py
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
|
find_model_directory ¶
find_model_directory()
Find the local path to the model. This supports two modes:
- the worker runs in ponos, the model is available at /data/extra_files
(first try) or /data/current
.
- the worker runs locally, the developer may specify it using either
- the model_dir
configuration parameter
- the --model-dir
CLI parameter
Returns:
Type | Description |
---|---|
Path
|
Path to the model on disk |
Source code in arkindex_worker/worker/base.py
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 |
|
find_parents_file_paths ¶
find_parents_file_paths(filename)
Find the paths of a specific file from the parent tasks. Only works if the task_parents attributes is updated, so if the cache is supported, if the task ID is set and if no database is passed as argument
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filename |
Path
|
Name of the file to find |
required |
Returns:
Type | Description |
---|---|
List[Path]
|
Paths to the parent files |
Source code in arkindex_worker/worker/base.py
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
|
extract_parent_archives ¶
extract_parent_archives(archive_name, dest)
Find and extract the paths from a specific file from the parent tasks. Only works if the task_parents attributes is updated, so if the cache is supported, if the task ID is set and if no database is passed as argument
Parameters:
Name | Type | Description | Default |
---|---|---|---|
archive_name |
Path
|
Name of the file to find |
required |
dest |
Path
|
Folder to store the extracted files |
required |
Source code in arkindex_worker/worker/base.py
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 |
|
request ¶
request(*args, **kwargs)
Wrapper around the ArkindexClient.request
method.
The API call will be retried up to 5 times in case of HTTP 5xx errors, with an exponential sleep time of 3, 4, 8 and 16 seconds between calls. If the 5th call still causes an HTTP 5xx error, the exception is re-raised and the caller should catch it.
Log messages are displayed when an HTTP 5xx error occurs, before waiting for the next call.
Source code in arkindex_worker/worker/base.py
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
|
add_arguments ¶
add_arguments()
Override this method to add argparse
arguments to this worker
Source code in arkindex_worker/worker/base.py
487 488 |
|
run ¶
run()
Override this method to implement your own process
Source code in arkindex_worker/worker/base.py
490 491 |
|