/
cli.py
231 lines (210 loc) · 6.8 KB
/
cli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
"""Main `cookiecutter` CLI."""
import collections
import json
import os
import sys
import click
from cookiecutter import __version__
from cookiecutter.exceptions import (
ContextDecodingException,
FailedHookException,
InvalidModeException,
InvalidZipRepository,
OutputDirExistsException,
RepositoryCloneFailed,
RepositoryNotFound,
UndefinedVariableInTemplate,
UnknownExtension,
)
from cookiecutter.log import configure_logger
from cookiecutter.main import cookiecutter
from cookiecutter.config import get_user_config
def version_msg():
"""Return the Cookiecutter version, location and Python powering it."""
python_version = sys.version
location = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
message = 'Cookiecutter %(version)s from {} (Python {})'
return message.format(location, python_version)
def validate_extra_context(ctx, param, value):
"""Validate extra context."""
for s in value:
if '=' not in s:
raise click.BadParameter(
'EXTRA_CONTEXT should contain items of the form key=value; '
"'{}' doesn't match that form".format(s)
)
# Convert tuple -- e.g.: ('program_name=foobar', 'startsecs=66')
# to dict -- e.g.: {'program_name': 'foobar', 'startsecs': '66'}
return collections.OrderedDict(s.split('=', 1) for s in value) or None
def list_installed_templates(default_config, passed_config_file):
"""List installed (locally cloned) templates. Use cookiecutter --list-installed."""
config = get_user_config(passed_config_file, default_config)
cookiecutter_folder = config.get('cookiecutters_dir')
if not os.path.exists(cookiecutter_folder):
click.echo(
'Error: Cannot list installed templates. Folder does not exist: '
'{}'.format(cookiecutter_folder)
)
sys.exit(-1)
template_names = [
folder
for folder in os.listdir(cookiecutter_folder)
if os.path.exists(
os.path.join(cookiecutter_folder, folder, 'cookiecutter.json')
)
]
click.echo('{} installed templates: '.format(len(template_names)))
for name in template_names:
click.echo(' * {}'.format(name))
@click.command(context_settings=dict(help_option_names=['-h', '--help']))
@click.version_option(__version__, '-V', '--version', message=version_msg())
@click.argument('template', required=False)
@click.argument('extra_context', nargs=-1, callback=validate_extra_context)
@click.option(
'--no-input',
is_flag=True,
help='Do not prompt for parameters and only use cookiecutter.json file content',
)
@click.option(
'-c',
'--checkout',
help='branch, tag or commit to checkout after git clone',
)
@click.option(
'--directory',
help='Directory within repo that holds cookiecutter.json file '
'for advanced repositories with multi templates in it',
)
@click.option(
'-v', '--verbose', is_flag=True, help='Print debug information', default=False
)
@click.option(
'--replay',
is_flag=True,
help='Do not prompt for parameters and only use information entered previously',
)
@click.option(
'--replay-file',
type=click.Path(),
default=None,
help='Use this file for replay instead of the default.',
)
@click.option(
'-f',
'--overwrite-if-exists',
is_flag=True,
help='Overwrite the contents of the output directory if it already exists',
)
@click.option(
'-s',
'--skip-if-file-exists',
is_flag=True,
help='Skip the files in the corresponding directories if they already exist',
default=False,
)
@click.option(
'-o',
'--output-dir',
default='.',
type=click.Path(),
help='Where to output the generated project dir into',
)
@click.option(
'--config-file', type=click.Path(), default=None, help='User configuration file'
)
@click.option(
'--default-config',
is_flag=True,
help='Do not load a config file. Use the defaults instead',
)
@click.option(
'--debug-file',
type=click.Path(),
default=None,
help='File to be used as a stream for DEBUG logging',
)
@click.option(
'--accept-hooks',
type=click.Choice(['yes', 'ask', 'no']),
default='yes',
help='Accept pre/post hooks',
)
@click.option(
'-l', '--list-installed', is_flag=True, help='List currently installed templates.'
)
def main(
template,
extra_context,
no_input,
checkout,
verbose,
replay,
overwrite_if_exists,
output_dir,
config_file,
default_config,
debug_file,
directory,
skip_if_file_exists,
accept_hooks,
replay_file,
list_installed,
):
"""Create a project from a Cookiecutter project template (TEMPLATE).
Cookiecutter is free and open source software, developed and managed by
volunteers. If you would like to help out or fund the project, please get
in touch at https://github.com/cookiecutter/cookiecutter.
"""
# Commands that should work without arguments
if list_installed:
list_installed_templates(default_config, config_file)
sys.exit(0)
# Raising usage, after all commands that should work without args.
if not template or template.lower() == 'help':
click.echo(click.get_current_context().get_help())
sys.exit(0)
configure_logger(stream_level='DEBUG' if verbose else 'INFO', debug_file=debug_file)
# If needed, prompt the user to ask whether or not they want to execute
# the pre/post hooks.
if accept_hooks == "ask":
_accept_hooks = click.confirm("Do you want to execute hooks?")
else:
_accept_hooks = accept_hooks == "yes"
if replay_file:
replay = replay_file
try:
cookiecutter(
template,
checkout,
no_input,
extra_context=extra_context,
replay=replay,
overwrite_if_exists=overwrite_if_exists,
output_dir=output_dir,
config_file=config_file,
default_config=default_config,
password=os.environ.get('COOKIECUTTER_REPO_PASSWORD'),
directory=directory,
skip_if_file_exists=skip_if_file_exists,
accept_hooks=_accept_hooks,
)
except (
ContextDecodingException,
OutputDirExistsException,
InvalidModeException,
FailedHookException,
UnknownExtension,
InvalidZipRepository,
RepositoryNotFound,
RepositoryCloneFailed,
) as e:
click.echo(e)
sys.exit(1)
except UndefinedVariableInTemplate as undefined_err:
click.echo('{}'.format(undefined_err.message))
click.echo('Error message: {}'.format(undefined_err.error.message))
context_str = json.dumps(undefined_err.context, indent=4, sort_keys=True)
click.echo('Context: {}'.format(context_str))
sys.exit(1)
if __name__ == "__main__":
main()