tests.py 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300
  1. """
  2. Unit tests for reverse URL lookups.
  3. """
  4. import sys
  5. import threading
  6. from admin_scripts.tests import AdminScriptTestCase
  7. from django.conf import settings
  8. from django.conf.urls import include, url
  9. from django.contrib.auth.models import User
  10. from django.core.exceptions import ImproperlyConfigured, ViewDoesNotExist
  11. from django.http import (
  12. HttpRequest, HttpResponsePermanentRedirect, HttpResponseRedirect,
  13. )
  14. from django.shortcuts import redirect
  15. from django.test import SimpleTestCase, TestCase, override_settings
  16. from django.test.utils import override_script_prefix
  17. from django.urls import (
  18. NoReverseMatch, Resolver404, ResolverMatch, URLPattern, URLResolver,
  19. get_callable, get_resolver, get_urlconf, resolve, reverse, reverse_lazy,
  20. )
  21. from django.urls.resolvers import RegexPattern
  22. from . import middleware, urlconf_outer, views
  23. from .utils import URLObject
  24. from .views import empty_view
  25. resolve_test_data = (
  26. # These entries are in the format: (path, url_name, app_name, namespace, view_name, func, args, kwargs)
  27. # Simple case
  28. ('/normal/42/37/', 'normal-view', '', '', 'normal-view', views.empty_view, (), {'arg1': '42', 'arg2': '37'}),
  29. (
  30. '/view_class/42/37/', 'view-class', '', '', 'view-class', views.view_class_instance, (),
  31. {'arg1': '42', 'arg2': '37'}
  32. ),
  33. (
  34. '/included/normal/42/37/', 'inc-normal-view', 'included_namespace_urls',
  35. 'included_namespace_urls', 'included_namespace_urls:inc-normal-view',
  36. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  37. ),
  38. (
  39. '/included/view_class/42/37/', 'inc-view-class', 'included_namespace_urls',
  40. 'included_namespace_urls', 'included_namespace_urls:inc-view-class',
  41. views.view_class_instance, (), {'arg1': '42', 'arg2': '37'}
  42. ),
  43. # Unnamed args are dropped if you have *any* kwargs in a pattern
  44. ('/mixed_args/42/37/', 'mixed-args', '', '', 'mixed-args', views.empty_view, (), {'arg2': '37'}),
  45. (
  46. '/included/mixed_args/42/37/', 'inc-mixed-args', 'included_namespace_urls',
  47. 'included_namespace_urls', 'included_namespace_urls:inc-mixed-args',
  48. views.empty_view, (), {'arg2': '37'}
  49. ),
  50. (
  51. '/included/12/mixed_args/42/37/', 'inc-mixed-args', 'included_namespace_urls',
  52. 'included_namespace_urls', 'included_namespace_urls:inc-mixed-args',
  53. views.empty_view, (), {'arg2': '37'}
  54. ),
  55. # Unnamed views should have None as the url_name. Regression data for #21157.
  56. (
  57. '/unnamed/normal/42/37/', None, '', '', 'urlpatterns_reverse.views.empty_view', views.empty_view, (),
  58. {'arg1': '42', 'arg2': '37'}
  59. ),
  60. (
  61. '/unnamed/view_class/42/37/', None, '', '', 'urlpatterns_reverse.views.ViewClass', views.view_class_instance,
  62. (), {'arg1': '42', 'arg2': '37'}
  63. ),
  64. # If you have no kwargs, you get an args list.
  65. ('/no_kwargs/42/37/', 'no-kwargs', '', '', 'no-kwargs', views.empty_view, ('42', '37'), {}),
  66. (
  67. '/included/no_kwargs/42/37/', 'inc-no-kwargs', 'included_namespace_urls',
  68. 'included_namespace_urls', 'included_namespace_urls:inc-no-kwargs',
  69. views.empty_view, ('42', '37'), {}
  70. ),
  71. (
  72. '/included/12/no_kwargs/42/37/', 'inc-no-kwargs', 'included_namespace_urls',
  73. 'included_namespace_urls', 'included_namespace_urls:inc-no-kwargs',
  74. views.empty_view, ('12', '42', '37'), {}
  75. ),
  76. # Namespaces
  77. (
  78. '/test1/inner/42/37/', 'urlobject-view', 'testapp', 'test-ns1', 'test-ns1:urlobject-view',
  79. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  80. ),
  81. (
  82. '/included/test3/inner/42/37/', 'urlobject-view', 'included_namespace_urls:testapp',
  83. 'included_namespace_urls:test-ns3', 'included_namespace_urls:test-ns3:urlobject-view',
  84. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  85. ),
  86. (
  87. '/ns-included1/normal/42/37/', 'inc-normal-view', 'included_namespace_urls',
  88. 'inc-ns1', 'inc-ns1:inc-normal-view',
  89. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  90. ),
  91. (
  92. '/included/test3/inner/42/37/', 'urlobject-view', 'included_namespace_urls:testapp',
  93. 'included_namespace_urls:test-ns3', 'included_namespace_urls:test-ns3:urlobject-view',
  94. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  95. ),
  96. (
  97. '/default/inner/42/37/', 'urlobject-view', 'testapp', 'testapp', 'testapp:urlobject-view',
  98. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  99. ),
  100. (
  101. '/other2/inner/42/37/', 'urlobject-view', 'nodefault', 'other-ns2', 'other-ns2:urlobject-view',
  102. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  103. ),
  104. (
  105. '/other1/inner/42/37/', 'urlobject-view', 'nodefault', 'other-ns1', 'other-ns1:urlobject-view',
  106. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  107. ),
  108. # Nested namespaces
  109. (
  110. '/ns-included1/test3/inner/42/37/', 'urlobject-view', 'included_namespace_urls:testapp',
  111. 'inc-ns1:test-ns3', 'inc-ns1:test-ns3:urlobject-view',
  112. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  113. ),
  114. (
  115. '/ns-included1/ns-included4/ns-included2/test3/inner/42/37/', 'urlobject-view',
  116. 'included_namespace_urls:namespace_urls:included_namespace_urls:testapp',
  117. 'inc-ns1:inc-ns4:inc-ns2:test-ns3',
  118. 'inc-ns1:inc-ns4:inc-ns2:test-ns3:urlobject-view',
  119. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  120. ),
  121. (
  122. '/app-included/test3/inner/42/37/', 'urlobject-view', 'included_namespace_urls:testapp', 'inc-app:test-ns3',
  123. 'inc-app:test-ns3:urlobject-view', views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  124. ),
  125. (
  126. '/app-included/ns-included4/ns-included2/test3/inner/42/37/', 'urlobject-view',
  127. 'included_namespace_urls:namespace_urls:included_namespace_urls:testapp',
  128. 'inc-app:inc-ns4:inc-ns2:test-ns3',
  129. 'inc-app:inc-ns4:inc-ns2:test-ns3:urlobject-view',
  130. views.empty_view, (), {'arg1': '42', 'arg2': '37'}
  131. ),
  132. # Namespaces capturing variables
  133. (
  134. '/inc70/', 'inner-nothing', 'included_urls', 'inc-ns5', 'inc-ns5:inner-nothing',
  135. views.empty_view, (), {'outer': '70'}
  136. ),
  137. (
  138. '/inc78/extra/foobar/', 'inner-extra', 'included_urls', 'inc-ns5', 'inc-ns5:inner-extra',
  139. views.empty_view, (), {'outer': '78', 'extra': 'foobar'}
  140. ),
  141. )
  142. test_data = (
  143. ('places', '/places/3/', [3], {}),
  144. ('places', '/places/3/', ['3'], {}),
  145. ('places', NoReverseMatch, ['a'], {}),
  146. ('places', NoReverseMatch, [], {}),
  147. ('places?', '/place/', [], {}),
  148. ('places+', '/places/', [], {}),
  149. ('places*', '/place/', [], {}),
  150. ('places2?', '/', [], {}),
  151. ('places2+', '/places/', [], {}),
  152. ('places2*', '/', [], {}),
  153. ('places3', '/places/4/', [4], {}),
  154. ('places3', '/places/harlem/', ['harlem'], {}),
  155. ('places3', NoReverseMatch, ['harlem64'], {}),
  156. ('places4', '/places/3/', [], {'id': 3}),
  157. ('people', NoReverseMatch, [], {}),
  158. ('people', '/people/adrian/', ['adrian'], {}),
  159. ('people', '/people/adrian/', [], {'name': 'adrian'}),
  160. ('people', NoReverseMatch, ['name with spaces'], {}),
  161. ('people', NoReverseMatch, [], {'name': 'name with spaces'}),
  162. ('people2', '/people/name/', [], {}),
  163. ('people2a', '/people/name/fred/', ['fred'], {}),
  164. ('people_backref', '/people/nate-nate/', ['nate'], {}),
  165. ('people_backref', '/people/nate-nate/', [], {'name': 'nate'}),
  166. ('optional', '/optional/fred/', [], {'name': 'fred'}),
  167. ('optional', '/optional/fred/', ['fred'], {}),
  168. ('named_optional', '/optional/1/', [1], {}),
  169. ('named_optional', '/optional/1/', [], {'arg1': 1}),
  170. ('named_optional', '/optional/1/2/', [1, 2], {}),
  171. ('named_optional', '/optional/1/2/', [], {'arg1': 1, 'arg2': 2}),
  172. ('named_optional_terminated', '/optional/1/2/', [1, 2], {}),
  173. ('named_optional_terminated', '/optional/1/2/', [], {'arg1': 1, 'arg2': 2}),
  174. ('hardcoded', '/hardcoded/', [], {}),
  175. ('hardcoded2', '/hardcoded/doc.pdf', [], {}),
  176. ('people3', '/people/il/adrian/', [], {'state': 'il', 'name': 'adrian'}),
  177. ('people3', NoReverseMatch, [], {'state': 'il'}),
  178. ('people3', NoReverseMatch, [], {'name': 'adrian'}),
  179. ('people4', NoReverseMatch, [], {'state': 'il', 'name': 'adrian'}),
  180. ('people6', '/people/il/test/adrian/', ['il/test', 'adrian'], {}),
  181. ('people6', '/people//adrian/', ['adrian'], {}),
  182. ('range', '/character_set/a/', [], {}),
  183. ('range2', '/character_set/x/', [], {}),
  184. ('price', '/price/$10/', ['10'], {}),
  185. ('price2', '/price/$10/', ['10'], {}),
  186. ('price3', '/price/$10/', ['10'], {}),
  187. ('product', '/product/chocolate+($2.00)/', [], {'price': '2.00', 'product': 'chocolate'}),
  188. ('headlines', '/headlines/2007.5.21/', [], {'year': 2007, 'month': 5, 'day': 21}),
  189. (
  190. 'windows', r'/windows_path/C:%5CDocuments%20and%20Settings%5Cspam/', [],
  191. {'drive_name': 'C', 'path': r'Documents and Settings\spam'}
  192. ),
  193. ('special', r'/special_chars/~@+%5C$*%7C/', [r'~@+\$*|'], {}),
  194. ('special', r'/special_chars/some%20resource/', [r'some resource'], {}),
  195. ('special', r'/special_chars/10%25%20complete/', [r'10% complete'], {}),
  196. ('special', r'/special_chars/some%20resource/', [], {'chars': r'some resource'}),
  197. ('special', r'/special_chars/10%25%20complete/', [], {'chars': r'10% complete'}),
  198. ('special', NoReverseMatch, [''], {}),
  199. ('mixed', '/john/0/', [], {'name': 'john'}),
  200. ('repeats', '/repeats/a/', [], {}),
  201. ('repeats2', '/repeats/aa/', [], {}),
  202. ('repeats3', '/repeats/aa/', [], {}),
  203. ('test', '/test/1', [], {}),
  204. ('inner-nothing', '/outer/42/', [], {'outer': '42'}),
  205. ('inner-nothing', '/outer/42/', ['42'], {}),
  206. ('inner-nothing', NoReverseMatch, ['foo'], {}),
  207. ('inner-extra', '/outer/42/extra/inner/', [], {'extra': 'inner', 'outer': '42'}),
  208. ('inner-extra', '/outer/42/extra/inner/', ['42', 'inner'], {}),
  209. ('inner-extra', NoReverseMatch, ['fred', 'inner'], {}),
  210. ('inner-no-kwargs', '/outer-no-kwargs/42/inner-no-kwargs/1/', ['42', '1'], {}),
  211. ('disjunction', NoReverseMatch, ['foo'], {}),
  212. ('inner-disjunction', NoReverseMatch, ['10', '11'], {}),
  213. ('extra-places', '/e-places/10/', ['10'], {}),
  214. ('extra-people', '/e-people/fred/', ['fred'], {}),
  215. ('extra-people', '/e-people/fred/', [], {'name': 'fred'}),
  216. ('part', '/part/one/', [], {'value': 'one'}),
  217. ('part', '/prefix/xx/part/one/', [], {'value': 'one', 'prefix': 'xx'}),
  218. ('part2', '/part2/one/', [], {'value': 'one'}),
  219. ('part2', '/part2/', [], {}),
  220. ('part2', '/prefix/xx/part2/one/', [], {'value': 'one', 'prefix': 'xx'}),
  221. ('part2', '/prefix/xx/part2/', [], {'prefix': 'xx'}),
  222. # Tests for nested groups. Nested capturing groups will only work if you
  223. # *only* supply the correct outer group.
  224. ('nested-noncapture', '/nested/noncapture/opt', [], {'p': 'opt'}),
  225. ('nested-capture', '/nested/capture/opt/', ['opt/'], {}),
  226. ('nested-capture', NoReverseMatch, [], {'p': 'opt'}),
  227. ('nested-mixedcapture', '/nested/capture/mixed/opt', ['opt'], {}),
  228. ('nested-mixedcapture', NoReverseMatch, [], {'p': 'opt'}),
  229. ('nested-namedcapture', '/nested/capture/named/opt/', [], {'outer': 'opt/'}),
  230. ('nested-namedcapture', NoReverseMatch, [], {'outer': 'opt/', 'inner': 'opt'}),
  231. ('nested-namedcapture', NoReverseMatch, [], {'inner': 'opt'}),
  232. ('non_path_include', '/includes/non_path_include/', [], {}),
  233. # Tests for #13154
  234. ('defaults', '/defaults_view1/3/', [], {'arg1': 3, 'arg2': 1}),
  235. ('defaults', '/defaults_view2/3/', [], {'arg1': 3, 'arg2': 2}),
  236. ('defaults', NoReverseMatch, [], {'arg1': 3, 'arg2': 3}),
  237. ('defaults', NoReverseMatch, [], {'arg2': 1}),
  238. # Security tests
  239. ('security', '/%2Fexample.com/security/', ['/example.com'], {}),
  240. )
  241. @override_settings(ROOT_URLCONF='urlpatterns_reverse.no_urls')
  242. class NoURLPatternsTests(SimpleTestCase):
  243. def test_no_urls_exception(self):
  244. """
  245. URLResolver should raise an exception when no urlpatterns exist.
  246. """
  247. resolver = URLResolver(RegexPattern(r'^$'), settings.ROOT_URLCONF)
  248. with self.assertRaisesMessage(
  249. ImproperlyConfigured,
  250. "The included URLconf 'urlpatterns_reverse.no_urls' does not "
  251. "appear to have any patterns in it. If you see valid patterns in "
  252. "the file then the issue is probably caused by a circular import."
  253. ):
  254. getattr(resolver, 'url_patterns')
  255. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls')
  256. class URLPatternReverse(SimpleTestCase):
  257. def test_urlpattern_reverse(self):
  258. for name, expected, args, kwargs in test_data:
  259. with self.subTest(name=name, args=args, kwargs=kwargs):
  260. try:
  261. got = reverse(name, args=args, kwargs=kwargs)
  262. except NoReverseMatch:
  263. self.assertEqual(NoReverseMatch, expected)
  264. else:
  265. self.assertEqual(got, expected)
  266. def test_reverse_none(self):
  267. # Reversing None should raise an error, not return the last un-named view.
  268. with self.assertRaises(NoReverseMatch):
  269. reverse(None)
  270. def test_mixing_args_and_kwargs(self):
  271. msg = "Don't mix *args and **kwargs in call to reverse()!"
  272. with self.assertRaisesMessage(ValueError, msg):
  273. reverse('name', args=['a'], kwargs={'b': 'c'})
  274. @override_script_prefix('/{{invalid}}/')
  275. def test_prefix_braces(self):
  276. self.assertEqual(
  277. '/%7B%7Binvalid%7D%7D/includes/non_path_include/',
  278. reverse('non_path_include')
  279. )
  280. def test_prefix_parenthesis(self):
  281. # Parentheses are allowed and should not cause errors or be escaped
  282. with override_script_prefix('/bogus)/'):
  283. self.assertEqual(
  284. '/bogus)/includes/non_path_include/',
  285. reverse('non_path_include')
  286. )
  287. with override_script_prefix('/(bogus)/'):
  288. self.assertEqual(
  289. '/(bogus)/includes/non_path_include/',
  290. reverse('non_path_include')
  291. )
  292. @override_script_prefix('/bump%20map/')
  293. def test_prefix_format_char(self):
  294. self.assertEqual(
  295. '/bump%2520map/includes/non_path_include/',
  296. reverse('non_path_include')
  297. )
  298. @override_script_prefix('/%7Eme/')
  299. def test_non_urlsafe_prefix_with_args(self):
  300. # Regression for #20022, adjusted for #24013 because ~ is an unreserved
  301. # character. Tests whether % is escaped.
  302. self.assertEqual('/%257Eme/places/1/', reverse('places', args=[1]))
  303. def test_patterns_reported(self):
  304. # Regression for #17076
  305. with self.assertRaisesMessage(NoReverseMatch, r"1 pattern(s) tried: ['people/(?P<name>\\w+)/$']"):
  306. # this url exists, but requires an argument
  307. reverse("people", args=[])
  308. @override_script_prefix('/script:name/')
  309. def test_script_name_escaping(self):
  310. self.assertEqual(
  311. reverse('optional', args=['foo:bar']),
  312. '/script:name/optional/foo:bar/'
  313. )
  314. def test_view_not_found_message(self):
  315. msg = (
  316. "Reverse for 'nonexistent-view' not found. 'nonexistent-view' "
  317. "is not a valid view function or pattern name."
  318. )
  319. with self.assertRaisesMessage(NoReverseMatch, msg):
  320. reverse('nonexistent-view')
  321. def test_no_args_message(self):
  322. msg = "Reverse for 'places' with no arguments not found. 1 pattern(s) tried:"
  323. with self.assertRaisesMessage(NoReverseMatch, msg):
  324. reverse('places')
  325. def test_illegal_args_message(self):
  326. msg = "Reverse for 'places' with arguments '(1, 2)' not found. 1 pattern(s) tried:"
  327. with self.assertRaisesMessage(NoReverseMatch, msg):
  328. reverse('places', args=(1, 2))
  329. def test_illegal_kwargs_message(self):
  330. msg = "Reverse for 'places' with keyword arguments '{'arg1': 2}' not found. 1 pattern(s) tried:"
  331. with self.assertRaisesMessage(NoReverseMatch, msg):
  332. reverse('places', kwargs={'arg1': 2})
  333. class ResolverTests(SimpleTestCase):
  334. def test_resolver_repr(self):
  335. """
  336. Test repr of URLResolver, especially when urlconf_name is a list
  337. (#17892).
  338. """
  339. # Pick a resolver from a namespaced URLconf
  340. resolver = get_resolver('urlpatterns_reverse.namespace_urls')
  341. sub_resolver = resolver.namespace_dict['test-ns1'][1]
  342. self.assertIn('<URLPattern list>', repr(sub_resolver))
  343. def test_reverse_lazy_object_coercion_by_resolve(self):
  344. """
  345. Verifies lazy object returned by reverse_lazy is coerced to
  346. text by resolve(). Previous to #21043, this would raise a TypeError.
  347. """
  348. urls = 'urlpatterns_reverse.named_urls'
  349. proxy_url = reverse_lazy('named-url1', urlconf=urls)
  350. resolver = get_resolver(urls)
  351. resolver.resolve(proxy_url)
  352. def test_resolver_reverse(self):
  353. resolver = get_resolver('urlpatterns_reverse.named_urls')
  354. test_urls = [
  355. # (name, args, kwargs, expected)
  356. ('named-url1', (), {}, ''),
  357. ('named-url2', ('arg',), {}, 'extra/arg/'),
  358. ('named-url2', (), {'extra': 'arg'}, 'extra/arg/'),
  359. ]
  360. for name, args, kwargs, expected in test_urls:
  361. with self.subTest(name=name, args=args, kwargs=kwargs):
  362. self.assertEqual(resolver.reverse(name, *args, **kwargs), expected)
  363. def test_resolver_reverse_conflict(self):
  364. """
  365. url() name arguments don't need to be unique. The last registered
  366. pattern takes precedence for conflicting names.
  367. """
  368. resolver = get_resolver('urlpatterns_reverse.named_urls_conflict')
  369. test_urls = [
  370. # (name, args, kwargs, expected)
  371. # Without arguments, the last URL in urlpatterns has precedence.
  372. ('name-conflict', (), {}, 'conflict/'),
  373. # With an arg, the last URL in urlpatterns has precedence.
  374. ('name-conflict', ('arg',), {}, 'conflict-last/arg/'),
  375. # With a kwarg, other url()s can be reversed.
  376. ('name-conflict', (), {'first': 'arg'}, 'conflict-first/arg/'),
  377. ('name-conflict', (), {'middle': 'arg'}, 'conflict-middle/arg/'),
  378. ('name-conflict', (), {'last': 'arg'}, 'conflict-last/arg/'),
  379. # The number and order of the arguments don't interfere with reversing.
  380. ('name-conflict', ('arg', 'arg'), {}, 'conflict/arg/arg/'),
  381. ]
  382. for name, args, kwargs, expected in test_urls:
  383. with self.subTest(name=name, args=args, kwargs=kwargs):
  384. self.assertEqual(resolver.reverse(name, *args, **kwargs), expected)
  385. def test_non_regex(self):
  386. """
  387. A Resolver404 is raised if resolving doesn't meet the basic
  388. requirements of a path to match - i.e., at the very least, it matches
  389. the root pattern '^/'. Never return None from resolve() to prevent a
  390. TypeError from occurring later (#10834).
  391. """
  392. test_urls = ['', 'a', '\\', '.']
  393. for path in test_urls:
  394. with self.subTest(path=path):
  395. with self.assertRaises(Resolver404):
  396. resolve(path)
  397. def test_404_tried_urls_have_names(self):
  398. """
  399. The list of URLs that come back from a Resolver404 exception contains
  400. a list in the right format for printing out in the DEBUG 404 page with
  401. both the patterns and URL names, if available.
  402. """
  403. urls = 'urlpatterns_reverse.named_urls'
  404. # this list matches the expected URL types and names returned when
  405. # you try to resolve a nonexistent URL in the first level of included
  406. # URLs in named_urls.py (e.g., '/included/nonexistent-url')
  407. url_types_names = [
  408. [{'type': URLPattern, 'name': 'named-url1'}],
  409. [{'type': URLPattern, 'name': 'named-url2'}],
  410. [{'type': URLPattern, 'name': None}],
  411. [{'type': URLResolver}, {'type': URLPattern, 'name': 'named-url3'}],
  412. [{'type': URLResolver}, {'type': URLPattern, 'name': 'named-url4'}],
  413. [{'type': URLResolver}, {'type': URLPattern, 'name': None}],
  414. [{'type': URLResolver}, {'type': URLResolver}],
  415. ]
  416. with self.assertRaisesMessage(Resolver404, 'tried') as cm:
  417. resolve('/included/nonexistent-url', urlconf=urls)
  418. e = cm.exception
  419. # make sure we at least matched the root ('/') url resolver:
  420. self.assertIn('tried', e.args[0])
  421. self.assertEqual(
  422. len(e.args[0]['tried']),
  423. len(url_types_names),
  424. 'Wrong number of tried URLs returned. Expected %s, got %s.' % (
  425. len(url_types_names), len(e.args[0]['tried'])
  426. )
  427. )
  428. for tried, expected in zip(e.args[0]['tried'], url_types_names):
  429. for t, e in zip(tried, expected):
  430. with self.subTest(t):
  431. self.assertIsInstance(t, e['type']), '%s is not an instance of %s' % (t, e['type'])
  432. if 'name' in e:
  433. if not e['name']:
  434. self.assertIsNone(t.name, 'Expected no URL name but found %s.' % t.name)
  435. else:
  436. self.assertEqual(
  437. t.name,
  438. e['name'],
  439. 'Wrong URL name. Expected "%s", got "%s".' % (e['name'], t.name)
  440. )
  441. def test_namespaced_view_detail(self):
  442. resolver = get_resolver('urlpatterns_reverse.nested_urls')
  443. self.assertTrue(resolver._is_callback('urlpatterns_reverse.nested_urls.view1'))
  444. self.assertTrue(resolver._is_callback('urlpatterns_reverse.nested_urls.view2'))
  445. self.assertTrue(resolver._is_callback('urlpatterns_reverse.nested_urls.View3'))
  446. self.assertFalse(resolver._is_callback('urlpatterns_reverse.nested_urls.blub'))
  447. def test_view_detail_as_method(self):
  448. # Views which have a class name as part of their path.
  449. resolver = get_resolver('urlpatterns_reverse.method_view_urls')
  450. self.assertTrue(resolver._is_callback('urlpatterns_reverse.method_view_urls.ViewContainer.method_view'))
  451. self.assertTrue(resolver._is_callback('urlpatterns_reverse.method_view_urls.ViewContainer.classmethod_view'))
  452. def test_populate_concurrency(self):
  453. """
  454. URLResolver._populate() can be called concurrently, but not more
  455. than once per thread (#26888).
  456. """
  457. resolver = URLResolver(RegexPattern(r'^/'), 'urlpatterns_reverse.urls')
  458. resolver._local.populating = True
  459. thread = threading.Thread(target=resolver._populate)
  460. thread.start()
  461. thread.join()
  462. self.assertNotEqual(resolver._reverse_dict, {})
  463. @override_settings(ROOT_URLCONF='urlpatterns_reverse.reverse_lazy_urls')
  464. class ReverseLazyTest(TestCase):
  465. def test_redirect_with_lazy_reverse(self):
  466. response = self.client.get('/redirect/')
  467. self.assertRedirects(response, "/redirected_to/", status_code=302)
  468. def test_user_permission_with_lazy_reverse(self):
  469. alfred = User.objects.create_user('alfred', 'alfred@example.com', password='testpw')
  470. response = self.client.get('/login_required_view/')
  471. self.assertRedirects(response, "/login/?next=/login_required_view/", status_code=302)
  472. self.client.force_login(alfred)
  473. response = self.client.get('/login_required_view/')
  474. self.assertEqual(response.status_code, 200)
  475. def test_inserting_reverse_lazy_into_string(self):
  476. self.assertEqual(
  477. 'Some URL: %s' % reverse_lazy('some-login-page'),
  478. 'Some URL: /login/'
  479. )
  480. class ReverseLazySettingsTest(AdminScriptTestCase):
  481. """
  482. reverse_lazy can be used in settings without causing a circular
  483. import error.
  484. """
  485. def setUp(self):
  486. self.write_settings(
  487. 'settings.py',
  488. extra="from django.urls import reverse_lazy\nLOGIN_URL = reverse_lazy('login')",
  489. )
  490. def tearDown(self):
  491. self.remove_settings('settings.py')
  492. def test_lazy_in_settings(self):
  493. out, err = self.run_manage(['check'])
  494. self.assertNoOutput(err)
  495. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls')
  496. class ReverseShortcutTests(SimpleTestCase):
  497. def test_redirect_to_object(self):
  498. # We don't really need a model; just something with a get_absolute_url
  499. class FakeObj:
  500. def get_absolute_url(self):
  501. return "/hi-there/"
  502. res = redirect(FakeObj())
  503. self.assertIsInstance(res, HttpResponseRedirect)
  504. self.assertEqual(res.url, '/hi-there/')
  505. res = redirect(FakeObj(), permanent=True)
  506. self.assertIsInstance(res, HttpResponsePermanentRedirect)
  507. self.assertEqual(res.url, '/hi-there/')
  508. def test_redirect_to_view_name(self):
  509. res = redirect('hardcoded2')
  510. self.assertEqual(res.url, '/hardcoded/doc.pdf')
  511. res = redirect('places', 1)
  512. self.assertEqual(res.url, '/places/1/')
  513. res = redirect('headlines', year='2008', month='02', day='17')
  514. self.assertEqual(res.url, '/headlines/2008.02.17/')
  515. with self.assertRaises(NoReverseMatch):
  516. redirect('not-a-view')
  517. def test_redirect_to_url(self):
  518. res = redirect('/foo/')
  519. self.assertEqual(res.url, '/foo/')
  520. res = redirect('http://example.com/')
  521. self.assertEqual(res.url, 'http://example.com/')
  522. # Assert that we can redirect using UTF-8 strings
  523. res = redirect('/æøå/abc/')
  524. self.assertEqual(res.url, '/%C3%A6%C3%B8%C3%A5/abc/')
  525. # Assert that no imports are attempted when dealing with a relative path
  526. # (previously, the below would resolve in a UnicodeEncodeError from __import__ )
  527. res = redirect('/æøå.abc/')
  528. self.assertEqual(res.url, '/%C3%A6%C3%B8%C3%A5.abc/')
  529. res = redirect('os.path')
  530. self.assertEqual(res.url, 'os.path')
  531. def test_no_illegal_imports(self):
  532. # modules that are not listed in urlpatterns should not be importable
  533. redirect("urlpatterns_reverse.nonimported_module.view")
  534. self.assertNotIn("urlpatterns_reverse.nonimported_module", sys.modules)
  535. def test_reverse_by_path_nested(self):
  536. # Views added to urlpatterns using include() should be reversible.
  537. from .views import nested_view
  538. self.assertEqual(reverse(nested_view), '/includes/nested_path/')
  539. def test_redirect_view_object(self):
  540. from .views import absolute_kwargs_view
  541. res = redirect(absolute_kwargs_view)
  542. self.assertEqual(res.url, '/absolute_arg_view/')
  543. with self.assertRaises(NoReverseMatch):
  544. redirect(absolute_kwargs_view, wrong_argument=None)
  545. @override_settings(ROOT_URLCONF='urlpatterns_reverse.namespace_urls')
  546. class NamespaceTests(SimpleTestCase):
  547. def test_ambiguous_object(self):
  548. """
  549. Names deployed via dynamic URL objects that require namespaces can't
  550. be resolved.
  551. """
  552. test_urls = [
  553. ('urlobject-view', [], {}),
  554. ('urlobject-view', [37, 42], {}),
  555. ('urlobject-view', [], {'arg1': 42, 'arg2': 37}),
  556. ]
  557. for name, args, kwargs in test_urls:
  558. with self.subTest(name=name, args=args, kwargs=kwargs):
  559. with self.assertRaises(NoReverseMatch):
  560. reverse(name, args=args, kwargs=kwargs)
  561. def test_ambiguous_urlpattern(self):
  562. """
  563. Names deployed via dynamic URL objects that require namespaces can't
  564. be resolved.
  565. """
  566. test_urls = [
  567. ('inner-nothing', [], {}),
  568. ('inner-nothing', [37, 42], {}),
  569. ('inner-nothing', [], {'arg1': 42, 'arg2': 37}),
  570. ]
  571. for name, args, kwargs in test_urls:
  572. with self.subTest(name=name, args=args, kwargs=kwargs):
  573. with self.assertRaises(NoReverseMatch):
  574. reverse(name, args=args, kwargs=kwargs)
  575. def test_non_existent_namespace(self):
  576. """Nonexistent namespaces raise errors."""
  577. test_urls = [
  578. 'blahblah:urlobject-view',
  579. 'test-ns1:blahblah:urlobject-view',
  580. ]
  581. for name in test_urls:
  582. with self.subTest(name=name):
  583. with self.assertRaises(NoReverseMatch):
  584. reverse(name)
  585. def test_normal_name(self):
  586. """Normal lookups work as expected."""
  587. test_urls = [
  588. ('normal-view', [], {}, '/normal/'),
  589. ('normal-view', [37, 42], {}, '/normal/37/42/'),
  590. ('normal-view', [], {'arg1': 42, 'arg2': 37}, '/normal/42/37/'),
  591. ('special-view', [], {}, '/+%5C$*/'),
  592. ]
  593. for name, args, kwargs, expected in test_urls:
  594. with self.subTest(name=name, args=args, kwargs=kwargs):
  595. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  596. def test_simple_included_name(self):
  597. """Normal lookups work on names included from other patterns."""
  598. test_urls = [
  599. ('included_namespace_urls:inc-normal-view', [], {}, '/included/normal/'),
  600. ('included_namespace_urls:inc-normal-view', [37, 42], {}, '/included/normal/37/42/'),
  601. ('included_namespace_urls:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/included/normal/42/37/'),
  602. ('included_namespace_urls:inc-special-view', [], {}, '/included/+%5C$*/'),
  603. ]
  604. for name, args, kwargs, expected in test_urls:
  605. with self.subTest(name=name, args=args, kwargs=kwargs):
  606. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  607. def test_namespace_object(self):
  608. """Dynamic URL objects can be found using a namespace."""
  609. test_urls = [
  610. ('test-ns1:urlobject-view', [], {}, '/test1/inner/'),
  611. ('test-ns1:urlobject-view', [37, 42], {}, '/test1/inner/37/42/'),
  612. ('test-ns1:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/test1/inner/42/37/'),
  613. ('test-ns1:urlobject-special-view', [], {}, '/test1/inner/+%5C$*/'),
  614. ]
  615. for name, args, kwargs, expected in test_urls:
  616. with self.subTest(name=name, args=args, kwargs=kwargs):
  617. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  618. def test_app_object(self):
  619. """
  620. Dynamic URL objects can return a (pattern, app_name) 2-tuple, and
  621. include() can set the namespace.
  622. """
  623. test_urls = [
  624. ('new-ns1:urlobject-view', [], {}, '/newapp1/inner/'),
  625. ('new-ns1:urlobject-view', [37, 42], {}, '/newapp1/inner/37/42/'),
  626. ('new-ns1:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/newapp1/inner/42/37/'),
  627. ('new-ns1:urlobject-special-view', [], {}, '/newapp1/inner/+%5C$*/'),
  628. ]
  629. for name, args, kwargs, expected in test_urls:
  630. with self.subTest(name=name, args=args, kwargs=kwargs):
  631. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  632. def test_app_object_default_namespace(self):
  633. """
  634. Namespace defaults to app_name when including a (pattern, app_name)
  635. 2-tuple.
  636. """
  637. test_urls = [
  638. ('newapp:urlobject-view', [], {}, '/new-default/inner/'),
  639. ('newapp:urlobject-view', [37, 42], {}, '/new-default/inner/37/42/'),
  640. ('newapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/new-default/inner/42/37/'),
  641. ('newapp:urlobject-special-view', [], {}, '/new-default/inner/+%5C$*/'),
  642. ]
  643. for name, args, kwargs, expected in test_urls:
  644. with self.subTest(name=name, args=args, kwargs=kwargs):
  645. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  646. def test_embedded_namespace_object(self):
  647. """Namespaces can be installed anywhere in the URL pattern tree."""
  648. test_urls = [
  649. ('included_namespace_urls:test-ns3:urlobject-view', [], {}, '/included/test3/inner/'),
  650. ('included_namespace_urls:test-ns3:urlobject-view', [37, 42], {}, '/included/test3/inner/37/42/'),
  651. (
  652. 'included_namespace_urls:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  653. '/included/test3/inner/42/37/',
  654. ),
  655. ('included_namespace_urls:test-ns3:urlobject-special-view', [], {}, '/included/test3/inner/+%5C$*/'),
  656. ]
  657. for name, args, kwargs, expected in test_urls:
  658. with self.subTest(name=name, args=args, kwargs=kwargs):
  659. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  660. def test_namespace_pattern(self):
  661. """Namespaces can be applied to include()'d urlpatterns."""
  662. test_urls = [
  663. ('inc-ns1:inc-normal-view', [], {}, '/ns-included1/normal/'),
  664. ('inc-ns1:inc-normal-view', [37, 42], {}, '/ns-included1/normal/37/42/'),
  665. ('inc-ns1:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/ns-included1/normal/42/37/'),
  666. ('inc-ns1:inc-special-view', [], {}, '/ns-included1/+%5C$*/'),
  667. ]
  668. for name, args, kwargs, expected in test_urls:
  669. with self.subTest(name=name, args=args, kwargs=kwargs):
  670. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  671. def test_app_name_pattern(self):
  672. """
  673. Namespaces can be applied to include()'d urlpatterns that set an
  674. app_name attribute.
  675. """
  676. test_urls = [
  677. ('app-ns1:inc-normal-view', [], {}, '/app-included1/normal/'),
  678. ('app-ns1:inc-normal-view', [37, 42], {}, '/app-included1/normal/37/42/'),
  679. ('app-ns1:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/app-included1/normal/42/37/'),
  680. ('app-ns1:inc-special-view', [], {}, '/app-included1/+%5C$*/'),
  681. ]
  682. for name, args, kwargs, expected in test_urls:
  683. with self.subTest(name=name, args=args, kwargs=kwargs):
  684. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  685. def test_namespace_pattern_with_variable_prefix(self):
  686. """
  687. Using include() with namespaces when there is a regex variable in front
  688. of it.
  689. """
  690. test_urls = [
  691. ('inc-outer:inc-normal-view', [], {'outer': 42}, '/ns-outer/42/normal/'),
  692. ('inc-outer:inc-normal-view', [42], {}, '/ns-outer/42/normal/'),
  693. ('inc-outer:inc-normal-view', [], {'arg1': 37, 'arg2': 4, 'outer': 42}, '/ns-outer/42/normal/37/4/'),
  694. ('inc-outer:inc-normal-view', [42, 37, 4], {}, '/ns-outer/42/normal/37/4/'),
  695. ('inc-outer:inc-special-view', [], {'outer': 42}, '/ns-outer/42/+%5C$*/'),
  696. ('inc-outer:inc-special-view', [42], {}, '/ns-outer/42/+%5C$*/'),
  697. ]
  698. for name, args, kwargs, expected in test_urls:
  699. with self.subTest(name=name, args=args, kwargs=kwargs):
  700. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  701. def test_multiple_namespace_pattern(self):
  702. """Namespaces can be embedded."""
  703. test_urls = [
  704. ('inc-ns1:test-ns3:urlobject-view', [], {}, '/ns-included1/test3/inner/'),
  705. ('inc-ns1:test-ns3:urlobject-view', [37, 42], {}, '/ns-included1/test3/inner/37/42/'),
  706. (
  707. 'inc-ns1:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  708. '/ns-included1/test3/inner/42/37/',
  709. ),
  710. ('inc-ns1:test-ns3:urlobject-special-view', [], {}, '/ns-included1/test3/inner/+%5C$*/'),
  711. ]
  712. for name, args, kwargs, expected in test_urls:
  713. with self.subTest(name=name, args=args, kwargs=kwargs):
  714. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  715. def test_nested_namespace_pattern(self):
  716. """Namespaces can be nested."""
  717. test_urls = [
  718. (
  719. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [], {},
  720. '/ns-included1/ns-included4/ns-included1/test3/inner/',
  721. ),
  722. (
  723. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [37, 42], {},
  724. '/ns-included1/ns-included4/ns-included1/test3/inner/37/42/',
  725. ),
  726. (
  727. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  728. '/ns-included1/ns-included4/ns-included1/test3/inner/42/37/',
  729. ),
  730. (
  731. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-special-view', [], {},
  732. '/ns-included1/ns-included4/ns-included1/test3/inner/+%5C$*/',
  733. ),
  734. ]
  735. for name, args, kwargs, expected in test_urls:
  736. with self.subTest(name=name, args=args, kwargs=kwargs):
  737. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  738. def test_app_lookup_object(self):
  739. """A default application namespace can be used for lookup."""
  740. test_urls = [
  741. ('testapp:urlobject-view', [], {}, '/default/inner/'),
  742. ('testapp:urlobject-view', [37, 42], {}, '/default/inner/37/42/'),
  743. ('testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/default/inner/42/37/'),
  744. ('testapp:urlobject-special-view', [], {}, '/default/inner/+%5C$*/'),
  745. ]
  746. for name, args, kwargs, expected in test_urls:
  747. with self.subTest(name=name, args=args, kwargs=kwargs):
  748. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  749. def test_app_lookup_object_with_default(self):
  750. """A default application namespace is sensitive to the current app."""
  751. test_urls = [
  752. ('testapp:urlobject-view', [], {}, 'test-ns3', '/default/inner/'),
  753. ('testapp:urlobject-view', [37, 42], {}, 'test-ns3', '/default/inner/37/42/'),
  754. ('testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'test-ns3', '/default/inner/42/37/'),
  755. ('testapp:urlobject-special-view', [], {}, 'test-ns3', '/default/inner/+%5C$*/'),
  756. ]
  757. for name, args, kwargs, current_app, expected in test_urls:
  758. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  759. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  760. def test_app_lookup_object_without_default(self):
  761. """
  762. An application namespace without a default is sensitive to the current
  763. app.
  764. """
  765. test_urls = [
  766. ('nodefault:urlobject-view', [], {}, None, '/other2/inner/'),
  767. ('nodefault:urlobject-view', [37, 42], {}, None, '/other2/inner/37/42/'),
  768. ('nodefault:urlobject-view', [], {'arg1': 42, 'arg2': 37}, None, '/other2/inner/42/37/'),
  769. ('nodefault:urlobject-special-view', [], {}, None, '/other2/inner/+%5C$*/'),
  770. ('nodefault:urlobject-view', [], {}, 'other-ns1', '/other1/inner/'),
  771. ('nodefault:urlobject-view', [37, 42], {}, 'other-ns1', '/other1/inner/37/42/'),
  772. ('nodefault:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'other-ns1', '/other1/inner/42/37/'),
  773. ('nodefault:urlobject-special-view', [], {}, 'other-ns1', '/other1/inner/+%5C$*/'),
  774. ]
  775. for name, args, kwargs, current_app, expected in test_urls:
  776. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  777. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  778. def test_special_chars_namespace(self):
  779. test_urls = [
  780. ('special:included_namespace_urls:inc-normal-view', [], {}, '/+%5C$*/included/normal/'),
  781. ('special:included_namespace_urls:inc-normal-view', [37, 42], {}, '/+%5C$*/included/normal/37/42/'),
  782. (
  783. 'special:included_namespace_urls:inc-normal-view', [], {'arg1': 42, 'arg2': 37},
  784. '/+%5C$*/included/normal/42/37/',
  785. ),
  786. ('special:included_namespace_urls:inc-special-view', [], {}, '/+%5C$*/included/+%5C$*/'),
  787. ]
  788. for name, args, kwargs, expected in test_urls:
  789. with self.subTest(name=name, args=args, kwargs=kwargs):
  790. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  791. def test_namespaces_with_variables(self):
  792. """Namespace prefixes can capture variables."""
  793. test_urls = [
  794. ('inc-ns5:inner-nothing', [], {'outer': '70'}, '/inc70/'),
  795. ('inc-ns5:inner-extra', [], {'extra': 'foobar', 'outer': '78'}, '/inc78/extra/foobar/'),
  796. ('inc-ns5:inner-nothing', ['70'], {}, '/inc70/'),
  797. ('inc-ns5:inner-extra', ['78', 'foobar'], {}, '/inc78/extra/foobar/'),
  798. ]
  799. for name, args, kwargs, expected in test_urls:
  800. with self.subTest(name=name, args=args, kwargs=kwargs):
  801. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  802. def test_nested_app_lookup(self):
  803. """
  804. A nested current_app should be split in individual namespaces (#24904).
  805. """
  806. test_urls = [
  807. ('inc-ns1:testapp:urlobject-view', [], {}, None, '/ns-included1/test4/inner/'),
  808. ('inc-ns1:testapp:urlobject-view', [37, 42], {}, None, '/ns-included1/test4/inner/37/42/'),
  809. ('inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, None, '/ns-included1/test4/inner/42/37/'),
  810. ('inc-ns1:testapp:urlobject-special-view', [], {}, None, '/ns-included1/test4/inner/+%5C$*/'),
  811. ('inc-ns1:testapp:urlobject-view', [], {}, 'inc-ns1:test-ns3', '/ns-included1/test3/inner/'),
  812. ('inc-ns1:testapp:urlobject-view', [37, 42], {}, 'inc-ns1:test-ns3', '/ns-included1/test3/inner/37/42/'),
  813. (
  814. 'inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'inc-ns1:test-ns3',
  815. '/ns-included1/test3/inner/42/37/',
  816. ),
  817. (
  818. 'inc-ns1:testapp:urlobject-special-view', [], {}, 'inc-ns1:test-ns3',
  819. '/ns-included1/test3/inner/+%5C$*/',
  820. ),
  821. ]
  822. for name, args, kwargs, current_app, expected in test_urls:
  823. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  824. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  825. def test_current_app_no_partial_match(self):
  826. """current_app shouldn't be used unless it matches the whole path."""
  827. test_urls = [
  828. ('inc-ns1:testapp:urlobject-view', [], {}, 'nonexistent:test-ns3', '/ns-included1/test4/inner/'),
  829. (
  830. 'inc-ns1:testapp:urlobject-view', [37, 42], {}, 'nonexistent:test-ns3',
  831. '/ns-included1/test4/inner/37/42/',
  832. ),
  833. (
  834. 'inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'nonexistent:test-ns3',
  835. '/ns-included1/test4/inner/42/37/',
  836. ),
  837. (
  838. 'inc-ns1:testapp:urlobject-special-view', [], {}, 'nonexistent:test-ns3',
  839. '/ns-included1/test4/inner/+%5C$*/',
  840. ),
  841. ]
  842. for name, args, kwargs, current_app, expected in test_urls:
  843. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  844. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  845. @override_settings(ROOT_URLCONF=urlconf_outer.__name__)
  846. class RequestURLconfTests(SimpleTestCase):
  847. def test_urlconf(self):
  848. response = self.client.get('/test/me/')
  849. self.assertEqual(response.status_code, 200)
  850. self.assertEqual(response.content, b'outer:/test/me/,inner:/inner_urlconf/second_test/')
  851. response = self.client.get('/inner_urlconf/second_test/')
  852. self.assertEqual(response.status_code, 200)
  853. response = self.client.get('/second_test/')
  854. self.assertEqual(response.status_code, 404)
  855. @override_settings(
  856. MIDDLEWARE=[
  857. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  858. ]
  859. )
  860. def test_urlconf_overridden(self):
  861. response = self.client.get('/test/me/')
  862. self.assertEqual(response.status_code, 404)
  863. response = self.client.get('/inner_urlconf/second_test/')
  864. self.assertEqual(response.status_code, 404)
  865. response = self.client.get('/second_test/')
  866. self.assertEqual(response.status_code, 200)
  867. self.assertEqual(response.content, b'outer:,inner:/second_test/')
  868. @override_settings(
  869. MIDDLEWARE=[
  870. '%s.NullChangeURLconfMiddleware' % middleware.__name__,
  871. ]
  872. )
  873. def test_urlconf_overridden_with_null(self):
  874. """
  875. Overriding request.urlconf with None will fall back to the default
  876. URLconf.
  877. """
  878. response = self.client.get('/test/me/')
  879. self.assertEqual(response.status_code, 200)
  880. self.assertEqual(response.content, b'outer:/test/me/,inner:/inner_urlconf/second_test/')
  881. response = self.client.get('/inner_urlconf/second_test/')
  882. self.assertEqual(response.status_code, 200)
  883. response = self.client.get('/second_test/')
  884. self.assertEqual(response.status_code, 404)
  885. @override_settings(
  886. MIDDLEWARE=[
  887. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  888. '%s.ReverseInnerInResponseMiddleware' % middleware.__name__,
  889. ]
  890. )
  891. def test_reverse_inner_in_response_middleware(self):
  892. """
  893. Test reversing an URL from the *overridden* URLconf from inside
  894. a response middleware.
  895. """
  896. response = self.client.get('/second_test/')
  897. self.assertEqual(response.status_code, 200)
  898. self.assertEqual(response.content, b'/second_test/')
  899. @override_settings(
  900. MIDDLEWARE=[
  901. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  902. '%s.ReverseOuterInResponseMiddleware' % middleware.__name__,
  903. ]
  904. )
  905. def test_reverse_outer_in_response_middleware(self):
  906. """
  907. Test reversing an URL from the *default* URLconf from inside
  908. a response middleware.
  909. """
  910. message = "Reverse for 'outer' not found."
  911. with self.assertRaisesMessage(NoReverseMatch, message):
  912. self.client.get('/second_test/')
  913. @override_settings(
  914. MIDDLEWARE=[
  915. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  916. '%s.ReverseInnerInStreaming' % middleware.__name__,
  917. ]
  918. )
  919. def test_reverse_inner_in_streaming(self):
  920. """
  921. Test reversing an URL from the *overridden* URLconf from inside
  922. a streaming response.
  923. """
  924. response = self.client.get('/second_test/')
  925. self.assertEqual(response.status_code, 200)
  926. self.assertEqual(b''.join(response), b'/second_test/')
  927. @override_settings(
  928. MIDDLEWARE=[
  929. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  930. '%s.ReverseOuterInStreaming' % middleware.__name__,
  931. ]
  932. )
  933. def test_reverse_outer_in_streaming(self):
  934. """
  935. Test reversing an URL from the *default* URLconf from inside
  936. a streaming response.
  937. """
  938. message = "Reverse for 'outer' not found."
  939. with self.assertRaisesMessage(NoReverseMatch, message):
  940. self.client.get('/second_test/')
  941. b''.join(self.client.get('/second_test/'))
  942. def test_urlconf_is_reset_after_request(self):
  943. """The URLconf is reset after each request."""
  944. self.assertIsNone(get_urlconf())
  945. with override_settings(MIDDLEWARE=['%s.ChangeURLconfMiddleware' % middleware.__name__]):
  946. self.client.get(reverse('inner'))
  947. self.assertIsNone(get_urlconf())
  948. class ErrorHandlerResolutionTests(SimpleTestCase):
  949. """Tests for handler400, handler404 and handler500"""
  950. def setUp(self):
  951. urlconf = 'urlpatterns_reverse.urls_error_handlers'
  952. urlconf_callables = 'urlpatterns_reverse.urls_error_handlers_callables'
  953. self.resolver = URLResolver(RegexPattern(r'^$'), urlconf)
  954. self.callable_resolver = URLResolver(RegexPattern(r'^$'), urlconf_callables)
  955. def test_named_handlers(self):
  956. handler = (empty_view, {})
  957. for code in [400, 404, 500]:
  958. with self.subTest(code=code):
  959. self.assertEqual(self.resolver.resolve_error_handler(code), handler)
  960. def test_callable_handlers(self):
  961. handler = (empty_view, {})
  962. for code in [400, 404, 500]:
  963. with self.subTest(code=code):
  964. self.assertEqual(self.callable_resolver.resolve_error_handler(code), handler)
  965. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls_without_full_import')
  966. class DefaultErrorHandlerTests(SimpleTestCase):
  967. def test_default_handler(self):
  968. "If the urls.py doesn't specify handlers, the defaults are used"
  969. response = self.client.get('/test/')
  970. self.assertEqual(response.status_code, 404)
  971. with self.assertRaisesMessage(ValueError, "I don't think I'm getting good"):
  972. self.client.get('/bad_view/')
  973. @override_settings(ROOT_URLCONF=None)
  974. class NoRootUrlConfTests(SimpleTestCase):
  975. """Tests for handler404 and handler500 if ROOT_URLCONF is None"""
  976. def test_no_handler_exception(self):
  977. msg = (
  978. "The included URLconf 'None' does not appear to have any patterns "
  979. "in it. If you see valid patterns in the file then the issue is "
  980. "probably caused by a circular import."
  981. )
  982. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  983. self.client.get('/test/me/')
  984. @override_settings(ROOT_URLCONF='urlpatterns_reverse.namespace_urls')
  985. class ResolverMatchTests(SimpleTestCase):
  986. def test_urlpattern_resolve(self):
  987. for path, url_name, app_name, namespace, view_name, func, args, kwargs in resolve_test_data:
  988. with self.subTest(path=path):
  989. # Legacy support for extracting "function, args, kwargs".
  990. match_func, match_args, match_kwargs = resolve(path)
  991. self.assertEqual(match_func, func)
  992. self.assertEqual(match_args, args)
  993. self.assertEqual(match_kwargs, kwargs)
  994. # ResolverMatch capabilities.
  995. match = resolve(path)
  996. self.assertEqual(match.__class__, ResolverMatch)
  997. self.assertEqual(match.url_name, url_name)
  998. self.assertEqual(match.app_name, app_name)
  999. self.assertEqual(match.namespace, namespace)
  1000. self.assertEqual(match.view_name, view_name)
  1001. self.assertEqual(match.func, func)
  1002. self.assertEqual(match.args, args)
  1003. self.assertEqual(match.kwargs, kwargs)
  1004. # and for legacy purposes:
  1005. self.assertEqual(match[0], func)
  1006. self.assertEqual(match[1], args)
  1007. self.assertEqual(match[2], kwargs)
  1008. def test_resolver_match_on_request(self):
  1009. response = self.client.get('/resolver_match/')
  1010. resolver_match = response.resolver_match
  1011. self.assertEqual(resolver_match.url_name, 'test-resolver-match')
  1012. def test_resolver_match_on_request_before_resolution(self):
  1013. request = HttpRequest()
  1014. self.assertIsNone(request.resolver_match)
  1015. def test_repr(self):
  1016. self.assertEqual(
  1017. repr(resolve('/no_kwargs/42/37/')),
  1018. "ResolverMatch(func=urlpatterns_reverse.views.empty_view, "
  1019. "args=('42', '37'), kwargs={}, url_name=no-kwargs, app_names=[], "
  1020. "namespaces=[], route=^no_kwargs/([0-9]+)/([0-9]+)/$)",
  1021. )
  1022. @override_settings(ROOT_URLCONF='urlpatterns_reverse.erroneous_urls')
  1023. class ErroneousViewTests(SimpleTestCase):
  1024. def test_noncallable_view(self):
  1025. # View is not a callable (explicit import; arbitrary Python object)
  1026. with self.assertRaisesMessage(TypeError, 'view must be a callable'):
  1027. url(r'uncallable-object/$', views.uncallable)
  1028. def test_invalid_regex(self):
  1029. # Regex contains an error (refs #6170)
  1030. msg = '(regex_error/$" is not a valid regular expression'
  1031. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1032. reverse(views.empty_view)
  1033. class ViewLoadingTests(SimpleTestCase):
  1034. def test_view_loading(self):
  1035. self.assertEqual(get_callable('urlpatterns_reverse.views.empty_view'), empty_view)
  1036. self.assertEqual(get_callable(empty_view), empty_view)
  1037. def test_view_does_not_exist(self):
  1038. msg = "View does not exist in module urlpatterns_reverse.views."
  1039. with self.assertRaisesMessage(ViewDoesNotExist, msg):
  1040. get_callable('urlpatterns_reverse.views.i_should_not_exist')
  1041. def test_attributeerror_not_hidden(self):
  1042. msg = 'I am here to confuse django.urls.get_callable'
  1043. with self.assertRaisesMessage(AttributeError, msg):
  1044. get_callable('urlpatterns_reverse.views_broken.i_am_broken')
  1045. def test_non_string_value(self):
  1046. msg = "'1' is not a callable or a dot-notation path"
  1047. with self.assertRaisesMessage(ViewDoesNotExist, msg):
  1048. get_callable(1)
  1049. def test_string_without_dot(self):
  1050. msg = "Could not import 'test'. The path must be fully qualified."
  1051. with self.assertRaisesMessage(ImportError, msg):
  1052. get_callable('test')
  1053. def test_module_does_not_exist(self):
  1054. with self.assertRaisesMessage(ImportError, "No module named 'foo'"):
  1055. get_callable('foo.bar')
  1056. def test_parent_module_does_not_exist(self):
  1057. msg = 'Parent module urlpatterns_reverse.foo does not exist.'
  1058. with self.assertRaisesMessage(ViewDoesNotExist, msg):
  1059. get_callable('urlpatterns_reverse.foo.bar')
  1060. def test_not_callable(self):
  1061. msg = (
  1062. "Could not import 'urlpatterns_reverse.tests.resolve_test_data'. "
  1063. "View is not callable."
  1064. )
  1065. with self.assertRaisesMessage(ViewDoesNotExist, msg):
  1066. get_callable('urlpatterns_reverse.tests.resolve_test_data')
  1067. class IncludeTests(SimpleTestCase):
  1068. url_patterns = [
  1069. url(r'^inner/$', views.empty_view, name='urlobject-view'),
  1070. url(r'^inner/(?P<arg1>[0-9]+)/(?P<arg2>[0-9]+)/$', views.empty_view, name='urlobject-view'),
  1071. url(r'^inner/\+\\\$\*/$', views.empty_view, name='urlobject-special-view'),
  1072. ]
  1073. app_urls = URLObject('inc-app')
  1074. def test_include_urls(self):
  1075. self.assertEqual(include(self.url_patterns), (self.url_patterns, None, None))
  1076. def test_include_namespace(self):
  1077. msg = (
  1078. 'Specifying a namespace in include() without providing an '
  1079. 'app_name is not supported.'
  1080. )
  1081. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1082. include(self.url_patterns, 'namespace')
  1083. def test_include_4_tuple(self):
  1084. msg = 'Passing a 4-tuple to include() is not supported.'
  1085. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1086. include((self.url_patterns, 'app_name', 'namespace', 'blah'))
  1087. def test_include_3_tuple(self):
  1088. msg = 'Passing a 3-tuple to include() is not supported.'
  1089. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1090. include((self.url_patterns, 'app_name', 'namespace'))
  1091. def test_include_3_tuple_namespace(self):
  1092. msg = 'Cannot override the namespace for a dynamic module that provides a namespace.'
  1093. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1094. include((self.url_patterns, 'app_name', 'namespace'), 'namespace')
  1095. def test_include_2_tuple(self):
  1096. self.assertEqual(
  1097. include((self.url_patterns, 'app_name')),
  1098. (self.url_patterns, 'app_name', 'app_name')
  1099. )
  1100. def test_include_2_tuple_namespace(self):
  1101. self.assertEqual(
  1102. include((self.url_patterns, 'app_name'), namespace='namespace'),
  1103. (self.url_patterns, 'app_name', 'namespace')
  1104. )
  1105. def test_include_app_name(self):
  1106. self.assertEqual(
  1107. include(self.app_urls),
  1108. (self.app_urls, 'inc-app', 'inc-app')
  1109. )
  1110. def test_include_app_name_namespace(self):
  1111. self.assertEqual(
  1112. include(self.app_urls, 'namespace'),
  1113. (self.app_urls, 'inc-app', 'namespace')
  1114. )
  1115. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls')
  1116. class LookaheadTests(SimpleTestCase):
  1117. def test_valid_resolve(self):
  1118. test_urls = [
  1119. '/lookahead-/a-city/',
  1120. '/lookbehind-/a-city/',
  1121. '/lookahead+/a-city/',
  1122. '/lookbehind+/a-city/',
  1123. ]
  1124. for test_url in test_urls:
  1125. with self.subTest(url=test_url):
  1126. self.assertEqual(resolve(test_url).kwargs, {'city': 'a-city'})
  1127. def test_invalid_resolve(self):
  1128. test_urls = [
  1129. '/lookahead-/not-a-city/',
  1130. '/lookbehind-/not-a-city/',
  1131. '/lookahead+/other-city/',
  1132. '/lookbehind+/other-city/',
  1133. ]
  1134. for test_url in test_urls:
  1135. with self.subTest(url=test_url):
  1136. with self.assertRaises(Resolver404):
  1137. resolve(test_url)
  1138. def test_valid_reverse(self):
  1139. test_urls = [
  1140. ('lookahead-positive', {'city': 'a-city'}, '/lookahead+/a-city/'),
  1141. ('lookahead-negative', {'city': 'a-city'}, '/lookahead-/a-city/'),
  1142. ('lookbehind-positive', {'city': 'a-city'}, '/lookbehind+/a-city/'),
  1143. ('lookbehind-negative', {'city': 'a-city'}, '/lookbehind-/a-city/'),
  1144. ]
  1145. for name, kwargs, expected in test_urls:
  1146. with self.subTest(name=name, kwargs=kwargs):
  1147. self.assertEqual(reverse(name, kwargs=kwargs), expected)
  1148. def test_invalid_reverse(self):
  1149. test_urls = [
  1150. ('lookahead-positive', {'city': 'other-city'}),
  1151. ('lookahead-negative', {'city': 'not-a-city'}),
  1152. ('lookbehind-positive', {'city': 'other-city'}),
  1153. ('lookbehind-negative', {'city': 'not-a-city'}),
  1154. ]
  1155. for name, kwargs in test_urls:
  1156. with self.subTest(name=name, kwargs=kwargs):
  1157. with self.assertRaises(NoReverseMatch):
  1158. reverse(name, kwargs=kwargs)