pyplugs

Decorators

@register(*, sort_value: float) → Callable[[Callable[[...], Any]], Callable[[...], Any]]

@register(func: Callable[[...], Any]) → Callable[[...], Any]

Decorator for registering a new plug-in

@task_nout(nout: int) → Callable[[Callable[[...], Any]], dioptra.pyplugs._plugins.NoutPlugin]

Methods

names(package: str) → List[str]

List all plug-ins in one package

funcs(package: str, plugin: str) → List[str]

List all functions in one plug-in

info(package: str, plugin: str, func: Optional[str] = None) → dioptra.pyplugs._plugins.PluginInfo

Get information about a plug-in

exists(package: str, plugin: str) → bool

Check if a given plugin exists

get(package: str, plugin: str, func: Optional[str] = None) → Callable[[...], Any]

Get a given plugin

call(package: str, plugin: str, func: Optional[str] = None, *args: Any, **kwargs: Any) → Any

Call the given plugin

get_task(package: str, plugin: str, func: Optional[str] = None) → FunctionTask

Get a given plugin wrapped as a prefect task

call_task(package: str, plugin: str, func: Optional[str] = None, *args: Any, **kwargs: Any) → Any

Call the given plugin as a prefect task

Method Factories

names_factory(package: str) → Callable[[], List[str]]

Create a names() function for one package

funcs_factory(package: str) → Callable[[str], List[str]]

Create a funcs() function for one package

info_factory(package: str) → Callable[[str, Optional[str]], dioptra.pyplugs._plugins.PluginInfo]

Create a info() function for one package

exists_factory(package: str) → Callable[[str], bool]

Create an exists() function for one package

get_factory(package: str) → Callable[[str, Optional[str]], Callable[[...], Any]]

Create a get() function for one package

call_factory(package: str) → Callable[[...], Any]

Create a call() function for one package

get_task_factory(package: str) → Callable[[str, Optional[str]], FunctionTask]

Create a get_task() function for one package

call_task_factory(package: str) → Callable[[...], Any]

Create a call_task() function for one package