qhana_plugin_runner.api.plugins_api module

Module containing the endpoints related to plugins.

class qhana_plugin_runner.api.plugins_api.PluginCollectionData(plugins: List[PluginData])

Bases: object

plugins: List[PluginData]

class qhana_plugin_runner.api.plugins_api.PluginCollectionSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qhana_plugin_runner.api.plugins_api.PluginData(name: str, version: str, identifier: str, api_root: str | None, description: str, tags: List[str])

Bases: object

api_root: str | None

description: str

identifier: str

name: str

tags: List[str]

version: str

class qhana_plugin_runner.api.plugins_api.PluginSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qhana_plugin_runner.api.plugins_api.PluginView

Bases: MethodView

Generic fallback plugins view.

get(plugin: str)

Redirect to the newest version of a plugin.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qhana_plugin_runner.api.plugins_api.PluginsView

Bases: MethodView

Plugins collection resource.

get()

Get all loaded plugins.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.