Builds a file tree based on the received spec. Params: spec: A mapping from filesystem paths to file contents. If the content

Generate a subproject from zero, ignoring what was in the folder. If `dst_path` was missing, it will be created. Otherwise, `src_path

Copy a template to a destination, from zero.

Load answers data from a `$dst_path/$answers_file` file if it exists.

Update a subproject, from its template.

Save the current repo state in git. Args: dst: Path to the repo to save. message: Commit message. tag: Tag to create, opt

Check that we get a prompt in the standard form

Spawn a copier process TUI to interact with.

Gets `git` command, or fails if it's not available.

Initialize a Git repository with a first commit. Args: message: The first commit message.

Update a subproject that was already generated. See [updating a project][updating-a-project].

Deprecate a module member as internal with a warning. Args: member: The module member name. module: The module name.

Deprecate a module as internal with a warning. Args: name: The module name.

Load settings from a file.

Update a subproject from its template, discarding subproject evolution.

Clone repo into some temporary destination. Remote repositories are cached as a local git mirror and checked out into a temporary worktree, s

Render one templated string. Args: string: The template source string. extra_context:

Render a single templated value using Jinja. If the value cannot be used as a template, it will be returned as is. `extra_answers` ar

Load settings from a YAML file. If `settings_path` is not given, the path is determined from the `COPIER_SETTINGS_PATH` environment variable

Multiple choices are properly remembered and selected in TUI when updating.

Compute the deterministic on-disk location of the mirror for `url`.

Produce render context for Jinja.

Parse anything to bool. Params: value: Anything to be casted to a bool. Tries to be as smart as possible. 1. Ca

Handle exceptions while running a method.

Cast answer to expected type.

Transform `url` into a git-parseable origin URL. Args: url: Valid examples: - gh:copier-org/copier -

Render the type name and return it.

Get or create yield context for an environment.

r"""Convert weird characters returned by Git to normal UTF-8 path strings. A filename like âñ will be reported by Git as "\\303\\242\\303\\261" (

Determine if a file or directory can be rendered. Args: dst_relpath: Relative path to destination. is

Get the default value for this question, casted to its expected type.

Get the installed git version.

Get skip condition for question.

Parse the answer according to the question's type.

Print string with common format.

Try to convert a value into an enum. If the value is not a valid enum member, return the original value.

Set the current phase for the duration of a context.

Validate user answer.

Check whether a template uses unsafe features.

Run the given tasks. Arguments: tasks: The list of tasks to run.

Load external data lazily. Result keys are used for rendering, and values are the parsed contents of the YAML files specified in [ext

Tell whether `url` points to a remote repository worth caching. Local repositories (existing directories or bundle files, as well as paths ma

Produce a function that matches against specified patterns.

Check that invalid input is reported correctly

Get closest match for the installed copier version.

Deprecate a module member with a new import statement with a warning. Args: member: The module member name. module: The module na

Separates config and questions data.

Get latest git tag, sorted by PEP 440. Args: url: Git-parseable URL of the repo. As returned by [get_repo][copier

Get the value for multiline.

Indicate if `git` is available in the system.

Indicate if a given path is a git repo root directory.

Check if a repository is trusted. Args: trust: The set of trusted repositories or prefixes. repository: The repository URL to che

Load the `copier.yml` file. This is like a simple YAML load, but applying all specific quirks needed for [the `copier.yml` file][the-copierym

Get a callable to match paths against all exclusions.

Get a callable to match paths against all skip-if-exists patterns.

Get migration objects that match current version spec. Versions are compared using PEP 440. See [migrations][]. Args:

Parse the `yield` tag.

Print exception with common format.

Update a subproject, keeping answers but discarding evolution.

Get only answers that will be remembered in the copier answers file.

Ask the questions of the questionnaire and record their answers.

Execute all stored cleanup methods.

Create a temporary worktree of `mirror` at `ref` in `location`. `git worktree add` refuses a path that already exists, so remove the pre-allo

Remove `path`, coping with git's read-only files (e.g. on Windows).

Get the directory where cached git mirrors are stored. Defaults to a per-user cache directory (via `platformdirs`), but can be overridden wit

Get a cached `--mirror` clone of `url`, creating or refreshing it. On first use the remote is mirror-cloned into the cache. On subsequent use

Initialize a git repository in the current directory.

Tell whether `mirror` is a usable bare git repository. Guards against partial or corrupt cache entries (e.g. left behind by an interrupted cl

Parse a single answer according to the question's type.

Remove files and directories only found in "old" template. This is an internal helper method used to process a comparison of 2 directories, w

Render one file. Args: src_relpath: File to be rendered. It must be a path relative to the template

Create one folder (without content). Args: dst_relpath: Folder to be created. It must be a path relative to the

Render a set of parts into path and context pairs. If a yield tag is found in a part, it will recursively yield multiple path and con

Render one relative path into multiple path and context pairs. Args: relpath: The relative path to be rendered. O

Render one symlink. Args: src_relpath: Symlink to be rendered. It must be a path relative to the

Render the template in the subproject root.

Render a value, which may or may not be a templated string. Args: value: The value to render. extra_

Properly solve render conflicts. It can ask the user if running in interactive mode.

Remove any embedded `user:password@` credentials from `url`. Used to build the cache key so that the same repository accessed with different

Propagate executable-bit changes to the destination's git index. Only needed when ``core.fileMode`` is ``false`` (the Windows default

Get the current phase.

Deprecate answers file template paths in template's non-root directory.