is_str#

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

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

Parameters:

valueany type: The variable that is tested as being of type str ;
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 str type;
raisesTypeError: If variable value is NOT of the str type;

Examples

>>> from paramcheckup import types
>>> output = types.is_str(
    value="tukey",
    param_name="test",
    kind="function",
    kind_name="comparison_test",
    stacklevel=3,
    error=True,
)
>>> print(output)
True

>>> from paramcheckup import types
>>> output = types.is_str(
    value=["tukey"],
    param_name="test",
    kind="function",
    kind_name="comparison_test",
    stacklevel=3,
    error=False,
)
UserWarning at line 2: The parameter `test` in function `comparison_test` must be of type `str`, but its type is `list`.