queenbee.io.inputs.job module

Input objects for Queenbee jobs.

class queenbee.io.inputs.job.JobArgument(*, type: ConstrainedStrValue = 'JobArgument', annotations: Dict[str, Any] = None, name: str, value: Any)[source]

Bases: BaseModel

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

property is_artifact
property is_parameter
name: str
type: ConstrainedStrValue
value: Any
class queenbee.io.inputs.job.JobPathArgument(*, type: ConstrainedStrValue = 'JobPathArgument', annotations: Dict[str, Any] = None, name: str, source: Union[HTTP, S3, ProjectFolder])[source]

Bases: BaseModel

property is_artifact
property is_parameter
name: str
source: Union[HTTP, S3, ProjectFolder]
type: ConstrainedStrValue
queenbee.io.inputs.job.load_job_arguments(fp: str) List[Union[JobArgument, JobPathArgument]][source]

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[Union[JobArgument, JobPathArgument]][source]

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.