File: test_entry_points.py

package info (click to toggle)
python-dist-meta 0.9.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,964 kB
  • sloc: python: 2,944; makefile: 9
file content (369 lines) | stat: -rw-r--r-- 10,216 bytes parent folder | download | duplicates (2)
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
365
366
367
368
369
# stdlib
from configparser import ConfigParser
from io import StringIO
from operator import attrgetter, itemgetter
from textwrap import dedent
from typing import Dict, Iterator, List, Sequence, Union

# 3rd party
import pytest
from coincidence.regressions import AdvancedDataRegressionFixture, AdvancedFileRegressionFixture
from domdf_python_tools.paths import PathPlus

# this package
from dist_meta import entry_points

expected_load_output = {"console_scripts": {"py.test": "pytest:console_main", "pytest": "pytest:console_main"}}


@pytest.fixture()
def example_metadata() -> str:
	return (PathPlus(__file__).parent / "example_entry_points.txt").read_text()


def test_loads(advanced_data_regression: AdvancedDataRegressionFixture):
	entry_points_content = dedent(
			"""
			[console_scripts]
			py.test = pytest:console_main
			pytest = pytest:console_main
			"""
			)

	assert entry_points.loads(entry_points_content) == expected_load_output

	cp = ConfigParser()
	cp.read_string(entry_points_content)

	for section in cp.sections():
		assert section in expected_load_output
		assert cp.options(section) == list(expected_load_output[section].keys())


def test_load(tmp_pathplus: PathPlus):
	(tmp_pathplus / "entry_points.txt").write_lines([
			"[console_scripts]",
			"py.test = pytest:console_main",
			"pytest = pytest:console_main",
			])

	assert entry_points.load(tmp_pathplus / "entry_points.txt") == expected_load_output


def test_loads_longer(
		advanced_data_regression: AdvancedDataRegressionFixture,
		example_metadata: str,
		):
	advanced_data_regression.check(entry_points.loads(example_metadata))


def test_load_longer(
		tmp_pathplus: PathPlus,
		advanced_data_regression: AdvancedDataRegressionFixture,
		example_metadata: str,
		):
	(tmp_pathplus / "entry_points.txt").write_text(example_metadata)
	advanced_data_regression.check(entry_points.load(tmp_pathplus / "entry_points.txt"))


def test_lazy_loads():
	entry_points_content = dedent(
			"""
			[console_scripts]
			py.test = pytest:console_main
			pytest = pytest:console_main
			"""
			)

	eps = entry_points.lazy_loads(entry_points_content)
	assert isinstance(eps, Iterator)

	for group, entries in eps:
		assert isinstance(group, str)
		assert group == "console_scripts"
		assert isinstance(entries, Iterator)

		for name, epstr in entries:
			assert name in {"py.test", "pytest"}
			assert epstr == "pytest:console_main"

	eps = entry_points.lazy_loads(entry_points_content)
	assert {k: dict(v) for k, v in eps} == expected_load_output


def test_lazy_load(tmp_pathplus: PathPlus):
	(tmp_pathplus / "entry_points.txt").write_lines([
			'',
			"[console_scripts]",
			"py.test = pytest:console_main",
			"pytest = pytest:console_main",
			])

	eps = entry_points.lazy_load(tmp_pathplus / "entry_points.txt")

	assert isinstance(eps, Iterator)

	for group, entries in eps:
		assert isinstance(group, str)
		assert group == "console_scripts"
		assert isinstance(entries, Iterator)

		for name, epstr in entries:
			assert name in {"py.test", "pytest"}
			assert epstr == "pytest:console_main"

	eps = entry_points.lazy_load(tmp_pathplus / "entry_points.txt")
	assert {k: dict(v) for k, v in eps} == expected_load_output


def test_loads_bad_syntax():
	entry_points_content = '\n'.join(["py.test = pytest:console_main", "pytest = pytest:console_main"])
	assert entry_points.loads(entry_points_content) == {}


