entry_points¶
Load plugins through entry points.
This module deals with handling all plugged in strategies through the entry points API and importlib metadata API.
Special functionality is put in place to handle the OTE-API-specific entry points.
Since the entry points are information complete in and of themselves, there is no need to import actual strategy classes until they are truly needed. This therefore implements lazy loading of all plugin strategies.
EntryPointNotFound
¶
Bases: Exception
A given strategy implementation (class) cannot be found from the given entry point value.
Source code in oteapi/plugins/entry_points.py
55 56 57 |
|
EntryPointStrategy
¶
A strategy realized from an entry point.
An entry point strategy is made unique by its "strategy", i.e., its
(strategy type, strategy name)-tuple, e.g., ("download", "https")
.
This tuple can be retrieved from the
strategy
property,
where the strategy type is represented by the
StrategyType
enumeration.
Note
It may be that in the future an entry points strategy is made unique by
its "full name" instead, i.e., the entry point group + the entry points name,
e.g., oteapi.download:oteapi.https
.
This value can be retrieved from the
full_name
property.
This is a condition for uniqueness that is considered to be a superset of the current condition for uniqueness. It adds an extra package-specific uniqueness trait, allowing for different packages to implement the same strategies (which is currently not allowed according to the condition of uniqueness explained above).
Currently there is no consensus on the API for handling this added strategy ambiguity.
Raises:
Type | Description |
---|---|
ValueError
|
If the entry point name is not properly defined. |
Source code in oteapi/plugins/entry_points.py
163 164 165 166 167 168 169 170 171 172 173 174 175 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 213 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 278 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 316 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 |
|
ENTRY_POINT_NAME_REGEX = re.compile('^(?P<package_name>[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9._-]*[A-Za-z0-9])\\.(?P<strategy_name>.+)$')
class-attribute
instance-attribute
¶
Regex for entry point names.
The package_name group is a valid non-normalized package name regex adapted from PEP 508. For more information, see: https://peps.python.org/pep-0508/#names.
full_name: str
property
¶
The full entry point name.
implementation: IStrategyType
property
¶
The actual strategy implementation.
implementation_name: str
property
¶
The EntryPoint attr, which should be the strategy implementation class name.
module: str
property
¶
The fully resolved importable module path.
name: str
property
¶
The strategy name.
One part of the (strategy type, strategy name)-tuple.
package: str
property
¶
The importable base package name for the strategy plugin.
strategy: tuple[StrategyType, str]
property
¶
The unique index identifier for the strategy.
type: StrategyType
property
¶
The strategy type.
One part of the (strategy type, strategy name)-tuple.
EntryPointStrategyCollection
¶
Bases: Collection
A collection of
EntryPointStrategy
s.
Source code in oteapi/plugins/entry_points.py
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 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 400 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 431 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 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
|
add(*entry_points)
¶
Add entry points to the collection.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*entry_points |
Iterable[EntryPointStrategy]
|
Entry points to add to the collection. |
()
|
Source code in oteapi/plugins/entry_points.py
357 358 359 360 361 362 363 364 365 |
|
exclusive_add(*entry_points)
¶
Exclusively add entry points to the collection.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*entry_points |
Iterable[EntryPointStrategy]
|
Entry points to add to the collection. |
()
|
Raises:
Type | Description |
---|---|
KeyError
|
If an entry point to be added already exists in the collection. |
Source code in oteapi/plugins/entry_points.py
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
|
get_entry_point(key)
¶
Retrieve an entry point from the collection.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
Union[EntryPointStrategy, str, tuple[Union[StrategyType, str], str]]
|
The key to check for in the collection. |
required |
Raises:
Type | Description |
---|---|
KeyError
|
If an entry point cannot be found in the collection. |
TypeError
|
If the |
Returns:
Type | Description |
---|---|
EntryPointStrategy
|
An entry point in the collection representing the key. |
Source code in oteapi/plugins/entry_points.py
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
|
remove(*entry_points)
¶
Remove entry points from the collection.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*entry_points |
Iterable[EntryPointStrategy]
|
Entry points to remove from the collection. |
()
|
Source code in oteapi/plugins/entry_points.py
367 368 369 370 371 372 373 374 375 |
|
StrategyType
¶
Bases: Enum
An enumeration of available strategy types.
Available strategy types:
- download
- filter
- function
- mapping
- parse
- resource
- transformation
Source code in oteapi/plugins/entry_points.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 157 158 159 160 |
|
config_cls: StrategyConfigType
property
¶
Return the strategy-specific *Config
class.
all_values()
classmethod
¶
Return all values.
Source code in oteapi/plugins/entry_points.py
138 139 140 141 |
|
init(value)
classmethod
¶
Initialize a StrategyType with more than just the enumeration value.
This method allows one to also initialize a StrategyType with an actual
strategy type string, e.g., scheme
, mediaType
, etc.
Raises:
Type | Description |
---|---|
ValueError
|
As normal if the enumeration value is not valid. |
Source code in oteapi/plugins/entry_points.py
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
|
map_from_field(strategy_type_field)
classmethod
¶
Map the strategy type's field to enumeration.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strategy_type_field |
str
|
The strategy type's field. E.g., |
required |
Raises:
Type | Description |
---|---|
KeyError
|
If the |
Returns:
Type | Description |
---|---|
StrategyType
|
An enumeration instance representing the strategy type's field. |
Source code in oteapi/plugins/entry_points.py
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
|
map_to_field()
¶
Map enumeration value to the strategy type's field.
Source code in oteapi/plugins/entry_points.py
83 84 85 86 87 88 89 90 91 92 93 |
|
get_strategy_entry_points(strategy_type, enforce_uniqueness=True)
¶
Retrieve all entry points from a specific strategy type.
Raises:
Type | Description |
---|---|
ValueError
|
If the strategy type is not supported. |
KeyError
|
If |
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strategy_type |
Union[StrategyType, str]
|
A strategy type for which the entry points will be retrieved. |
required |
enforce_uniqueness |
bool
|
Whether or not duplicate entry point strategies are
allowed. Defaults to |
True
|
Returns:
Type | Description |
---|---|
EntryPointStrategyCollection
|
A collection of entry points for the specific strategy type. |
Source code in oteapi/plugins/entry_points.py
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
|