queenbee.io.outputs.function module¶

Queenbee output types for functions.

For more information on plugins see plugin module.

class queenbee.io.outputs.function.FunctionArrayOutput(*, type: ConstrainedStrValue = 'FunctionArrayOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True, items_type: ItemType = ItemType.String)[source]¶

Bases: FunctionStringOutput

Function array output.

This output loads the content from a JSON file which must be a JSON Array.

items_type: ItemType¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionBooleanOutput(*, type: ConstrainedStrValue = 'FunctionBooleanOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: FunctionStringOutput

Function boolean output.

This output loads the content from a file as a boolean.

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionFileOutput(*, type: ConstrainedStrValue = 'FunctionFileOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: PathOutput

Function File output.

property is_artifact¶

path: str¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionFolderOutput(*, type: ConstrainedStrValue = 'FunctionFolderOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: PathOutput

Function Folder output.

property is_artifact¶

path: str¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionIntegerOutput(*, type: ConstrainedStrValue = 'FunctionIntegerOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: FunctionStringOutput

Function integer output.

This output loads the content from a file as an integer.

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionJSONObjectOutput(*, type: ConstrainedStrValue = 'FunctionJSONObjectOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: FunctionStringOutput

Function object output.

This output loads the content from a file as a JSON object.

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionNumberOutput(*, type: ConstrainedStrValue = 'FunctionNumberOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: FunctionStringOutput

Function number output.

This output loads the content from a file as a floating number.

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionPathOutput(*, type: ConstrainedStrValue = 'FunctionPathOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: PathOutput

Function Path output.

property is_artifact¶

path: str¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.function.FunctionStringOutput(*, type: ConstrainedStrValue = 'FunctionStringOutput', annotations: Dict[str, Any] = None, name: str, description: str = None, path: str, required: bool = True)[source]¶

Bases: FunctionFileOutput

Function string output.

This output loads the content from a file as a string.

property is_artifact¶

type: ConstrainedStrValue¶