def to_pure_dict(
		data: Union[entry_points.EntryPointMap, Dict[str, Sequence[entry_points.EntryPoint]]],
		) -> entry_points.EntryPointMap:

	output: entry_points.EntryPointMap = {}

	for group in data:
		output[group] = {}

		for name in data[group]:
			if isinstance(name, entry_points.EntryPoint):
				output[group][name.name] = name.value
			else:
				output[group][name] = data[group][name]  # type: ignore[call-overload]

	return output


@pytest.mark.parametrize(
		"ep_dict",
		[
				pytest.param({
						"console_scripts": {"py.test": "pytest:console_main", "pytest": "pytest:console_main"}
						},
								id="short"),
				pytest.param({
						"console_scripts": {"spam-cli": "spam:main_cli", "foobar": "foomod:main_bar [bar,baz]"},
						"gui_scripts": {"spam-gui": "spam.gui:main_gui"},
						"spam.magical": {"tomatoes": "spam:main_tomatoes"},
						"pytest11": {"nbval": "nbval.plugin"},
						},
								id="complex"),
				pytest.param({
						"console_scripts": [
								entry_points.EntryPoint("py.test", "pytest:console_main"),
								entry_points.EntryPoint("pytest", "pytest:console_main"),
								],
						},
								id="short_obj"),
				pytest.param({
						"console_scripts": [
								entry_points.EntryPoint("spam-cli", "spam:main_cli"),
								entry_points.EntryPoint("foobar", "foomod:main_bar [bar,baz]"),
								],
						"gui_scripts": [entry_points.EntryPoint("spam-gui", "spam.gui:main_gui")],
						"spam.magical": [entry_points.EntryPoint("tomatoes", "spam:main_tomatoes")],
						"pytest11": [entry_points.EntryPoint("nbval", "nbval.plugin")],
						},
								id="complex_obj"),
				]
		)
def test_dumps(
		advanced_file_regression: AdvancedFileRegressionFixture,
		ep_dict: Dict[str, Dict[str, str]],
		):
	advanced_file_regression.check(entry_points.dumps(ep_dict))

	pure_ep_dict = to_pure_dict(ep_dict)

	cp = ConfigParser()
	cp.read_dict(pure_ep_dict)
	output = StringIO()
	cp.write(output)
	advanced_file_regression.check(output.getvalue())

	for section in cp.sections():
		assert section in ep_dict
		assert cp.options(section) == list(pure_ep_dict[section].keys())

	cp = ConfigParser()
	cp.read_string(entry_points.dumps(ep_dict))
	output = StringIO()
	cp.write(output)
	advanced_file_regression.check(output.getvalue())


@pytest.mark.parametrize(
		"ep_dict",
		[
				pytest.param({
						"console_scripts": {"py.test": "pytest:console_main", "pytest": "pytest:console_main"},
						},
								id="short"),
				pytest.param({
						"console_scripts": {"spam-cli": "spam:main_cli", "foobar": "foomod:main_bar [bar,baz]"},
						"gui_scripts": {"spam-gui": "spam.gui:main_gui"},
						"spam.magical": {"tomatoes": "spam:main_tomatoes"},
						"pytest11": {"nbval": "nbval.plugin"},
						},
								id="complex"),
				]
		)
def test_dump(
		tmp_pathplus: PathPlus,
		advanced_file_regression: AdvancedFileRegressionFixture,
		ep_dict: Dict[str, Dict[str, str]],
		):
	entry_points.dump(ep_dict, tmp_pathplus / "entry_points.txt")
	advanced_file_regression.check_file(tmp_pathplus / "entry_points.txt")


def test_entry_point_class():

	ep = entry_points.EntryPoint(
			name="pytest",
			value="pytest:console_main",
			group="console_scripts",
			)

	assert ep.name == "pytest"
	assert ep.value == "pytest:console_main"
	assert ep.group == "console_scripts"
	assert ep.distro is None

	assert ep.load() is pytest.console_main

	assert ep.extras == []
	assert ep.module == "pytest"
	assert ep.attr == "console_main"


