sidpy.base.string_utils.validate_single_string_arg

sidpy.base.string_utils.validate_single_string_arg(value, name)[source]

This function is to be used when validating a SINGLE string parameter for a function. Trims the provided value. Errors in the string will result in Exceptions

Parameters:

  • value (str) – Value of the parameter

  • name (str) – Name of the parameter

Returns:

Cleaned string value of the parameter

Return type:

str