def verify_all(
header: str,
alist: List[str],
formatter: Optional[Callable] = None,
reporter: Optional[DiffReporter] = None,
encoding: None = None,
errors: None = None,
newline: None = None,
*, # enforce keyword arguments - https://www.python.org/dev/peps/pep-3102/
options: Optional[Options] = None
) -> None:
"""Verify a collection of items against a previously approved collection.
Args:
header: A header line string to be included before the list of items.
alist: An iterable series of objects, a string representation of each of which will be
included in an aggregated string for comparison.
formatter: An optional object which must have a print_item(x) method such that
formatter.print_item(x) will return a string representation of a single item from alist.
reporter: An optional Reporter. If None (the default), the default reporter
will be used; see get_default_reporter().
encoding: An optional encoding to be used when serialising the data to a byte stream for
comparison. If None (the default) a locale-dependent encoding will be used; see
locale.getpreferredencoding().
errors: An optional string that specifies how encoding and decoding errors are to be handled
If None (the default) or 'strict', raise a ValueError exception if there is an encoding
error. Pass 'ignore' to ignore encoding errors. Pass 'replace' to use a replacement
marker (such as '?') when there is malformed data.
newline: An optional string that controls how universal newlines work when comparing data.
It can be None, '', '\n', '\r', and '\r\n'. If None (the default) universal newlines are
enabled and any '\n' characters are translated to the system default line separator
given by os.linesep. If newline is '', no translation takes place. If newline is any of
the other legal values, any '\n' characters written are translated to the given string.
Raises:
ApprovalException: If the verification fails because the given string does not match the
approved string.
ValueError: If data cannot be encoded using the specified encoding when errors is set to
None or 'strict'.
"""
options = initialize_options(options, reporter)
text = format_list(alist, formatter, header)
verify(
text, None, encoding=encoding, errors=errors, newline=newline, options=options
)
def verify_all(header, alist, formatter=None, reporter=None):
text = format_list(alist, formatter, header)
verify(text, reporter)
def verify_all(header, alist, formatter=None, reporter=None):
text = format_list(alist, formatter, header)
verify(text, reporter)
