is_float#

paramcheckup.types.is_float(value, param_name, kind, kind_name, stacklevel=4, error=True)[source]#

This function checks whether a variable value is of the float type.

Parameters:

valueany type: The variable that is tested as being of type float;
param_namestr: The name of the parameter that received the variable value;
kindstr: The object where param_name is applied (function, method, class, etc.);
kind_namestr: The name of the object kind;
stacklevelint, optional: The stacking level (default is 4);
errorbool, optional: Whether to display error text (True, default) or not (False);

Returns:

outputTrue: If variable value IS of the float type;
raisesTypeError: If variable value is NOT of the float type;

Notes

The following types are considered to be True:

float;
np.floating;

Examples

>>> from paramcheckup import types
>>> result = types.is_float(
    value=0.05,
    param_name="alpha",
    kind="function",
    kind_name="ttest",
    stacklevel=3,
    error=True,
)
>>> print(result)
True

>>> from paramcheckup import types
>>> result = types.is_float(
    value=5,
    param_name="alpha",
    kind="function",
    kind_name="ttest",
    stacklevel=3,
    error=False,
)
UserWarning at line 2: The parameter `alpha` in function `ttest` must be of type `float`, but its type is `int`.