qhana_plugin_runner package

Subpackages

• qhana_plugin_runner.api package
  • Submodules
    • qhana_plugin_runner.api.extra_fields module
      • CSVList
      • EnumField
      • OneOfEnum
    • qhana_plugin_runner.api.files_api module
      • FileSecurityTagSchema
      • FileView
    • qhana_plugin_runner.api.jwt_helper module
      • DemoUser
      • JWT
      • JWTMixin
      • 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
      • ApiLinkSchema
      • DataMetadata
      • DataMetadataSchema
      • EntryPoint
      • EntryPointSchema
      • InputDataMetadata
      • InputDataMetadataSchema
      • OutputDataMetadata
      • OutputDataMetadataSchema
      • PluginDependencyMetadata
      • PluginDependencyMetadataSchema
      • PluginMetadata
      • PluginMetadataSchema
      • PluginType
      • ProgressMetadata
      • ProgressMetadataSchema
      • StepMetadata
      • StepMetadataSchema
      • WebhookParams
      • WebhookParamsSchema
    • qhana_plugin_runner.api.plugins_api module
      • PluginCollectionData
      • PluginCollectionSchema
      • PluginData
      • PluginSchema
      • PluginView
      • PluginsView
    • qhana_plugin_runner.api.tasks_api module
      • OutputDataMetadata
      • OutputDataMetadataSchema
      • SubscriptionDataSchema
      • TaskData
      • TaskLink
      • TaskLinkSchema
      • TaskStatusSchema
      • TaskView
    • qhana_plugin_runner.api.util module
      • DataUrlValidator
      • FileUrl
      • FileUrlValidator
      • FrontendFormBaseSchema
      • HtmlResponseMixin
      • MaBaseSchema
      • PluginUrl
      • SecurityBlueprint
      • camelcase()
  • Module contents
    • RootView
      • RootView.get()
      • RootView.methods
    • VersionsRootSchema
      • VersionsRootSchema.opts
    • register_root_api()
• qhana_plugin_runner.db package
  • Subpackages
    • qhana_plugin_runner.db.models package
      • Submodules
      • Module contents
  • Submodules
    • qhana_plugin_runner.db.cli module
      • create_db_function()
      • drop_db_function()
      • register_db_cli_blueprint()
    • qhana_plugin_runner.db.db module
  • Module contents
    • register_db()
• qhana_plugin_runner.plugin_utils package
  • Submodules
    • qhana_plugin_runner.plugin_utils.attributes module
      • AttributeMetadata
      • default_serialize()
      • dict_deserializer()
      • dict_serializer()
      • parse_attribute_metadata()
      • parse_bool()
      • parse_multi()
      • parse_optional_value()
      • serialize_multi()
      • tuple_deserializer()
      • tuple_serializer()
    • qhana_plugin_runner.plugin_utils.entity_marshalling module
      • ArrayEntity
      • DefaultDialect
      • EntityTupleMixin
      • ResponseLike
      • array_to_entity()
      • ensure_array()
      • ensure_dict()
      • ensure_tuple()
      • entity_attribute_sort_key()
      • get_entity_tuple_class()
      • iskeyword()
      • load_entities()
      • save_entities()
    • qhana_plugin_runner.plugin_utils.zip_utils module
      • get_files_from_zip_url()
  • Module contents
• qhana_plugin_runner.registry_client package
  • Submodules
    • qhana_plugin_runner.registry_client.client module
      • PluginRegistryClient
    • qhana_plugin_runner.registry_client.types module
      • ApiLink
      • ApiLinkBase
      • ApiObject
      • ApiResponse
      • BaseApiObject
      • KeyedApiLink
      • match_api_link()
  • Module contents
    • register_plugin_registry_client()
