docs: include full _copier_conf attributes list #2127
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -95,27 +95,40 @@ suitable to [autoupdate your project safely][the-copier-answersyml-file]: | |||||
|
|
||||||
| ### `_copier_conf` | ||||||
|
|
||||||
| !!! note | ||||||
|
|
||||||
| - `_copier_conf` contains JSON-serializable data. | ||||||
| - `_copier_conf` can be serialized with `{{ _copier_conf|to_json }}`. | ||||||
| - ⚠️ `_copier_conf` may contain secret answers inside its `.data` key. | ||||||
| - Modifying `_copier_conf` doesn't alter the current rendering configuration. | ||||||
|
|
||||||
| Attributes: | ||||||
|
|
||||||
| | Name | Type | Description | | ||||||
| | ------------------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ||||||
| | `answers_file` | `Path` | The path for [the answers file][the-copier-answersyml-file] relative to `dst_path`.<br>See the [`answers_file`][] setting for related information. | | ||||||
| | `cleanup_on_error` | `bool` | When `True`, delete `dst_path` if there's an error.<br>See the [`cleanup_on_error`][] setting for related information. | | ||||||
| | `conflict` | `Literal["inline", "rej"]` | The output format of a diff code hunk when [updating][updating-a-project] a file yields conflicts.<br>See the [`conflict`][] setting for related information. | | ||||||
| | `context_lines` | `PositiveInt` | Lines of context to consider when solving conflicts in updates.<br>See the [`context_lines`][] setting for related information. | | ||||||
| | `data` | `dict[str, Any]` | Answers to the questionnaire, defined in the template, provided via CLI (`-d,--data`) or API (`data`).<br>See the [`data`][] setting for related information.<br>⚠️ May contain secret answers. | | ||||||
| | `defaults` | `bool` | When `True`, use default answers to questions.<br>See the [`defaults`][] setting for related information. | | ||||||
| | `dst_path` | `Path` | Destination path where to render the subproject.<br>⚠️ When [updating a project][updating-a-project], it may be a temporary directory, as Copier's update algorithm generates fresh copies using the old and new template versions in temporary locations. | | ||||||
| | `exclude` | `Sequence[str]` | Specified additional [file exclusion patterns][patterns-syntax].<br>See the [`exclude`][] setting for related information. | | ||||||
| | `os` | `str` | The detected operating system, either `"linux"`, `"macos"`, `"windows"` or `None`. | | ||||||
| | `overwrite` | `bool` | When `True`, overwrite files that already exist, without asking.<br>See the [`overwrite`][] setting for related information. | | ||||||
| | `pretend` | `bool` | When `True`, produce no real rendering.<br>See the [`pretend`][] setting for related information. | | ||||||
| | `quiet` | `bool` | When `True`, disable all output.<br>See the [`quiet`][] setting for related information. | | ||||||
| | `sep` | `str` | The operating system-specific directory separator. | | ||||||
| | `settings` | `pydantic.BaseModel` | Specified settings that control copier's behavior.<br>See the [`settings`][] page for related information. | | ||||||
| | `skip_answered` | `bool` | When `True`, skip questions that have already been answered.<br>See the [`skip_answered`][] setting for related information. | | ||||||
| | `skip_if_exists` | `Sequence[str]` | Specified additional [file skip patterns][patterns-syntax].<br>See the [`skip_if_exists`][] setting for related information. | | ||||||
| | `skip_tasks` | `bool` | When `True`, skip [template tasks execution][tasks].<br>See the [`skip_tasks`][] setting for related information. | | ||||||
| | `src_path` | `Path` | The absolute path to the (cloned/downloaded) template on disk. | | ||||||
| | `unsafe` | `bool` | When `True`, allow usage of unsafe templates.<br>See the [`unsafe`][] setting for related information. | | ||||||
| | `use_prereleases` | `bool` | When `True`, `vcs_ref`/`vcs_ref_hash` may refer to a prerelease version of the template.<br>See the [`use_prereleases`][] setting for related information. | | ||||||
| | `user_defaults` | `dict[str, Any]` | Specified user defaults that may override a template's defaults during question prompts. | | ||||||
| | `vcs_ref` | `str | None` | The VCS tag/commit of the template, `None` if the template is not VCS-tracked.<br>See the [`vcs_ref`][] setting for related information. | | ||||||
|
There was a problem hiding this comment. @sisp we might have to disable There was a problem hiding this comment. Mhhh, not the first time that Prettier is causing some problems with Markdown formatting. How about using HTML and entity escaping in this particular case?
Suggested change
Not great, but perhaps better than disabling Prettier altogether for the table. |
||||||
| | `vcs_ref_hash` | `str | None` | The VCS commit hash of the template, `None` if the template is not VCS-tracked. | | ||||||
|
|
||||||
| ### `_copier_python` | ||||||
|
|
||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sisp Thoughts on the content for this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about referring to the
copier.settings.Settingsmodel class via[copier.settings.Settings][](thanks to mkdocstrings)?(The other rows will need re-formatting because of the wider column ...)