def test_entry_point_class_from_mapping():

	eps = entry_points.EntryPoint.from_mapping(
			{"pytest": "pytest:console_main", "py.test": "pytest:console_main"},
			group="console_scripts",
			)

	ep = eps[0]

	assert ep.name == "pytest"
	assert ep.value == "pytest:console_main"
	assert ep.group == "console_scripts"
	assert ep.distro is None

	assert ep.load() is pytest.console_main

	assert ep.extras == []
	assert ep.module == "pytest"
	assert ep.attr == "console_main"

	ep = eps[1]

	assert ep.name == "py.test"
	assert ep.value == "pytest:console_main"
	assert ep.group == "console_scripts"
	assert ep.distro is None

	assert ep.load() is pytest.console_main

	assert ep.extras == []
	assert ep.module == "pytest"
	assert ep.attr == "console_main"


def test_entry_point_class_extras():

	ep = entry_points.EntryPoint(
			name="pytest",
			value="pytest:console_main [cli]",
			group="console_scripts",
			)

	assert ep.name == "pytest"
	assert ep.value == "pytest:console_main [cli]"
	assert ep.group == "console_scripts"
	assert ep.distro is None

	assert ep.load() is pytest.console_main

	assert ep.extras == ["cli"]
	assert ep.module == "pytest"
	assert ep.attr == "console_main"


@pytest.mark.parametrize("value", ['', "1:", '-', ":console_main", "foo-bar"])
def test_entry_point_class_malformed(value: str):

	ep = entry_points.EntryPoint(
			name="pytest",
			value=value,
			group="console_scripts",
			)

	assert ep.value == value

	with pytest.raises(ValueError, match="Malformed entry point '.*'"):
		ep.load()

	with pytest.raises(ValueError, match="Malformed entry point '.*'"):
		attrgetter("extras")(ep)

	with pytest.raises(ValueError, match="Malformed entry point '.*'"):
		attrgetter("module")(ep)

	with pytest.raises(ValueError, match="Malformed entry point '.*'"):
		attrgetter("attr")(ep)

@pytest.mark.skip(reason="unknown error")
def test_get_entry_points(
		fake_virtualenv: List[PathPlus],
		tmp_pathplus: PathPlus,
		advanced_data_regression: AdvancedDataRegressionFixture,
		):

	all_eps = []

	for ep in entry_points.get_entry_points("console_scripts", path=fake_virtualenv):
		assert ep.group == "console_scripts"
		assert ep.distro is not None
		as_dict = ep._asdict()
		as_dict["extras"] = ep.extras
		as_dict["module"] = ep.module
		as_dict["attr"] = ep.attr
		as_dict["distro"] = as_dict["distro"]._asdict()
		as_dict["distro"]["path"] = as_dict["distro"]["path"].relative_to(tmp_pathplus)
		all_eps.append(as_dict)

	advanced_data_regression.check(sorted(all_eps, key=itemgetter("name")))

@pytest.mark.skip(reason="unknown error")
def test_get_all_entry_points(
		fake_virtualenv: List[PathPlus],
		tmp_pathplus: PathPlus,
		advanced_data_regression: AdvancedDataRegressionFixture,
		):

	all_eps: Dict[str, List[Dict]] = {}

	for group, eps in entry_points.get_all_entry_points(path=fake_virtualenv).items():
		all_eps[group] = []

		for ep in eps:
			assert ep.group == group
			assert ep.distro is not None
			as_dict = ep._asdict()
			as_dict["extras"] = ep.extras
			as_dict["module"] = ep.module
			as_dict["attr"] = ep.attr
			as_dict["distro"] = as_dict["distro"]._asdict()
			as_dict["distro"]["path"] = as_dict["distro"]["path"].relative_to(tmp_pathplus)
			all_eps[group].append(as_dict)

		all_eps[group] = sorted(all_eps[group], key=itemgetter("name"))

	advanced_data_regression.check(all_eps)