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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
# -*- coding: utf-8 -*-
import click
def test_ensure_context_objects(runner):
class Foo(object):
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo, ensure=True)
@click.group()
@pass_foo
def cli(foo):
pass
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "default\n"
def test_get_context_objects(runner):
class Foo(object):
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo, ensure=True)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
ctx.obj.title = "test"
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_get_context_objects_no_ensuring(runner):
class Foo(object):
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
ctx.obj.title = "test"
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_get_context_objects_missing(runner):
class Foo(object):
pass
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
pass
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert result.exception is not None
assert isinstance(result.exception, RuntimeError)
assert (
"Managed to invoke callback without a context object of type"
" 'Foo' existing" in str(result.exception)
)
def test_multi_enter(runner):
called = []
@click.command()
@click.pass_context
def cli(ctx):
def callback():
called.append(True)
ctx.call_on_close(callback)
with ctx:
pass
assert not called
result = runner.invoke(cli, [])
assert result.exception is None
assert called == [True]
def test_global_context_object(runner):
@click.command()
@click.pass_context
def cli(ctx):
assert click.get_current_context() is ctx
ctx.obj = "FOOBAR"
assert click.get_current_context().obj == "FOOBAR"
assert click.get_current_context(silent=True) is None
runner.invoke(cli, [], catch_exceptions=False)
assert click.get_current_context(silent=True) is None
def test_context_meta(runner):
LANG_KEY = "{}.lang".format(__name__)
def set_language(value):
click.get_current_context().meta[LANG_KEY] = value
def get_language():
return click.get_current_context().meta.get(LANG_KEY, "en_US")
@click.command()
@click.pass_context
def cli(ctx):
assert get_language() == "en_US"
set_language("de_DE")
assert get_language() == "de_DE"
runner.invoke(cli, [], catch_exceptions=False)
def test_context_pushing():
rv = []
@click.command()
def cli():
pass
ctx = click.Context(cli)
@ctx.call_on_close
def test_callback():
rv.append(42)
with ctx.scope(cleanup=False):
# Internal
assert ctx._depth == 2
assert rv == []
with ctx.scope():
# Internal
assert ctx._depth == 1
assert rv == [42]
def test_pass_obj(runner):
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = "test"
@cli.command()
@click.pass_obj
def test(obj):
click.echo(obj)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_close_before_pop(runner):
called = []
@click.command()
@click.pass_context
def cli(ctx):
ctx.obj = "test"
@ctx.call_on_close
def foo():
assert click.get_current_context().obj == "test"
called.append(True)
click.echo("aha!")
result = runner.invoke(cli, [])
assert not result.exception
assert result.output == "aha!\n"
assert called == [True]
def test_make_pass_decorator_args(runner):
"""
Test to check that make_pass_decorator doesn't consume arguments based on
invocation order.
"""
class Foo(object):
title = "foocmd"
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
@cli.command()
@click.pass_context
@pass_foo
def test1(foo, ctx):
click.echo(foo.title)
@cli.command()
@pass_foo
@click.pass_context
def test2(ctx, foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test1"])
assert not result.exception
assert result.output == "foocmd\n"
result = runner.invoke(cli, ["test2"])
assert not result.exception
assert result.output == "foocmd\n"
def test_exit_not_standalone():
@click.command()
@click.pass_context
def cli(ctx):
ctx.exit(1)
assert cli.main([], "test_exit_not_standalone", standalone_mode=False) == 1
@click.command()
@click.pass_context
def cli(ctx):
ctx.exit(0)
assert cli.main([], "test_exit_not_standalone", standalone_mode=False) == 0
|
