Skip to content

Sanitize file name

sanitize_file_name #

Functions:

Name Description
sanitize_file_name

Sanitize filenames by replacing potentially dangerous characters.

Examples:

Sanitize a filename: >>> sanitize_file_name("test<>file:/name.dcm") 'test_file_name.dcm'

sanitize_file_name #

sanitize_file_name(filename: str) -> str

Sanitize the file name by removing or replacing disallowed characters, while preserving forward slashes.

Parameters:

Name Type Description Default

filename #

 str

The input file name to sanitize.

 required

Returns:

Type Description
str

The sanitized file name.
Source code in src/imgtools/utils/sanitize_file_name.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def sanitize_file_name(filename: str) -> str:
    """
    Sanitize the file name by removing or replacing disallowed characters,
    while preserving forward slashes.

    Parameters
    ----------
    filename : str
        The input file name to sanitize.

    Returns
    -------
    str
        The sanitized file name.
    """
    assert filename and isinstance(filename, str)

    # Remove disallowed characters at the start and end
    filename = DISALLOWED_CHARS_STRIP_REGEX.sub("", filename).strip()

    filename = filename.replace(" - ", "-")

    # Replace multiple spaces with a single space
    filename = re.sub(r"\s+", "_", filename)

    # Replace multiple consecutive disallowed characters with a single underscore
    filename = re.sub(f"[{DISALLOWED_CHARS}]+", "_", filename)

    # Replace remaining disallowed characters with underscores
    sanitized = DISALLOWED_CHARS_PATTERN.sub("_", filename)

    return sanitized