Report

class lsst.images.Report(type_name, title=None, summary=None, fields=<factory>, tables=<factory>, value_groups=<factory>, children=<factory>, inline=False)

Bases: object

A renderer-agnostic description of an object.

Parameters:

• type_name (str)

• title (str | None, default: None)

• summary (str | None, default: None)

• fields (list[ReportField], default: <factory>)

• tables (list[ReportTable], default: <factory>)

• value_groups (list[ReportValueGroup], default: <factory>)

• children (dict[str, Report], default: <factory>)

• inline (bool, default: False)

Attributes Summary

inline	If True, render as a single key: summary line when embedded as a child of another report, instead of a nested branch.
summary	Optional one-line hint used by __str__.
title	Optional headline shown above the fields.

Methods Summary

to_repr()	Return a repr string built from the fields whose role feeds repr.
to_str()	Return a compact one-line summary.

Attributes Documentation

inline: bool = False

If True, render as a single key: summary line when embedded as a child of another report, instead of a nested branch.

summary: str | None = None

Optional one-line hint used by __str__.

title: str | None = None

Optional headline shown above the fields.

Methods Documentation

to_repr()

Return a repr string built from the fields whose role feeds repr.

Return type:

str

Notes

Reports with no such fields describe objects that cannot be rebuilt from a string, such as those wrapping an AST mapping. Those get the angle-bracket form Python uses for objects whose repr is descriptive, rather than an empty call that would claim an eval-ability they do not have.

to_str()

Return a compact one-line summary.

Return type:

str