queenbee.io.inputs.job module

Input objects for Queenbee jobs.

class queenbee.io.inputs.job.JobArgument(*, type: ~typing.Literal['JobArgument'] = 'JobArgument', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, value: ~typing.Any)

Bases: BaseModel

Job argument is an argument input for arguments which are not files or folders.

property is_artifact

property is_parameter

model_config: ClassVar[ConfigDict] = {}

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

name: str

type: Literal['JobArgument']

value: Any

class queenbee.io.inputs.job.JobPathArgument(*, type: ~typing.Literal['JobPathArgument'] = 'JobPathArgument', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, source: ~queenbee.io.artifact_source.HTTP | ~queenbee.io.artifact_source.S3 | ~queenbee.io.artifact_source.ProjectFolder)

Bases: BaseModel

property is_artifact

property is_parameter

model_config: ClassVar[ConfigDict] = {}

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

name: str

source: HTTP | S3 | ProjectFolder

type: Literal['JobPathArgument']

queenbee.io.inputs.job.load_job_arguments(fp: str) → List[JobArgument | JobPathArgument]

Load Job arguments from a JSON or YAML file.

Parameters:

fp – File path to a JSON or YAML file with a list of JobArguments.

Returns:

List - A list of of JobArgument and JobPathArgument objects.

queenbee.io.inputs.job.load_job_arguments_from_dict(data: List[Dict]) → List[JobArgument | JobPathArgument]

Load Job arguments from a list of dictionaries.

Parameters:

data – A list of job arguments as dictionaries.

Returns:

List - A list of of JobArgument and JobPathArgument objects.