Source code for ramble.util.file_util

# Copyright 2022-2025 The Ramble Authors
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
# option. This file may not be copied, modified, or distributed
# except according to those terms.

import os


_DRY_RUN_PATH_PREFIX = os.path.join("dry-run", "path", "to")



[docs]
def get_file_path(path: str, workspace) -> str:
    """A wrapper for file paths used in a Ramble application, to facilitate testing.

    Args:
        path (str): A file path
        workspace (Workspace): A ramble workspace

    Returns:
        (str): A file path
    """
    if not workspace.dry_run or is_dry_run_path(path):
        return path
    return os.path.join(_DRY_RUN_PATH_PREFIX, os.path.relpath(path))




[docs]
def is_dry_run_path(path: str) -> bool:
    """Check if the path is already a dry_run path"""
    return str(path).startswith(_DRY_RUN_PATH_PREFIX)




[docs]
def create_symlink(base, link):
    """
    Create symlink of a file to give a known and predictable path
    """
    if os.path.islink(link):
        os.unlink(link)

    os.symlink(base, link)