queenbee.io.inputs.step module

Input types for Queenbee job steps.

For more information on plugins see plugin module.

class queenbee.io.inputs.step.StepArrayInput(*, type: ConstrainedStrValue = 'StepArrayInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: List = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, items_type: ItemType = ItemType.String, value: List)[source]

Bases: FunctionArrayInput

A JSON array input.

type: ConstrainedStrValue
value: List
class queenbee.io.inputs.step.StepBooleanInput(*, type: ConstrainedStrValue = 'StepBooleanInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: bool = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, value: bool)[source]

Bases: FunctionBooleanInput

The boolean type matches only two special values: True and False.

type: ConstrainedStrValue
value: bool
class queenbee.io.inputs.step.StepFileInput(*, type: ConstrainedStrValue = 'StepFileInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: HTTP | S3 | ProjectFolder = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, path: str = None, extensions: List[str] = None, source: HTTP | S3 | ProjectFolder)[source]

Bases: FunctionFileInput

A file input.

path: str
source: HTTP | S3 | ProjectFolder
type: ConstrainedStrValue
class queenbee.io.inputs.step.StepFolderInput(*, type: ConstrainedStrValue = 'StepFolderInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: HTTP | S3 | ProjectFolder = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, path: str = None, source: HTTP | S3 | ProjectFolder)[source]

Bases: FunctionFolderInput

A folder input.

path: str
source: HTTP | S3 | ProjectFolder
type: ConstrainedStrValue
class queenbee.io.inputs.step.StepIntegerInput(*, type: ConstrainedStrValue = 'StepIntegerInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: int = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, value: int)[source]

Bases: FunctionIntegerInput

An integer input.

type: ConstrainedStrValue
value: int
class queenbee.io.inputs.step.StepJSONObjectInput(*, type: ConstrainedStrValue = 'StepJSONObjectInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: Dict = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, value: Dict)[source]

Bases: FunctionJSONObjectInput

A JSON object input.

type: ConstrainedStrValue
value: Dict
class queenbee.io.inputs.step.StepNumberInput(*, type: ConstrainedStrValue = 'StepNumberInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: float = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, value: float)[source]

Bases: FunctionNumberInput

A number input.

type: ConstrainedStrValue
value: float
class queenbee.io.inputs.step.StepPathInput(*, type: ConstrainedStrValue = 'StepPathInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: HTTP | S3 | ProjectFolder = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, path: str = None, extensions: List[str] = None, source: HTTP | S3 | ProjectFolder)[source]

Bases: FunctionPathInput

A file or a folder input.

path: str
source: HTTP | S3 | ProjectFolder
type: ConstrainedStrValue
class queenbee.io.inputs.step.StepStringInput(*, type: ConstrainedStrValue = 'StepStringInput', annotations: Dict[str, Any] = None, name: str, description: str = None, default: str = None, alias: List[DAGGenericInputAlias | DAGStringInputAlias | DAGIntegerInputAlias | DAGNumberInputAlias | DAGBooleanInputAlias | DAGFolderInputAlias | DAGFileInputAlias | DAGPathInputAlias | DAGArrayInputAlias | DAGJSONObjectInputAlias | DAGLinkedInputAlias] = None, required: bool = False, spec: Dict = None, value: str)[source]

Bases: FunctionStringInput

A String input.

type: ConstrainedStrValue
value: str
queenbee.io.inputs.step.from_template(template: DAGGenericInput | DAGStringInput | DAGIntegerInput | DAGNumberInput | DAGBooleanInput | DAGFolderInput | DAGFileInput | DAGPathInput | DAGArrayInput | DAGJSONObjectInput | FunctionStringInput | FunctionIntegerInput | FunctionNumberInput | FunctionBooleanInput | FunctionFolderInput | FunctionFileInput | FunctionPathInput | FunctionArrayInput | FunctionJSONObjectInput, value: Any) → StepStringInput | StepIntegerInput | StepNumberInput | StepBooleanInput | StepFolderInput | StepFileInput | StepPathInput | StepArrayInput | StepJSONObjectInput[source]

Generate a step input from a template input type and a value

Parameters:

  • {Union[DAGInputs (template) – template (DAG or Function)

  • a (FunctionInputs]} -- An input from) – template (DAG or Function)

  • in (value {Any} -- The input value calculated for this template) – the workflow step

Returns:

StepInputs – A Step Input object