pyvista.core._validation.validate.validate_number

pyvista.core._validation.validate.validate_number#

validate_number(num: float, /, *, reshape: bool = True, **kwargs)[ソース]#

有限の実数を検証します．

デフォルトでは，数字は確実にチェックされます:

  • スカラーであるか，スカラーとして整形できる配列

  • 実数

  • 有限

パラメータ:
numfloat

検証する数字．

reshapebool, default: True

もし True ならば，1つの要素を持つ1次元配列は有効な入力とみなされ，0次元に整形される．

**kwargsdict, optional

validate_array() に渡す追加のキーワード引数です．

戻り値:
int | float

有効な数字．

参考

validate_array

汎用的な配列検証関数．

例

数字を検証します．

>>> from pyvista import _validation
>>> _validation.validate_number(1)
1

1D配列は自動的に変形されます．

>>> _validation.validate_number([42.0])
42.0

必要に応じてチェックを追加できます．

>>> _validation.validate_number(
...     10, must_be_in_range=[0, 10], must_be_integer=True
... )
10
目次