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
|
import contextlib
import os
import site
import sys
from pathlib import Path
import pytest
from editables import EditableException, EditableProject
# Use a project name that is not a valid Python identifier,
# to test that it gets normalised correctly
PROJECT_NAME = "my-project"
def build_project(target, structure):
target.mkdir(exist_ok=True, parents=True)
for name, content in structure.items():
path = target / name
if isinstance(content, str):
# If the name contains slashes, create any
# required parent directories
path.parent.mkdir(exist_ok=True, parents=True)
path.write_text(content, encoding="utf-8")
else:
build_project(path, content)
# to test in-process:
# Put stuff in somedir
# sys.path.append("somedir")
# site.addsitedir("somedir")
# Check stuff is visible
@contextlib.contextmanager
def import_state(extra_site=None):
extra_site = os.fspath(extra_site)
orig_modules = set(sys.modules.keys())
orig_path = list(sys.path)
orig_meta_path = list(sys.meta_path)
orig_path_hooks = list(sys.path_hooks)
orig_path_importer_cache = sys.path_importer_cache
if extra_site:
sys.path.append(extra_site)
site.addsitedir(extra_site)
try:
yield
finally:
remove = [key for key in sys.modules if key not in orig_modules]
for key in remove:
del sys.modules[key]
sys.path[:] = orig_path
sys.meta_path[:] = orig_meta_path
sys.path_hooks[:] = orig_path_hooks
sys.path_importer_cache.clear()
sys.path_importer_cache.update(orig_path_importer_cache)
@pytest.fixture
def project(tmp_path):
project = tmp_path / "project"
structure = {
"foo": {
"__init__.py": "print('foo')",
"bar": {"__init__.py": "print('foo.bar')"},
"baz": {"__init__.py": "print('foo.baz')"},
}
}
build_project(project, structure)
yield project
def test_invalid_project():
with pytest.raises(ValueError):
_ = EditableProject("a$b", "")
def test_nonexistent_module(project):
p = EditableProject(PROJECT_NAME, project)
with pytest.raises(EditableException):
p.map("foo", "xxx")
def test_not_toplevel(project):
p = EditableProject(PROJECT_NAME, project)
with pytest.raises(EditableException):
p.map("foo.bar", "foo/bar")
@pytest.mark.parametrize(
"name,expected",
[
("_invalid", None),
("invalid_", None),
("invalid%character", None),
("project", "project.pth"),
("Project", "project.pth"),
("project_1", "project_1.pth"),
("project-1", "project_1.pth"),
("project.1", "project_1.pth"),
("project---1", "project_1.pth"),
("project-._1", "project_1.pth"),
("0leading_digit_ok", "0leading_digit_ok.pth"),
],
)
def test_project_names_normalised(name, expected):
try:
# Tricky here. We create a dummy project, add
# an empty directory name to the path,
# then get the list of files generated.
# The .pth file should always be the first one,
# and we only care about the first item (the name)
p = EditableProject(name, "")
p.add_to_path("")
pth = next(p.files())[0]
except ValueError:
# If the project name isn't valid, we don't
# expect a pth file
pth = None
assert pth == expected
def test_dependencies(project):
p = EditableProject(PROJECT_NAME, project)
assert len(p.dependencies()) == 0
p.map("foo", "foo")
assert len(p.dependencies()) == 1
def test_simple_pth(tmp_path, project):
p = EditableProject(PROJECT_NAME, project)
p.add_to_path(".")
structure = {name: content for name, content in p.files()}
site_packages = tmp_path / "site-packages"
build_project(site_packages, structure)
with import_state(extra_site=site_packages):
import foo
assert Path(foo.__file__) == project / "foo/__init__.py"
def test_make_project(project, tmp_path):
p = EditableProject(PROJECT_NAME, project)
p.map("foo", "foo")
structure = {name: content for name, content in p.files()}
site_packages = tmp_path / "site-packages"
build_project(site_packages, structure)
with import_state(extra_site=site_packages):
import foo
assert Path(foo.__file__) == project / "foo/__init__.py"
def test_subpackage_pth(tmp_path, project):
p = EditableProject(PROJECT_NAME, project)
p.add_to_subpackage("a.b", ".")
structure = {name: content for name, content in p.files()}
site_packages = tmp_path / "site-packages"
build_project(site_packages, structure)
with import_state(extra_site=site_packages):
import a.b.foo
assert Path(a.b.foo.__file__) == project / "foo/__init__.py"
|
