pyvista.core._validation.check.check_instance

check_instance(

obj: object,

/,

classinfo: type | tuple[type, ...],

*,

allow_subclass: bool = True,

name: str = 'Object',

) → None

オブジェクトが与えられた型または複数型のインスタンスであるかどうかをチェックします．

パラメータ:

objAny

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

classinfotype | tuple[type, ...]

type またはtypeのタプル．オブジェクトはいずれかの型のインスタンスでなければなりません．

allow_subclassbool, default: True

もし True ならば，オブジェクトのタイプは classinfo で指定する必要があります．

またはそのサブクラスのいずれか．そうでない場合，サブクラスは許可されません．

namestr, default: "Object"

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

エラー処理:

TypeError

オブジェクトが指定された型のインスタンスでない場合．

参考

check_type

check_number

check_string

check_iterable

check_sequence

例

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

>>> from pyvista import _validation
>>> _validation.check_instance(1 + 2j, complex)

オブジェクトがいくつかの型のうちの1つのインスタンスであるかどうかをチェックします．

>>> _validation.check_instance('eggs', (int, str))