Back to Prefect

plugins

docs/v3/api-ref/python/prefect-plugins.mdx

3.6.30.dev31.1 KB
Original Source

prefect.plugins

Utilities for loading plugins that extend Prefect's functionality.

Plugins are detected by entry point definitions in package setup files.

Currently supported entrypoints: - prefect.collections: Identifies this package as a Prefect collection that should be imported when Prefect is imported.

Functions

safe_load_entrypoints <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/plugins.py#L20" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
safe_load_entrypoints(entrypoints: EntryPoints) -> dict[str, Union[Exception, Any]]

Load entry points for a group capturing any exceptions that occur.

load_prefect_collections <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/plugins.py#L43" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
load_prefect_collections() -> dict[str, Union[ModuleType, Exception]]

Load all Prefect collections that define an entrypoint in the group prefect.collections.