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
|
import pathlib
import sys
from django.test import SimpleTestCase
def last_n_parts(path, n):
return "/".join(path.parts[-n:])
# The import must happen at the end of setUpClass, so it can't be imported at
# the top of the file.
github_links = None
class GitHubLinkTests(SimpleTestCase):
@classmethod
def setUpClass(cls):
# The file implementing the code under test is in the docs folder and
# is not part of the Django package. This means it cannot be imported
# through standard means. Include its parent in the pythonpath for the
# duration of the tests to allow the code to be imported.
cls.ext_path = str((pathlib.Path(__file__).parents[2] / "docs/_ext").resolve())
sys.path.insert(0, cls.ext_path)
cls.addClassCleanup(sys.path.remove, cls.ext_path)
cls.addClassCleanup(sys.modules.pop, "github_links", None)
# Linters/IDEs may not be able to detect this as a valid import.
import github_links as _github_links
global github_links
github_links = _github_links
def test_code_locator(self):
locator = github_links.CodeLocator.from_code(
"""
from a import b, c
from .d import e, f as g
def h():
pass
class I:
def j(self):
pass"""
)
self.assertEqual(locator.node_line_numbers, {"h": 5, "I": 8, "I.j": 9})
self.assertEqual(locator.import_locations, {"b": "a", "c": "a", "e": ".d"})
def test_module_name_to_file_path_package(self):
path = github_links.module_name_to_file_path("django")
self.assertEqual(last_n_parts(path, 2), "django/__init__.py")
def test_module_name_to_file_path_module(self):
path = github_links.module_name_to_file_path("django.shortcuts")
self.assertEqual(last_n_parts(path, 2), "django/shortcuts.py")
def test_get_path_and_line_class(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module", fullname="MyClass"
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/module.py"
)
self.assertEqual(line, 12)
def test_get_path_and_line_func(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module", fullname="my_function"
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/module.py"
)
self.assertEqual(line, 24)
def test_get_path_and_line_method(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module", fullname="MyClass.my_method"
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/module.py"
)
self.assertEqual(line, 16)
def test_get_path_and_line_cached_property(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module",
fullname="MyClass.my_cached_property",
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/module.py"
)
self.assertEqual(line, 20)
def test_get_path_and_line_forwarded_import(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module", fullname="MyOtherClass"
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/other_module.py"
)
self.assertEqual(line, 1)
def test_get_path_and_line_wildcard_import(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module", fullname="WildcardClass"
)
self.assertEqual(
last_n_parts(path, 5),
"tests/sphinx/testdata/package/wildcard_module.py",
)
self.assertEqual(line, 4)
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module",
fullname="WildcardMixin",
)
self.assertEqual(
last_n_parts(path, 5),
"tests/sphinx/testdata/package/wildcard_base.py",
)
self.assertEqual(line, 1)
def test_get_path_and_line_forwarded_import_module(self):
path, line = github_links.get_path_and_line(
module="tests.sphinx.testdata.package.module",
fullname="other_module.MyOtherClass",
)
self.assertEqual(
last_n_parts(path, 5), "tests/sphinx/testdata/package/other_module.py"
)
self.assertEqual(line, 1)
def test_get_branch_stable(self):
branch = github_links.get_branch(version="2.2", next_version="3.2")
self.assertEqual(branch, "stable/2.2.x")
def test_get_branch_latest(self):
branch = github_links.get_branch(version="3.2", next_version="3.2")
self.assertEqual(branch, "main")
def test_github_linkcode_resolve_unspecified_domain(self):
domain = "unspecified"
info = {}
self.assertIsNone(
github_links.github_linkcode_resolve(
domain, info, version="3.2", next_version="3.2"
)
)
def test_github_linkcode_resolve_unspecified_info(self):
domain = "py"
info = {"module": None, "fullname": None}
self.assertIsNone(
github_links.github_linkcode_resolve(
domain, info, version="3.2", next_version="3.2"
)
)
def test_github_linkcode_resolve_not_found(self):
info = {
"module": "foo.bar.baz.hopefully_non_existant_module",
"fullname": "MyClass",
}
self.assertIsNone(
github_links.github_linkcode_resolve(
"py", info, version="3.2", next_version="3.2"
)
)
def test_github_linkcode_resolve_link_to_object(self):
info = {
"module": "tests.sphinx.testdata.package.module",
"fullname": "MyClass",
}
self.assertEqual(
github_links.github_linkcode_resolve(
"py", info, version="3.2", next_version="3.2"
),
"https://github.com/django/django/blob/main/tests/sphinx/"
"testdata/package/module.py#L12",
)
def test_github_linkcode_resolve_link_to_class_older_version(self):
info = {
"module": "tests.sphinx.testdata.package.module",
"fullname": "MyClass",
}
self.assertEqual(
github_links.github_linkcode_resolve(
"py", info, version="2.2", next_version="3.2"
),
"https://github.com/django/django/blob/stable/2.2.x/tests/sphinx/"
"testdata/package/module.py#L12",
)
def test_import_error(self):
msg = "Could not import '.....test' in 'tests.sphinx.testdata.package'."
with self.assertRaisesMessage(ImportError, msg):
github_links.get_path_and_line(
module="tests.sphinx.testdata.package.import_error", fullname="Test"
)
|
