pyplugs#

Decorators#

@register(*, sort_value: float) Callable[[Callable[[...], Any]], Callable[[...], Any]][source]#
@register(func: Callable[[...], Any]) Callable[[...], Any]

Decorator for registering a new plug-in

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

Methods#

names(package: str) List[str][source]#

List all plug-ins in one package

funcs(package: str, plugin: str) List[str][source]#

List all functions in one plug-in

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

Get information about a plug-in

exists(package: str, plugin: str) bool[source]#

Check if a given plugin exists

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

Get a given plugin

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

Call the given plugin

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

Get a given plugin wrapped as a prefect task

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

Call the given plugin as a prefect task

Method Factories#

names_factory(package: str) Callable[[], List[str]][source]#

Create a names() function for one package

funcs_factory(package: str) Callable[[str], List[str]][source]#

Create a funcs() function for one package

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

Create a info() function for one package

exists_factory(package: str) Callable[[str], bool][source]#

Create an exists() function for one package

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

Create a get() function for one package

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

Create a call() function for one package

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

Create a get_task() function for one package

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

Create a call_task() function for one package