pyvista_validation.check.check_string

pyvista_validation.check.check_string(obj: str, /, *, allow_subclass: bool = True, name: str = 'Object') → None

Check if an object is an instance of str.

Parameters:

objstr

Object to check.

allow_subclassbool, default: True

If True, the object’s type must be str or a subclass of str. Otherwise, subclasses are not allowed.

namestr, default: “Object”

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

Raises:

TypeError

If input is not an instance of str.

See also

check_contains

check_iterable_items

check_sequence

check_instance

Examples

Check if an object is a string.

>>> from pyvista_validation import check_string
>>> check_string('eggs')