pastas.utils.validate_name

pastas.utils.validate_name(name: str, raise_error: bool = False) → str

Method to check user-provided names and log a warning if wrong.

Parameters:

• name (str) – String with the name to check for illegal characters.

• raise_error (bool) – raise Exception error if illegal character is found, default is False which only logs a warning.

Returns:

name – Unchanged name string.

Return type:

str