lsst.pipe.base.pipelineIR.LabeledSubset Class Reference

Public Member Functions
Dict[str, Union[List[str], str]]	to_primitives (self)

Static Public Member Functions
LabeledSubset	from_primitives (str label, Union[List[str], dict] value)

Detailed Description

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

Definition at line 103 of file pipelineIR.py.

Member Function Documentation

from_primitives()

LabeledSubset lsst.pipe.base.pipelineIR.LabeledSubset.from_primitives ( str  label, Union[List[str], dict]  value  )

static

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

Parameters
----------
label : `str`
    The label that will be used to identify this labeled subset.
value : `list` of `str` or `dict`
    Object returned from loading a labeled subset section from a yaml
    document.

Returns
-------
labeledSubset : `LabeledSubset`
    A `LabeledSubset` object build from the inputs.

Raises
------
ValueError
    Raised if the value input is not properly formatted for parsing

Definition at line 118 of file pipelineIR.py.

    def from_primitives(label: str, value: Union[List[str], dict]) -> LabeledSubset:
        """Generate `LabeledSubset` objects given a properly formatted object
        that as been created by a yaml loader.
 
        Parameters
        ----------
        label : `str`
            The label that will be used to identify this labeled subset.
        value : `list` of `str` or `dict`
            Object returned from loading a labeled subset section from a yaml
            document.
 
        Returns
        -------
        labeledSubset : `LabeledSubset`
            A `LabeledSubset` object build from the inputs.
 
        Raises
        ------
        ValueError
            Raised if the value input is not properly formatted for parsing
        """
        if isinstance(value, MutableMapping):
            subset = value.pop("subset", None)
            if subset is None:
                raise ValueError("If a labeled subset is specified as a mapping, it must contain the key "
                                 "'subset'")
            description = value.pop("description", None)
        elif isinstance(value, abcIterable):
            subset = value
            description = None
        else:
            raise ValueError(f"There was a problem parsing the labeled subset {label}, make sure the "
                             "definition is either a valid yaml list, or a mapping with keys "
                             "(subset, description) where subset points to a yaml list, and description is "
                             "associated with a string")
        return LabeledSubset(label, set(subset), description)
 

to_primitives()

Dict[str, Union[List[str], str]] lsst.pipe.base.pipelineIR.LabeledSubset.to_primitives

(

self

)

Convert to a representation used in yaml serialization

Definition at line 156 of file pipelineIR.py.

    def to_primitives(self) -> Dict[str, Union[List[str], str]]:
        """Convert to a representation used in yaml serialization
        """
        accumulate: Dict[str, Union[List[str], str]] = {"subset": list(self.subset)}
        if self.description is not None:
            accumulate["description"] = self.description
        return accumulate
 
 
@dataclass

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/pipelineIR.py