compareConfigs¶
- lsst.pex.config.compareConfigs(name, c1, c2, shortcut=True, rtol=1e-08, atol=1e-08, output=None)¶
Compare two
lsst.pex.config.Config
instances for equality.This function is a helper for
lsst.pex.config.Config.compare
.- Parameters:
- name
str
Name to use when reporting differences, typically created by
getComparisonName
.- v1
lsst.pex.config.Config
Left-hand side config to compare.
- v2
lsst.pex.config.Config
Right-hand side config to compare.
- shortcut
bool
, optional If
True
, return as soon as an inequality is found. Default isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities. For example:
print
.
- name
- Returns:
- areEqual
bool
True
when the twolsst.pex.config.Config
instances are equal.False
if there is an inequality.
- areEqual
See also
Notes
Floating point comparisons are performed by
numpy.allclose
.If
c1
orc2
containRegistryField
orConfigChoiceField
instances, unselectedConfig
instances will not be compared.