Report

class lsst.images.Report(type_name, title=None, summary=None, fields=<factory>, tables=<factory>, value_groups=<factory>, children=<factory>, inline=False, emphasis_markup=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)

• emphasis_markup (bool, default: False)

Attributes Summary

emphasis_markup	Whether this report's headline marks spans markdown-style, as *emphasis* and **strong**.
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

emphasis_markup: bool = False

Whether this report’s headline marks spans markdown-style, as *emphasis* and **strong**.

The headline is the heading of this report’s branch, or the single line it renders as when inline. Marking a span rather than styling the whole line keeps the eye off the routine part of it, and a headline may mark as many spans as it needs. The delimiters are removed wherever the headline is read as plain text, so str and repr never show them.

Emphasis never carries meaning on its own, since a plain-text export drops it, so a marked span has to read as the point it is making. Reports leave this False unless they mark something, so a stray * in a value is never mistaken for a delimiter.

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