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
|
# -*- coding: utf-8 -*-
import functools
import json
import re
from django.conf import settings
from django.contrib.admindocs.views import simplify_regex
from django.core.exceptions import ViewDoesNotExist
from django.core.management.base import BaseCommand, CommandError
from django.utils import translation
from django_extensions.management.color import color_style, no_style
from django_extensions.management.utils import signalcommand
from django.urls import URLPattern, URLResolver # type: ignore
class RegexURLPattern: # type: ignore
pass
class RegexURLResolver: # type: ignore
pass
class LocaleRegexURLResolver: # type: ignore
pass
def describe_pattern(p):
return str(p.pattern)
FMTR = {
"dense": "{url}\t{module}\t{url_name}\t{decorator}",
"table": "{url},{module},{url_name},{decorator}",
"aligned": "{url},{module},{url_name},{decorator}",
"verbose": "{url}\n\tController: {module}\n\tURL Name: {url_name}\n\tDecorators: {decorator}\n", # noqa: E501
"json": "",
"pretty-json": "",
}
class Command(BaseCommand):
help = "Displays all of the url matching routes for the project."
def add_arguments(self, parser):
super().add_arguments(parser)
parser.add_argument(
"--unsorted",
"-u",
action="store_true",
dest="unsorted",
help="Show urls unsorted but same order as found in url patterns",
)
parser.add_argument(
"--language",
"-l",
dest="language",
help="Only show this language code (useful for i18n_patterns)",
)
parser.add_argument(
"--decorator",
"-d",
action="append",
dest="decorator",
default=[],
help="Show the presence of given decorator on views",
)
parser.add_argument(
"--format",
"-f",
dest="format_style",
default="dense",
help="Style of the output. Choices: %s" % FMTR.keys(),
)
parser.add_argument(
"--urlconf",
"-c",
dest="urlconf",
default="ROOT_URLCONF",
help="Set the settings URL conf variable to use",
)
@signalcommand
def handle(self, *args, **options):
style = no_style() if options["no_color"] else color_style()
language = options["language"]
if language is not None:
translation.activate(language)
self.LANGUAGES = [
(code, name)
for code, name in getattr(settings, "LANGUAGES", [])
if code == language
]
else:
self.LANGUAGES = getattr(settings, "LANGUAGES", ((None, None),))
decorator = options["decorator"]
if not decorator:
decorator = ["login_required"]
format_style = options["format_style"]
if format_style not in FMTR:
raise CommandError(
"Format style '%s' does not exist. Options: %s"
% (
format_style,
", ".join(sorted(FMTR.keys())),
)
)
pretty_json = format_style == "pretty-json"
if pretty_json:
format_style = "json"
fmtr = FMTR[format_style]
urlconf = options["urlconf"]
views = []
if not hasattr(settings, urlconf):
raise CommandError(
"Settings module {} does not have the attribute {}.".format(
settings, urlconf
)
)
try:
urlconf = __import__(getattr(settings, urlconf), {}, {}, [""])
except Exception as e:
if options["traceback"]:
import traceback
traceback.print_exc()
raise CommandError(
"Error occurred while trying to load %s: %s"
% (getattr(settings, urlconf), str(e))
)
view_functions = self.extract_views_from_urlpatterns(urlconf.urlpatterns)
for func, regex, url_name in view_functions:
if hasattr(func, "__globals__"):
func_globals = func.__globals__
elif hasattr(func, "func_globals"):
func_globals = func.func_globals
else:
func_globals = {}
decorators = [d for d in decorator if d in func_globals]
if isinstance(func, functools.partial):
func = func.func
decorators.insert(0, "functools.partial")
if hasattr(func, "view_class"):
func = func.view_class
if hasattr(func, "__name__"):
func_name = func.__name__
elif hasattr(func, "__class__"):
func_name = "%s()" % func.__class__.__name__
else:
func_name = re.sub(r" at 0x[0-9a-f]+", "", repr(func))
module = "{0}.{1}".format(func.__module__, func_name)
url_name = url_name or ""
url = simplify_regex(regex)
decorator = ", ".join(decorators)
if format_style == "json":
views.append(
{
"url": url,
"module": module,
"name": url_name,
"decorators": decorator,
}
)
else:
views.append(
fmtr.format(
module="{0}.{1}".format(
style.MODULE(func.__module__), style.MODULE_NAME(func_name)
),
url_name=style.URL_NAME(url_name),
url=style.URL(url),
decorator=decorator,
).strip()
)
if not options["unsorted"] and format_style != "json":
views = sorted(views)
if format_style == "aligned":
views = [row.split(",", 3) for row in views]
widths = [len(max(columns, key=len)) for columns in zip(*views)]
views = [
" ".join(
"{0:<{1}}".format(cdata, width) for width, cdata in zip(widths, row)
)
for row in views
]
elif format_style == "table":
# Reformat all data and show in a table format
views = [row.split(",", 3) for row in views]
widths = [len(max(columns, key=len)) for columns in zip(*views)]
table_views = []
header = (
style.MODULE_NAME("URL"),
style.MODULE_NAME("Module"),
style.MODULE_NAME("Name"),
style.MODULE_NAME("Decorator"),
)
table_views.append(
" | ".join(
"{0:<{1}}".format(title, width)
for width, title in zip(widths, header)
)
)
table_views.append("-+-".join("-" * width for width in widths))
for row in views:
table_views.append(
" | ".join(
"{0:<{1}}".format(cdata, width)
for width, cdata in zip(widths, row)
)
)
# Replace original views so we can return the same object
views = table_views
elif format_style == "json":
if pretty_json:
return json.dumps(views, indent=4)
return json.dumps(views)
return "\n".join([v for v in views]) + "\n"
def extract_views_from_urlpatterns(self, urlpatterns, base="", namespace=None):
"""
Return a list of views from a list of urlpatterns.
Each object in the returned list is a three-tuple: (view_func, regex, name)
"""
views = []
for p in urlpatterns:
if isinstance(p, (URLPattern, RegexURLPattern)):
try:
if not p.name:
name = p.name
elif namespace:
name = "{0}:{1}".format(namespace, p.name)
else:
name = p.name
pattern = describe_pattern(p)
views.append((p.callback, base + pattern, name))
except ViewDoesNotExist:
continue
elif isinstance(p, (URLResolver, RegexURLResolver)):
try:
patterns = p.url_patterns
except ImportError:
continue
if namespace and p.namespace:
_namespace = "{0}:{1}".format(namespace, p.namespace)
else:
_namespace = p.namespace or namespace
pattern = describe_pattern(p)
if isinstance(p, LocaleRegexURLResolver):
for language in self.LANGUAGES:
with translation.override(language[0]):
views.extend(
self.extract_views_from_urlpatterns(
patterns, base + pattern, namespace=_namespace
)
)
else:
views.extend(
self.extract_views_from_urlpatterns(
patterns, base + pattern, namespace=_namespace
)
)
elif hasattr(p, "_get_callback"):
try:
views.append(
(p._get_callback(), base + describe_pattern(p), p.name)
)
except ViewDoesNotExist:
continue
elif hasattr(p, "url_patterns") or hasattr(p, "_get_url_patterns"):
try:
patterns = p.url_patterns
except ImportError:
continue
views.extend(
self.extract_views_from_urlpatterns(
patterns, base + describe_pattern(p), namespace=namespace
)
)
else:
raise TypeError("%s does not appear to be a urlpattern object" % p)
return views
|
