astropy 5.0

ParametersReturns
report(self, fileobj=None, indent=0, overwrite=False)

Parameters

fileobj : file-like, string, or None, optional

If :None:None:`None`, this method returns the report as a string. Otherwise it returns :None:None:`None` and writes the report to the given file-like object (which must have a .write() method at a minimum), or to a new file at the path specified.

indent : int

The number of 4 space tabs to indent the report.

overwrite : bool, optional

If True , overwrite the output file if it exists. Raises an OSError if False and the output file exists. Default is False .

versionchanged

overwrite replaces the deprecated clobber argument.

Returns

report : str or None

Generates a text report on the differences (if any) between two objects, and either returns it as a string or writes it to a file-like object.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /astropy/io/fits/diff.py#124
type: <class 'function'>
Commit: