LabeledSubset

class lsst.pipe.base.pipelineIR.LabeledSubset(label: str, subset: set[str], description: str | None)

Bases: object

Intermediate representation of named subset of task labels read from a pipeline yaml file.

Attributes Summary

description	A description of what this subset of tasks is intended to do
label	The label used to identify the subset of task labels.
subset	A set of task labels contained in this subset.

Methods Summary

from_primitives(label, value)	Generate LabeledSubset objects given a properly formatted object that as been created by a yaml loader.
to_primitives()	Convert to a representation used in yaml serialization.

Attributes Documentation

description: str | None = <dataclasses._MISSING_TYPE object>

A description of what this subset of tasks is intended to do

label: str = <dataclasses._MISSING_TYPE object>

The label used to identify the subset of task labels.

subset: set[str] = <dataclasses._MISSING_TYPE object>

A set of task labels contained in this subset.

Methods Documentation

static from_primitives(label: str, value: list[str] | dict) → LabeledSubset

Generate LabeledSubset objects given a properly formatted object that as been created by a yaml loader.

Parameters

labelstr

The label that will be used to identify this labeled subset.

valuelist of str or dict

Object returned from loading a labeled subset section from a yaml document.

Returns

labeledSubsetLabeledSubset

A LabeledSubset object build from the inputs.

Raises

ValueError

Raised if the value input is not properly formatted for parsing

to_primitives() → dict[str, list[str] | str]

Convert to a representation used in yaml serialization.