Classes
InitError
1
▼
Raised when the scaffold cannot be written (e.g. file collisions).
InitError
1
▼
Raised when the scaffold cannot be written (e.g. file collisions).
Methods
Internal Methods 1 ▼
__init__
2
▼
__init__
2
▼
def __init__(self, message: str, *, colliding: list[str] | None = None) -> None
Parameters
| Name | Type | Description |
|---|---|---|
message |
— |
|
colliding |
— |
Default:None
|
Functions
_existing_files
1
list[str]
▼
Return scaffold filenames that already exist in *directory*.
_existing_files
1
list[str]
▼
def _existing_files(directory: Path) -> list[str]
Parameters
| Name | Type | Description |
|---|---|---|
directory |
Path |
Returns
list[str]
run_init
2
list[Path]
▼
Write the scaffold into *directory*.
run_init
2
list[Path]
▼
def run_init(directory: Path, *, force: bool = False) -> list[Path]
Parameters
| Name | Type | Description |
|---|---|---|
directory |
Path |
Target directory (must exist). |
force |
bool |
Overwrite existing scaffold files if True. Default:False
|
Returns
list[Path]