pyvista.core._validation.check.check_iterable_items

pyvista.core._validation.check.check_iterable_items#

check_iterable_items(
iterable_obj: Iterable[Any],
/,
item_type: type | tuple[type, ...],
*,
allow_subclass: bool = True,
name: str = 'Iterable',
) None[ソース]#

イテラブルのアイテムがすべて指定された型を持っているかどうかをチェックします.

パラメータ:
iterable_objIterable

チェックする反復可能.

item_typetype | tuple[type, ...]

チェックする(複数の)クラス型.シーケンスの各要素は,指定された型またはそのいずれかを持っていなければなりません.

allow_subclassbool, default: True

もし True ならば,反復可能なアイテムの型は,与えられた型のいずれか,またはそのサブクラスでなければなりません.そうでない場合,サブクラスは許可されません.

namestr, default: "Iterable"

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

エラー処理:
TypeError

反復可能な項目の中に不正な型がある場合.

tupleint または float の要素しか持たないかチェックします.

>>> from pyvista import _validation
>>> _validation.check_iterable_items((1, 2, 3.0), (int, float))

listlist 要素しか持たないかどうかをチェックします.

>>> from pyvista import _validation
>>> _validation.check_iterable_items([[1], [2], [3]], list)