pyvista.core._validation.check.check_string

Contents

pyvista.core._validation.check.check_string#

check_string(obj, /, *, allow_subclass=True, name='Object')[source]#

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.

Examples

Check if an object is a string.

>>> from pyvista import _validation
>>> _validation.check_string("eggs")