validation

red = Fore.RED + Style.BRIGHT module-attribute

check_bool_param(func)

Decorator to check if the first function parameter is a boolean

check_file(func)

Decorator to check if the first function parameter is a list-like (list, tuple or np.ndarray)

check_int_param(func)

check_list_param(func)

Decorator to check if the first function parameter is a list-like (list, tuple or np.ndarray)

check_non_negative(func)

Decorator to check if the first function parameter is non negative -> place after @check_number_param

check_number_param(func)

Decorator to check if the first function parameter is a number (int or float)

check_param_type(type_)

Decorator to check if the first function parameter falls within the range [min_val, max_val]

check_property(*attribute_names)

Decorator to check if property is not None

check_range_param(min_val, max_val)

Decorator to check if the first function parameter falls within the range [min_val, max_val]

check_string_param(func)

check_valid_key(values=None, capitalized=True)

Decorator to check if the first function parameter is a valid value in the values list