Function safe_path

src/commoncode/paths.py:29–65

Convert `path` to a safe and portable POSIX path usable on multiple OSes. The returned path is an ASCII-only byte string, resolved for relative segments and itself relative. The `path` is treated as a POSIX path if `posix` is True or as a Windows path with blackslash separators

(path, posix=False, preserve_spaces=False, posix_only=False)

def safe_path(path, posix=False, preserve_spaces=False, posix_only=False):
    """
    Convert `path` to a safe and portable POSIX path usable on multiple OSes.
    The returned path is an ASCII-only byte string, resolved for relative
    segments and itself relative.

    The `path` is treated as a POSIX path if `posix` is True or as a Windows
    path with blackslash separators otherwise.

    If `preserve_spaces` is True, then the spaces in `path` will not be replaced.
    """
    # if the path is UTF, try to use unicode instead
    if not isinstance(path, str):
        path = as_unicode(path)

    path = path.strip()

    if not is_posixpath(path):
        path = as_winpath(path)
        posix = False

    path = resolve(path, posix)

    _pathmod, path_sep = path_handlers(path, posix)

    segments = [s.strip() for s in path.split(path_sep) if s.strip()]
    segments = [
        portable_filename(s, preserve_spaces=preserve_spaces, posix_only=posix_only)
        for s in segments
    ]

    if not segments:
        return "_"

    # always return posix
    path = "/".join(segments)
    return as_posixpath(path)


def path_handlers(path, posix=True):