Function save_code

cdslib/core/utils/print_and_save.py:146–204

Backup the code in a src directory to a dst directory. The function recursively copies the code (determined by their file extensions) in the folder base_src_dir to a target folder dest_dir while preserving the sub-folder structures. This is useful to take snapshot of the codebase.

(src_dir: str, dest_dir: str, excluded_folders=("artifacts", "__MACOSX"))

def save_code(src_dir: str, dest_dir: str, excluded_folders=("artifacts", "__MACOSX")):
    """Backup the code in a src directory to a dst directory.

    The function recursively copies the code (determined by their file extensions) in the folder base_src_dir
    to a target folder dest_dir while preserving the sub-folder structures.

    This is useful to take snapshot of the codebase.

    Args:
        src_dir:
            The root folder directory to copy the code.
        dest_dir:
            The destination folder.
        excluded_folders:
            A list of subfolder names to exclude from the copying.  None: no excluded sub-folders.

    """
    if not os.path.exists(src_dir):
        assert False, "Source directory : " + src_dir + " does not exist"

    if not os.path.exists(dest_dir):
        os.makedirs(dest_dir)

    path_queue = [""]

    while len(path_queue) > 0:
        current_path = path_queue.pop()  # last item in the queue
        if not os.path.isdir(os.path.join(src_dir, current_path)):
            src_file = os.path.join(src_dir, current_path)
            if src_file.endswith(
                    (
                            ".py",
                            ".sh",
                            ".txt",
                            ".cpp",
                            ".c",
                            ".h",
                            ".hpp",
                            ".ipynb",
                            ".yaml",
                            ".cu",
                    )
            ):
                shutil.copyfile(src_file, os.path.join(dest_dir, current_path))
        else:
            if excluded_folders is not None and current_path in excluded_folders:
                continue
            subdirs = os.listdir(os.path.join(src_dir, current_path))
            for subdir in subdirs:
                if subdir.startswith(".") or subdir.startswith("__"):  # ignore hidden directories or files
                    continue

                # create dst dir if src is a dir
                if os.path.isdir(os.path.join(src_dir, current_path, subdir)):
                    dst_subdir = os.path.join(dest_dir, current_path, subdir)
                    if not os.path.exists(dst_subdir):
                        os.makedirs(dst_subdir)