pyvista_validation.check.check_sequence

pyvista_validation.check.check_sequence(obj: Sequence[Any], /, *, name: str = 'Object') → None

Check if an object is an instance of Sequence.

Parameters:

objSequence

Object to check.

namestr, default: “Object”

Variable name to use in the error messages if any are raised.

Raises:

TypeError

If input is not an instance of Sequence.

See also

check_iterable

check_instance

Examples

Check if an object is a sequence.

>>> import numpy as np
>>> from pyvista_validation import check_sequence
>>> check_sequence([1, 2, 3])
>>> check_sequence('A')