ContractIR

class lsst.pipe.base.pipelineIR.ContractIR(contract: str, msg: str | None = None)

Bases: object

Intermediate representation of configuration contracts read from a pipeline yaml file.

Attributes Summary

contract	A string of python code representing one or more conditions on configs in a pipeline.
msg	An optional message to be shown to the user if a contract fails

Methods Summary

to_primitives()

Convert to a representation used in yaml serialization.

Attributes Documentation

contract: str = <dataclasses._MISSING_TYPE object>

A string of python code representing one or more conditions on configs in a pipeline. This code-as-string should, once evaluated, should be True if the configs are fine, and False otherwise.

msg: str | None = None

An optional message to be shown to the user if a contract fails

Methods Documentation

to_primitives() → dict[str, str]

Convert to a representation used in yaml serialization.