`astropy.io.fits.diff:_BaseDiff.report`

source: /astropy/io/fits/diff.py :138

Signature

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

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.

fileobj : file-like, string, or None, optional: If None, this method returns the report as a string. Otherwise it returns 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.