Base

class q2_sdk.core.install_steps.base.InstallStepArguments[source]: Bases: TypedDict

class q2_sdk.core.install_steps.base.InstallStep(**kwargs)[source]

Bases: object

Base class for DbPlan Steps

Parameters:

allow_editable – If False, will force all InstallStepAttributes’ to is_editable==False
required_install_step_attrs – An optional list of strings for names of install steps that will be forced to is_required==True

property install_vars: Returns all attributes that are also InstallStepAttributes

property required_attrs: list[str]: Returns all install steps with the .is_required flag set to True

property editable_attrs: list[str]: Returns all attributes with the .is_editable flag set to True

property has_editable_attrs: bool: True if at least one attribute has .is_editable == True

property hidden_attrs: list[str]: Returns all attributes with the .is_hidden flag set to True

async install()[source]: Must be overridden in inherited class to work with install

async uninstall()[source]: Must be overridden in inherited class to work with remove_form