Source code for simstack.methods.get_file

from pathlib import Path

from simstack.core.node import node
from simstack.models.files import FileStack, FileGetterArgs
from simstack.models.parameters import Resource



@node
def get_file(file_getter_args: FileGetterArgs) -> FileStack:
    """
    Retrieves a file from a given source and saves it to the specified target path.

    This function is responsible for handling the retrieval of files from a
    FileStack source and storing them to a local resource's target location.
    It will update the FileStack

    Args:
        file_getter_args (FileGetterArgs): The arguments for the file retrieval operation.

    Returns:
        FileStack: The modified FileStack with the local resource.

    Raises:
        NotImplementedError: If the function is not yet implemented.
    """
    raise NotImplementedError("get_file is not implemented yet.")
    return False