Function run_update

copier/_main.py:1796–1849

Update a subproject, from its template.

(
    dst_path: Path | str = ".",
    data: dict[str, Any] | None = None,
    *,
    answers_file: Path | str | None = None,
    vcs_ref: str | VcsRef | None = None,
    settings: Settings | SettingsModel | None = None,
    exclude: Sequence[str] = (),
    use_prereleases: bool = False,
    skip_if_exists: Sequence[str] = (),
    cleanup_on_error: bool = True,
    defaults: bool = False,
    user_defaults: dict[str, Any] | None = None,
    overwrite: bool = False,
    pretend: bool = False,
    quiet: bool = False,
    conflict: Literal["inline", "rej"] = "inline",
    context_lines: PositiveInt = 3,
    unsafe: bool = False,
    skip_answered: bool = False,
    skip_tasks: bool = False,
)

def run_update(
    dst_path: Path | str = ".",
    data: dict[str, Any] | None = None,
    *,
    answers_file: Path | str | None = None,
    vcs_ref: str | VcsRef | None = None,
    settings: Settings | SettingsModel | None = None,
    exclude: Sequence[str] = (),
    use_prereleases: bool = False,
    skip_if_exists: Sequence[str] = (),
    cleanup_on_error: bool = True,
    defaults: bool = False,
    user_defaults: dict[str, Any] | None = None,
    overwrite: bool = False,
    pretend: bool = False,
    quiet: bool = False,
    conflict: Literal["inline", "rej"] = "inline",
    context_lines: PositiveInt = 3,
    unsafe: bool = False,
    skip_answered: bool = False,
    skip_tasks: bool = False,
) -> Worker:
    """Update a subproject, from its template."""
    with Worker(
        dst_path=Path(dst_path),
        data=data or {},
        answers_file=(
            RelativePath(answers_file)
            if isinstance(answers_file, str)
            else answers_file
        ),
        vcs_ref=vcs_ref,
        settings=(
            SettingsModel(defaults=settings.defaults, trust=settings.trust)
            if isinstance(settings, Settings)
            else (settings or SettingsModel.from_file())
        ),
        exclude=exclude,
        use_prereleases=use_prereleases,
        skip_if_exists=skip_if_exists,
        cleanup_on_error=cleanup_on_error,
        defaults=defaults,
        user_defaults=user_defaults or {},
        overwrite=overwrite,
        pretend=pretend,
        quiet=quiet,
        conflict=conflict,
        context_lines=context_lines,
        unsafe=unsafe,
        skip_answered=skip_answered,
        skip_tasks=skip_tasks,
    ) as worker:
        worker.run_update()
    return worker


def get_update_data(