pyvista.core._validation.check.check_string

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

オブジェクトが str のインスタンスであるかどうかをチェックします．

パラメータ:

objstr

チェックするオブジェクト．

allow_subclassbool, default: True

もし True なら，オブジェクトの型は str か str のサブクラスでなければなりません．そうでない場合，サブクラスは許可されません．

namestr, default: "Object"

エラーメッセージが発生した場合に使用する変数名．

エラー処理:

TypeError

入力が str のインスタンスでない場合．

参考

check_contains

check_iterable_items

check_sequence

check_instance

例

オブジェクトがストリングかどうかをチェックします．

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