string_tools

sanitize_string(value)

Make string safe to be used in file/folder names and subprocess commands.

Make the string lower-case, and replace any special character with an underscore, where special characters are:

>>> string.punctuation
'!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~'
>>> string.whitespace
' \t\n\r\x0b\x0c'

Parameters:

Name	Type	Description	Default
value	str	Input string	required

Returns:

Type	Description
str	Sanitized value

Source code in fractal_server/string_tools.py

def sanitize_string(value: str) -> str:
    """
    Make string safe to be used in file/folder names and subprocess commands.

    Make the string lower-case, and replace any special character with an
    underscore, where special characters are:


        >>> string.punctuation
        '!"#$%&\'()*+,-./:;<=>?@[\\\\]^_`{|}~'
        >>> string.whitespace
        ' \\t\\n\\r\\x0b\\x0c'

    Args:
        value: Input string

    Returns:
        Sanitized value
    """
    new_value = value.lower()
    for character in __SPECIAL_CHARACTERS__:
        new_value = new_value.replace(character, "_")
    return new_value

slugify_task_name_for_source_v1(task_name)

NOTE: this function is used upon creation of tasks' sources, therefore for the moment we cannot replace it with its more comprehensive version from fractal_server.string_tools.sanitize_string, nor we can remove it.

As of 2.3.1, we are renaming it to slugify_task_name_for_source, to make it clear that it should not be used for other purposes.

As of 2.7.0, we are renaming it to slugify_task_name_for_source_v1, to make it clear that it is not used for v2.

Parameters:

Name	Type	Description	Default
task_name	str		required

Return

Slug-ified task name.

Source code in fractal_server/string_tools.py

def slugify_task_name_for_source_v1(task_name: str) -> str:
    """
    NOTE: this function is used upon creation of tasks' sources, therefore
    for the moment we cannot replace it with its more comprehensive version
    from `fractal_server.string_tools.sanitize_string`, nor we can remove it.

    As of 2.3.1, we are renaming it to `slugify_task_name_for_source`, to make
    it clear that it should not be used for other purposes.

    As of 2.7.0, we are renaming it to `slugify_task_name_for_source_v1`, to
    make it clear that it is not used for v2.

    Args:
        task_name:

    Return:
        Slug-ified task name.
    """
    return task_name.replace(" ", "_").lower()

validate_cmd(command, *, allow_char=None, attribute_name='Command')

Assert that the provided command does not contain any of the forbidden characters for commands (fractal_server.string_tools.NOT_ALLOWED_FOR_COMMANDS)

Parameters:

Name	Type	Description	Default
command	str	command to validate.	required
allow_char	Optional[str]	chars to accept among the forbidden ones	None
attribute_name	str	Name of the attribute, to be used in error message.	'Command'

Source code in fractal_server/string_tools.py

def validate_cmd(
    command: str,
    *,
    allow_char: Optional[str] = None,
    attribute_name: str = "Command",
):
    """
    Assert that the provided `command` does not contain any of the forbidden
    characters for commands
    (fractal_server.string_tools.__NOT_ALLOWED_FOR_COMMANDS__)

    Args:
        command: command to validate.
        allow_char: chars to accept among the forbidden ones
        attribute_name: Name of the attribute, to be used in error message.
    """
    if not isinstance(command, str):
        raise ValueError(f"{command=} is not a string.")
    forbidden = set(__NOT_ALLOWED_FOR_COMMANDS__)
    if allow_char is not None:
        forbidden = forbidden - set(allow_char)
    if not forbidden.isdisjoint(set(command)):
        raise ValueError(
            f"{attribute_name} must not contain any of this characters: "
            f"'{forbidden}'\n"
            f"Provided {attribute_name.lower()}: '{command}'."
        )