Describable

class lsst.images.Describable(*args, **kwargs)

Bases: Protocol

An object that can produce a Report describing itself.

describe is the entry point callers use; _describe is the recursive contract composites use to build child reports. They differ in signature: describe spells its options out as keyword arguments for convenience, while _describe takes the single DescribeOptions value that composites thread down the tree.

Methods Summary

describe(*[, brief, detail, exclude])

Return a Report describing this object.

Methods Documentation

describe(*, brief=False, detail=False, exclude=())

Return a Report describing this object.

Parameters:

• brief (bool, optional) – Whether to build only what repr and str read.

• detail (bool, optional) – Whether to include extras that are too expensive for a default report.

• exclude (Collection [str], optional) – Names of report elements to omit.

Returns:

report – Report describing this object.

Return type:

Report