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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
from __future__ import annotations
import argparse
import pytest
from streamlink.options import Argument, Arguments, Options
from streamlink.utils.args import comma_list_filter
class TestOptions:
@pytest.fixture()
def options(self):
return Options({
"foo-bar": "1",
"baz_qux": "2",
})
def test_defaults(self, options: Options):
empty = Options()
assert empty == {}
assert empty.defaults == {}
assert options.defaults == {
"foo-bar": "1",
"baz-qux": "2",
}
assert options == options.defaults
def test_get_set(self, options: Options):
assert options.get("foo-bar") == "1"
assert options["foo-bar"] == "1"
assert options.get("baz_qux") == "2"
assert options["baz_qux"] == "2"
assert options.get("non_existing") is None
assert options["non_existing"] is None
options.set("abc-def", 3.14)
assert options.get("abc-def") == 3.14
assert options.get("abc-def") == 3.14
obj = object()
options["foo_bar"] = obj
assert options.get("foo-bar") is obj
assert options.get("foo_bar") is obj
assert list(options.items()) == [
("foo-bar", obj),
("baz-qux", "2"),
("abc-def", 3.14),
]
def test_update(self, options: Options):
assert options.get("foo-bar") == "1"
assert options.get("non_existing") is None
options.update({"foo-bar": "value"})
assert options.get("foo-bar") == "value"
other = Options({"foo-bar": "VALUE"})
other.set("abc", "def")
options.update(other)
assert list(options.items()) == [
("foo-bar", "VALUE"),
("baz-qux", "2"),
("abc", "def"),
]
def test_clear(self, options: Options):
assert options.get("foo-bar") == "1"
options.set("foo-bar", "other")
assert options.get("foo-bar") == "other"
options.clear()
assert options.get("foo-bar") == "1"
class TestMappedOptions:
class MappedOptions(Options):
def _get_uppercase(self, key):
return self.get_explicit(key.upper())
def _get_add(self, key):
return int(self.get_explicit(key)) + 1
def _set_uppercase(self, key, value):
self.set_explicit(key.upper(), value)
def _set_add(self, key, value):
self.set_explicit(key, int(value) + 1)
_MAP_GETTERS = {
"foo-bar": _get_uppercase,
"baz": _get_add,
}
_MAP_SETTERS = {
"foo-bar": _set_uppercase,
"baz": _set_add,
}
@pytest.fixture()
def options(self):
return self.MappedOptions({"foo-bar": 123, "baz": 100})
def test_mapped_key(self, options: MappedOptions):
assert options.get("foo-bar") is None
assert options.get("foo_bar") is None
assert options.get_explicit("foo-bar") == 123
assert options.get_explicit("foo_bar") == 123
assert options.get_explicit("FOO-BAR") is None
assert options.get_explicit("FOO_BAR") is None
options.set("foo-bar", 321)
assert options.get("foo-bar") == 321
assert options.get("foo_bar") == 321
assert options.get_explicit("foo-bar") == 123
assert options.get_explicit("foo_bar") == 123
assert options.get_explicit("FOO-BAR") == 321
assert options.get_explicit("FOO_BAR") == 321
def test_mapped_value(self, options: MappedOptions):
assert options.get("baz") == 101
assert options.get_explicit("baz") == 100
options.set("baz", 0)
assert options.get("baz") == 2
assert options.get_explicit("baz") == 1
def test_mutablemapping_methods(self, options: MappedOptions):
options["key"] = "value"
assert options["key"] == "value"
assert options["foo-bar"] is None
options["baz"] = 0
assert options["baz"] == 2
assert "foo-bar" in options
assert "qux" not in options
assert len(options) == 3
assert list(iter(options)) == ["foo-bar", "baz", "key"]
assert list(options.keys()) == ["foo-bar", "baz", "key"]
assert list(options.values()) == [123, 1, "value"]
assert list(options.items()) == [("foo-bar", 123), ("baz", 1), ("key", "value")]
class TestArgument:
def test_name(self):
assert Argument("test-arg").argument_name("plugin") == "--plugin-test-arg"
assert Argument("test-arg").namespace_dest("plugin") == "plugin_test_arg"
assert Argument("test-arg").dest == "test_arg"
def test_name_plugin(self):
assert Argument("test-arg").argument_name("test_plugin") == "--test-plugin-test-arg"
assert Argument("test-arg").namespace_dest("test_plugin") == "test_plugin_test_arg"
assert Argument("test-arg").dest == "test_arg"
def test_name_override(self):
assert Argument("test", argument_name="override-name").argument_name("plugin") == "--override-name"
assert Argument("test", argument_name="override-name").namespace_dest("plugin") == "override_name"
assert Argument("test", argument_name="override-name").dest == "test"
def test_default(self):
arg = Argument("test", default=123)
assert arg.default == 123
with pytest.raises(AttributeError):
# noinspection PyPropertyAccess
arg.default = 456
def test_help_suppress(self):
argA = Argument("test", help="test")
argB = Argument("test", help=argparse.SUPPRESS)
argC = Argument("test", help=f"{argparse.SUPPRESS[:1]}{argparse.SUPPRESS[1:]}")
assert argA.help is not argparse.SUPPRESS
assert id(argB.help) == id(argparse.SUPPRESS)
assert id(argC.help) == id(argparse.SUPPRESS)
def test_options(self):
arg = Argument(
"test",
action="append",
nargs=2,
default=(0, 0),
type=int,
choices=[1, 2, 3],
required=True,
help=argparse.SUPPRESS,
metavar=("ONE", "TWO"),
dest="dest",
requires=["other"],
prompt="Test!",
sensitive=False,
argument_name=None,
)
assert arg.options == {
"action": "append",
"nargs": 2,
"default": (0, 0),
"type": int,
"choices": (1, 2, 3),
"help": argparse.SUPPRESS,
"metavar": ("ONE", "TWO"),
"dest": "dest",
}
arg = Argument(
"test",
action="store_const",
const=123,
)
assert arg.options == {
"action": "store_const",
"const": 123,
}
# doesn't include the const keyword if action is store_true or store_false
assert Argument("test", action="store_true").options == {"action": "store_true", "default": False}
assert Argument("test", action="store_true", default=123).options == {"action": "store_true", "default": 123}
assert Argument("test", action="store_false").options == {"action": "store_false", "default": True}
assert Argument("test", action="store_false", default=123).options == {"action": "store_false", "default": 123}
def test_equality(self):
a1 = Argument(
"test",
action="append",
nargs=2,
default=("0", "0"),
type=comma_list_filter(["1", "2", "3"], unique=True),
choices=["1", "2", "3"],
required=True,
help=argparse.SUPPRESS,
metavar=("ONE", "TWO"),
dest="dest",
requires=["other"],
prompt="Test!",
sensitive=False,
argument_name="custom-name",
)
a2 = Argument(
"test",
action="append",
nargs=2,
default=("0", "0"),
type=comma_list_filter(["1", "2", "3"], unique=True),
choices=["1", "2", "3"],
required=True,
help=argparse.SUPPRESS,
metavar=("ONE", "TWO"),
dest="dest",
requires=["other"],
prompt="Test!",
sensitive=False,
argument_name="custom-name",
)
a3 = Argument("foo")
assert a1 is not a2
assert a1 == a2
assert a1 != a3
assert a2 != a3
@pytest.mark.parametrize(
("action", "default", "expected_const", "expected_default"),
[
pytest.param("store_true", None, True, False, id="store_true-no-default"),
pytest.param("store_true", "default", True, "default", id="store_true-with-default"),
pytest.param("store_false", None, False, True, id="store_false-no-default"),
pytest.param("store_false", "default", False, "default", id="store_false-with-default"),
],
)
def test_store_true_false(self, action: str, default: str | None, expected_const: bool, expected_default: str | None):
arg = Argument("foo", action=action, default=default)
assert arg.const is expected_const
assert arg.default is expected_default
class TestArguments:
def test_getter(self):
test1 = Argument("test1")
test2 = Argument("test2")
args = Arguments(test1, test2)
assert args.get("test1") == test1
assert args.get("test2") == test2
assert args.get("test3") is None
def test_iter(self):
test1 = Argument("test1")
test2 = Argument("test2")
args = Arguments(test1, test2)
i_args = iter(args)
assert next(i_args) == test1
assert next(i_args) == test2
def test_add(self):
test1 = Argument("test1")
test2 = Argument("test2")
test3 = Argument("test3")
args = Arguments(test1, test2)
assert list(iter(args)) == [test1, test2]
args.add(test3)
assert list(iter(args)) == [test3, test1, test2]
def test_equality(self):
test1 = Arguments()
test1.add(Argument("testA"))
test1.add(Argument("testB"))
test2 = Arguments(Argument("testB"), Argument("testA"))
test3 = Arguments(Argument("testA"), Argument("testB"))
assert test1 == test2
assert test1 != test3
assert test2 != test3
def test_requires(self):
test1 = Argument("test1", requires="test2")
test2 = Argument("test2", requires="test3")
test3 = Argument("test3")
args = Arguments(test1, test2, test3)
assert list(args.requires("test1")) == [test2, test3]
def test_requires_invalid(self):
test1 = Argument("test1", requires="test2")
args = Arguments(test1)
with pytest.raises(KeyError) as cm:
list(args.requires("test1"))
assert cm.value.args[0] == "test2 is not a valid argument for this plugin"
@pytest.mark.parametrize(
"args",
[
pytest.param(
Arguments(
Argument("test1", requires="test2"),
Argument("test2", requires="test1"),
),
id="Cycle",
),
pytest.param(
Arguments(
Argument("test1", requires="test2"),
Argument("test2", requires="test3"),
Argument("test3", requires="test1"),
),
id="Cycle deep",
),
pytest.param(
Arguments(
Argument("test1", requires="test1"),
),
id="Cycle self",
),
],
)
def test_requires_cycle(self, args: Arguments):
with pytest.raises(RuntimeError) as cm:
list(args.requires("test1"))
assert cm.value.args[0] == "cycle detected in plugin argument config"
|
