fatf.utils.array.validation.is_textual_dtype

fatf.utils.array.validation.is_textual_dtype(dtype)[source]

Determines whether a numpy dtype object is of textual type.

Checks whether the dtype is a unicode string type (textual). The zero-terminated bytes type is unsupported and not considered a textual type.

Parameters
dtypenumpy.dtype

The dtype to be checked.

Returns
is_textualboolean

True if the dtype is of a textual type, False otherwise.

Raises
TypeError

The input is not a numpy’s dtype object.

ValueError

The dtype is structured – this function only accepts plane dtypes.