qhana_plugin_runner.api.plugin_schemas module

Module containing schemas to be used by plugins.

class qhana_plugin_runner.api.plugin_schemas.ApiLink(type: str, href: str)

Bases: object

href: str

type: str

class qhana_plugin_runner.api.plugin_schemas.ApiLinkSchema(*, 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

make_api_link(data: Dict[str, Any], **kwargs)

Create a ApiLink object from the deserialized data.

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

class qhana_plugin_runner.api.plugin_schemas.DataMetadata(data_type: str, content_type: List[str], required: bool)

Bases: object

content_type: List[str]

data_type: str

required: bool

class qhana_plugin_runner.api.plugin_schemas.DataMetadataSchema(*, 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.plugin_schemas.EntryPoint(href: str, ui_href: str, data_input: List[qhana_plugin_runner.api.plugin_schemas.InputDataMetadata] = <factory>, data_output: List[Union[qhana_plugin_runner.api.plugin_schemas.OutputDataMetadata, qhana_plugin_runner.api.plugin_schemas.DataMetadata]] = <factory>, plugin_dependencies: List[qhana_plugin_runner.api.plugin_schemas.PluginDependencyMetadata] = <factory>)

Bases: object

data_input: List[InputDataMetadata]

data_output: List[OutputDataMetadata | DataMetadata]

href: str

plugin_dependencies: List[PluginDependencyMetadata]

ui_href: str

class qhana_plugin_runner.api.plugin_schemas.EntryPointSchema(*, 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

make_entry_point(data: Dict[str, Any], **kwargs)

Create a EntryPoint object from the deserialized data.

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

unquote_url(data: Dict[str, Any], **kwargs)

Unquote the url.

class qhana_plugin_runner.api.plugin_schemas.InputDataMetadata(data_type: str, content_type: List[str], required: bool, parameter: str)

Bases: DataMetadata

parameter: str

class qhana_plugin_runner.api.plugin_schemas.InputDataMetadataSchema(*, 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: DataMetadataSchema

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

class qhana_plugin_runner.api.plugin_schemas.OutputDataMetadata(data_type: str, content_type: List[str], required: bool, name: str | None)

Bases: DataMetadata

name: str | None

class qhana_plugin_runner.api.plugin_schemas.OutputDataMetadataSchema(*, 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: DataMetadataSchema

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

class qhana_plugin_runner.api.plugin_schemas.PluginDependencyMetadata(parameter: str, required: bool, name: str | None = None, version: str | None = None, tags: List[str] | None = None, type: PluginType | None = None)

Bases: object

name: str | None = None

parameter: str

required: bool

tags: List[str] | None = None

type: PluginType | None = None

version: str | None = None

class qhana_plugin_runner.api.plugin_schemas.PluginDependencyMetadataSchema(*, 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>

remove_empty_attributes(data: Dict[str, Any], **kwargs)

Remove result attributes from serialized tasks that have not finished.

class qhana_plugin_runner.api.plugin_schemas.PluginMetadata(title: str, description: str, name: str, version: str, type: Literal[<PluginType.processing: 'processing'>, <PluginType.visualization: 'visualization'>, <PluginType.conversion: 'conversion'>, <PluginType.interaction: 'interaction'>], entry_point: qhana_plugin_runner.api.plugin_schemas.EntryPoint, tags: List[str] = <factory>, links: List[qhana_plugin_runner.api.plugin_schemas.ApiLink] = <factory>)

Bases: object

description: str

entry_point: EntryPoint

links: List[ApiLink]

name: str

tags: List[str]

title: str

type: interaction: 'interaction'>]

version: str

class qhana_plugin_runner.api.plugin_schemas.PluginMetadataSchema(*, 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

make_plugin_metadata(data: Dict[str, Any], **kwargs)

Create a PluginMetadata object from the deserialized data.

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

class qhana_plugin_runner.api.plugin_schemas.PluginType(value)

Bases: Enum

Type of the plugin.

• processing: type for processing data (data comes in, processed data comes out)

• visualization: type for visualizing data (used as data previews)

• conversion: type for converting between data (and content) types

• dataloader: type for loading data into the qhana ecosystem

• interaction: type for plugins that do not handle data but provide user interaction

conversion = 'conversion'

dataloader = 'dataloader'

interaction = 'interaction'

processing = 'processing'

visualization = 'visualization'

class qhana_plugin_runner.api.plugin_schemas.ProgressMetadata(value: int, start: int = 0, target: int = 100, unit: str = '%')

Bases: object

start: int = 0

target: int = 100

unit: str = '%'

value: int

class qhana_plugin_runner.api.plugin_schemas.ProgressMetadataSchema(*, 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.plugin_schemas.StepMetadata(href: str, uiHref: str, stepId: str, cleared: bool = False)

Bases: object

cleared: bool = False

href: str

stepId: str

uiHref: str

class qhana_plugin_runner.api.plugin_schemas.StepMetadataSchema(*, 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.plugin_schemas.WebhookParams

Bases: TypedDict

Parameters passed as query params to webhooks subscribed to task updates.

Keys:

source (str): The url of the task result that was updated. event (str|None): The type of event that triggered this update. (i.e. ‘status’|’steps’|’details’)

event: str | None

source: str

class qhana_plugin_runner.api.plugin_schemas.WebhookParamsSchema(*, 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

Parameters passed as query params to webhooks subscribed to task updates.

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