qhana_plugin_runner.api package

Submodules

• qhana_plugin_runner.api.extra_fields module
  • CSVList
  • EnumField
    • EnumField.default_error_messages
  • OneOfEnum
• qhana_plugin_runner.api.files_api module
  • FileSecurityTagSchema
    • FileSecurityTagSchema.opts
  • FileView
    • FileView.get()
    • FileView.methods
• qhana_plugin_runner.api.jwt_helper module
  • DemoUser
    • DemoUser.username
  • JWT
  • JWTMixin
    • JWTMixin.require_jwt()
  • JWT_REFRESH_SCHEME
  • JWT_SCHEME
  • loadUserObject()
  • load_user_identity()
  • on_expired_token()
  • on_invalid_token()
  • on_revoked_token()
  • on_stale_token()
  • on_unauthorized()
  • on_user_load_error()
  • register_jwt()
• qhana_plugin_runner.api.plugin_schemas module
  • ApiLink
    • ApiLink.href
    • ApiLink.type
  • ApiLinkSchema
    • ApiLinkSchema.make_api_link()
    • ApiLinkSchema.opts
  • DataMetadata
    • DataMetadata.content_type
    • DataMetadata.data_type
    • DataMetadata.required
  • DataMetadataSchema
    • DataMetadataSchema.opts
  • EntryPoint
    • EntryPoint.data_input
    • EntryPoint.data_output
    • EntryPoint.href
    • EntryPoint.plugin_dependencies
    • EntryPoint.ui_href
  • EntryPointSchema
    • EntryPointSchema.make_entry_point()
    • EntryPointSchema.opts
    • EntryPointSchema.unquote_url()
  • InputDataMetadata
    • InputDataMetadata.parameter
  • InputDataMetadataSchema
    • InputDataMetadataSchema.opts
  • OutputDataMetadata
    • OutputDataMetadata.name
  • OutputDataMetadataSchema
    • OutputDataMetadataSchema.opts
  • PluginDependencyMetadata
    • PluginDependencyMetadata.name
    • PluginDependencyMetadata.parameter
    • PluginDependencyMetadata.required
    • PluginDependencyMetadata.tags
    • PluginDependencyMetadata.type
    • PluginDependencyMetadata.version
  • PluginDependencyMetadataSchema
    • PluginDependencyMetadataSchema.opts
    • PluginDependencyMetadataSchema.remove_empty_attributes()
  • PluginMetadata
    • PluginMetadata.description
    • PluginMetadata.entry_point
    • PluginMetadata.links
    • PluginMetadata.name
    • PluginMetadata.tags
    • PluginMetadata.title
    • PluginMetadata.type
    • PluginMetadata.version
  • PluginMetadataSchema
    • PluginMetadataSchema.make_plugin_metadata()
    • PluginMetadataSchema.opts
  • PluginType
    • PluginType.conversion
    • PluginType.dataloader
    • PluginType.interaction
    • PluginType.processing
    • PluginType.visualization
  • ProgressMetadata
    • ProgressMetadata.start
    • ProgressMetadata.target
    • ProgressMetadata.unit
    • ProgressMetadata.value
  • ProgressMetadataSchema
    • ProgressMetadataSchema.opts
  • StepMetadata
    • StepMetadata.cleared
    • StepMetadata.href
    • StepMetadata.stepId
    • StepMetadata.uiHref
  • StepMetadataSchema
    • StepMetadataSchema.opts
  • WebhookParams
    • WebhookParams.event
    • WebhookParams.source
  • WebhookParamsSchema
    • WebhookParamsSchema.opts
• qhana_plugin_runner.api.plugins_api module
  • PluginCollectionData
    • PluginCollectionData.plugins
  • PluginCollectionSchema
    • PluginCollectionSchema.opts
  • PluginData
    • PluginData.api_root
    • PluginData.description
    • PluginData.identifier
    • PluginData.name
    • PluginData.tags
    • PluginData.version
  • PluginSchema
    • PluginSchema.opts
  • PluginView
    • PluginView.get()
    • PluginView.methods
  • PluginsView
    • PluginsView.get()
    • PluginsView.methods
• qhana_plugin_runner.api.tasks_api module
  • OutputDataMetadata
    • OutputDataMetadata.content_type
    • OutputDataMetadata.data_type
    • OutputDataMetadata.href
    • OutputDataMetadata.name
  • OutputDataMetadataSchema
    • OutputDataMetadataSchema.opts
    • OutputDataMetadataSchema.remove_empty_attributes()
  • SubscriptionDataSchema
    • SubscriptionDataSchema.opts
  • TaskData
    • TaskData.links
    • TaskData.log
    • TaskData.outputs
    • TaskData.progress
    • TaskData.status
    • TaskData.steps
  • TaskLink
    • TaskLink.href
    • TaskLink.type
  • TaskLinkSchema
    • TaskLinkSchema.opts
  • TaskStatusSchema
    • TaskStatusSchema.make_task_data()
    • TaskStatusSchema.opts
    • TaskStatusSchema.remove_empty_attributes()
  • TaskView
    • TaskView.convert_task_data()
    • TaskView.get()
    • TaskView.methods
    • TaskView.post()
    • TaskView.subscribe()
    • TaskView.unsubscribe()
• qhana_plugin_runner.api.util module
  • DataUrlValidator
    • DataUrlValidator.default_schemes
  • FileUrl
    • FileUrl.deserialize()
  • FileUrlValidator
    • FileUrlValidator.default_schemes
  • FrontendFormBaseSchema
    • FrontendFormBaseSchema.Meta
      • FrontendFormBaseSchema.Meta.ordered
    • FrontendFormBaseSchema.load()
    • FrontendFormBaseSchema.opts
  • HtmlResponseMixin
    • HtmlResponseMixin.html_response()
  • MaBaseSchema
    • MaBaseSchema.on_bind_field()
    • MaBaseSchema.opts
  • PluginUrl
    • PluginUrl.deserialize()
  • SecurityBlueprint
  • camelcase()

Module contents

Module containing all API related code of the project.

class qhana_plugin_runner.api.RootView

Bases: MethodView

get() → Dict[str, str]

Get the Root API information containing the links other endpoints of this api.

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.VersionsRootSchema(*, 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>

qhana_plugin_runner.api.register_root_api(app: Flask)

Register the API with the flask app.