• qhana_plugin_runner.util package
  • Subpackages
    • qhana_plugin_runner.util.config package
      • Submodules
      • Module contents
    • qhana_plugin_runner.util.debug_routes package
      • Submodules
      • Module contents
  • Submodules
    • qhana_plugin_runner.util.jinja_helpers module
      • get_datalist_from_schema()
      • marshmallow_field_to_input_type()
      • marshmallow_field_to_step_attr()
      • marshmallow_validators_to_field_attrs()
      • register_helpers()
      • space_delimited_list()
    • qhana_plugin_runner.util.logging module
      • get_logger()
      • redact_log_data()
    • qhana_plugin_runner.util.plugins module
      • QHAnaPluginBase
      • plugin_identifier()
      • register_plugins()
    • qhana_plugin_runner.util.request_helpers module
      • DataAdapter
      • FileAdapter
      • register_additional_schemas()
    • qhana_plugin_runner.util.reverse_proxy_fix module
      • apply_reverse_proxy_fix()
  • Module contents

Submodules

• qhana_plugin_runner.babel module
  • get_locale()
  • inject_lang_from_header()
  • register_babel()
• qhana_plugin_runner.celery module
  • FlaskTask
    • FlaskTask.ignore_result
    • FlaskTask.priority
    • FlaskTask.rate_limit
    • FlaskTask.reject_on_worker_lost
    • FlaskTask.request_stack
    • FlaskTask.serializer
    • FlaskTask.store_errors_even_if_ignored
    • FlaskTask.track_started
    • FlaskTask.typing
  • register_celery()
• qhana_plugin_runner.celery_worker module
• qhana_plugin_runner.licenses module
  • register_licenses()
  • show_licenses()
• qhana_plugin_runner.markdown module
  • register_markdown_filter()
• qhana_plugin_runner.plugins_cli module
  • append_plugin_dependencies()
  • append_runner_dependencies()
  • register_plugin_cli_blueprint()
• qhana_plugin_runner.requests module
  • get_mimetype()
  • open_url()
  • open_url_as_file_like()
  • open_url_as_file_like_simple()
  • retrieve_attribute_metadata_url()
  • retrieve_data_type()
  • retrieve_filename()
• qhana_plugin_runner.storage module
  • FileStore
    • FileStore.get_task_file_url()
    • FileStore.init_app()
    • FileStore.name
    • FileStore.open()
    • FileStore.persist_task_result()
    • FileStore.persist_task_temp_file()
    • FileStore.prepare_path()
  • FileStoreInterface
    • FileStoreInterface.get_file_url()
    • FileStoreInterface.get_task_file_url()
    • FileStoreInterface.open()
    • FileStoreInterface.persist_file()
    • FileStoreInterface.persist_task_result()
    • FileStoreInterface.persist_task_temp_file()
  • FileStoreRegistry
    • FileStoreRegistry.get_file_url()
    • FileStoreRegistry.get_task_file_url()
    • FileStoreRegistry.init_app()
    • FileStoreRegistry.open()
    • FileStoreRegistry.persist_file()
    • FileStoreRegistry.persist_task_result()
    • FileStoreRegistry.persist_task_temp_file()
  • LocalFileStore
    • LocalFileStore.get_file_url()
    • LocalFileStore.get_task_file_url()
    • LocalFileStore.name
    • LocalFileStore.open()
    • LocalFileStore.persist_file()
    • LocalFileStore.persist_raw_data()
  • UrlFileStore
    • UrlFileStore.get_file_url()
    • UrlFileStore.name
    • UrlFileStore.persist_file()
  • register_file_store()
• qhana_plugin_runner.tasks module
  • TASK_DETAILS_CHANGED
  • TASK_STATUS_CHANGED
  • TASK_STEPS_CHANGED

Module contents

Root module containing the flask app factory.

qhana_plugin_runner.create_app(test_config: Dict[str, Any] | None = None, silent_log: bool = False)

Flask app factory.

qhana_plugin_runner.load_toml(file_like: IO[Any]) → Mapping[str, Any]