queenbee.io.outputs.alias module

Queenbee alias output types.

Use these alias outputs to create a different IO object for client side UIs.

class queenbee.io.outputs.alias.DAGArrayOutputAlias(*, type: ~typing.Literal['DAGArrayOutputAlias'] = 'DAGArrayOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, items_type: ~queenbee.io.common.ItemType = ItemType.String)

Bases: DAGStringOutputAlias

DAG alias array output.

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

items_type: ItemType

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGArrayOutputAlias']

class queenbee.io.outputs.alias.DAGBooleanOutputAlias(*, type: ~typing.Literal['DAGBooleanOutputAlias'] = 'DAGBooleanOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: DAGStringOutputAlias

DAG alias boolean output.

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

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGBooleanOutputAlias']

class queenbee.io.outputs.alias.DAGFileOutputAlias(*, type: ~typing.Literal['DAGFileOutputAlias'] = 'DAGFileOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: _DAGArtifactOutputAlias

DAG alias file output.

from_: TaskReference | FileReference

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGFileOutputAlias']

class queenbee.io.outputs.alias.DAGFolderOutputAlias(*, type: ~typing.Literal['DAGFolderOutputAlias'] = 'DAGFolderOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FolderReference)

Bases: _DAGArtifactOutputAlias

DAG alias folder output.

from_: TaskReference | FolderReference

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGFolderOutputAlias']

class queenbee.io.outputs.alias.DAGGenericOutputAlias(*, type: ~typing.Literal['DAGGenericOutputAlias'] = 'DAGGenericOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler])

Bases: GenericOutput

DAG generic alias output.

In most cases, you should not be using the generic output unless you need a dynamic output that changes its type in different platforms because of returning different objects in handler.

classmethod check_duplicate_platform_name(v: List[IOAliasHandler], info: ValidationInfo) → List[IOAliasHandler]

classmethod create_empty_platform_list(v: List[str]) → List[str]

handler: List[IOAliasHandler]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

platform: List[str]

type: Literal['DAGGenericOutputAlias']

class queenbee.io.outputs.alias.DAGIntegerOutputAlias(*, type: ~typing.Literal['DAGIntegerOutputAlias'] = 'DAGIntegerOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: DAGStringOutputAlias

DAG alias integer output.

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

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGIntegerOutputAlias']

class queenbee.io.outputs.alias.DAGJSONObjectOutputAlias(*, type: ~typing.Literal['DAGJSONObjectOutputAlias'] = 'DAGJSONObjectOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: DAGStringOutputAlias

DAG alias object output.

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

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGJSONObjectOutputAlias']

class queenbee.io.outputs.alias.DAGLinkedOutputAlias(*, type: ~typing.Literal['DAGLinkedOutputAlias'] = 'DAGLinkedOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler])

Bases: DAGGenericOutputAlias

An Alias for Linked Outputs.

A linked output alias will be translated to an object in the UI and stay linked to it.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGLinkedOutputAlias']

class queenbee.io.outputs.alias.DAGNumberOutputAlias(*, type: ~typing.Literal['DAGNumberOutputAlias'] = 'DAGNumberOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: DAGStringOutputAlias

DAG alias number output.

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

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGNumberOutputAlias']

class queenbee.io.outputs.alias.DAGPathOutputAlias(*, type: ~typing.Literal['DAGPathOutputAlias'] = 'DAGPathOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference | ~queenbee.io.reference.FolderReference)

Bases: _DAGArtifactOutputAlias

DAG alias path output.

from_: TaskReference | FileReference | FolderReference

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGPathOutputAlias']

class queenbee.io.outputs.alias.DAGStringOutputAlias(*, type: ~typing.Literal['DAGStringOutputAlias'] = 'DAGStringOutputAlias', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, platform: ~typing.List[str], handler: ~typing.List[~queenbee.io.common.IOAliasHandler], required: bool = True, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference)

Bases: DAGFileOutputAlias

DAG alias string output.

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

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGStringOutputAlias']