{ } Raw JSON

bundles / astropy 7.0.1 / astropy / utils / diff / report_diff_values

function

astropy.utils.diff:report_diff_values

source: /astropy/utils/diff.py:54

Signature

def report_diff_values(a, b, fileobj = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, indent_width = 0, rtol = 0.0, atol = 0.0)

Summary

Write a diff report between two values to the specified file-like object.

Parameters

a, b

Values to compare. Anything that can be turned into strings and compared using difflib should work.

fileobj : object

File-like object to write to. The default is sys.stdout, which writes to terminal.

indent_width : int

Character column(s) to indent.

rtol, atol : float

Relative and absolute tolerances as accepted by numpy.allclose.

Returns

identical : bool

True if no diff, else False.

Aliases

  • astropy.io.fits.diff.report_diff_values