tests.py 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259
  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, 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('settings.py', extra="""
  487. from django.urls import reverse_lazy
  488. LOGIN_URL = reverse_lazy('login')""")
  489. def tearDown(self):
  490. self.remove_settings('settings.py')
  491. def test_lazy_in_settings(self):
  492. out, err = self.run_manage(['check'])
  493. self.assertNoOutput(err)
  494. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls')
  495. class ReverseShortcutTests(SimpleTestCase):
  496. def test_redirect_to_object(self):
  497. # We don't really need a model; just something with a get_absolute_url
  498. class FakeObj:
  499. def get_absolute_url(self):
  500. return "/hi-there/"
  501. res = redirect(FakeObj())
  502. self.assertIsInstance(res, HttpResponseRedirect)
  503. self.assertEqual(res.url, '/hi-there/')
  504. res = redirect(FakeObj(), permanent=True)
  505. self.assertIsInstance(res, HttpResponsePermanentRedirect)
  506. self.assertEqual(res.url, '/hi-there/')
  507. def test_redirect_to_view_name(self):
  508. res = redirect('hardcoded2')
  509. self.assertEqual(res.url, '/hardcoded/doc.pdf')
  510. res = redirect('places', 1)
  511. self.assertEqual(res.url, '/places/1/')
  512. res = redirect('headlines', year='2008', month='02', day='17')
  513. self.assertEqual(res.url, '/headlines/2008.02.17/')
  514. with self.assertRaises(NoReverseMatch):
  515. redirect('not-a-view')
  516. def test_redirect_to_url(self):
  517. res = redirect('/foo/')
  518. self.assertEqual(res.url, '/foo/')
  519. res = redirect('http://example.com/')
  520. self.assertEqual(res.url, 'http://example.com/')
  521. # Assert that we can redirect using UTF-8 strings
  522. res = redirect('/æøå/abc/')
  523. self.assertEqual(res.url, '/%C3%A6%C3%B8%C3%A5/abc/')
  524. # Assert that no imports are attempted when dealing with a relative path
  525. # (previously, the below would resolve in a UnicodeEncodeError from __import__ )
  526. res = redirect('/æøå.abc/')
  527. self.assertEqual(res.url, '/%C3%A6%C3%B8%C3%A5.abc/')
  528. res = redirect('os.path')
  529. self.assertEqual(res.url, 'os.path')
  530. def test_no_illegal_imports(self):
  531. # modules that are not listed in urlpatterns should not be importable
  532. redirect("urlpatterns_reverse.nonimported_module.view")
  533. self.assertNotIn("urlpatterns_reverse.nonimported_module", sys.modules)
  534. def test_reverse_by_path_nested(self):
  535. # Views added to urlpatterns using include() should be reversible.
  536. from .views import nested_view
  537. self.assertEqual(reverse(nested_view), '/includes/nested_path/')
  538. def test_redirect_view_object(self):
  539. from .views import absolute_kwargs_view
  540. res = redirect(absolute_kwargs_view)
  541. self.assertEqual(res.url, '/absolute_arg_view/')
  542. with self.assertRaises(NoReverseMatch):
  543. redirect(absolute_kwargs_view, wrong_argument=None)
  544. @override_settings(ROOT_URLCONF='urlpatterns_reverse.namespace_urls')
  545. class NamespaceTests(SimpleTestCase):
  546. def test_ambiguous_object(self):
  547. """
  548. Names deployed via dynamic URL objects that require namespaces can't
  549. be resolved.
  550. """
  551. test_urls = [
  552. ('urlobject-view', [], {}),
  553. ('urlobject-view', [37, 42], {}),
  554. ('urlobject-view', [], {'arg1': 42, 'arg2': 37}),
  555. ]
  556. for name, args, kwargs in test_urls:
  557. with self.subTest(name=name, args=args, kwargs=kwargs):
  558. with self.assertRaises(NoReverseMatch):
  559. reverse(name, args=args, kwargs=kwargs)
  560. def test_ambiguous_urlpattern(self):
  561. """
  562. Names deployed via dynamic URL objects that require namespaces can't
  563. be resolved.
  564. """
  565. test_urls = [
  566. ('inner-nothing', [], {}),
  567. ('inner-nothing', [37, 42], {}),
  568. ('inner-nothing', [], {'arg1': 42, 'arg2': 37}),
  569. ]
  570. for name, args, kwargs in test_urls:
  571. with self.subTest(name=name, args=args, kwargs=kwargs):
  572. with self.assertRaises(NoReverseMatch):
  573. reverse(name, args=args, kwargs=kwargs)
  574. def test_non_existent_namespace(self):
  575. """Nonexistent namespaces raise errors."""
  576. test_urls = [
  577. 'blahblah:urlobject-view',
  578. 'test-ns1:blahblah:urlobject-view',
  579. ]
  580. for name in test_urls:
  581. with self.subTest(name=name):
  582. with self.assertRaises(NoReverseMatch):
  583. reverse(name)
  584. def test_normal_name(self):
  585. """Normal lookups work as expected."""
  586. test_urls = [
  587. ('normal-view', [], {}, '/normal/'),
  588. ('normal-view', [37, 42], {}, '/normal/37/42/'),
  589. ('normal-view', [], {'arg1': 42, 'arg2': 37}, '/normal/42/37/'),
  590. ('special-view', [], {}, '/+%5C$*/'),
  591. ]
  592. for name, args, kwargs, expected in test_urls:
  593. with self.subTest(name=name, args=args, kwargs=kwargs):
  594. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  595. def test_simple_included_name(self):
  596. """Normal lookups work on names included from other patterns."""
  597. test_urls = [
  598. ('included_namespace_urls:inc-normal-view', [], {}, '/included/normal/'),
  599. ('included_namespace_urls:inc-normal-view', [37, 42], {}, '/included/normal/37/42/'),
  600. ('included_namespace_urls:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/included/normal/42/37/'),
  601. ('included_namespace_urls:inc-special-view', [], {}, '/included/+%5C$*/'),
  602. ]
  603. for name, args, kwargs, expected in test_urls:
  604. with self.subTest(name=name, args=args, kwargs=kwargs):
  605. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  606. def test_namespace_object(self):
  607. """Dynamic URL objects can be found using a namespace."""
  608. test_urls = [
  609. ('test-ns1:urlobject-view', [], {}, '/test1/inner/'),
  610. ('test-ns1:urlobject-view', [37, 42], {}, '/test1/inner/37/42/'),
  611. ('test-ns1:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/test1/inner/42/37/'),
  612. ('test-ns1:urlobject-special-view', [], {}, '/test1/inner/+%5C$*/'),
  613. ]
  614. for name, args, kwargs, expected in test_urls:
  615. with self.subTest(name=name, args=args, kwargs=kwargs):
  616. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  617. def test_app_object(self):
  618. """
  619. Dynamic URL objects can return a (pattern, app_name) 2-tuple, and
  620. include() can set the namespace.
  621. """
  622. test_urls = [
  623. ('new-ns1:urlobject-view', [], {}, '/newapp1/inner/'),
  624. ('new-ns1:urlobject-view', [37, 42], {}, '/newapp1/inner/37/42/'),
  625. ('new-ns1:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/newapp1/inner/42/37/'),
  626. ('new-ns1:urlobject-special-view', [], {}, '/newapp1/inner/+%5C$*/'),
  627. ]
  628. for name, args, kwargs, expected in test_urls:
  629. with self.subTest(name=name, args=args, kwargs=kwargs):
  630. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  631. def test_app_object_default_namespace(self):
  632. """
  633. Namespace defaults to app_name when including a (pattern, app_name)
  634. 2-tuple.
  635. """
  636. test_urls = [
  637. ('newapp:urlobject-view', [], {}, '/new-default/inner/'),
  638. ('newapp:urlobject-view', [37, 42], {}, '/new-default/inner/37/42/'),
  639. ('newapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/new-default/inner/42/37/'),
  640. ('newapp:urlobject-special-view', [], {}, '/new-default/inner/+%5C$*/'),
  641. ]
  642. for name, args, kwargs, expected in test_urls:
  643. with self.subTest(name=name, args=args, kwargs=kwargs):
  644. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  645. def test_embedded_namespace_object(self):
  646. """Namespaces can be installed anywhere in the URL pattern tree."""
  647. test_urls = [
  648. ('included_namespace_urls:test-ns3:urlobject-view', [], {}, '/included/test3/inner/'),
  649. ('included_namespace_urls:test-ns3:urlobject-view', [37, 42], {}, '/included/test3/inner/37/42/'),
  650. (
  651. 'included_namespace_urls:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  652. '/included/test3/inner/42/37/',
  653. ),
  654. ('included_namespace_urls:test-ns3:urlobject-special-view', [], {}, '/included/test3/inner/+%5C$*/'),
  655. ]
  656. for name, args, kwargs, expected in test_urls:
  657. with self.subTest(name=name, args=args, kwargs=kwargs):
  658. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  659. def test_namespace_pattern(self):
  660. """Namespaces can be applied to include()'d urlpatterns."""
  661. test_urls = [
  662. ('inc-ns1:inc-normal-view', [], {}, '/ns-included1/normal/'),
  663. ('inc-ns1:inc-normal-view', [37, 42], {}, '/ns-included1/normal/37/42/'),
  664. ('inc-ns1:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/ns-included1/normal/42/37/'),
  665. ('inc-ns1:inc-special-view', [], {}, '/ns-included1/+%5C$*/'),
  666. ]
  667. for name, args, kwargs, expected in test_urls:
  668. with self.subTest(name=name, args=args, kwargs=kwargs):
  669. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  670. def test_app_name_pattern(self):
  671. """
  672. Namespaces can be applied to include()'d urlpatterns that set an
  673. app_name attribute.
  674. """
  675. test_urls = [
  676. ('app-ns1:inc-normal-view', [], {}, '/app-included1/normal/'),
  677. ('app-ns1:inc-normal-view', [37, 42], {}, '/app-included1/normal/37/42/'),
  678. ('app-ns1:inc-normal-view', [], {'arg1': 42, 'arg2': 37}, '/app-included1/normal/42/37/'),
  679. ('app-ns1:inc-special-view', [], {}, '/app-included1/+%5C$*/'),
  680. ]
  681. for name, args, kwargs, expected in test_urls:
  682. with self.subTest(name=name, args=args, kwargs=kwargs):
  683. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  684. def test_namespace_pattern_with_variable_prefix(self):
  685. """
  686. Using include() with namespaces when there is a regex variable in front
  687. of it.
  688. """
  689. test_urls = [
  690. ('inc-outer:inc-normal-view', [], {'outer': 42}, '/ns-outer/42/normal/'),
  691. ('inc-outer:inc-normal-view', [42], {}, '/ns-outer/42/normal/'),
  692. ('inc-outer:inc-normal-view', [], {'arg1': 37, 'arg2': 4, 'outer': 42}, '/ns-outer/42/normal/37/4/'),
  693. ('inc-outer:inc-normal-view', [42, 37, 4], {}, '/ns-outer/42/normal/37/4/'),
  694. ('inc-outer:inc-special-view', [], {'outer': 42}, '/ns-outer/42/+%5C$*/'),
  695. ('inc-outer:inc-special-view', [42], {}, '/ns-outer/42/+%5C$*/'),
  696. ]
  697. for name, args, kwargs, expected in test_urls:
  698. with self.subTest(name=name, args=args, kwargs=kwargs):
  699. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  700. def test_multiple_namespace_pattern(self):
  701. """Namespaces can be embedded."""
  702. test_urls = [
  703. ('inc-ns1:test-ns3:urlobject-view', [], {}, '/ns-included1/test3/inner/'),
  704. ('inc-ns1:test-ns3:urlobject-view', [37, 42], {}, '/ns-included1/test3/inner/37/42/'),
  705. (
  706. 'inc-ns1:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  707. '/ns-included1/test3/inner/42/37/',
  708. ),
  709. ('inc-ns1:test-ns3:urlobject-special-view', [], {}, '/ns-included1/test3/inner/+%5C$*/'),
  710. ]
  711. for name, args, kwargs, expected in test_urls:
  712. with self.subTest(name=name, args=args, kwargs=kwargs):
  713. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  714. def test_nested_namespace_pattern(self):
  715. """Namespaces can be nested."""
  716. test_urls = [
  717. (
  718. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [], {},
  719. '/ns-included1/ns-included4/ns-included1/test3/inner/',
  720. ),
  721. (
  722. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [37, 42], {},
  723. '/ns-included1/ns-included4/ns-included1/test3/inner/37/42/',
  724. ),
  725. (
  726. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-view', [], {'arg1': 42, 'arg2': 37},
  727. '/ns-included1/ns-included4/ns-included1/test3/inner/42/37/',
  728. ),
  729. (
  730. 'inc-ns1:inc-ns4:inc-ns1:test-ns3:urlobject-special-view', [], {},
  731. '/ns-included1/ns-included4/ns-included1/test3/inner/+%5C$*/',
  732. ),
  733. ]
  734. for name, args, kwargs, expected in test_urls:
  735. with self.subTest(name=name, args=args, kwargs=kwargs):
  736. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  737. def test_app_lookup_object(self):
  738. """A default application namespace can be used for lookup."""
  739. test_urls = [
  740. ('testapp:urlobject-view', [], {}, '/default/inner/'),
  741. ('testapp:urlobject-view', [37, 42], {}, '/default/inner/37/42/'),
  742. ('testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, '/default/inner/42/37/'),
  743. ('testapp:urlobject-special-view', [], {}, '/default/inner/+%5C$*/'),
  744. ]
  745. for name, args, kwargs, expected in test_urls:
  746. with self.subTest(name=name, args=args, kwargs=kwargs):
  747. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  748. def test_app_lookup_object_with_default(self):
  749. """A default application namespace is sensitive to the current app."""
  750. test_urls = [
  751. ('testapp:urlobject-view', [], {}, 'test-ns3', '/default/inner/'),
  752. ('testapp:urlobject-view', [37, 42], {}, 'test-ns3', '/default/inner/37/42/'),
  753. ('testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'test-ns3', '/default/inner/42/37/'),
  754. ('testapp:urlobject-special-view', [], {}, 'test-ns3', '/default/inner/+%5C$*/'),
  755. ]
  756. for name, args, kwargs, current_app, expected in test_urls:
  757. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  758. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  759. def test_app_lookup_object_without_default(self):
  760. """
  761. An application namespace without a default is sensitive to the current
  762. app.
  763. """
  764. test_urls = [
  765. ('nodefault:urlobject-view', [], {}, None, '/other2/inner/'),
  766. ('nodefault:urlobject-view', [37, 42], {}, None, '/other2/inner/37/42/'),
  767. ('nodefault:urlobject-view', [], {'arg1': 42, 'arg2': 37}, None, '/other2/inner/42/37/'),
  768. ('nodefault:urlobject-special-view', [], {}, None, '/other2/inner/+%5C$*/'),
  769. ('nodefault:urlobject-view', [], {}, 'other-ns1', '/other1/inner/'),
  770. ('nodefault:urlobject-view', [37, 42], {}, 'other-ns1', '/other1/inner/37/42/'),
  771. ('nodefault:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'other-ns1', '/other1/inner/42/37/'),
  772. ('nodefault:urlobject-special-view', [], {}, 'other-ns1', '/other1/inner/+%5C$*/'),
  773. ]
  774. for name, args, kwargs, current_app, expected in test_urls:
  775. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  776. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  777. def test_special_chars_namespace(self):
  778. test_urls = [
  779. ('special:included_namespace_urls:inc-normal-view', [], {}, '/+%5C$*/included/normal/'),
  780. ('special:included_namespace_urls:inc-normal-view', [37, 42], {}, '/+%5C$*/included/normal/37/42/'),
  781. (
  782. 'special:included_namespace_urls:inc-normal-view', [], {'arg1': 42, 'arg2': 37},
  783. '/+%5C$*/included/normal/42/37/',
  784. ),
  785. ('special:included_namespace_urls:inc-special-view', [], {}, '/+%5C$*/included/+%5C$*/'),
  786. ]
  787. for name, args, kwargs, expected in test_urls:
  788. with self.subTest(name=name, args=args, kwargs=kwargs):
  789. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  790. def test_namespaces_with_variables(self):
  791. """Namespace prefixes can capture variables."""
  792. test_urls = [
  793. ('inc-ns5:inner-nothing', [], {'outer': '70'}, '/inc70/'),
  794. ('inc-ns5:inner-extra', [], {'extra': 'foobar', 'outer': '78'}, '/inc78/extra/foobar/'),
  795. ('inc-ns5:inner-nothing', ['70'], {}, '/inc70/'),
  796. ('inc-ns5:inner-extra', ['78', 'foobar'], {}, '/inc78/extra/foobar/'),
  797. ]
  798. for name, args, kwargs, expected in test_urls:
  799. with self.subTest(name=name, args=args, kwargs=kwargs):
  800. self.assertEqual(reverse(name, args=args, kwargs=kwargs), expected)
  801. def test_nested_app_lookup(self):
  802. """
  803. A nested current_app should be split in individual namespaces (#24904).
  804. """
  805. test_urls = [
  806. ('inc-ns1:testapp:urlobject-view', [], {}, None, '/ns-included1/test4/inner/'),
  807. ('inc-ns1:testapp:urlobject-view', [37, 42], {}, None, '/ns-included1/test4/inner/37/42/'),
  808. ('inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, None, '/ns-included1/test4/inner/42/37/'),
  809. ('inc-ns1:testapp:urlobject-special-view', [], {}, None, '/ns-included1/test4/inner/+%5C$*/'),
  810. ('inc-ns1:testapp:urlobject-view', [], {}, 'inc-ns1:test-ns3', '/ns-included1/test3/inner/'),
  811. ('inc-ns1:testapp:urlobject-view', [37, 42], {}, 'inc-ns1:test-ns3', '/ns-included1/test3/inner/37/42/'),
  812. (
  813. 'inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'inc-ns1:test-ns3',
  814. '/ns-included1/test3/inner/42/37/',
  815. ),
  816. (
  817. 'inc-ns1:testapp:urlobject-special-view', [], {}, 'inc-ns1:test-ns3',
  818. '/ns-included1/test3/inner/+%5C$*/',
  819. ),
  820. ]
  821. for name, args, kwargs, current_app, expected in test_urls:
  822. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  823. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  824. def test_current_app_no_partial_match(self):
  825. """current_app shouldn't be used unless it matches the whole path."""
  826. test_urls = [
  827. ('inc-ns1:testapp:urlobject-view', [], {}, 'nonexistent:test-ns3', '/ns-included1/test4/inner/'),
  828. (
  829. 'inc-ns1:testapp:urlobject-view', [37, 42], {}, 'nonexistent:test-ns3',
  830. '/ns-included1/test4/inner/37/42/',
  831. ),
  832. (
  833. 'inc-ns1:testapp:urlobject-view', [], {'arg1': 42, 'arg2': 37}, 'nonexistent:test-ns3',
  834. '/ns-included1/test4/inner/42/37/',
  835. ),
  836. (
  837. 'inc-ns1:testapp:urlobject-special-view', [], {}, 'nonexistent:test-ns3',
  838. '/ns-included1/test4/inner/+%5C$*/',
  839. ),
  840. ]
  841. for name, args, kwargs, current_app, expected in test_urls:
  842. with self.subTest(name=name, args=args, kwargs=kwargs, current_app=current_app):
  843. self.assertEqual(reverse(name, args=args, kwargs=kwargs, current_app=current_app), expected)
  844. @override_settings(ROOT_URLCONF=urlconf_outer.__name__)
  845. class RequestURLconfTests(SimpleTestCase):
  846. def test_urlconf(self):
  847. response = self.client.get('/test/me/')
  848. self.assertEqual(response.status_code, 200)
  849. self.assertEqual(response.content, b'outer:/test/me/,inner:/inner_urlconf/second_test/')
  850. response = self.client.get('/inner_urlconf/second_test/')
  851. self.assertEqual(response.status_code, 200)
  852. response = self.client.get('/second_test/')
  853. self.assertEqual(response.status_code, 404)
  854. @override_settings(
  855. MIDDLEWARE=[
  856. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  857. ]
  858. )
  859. def test_urlconf_overridden(self):
  860. response = self.client.get('/test/me/')
  861. self.assertEqual(response.status_code, 404)
  862. response = self.client.get('/inner_urlconf/second_test/')
  863. self.assertEqual(response.status_code, 404)
  864. response = self.client.get('/second_test/')
  865. self.assertEqual(response.status_code, 200)
  866. self.assertEqual(response.content, b'outer:,inner:/second_test/')
  867. @override_settings(
  868. MIDDLEWARE=[
  869. '%s.NullChangeURLconfMiddleware' % middleware.__name__,
  870. ]
  871. )
  872. def test_urlconf_overridden_with_null(self):
  873. """
  874. Overriding request.urlconf with None will fall back to the default
  875. URLconf.
  876. """
  877. response = self.client.get('/test/me/')
  878. self.assertEqual(response.status_code, 200)
  879. self.assertEqual(response.content, b'outer:/test/me/,inner:/inner_urlconf/second_test/')
  880. response = self.client.get('/inner_urlconf/second_test/')
  881. self.assertEqual(response.status_code, 200)
  882. response = self.client.get('/second_test/')
  883. self.assertEqual(response.status_code, 404)
  884. @override_settings(
  885. MIDDLEWARE=[
  886. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  887. '%s.ReverseInnerInResponseMiddleware' % middleware.__name__,
  888. ]
  889. )
  890. def test_reverse_inner_in_response_middleware(self):
  891. """
  892. Test reversing an URL from the *overridden* URLconf from inside
  893. a response middleware.
  894. """
  895. response = self.client.get('/second_test/')
  896. self.assertEqual(response.status_code, 200)
  897. self.assertEqual(response.content, b'/second_test/')
  898. @override_settings(
  899. MIDDLEWARE=[
  900. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  901. '%s.ReverseOuterInResponseMiddleware' % middleware.__name__,
  902. ]
  903. )
  904. def test_reverse_outer_in_response_middleware(self):
  905. """
  906. Test reversing an URL from the *default* URLconf from inside
  907. a response middleware.
  908. """
  909. message = "Reverse for 'outer' not found."
  910. with self.assertRaisesMessage(NoReverseMatch, message):
  911. self.client.get('/second_test/')
  912. @override_settings(
  913. MIDDLEWARE=[
  914. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  915. '%s.ReverseInnerInStreaming' % middleware.__name__,
  916. ]
  917. )
  918. def test_reverse_inner_in_streaming(self):
  919. """
  920. Test reversing an URL from the *overridden* URLconf from inside
  921. a streaming response.
  922. """
  923. response = self.client.get('/second_test/')
  924. self.assertEqual(response.status_code, 200)
  925. self.assertEqual(b''.join(response), b'/second_test/')
  926. @override_settings(
  927. MIDDLEWARE=[
  928. '%s.ChangeURLconfMiddleware' % middleware.__name__,
  929. '%s.ReverseOuterInStreaming' % middleware.__name__,
  930. ]
  931. )
  932. def test_reverse_outer_in_streaming(self):
  933. """
  934. Test reversing an URL from the *default* URLconf from inside
  935. a streaming response.
  936. """
  937. message = "Reverse for 'outer' not found."
  938. with self.assertRaisesMessage(NoReverseMatch, message):
  939. self.client.get('/second_test/')
  940. b''.join(self.client.get('/second_test/'))
  941. class ErrorHandlerResolutionTests(SimpleTestCase):
  942. """Tests for handler400, handler404 and handler500"""
  943. def setUp(self):
  944. urlconf = 'urlpatterns_reverse.urls_error_handlers'
  945. urlconf_callables = 'urlpatterns_reverse.urls_error_handlers_callables'
  946. self.resolver = URLResolver(RegexPattern(r'^$'), urlconf)
  947. self.callable_resolver = URLResolver(RegexPattern(r'^$'), urlconf_callables)
  948. def test_named_handlers(self):
  949. handler = (empty_view, {})
  950. for code in [400, 404, 500]:
  951. with self.subTest(code=code):
  952. self.assertEqual(self.resolver.resolve_error_handler(code), handler)
  953. def test_callable_handlers(self):
  954. handler = (empty_view, {})
  955. for code in [400, 404, 500]:
  956. with self.subTest(code=code):
  957. self.assertEqual(self.callable_resolver.resolve_error_handler(code), handler)
  958. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls_without_full_import')
  959. class DefaultErrorHandlerTests(SimpleTestCase):
  960. def test_default_handler(self):
  961. "If the urls.py doesn't specify handlers, the defaults are used"
  962. response = self.client.get('/test/')
  963. self.assertEqual(response.status_code, 404)
  964. with self.assertRaisesMessage(ValueError, "I don't think I'm getting good"):
  965. self.client.get('/bad_view/')
  966. @override_settings(ROOT_URLCONF=None)
  967. class NoRootUrlConfTests(SimpleTestCase):
  968. """Tests for handler404 and handler500 if ROOT_URLCONF is None"""
  969. def test_no_handler_exception(self):
  970. msg = (
  971. "The included URLconf 'None' does not appear to have any patterns "
  972. "in it. If you see valid patterns in the file then the issue is "
  973. "probably caused by a circular import."
  974. )
  975. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  976. self.client.get('/test/me/')
  977. @override_settings(ROOT_URLCONF='urlpatterns_reverse.namespace_urls')
  978. class ResolverMatchTests(SimpleTestCase):
  979. def test_urlpattern_resolve(self):
  980. for path, url_name, app_name, namespace, view_name, func, args, kwargs in resolve_test_data:
  981. with self.subTest(path=path):
  982. # Legacy support for extracting "function, args, kwargs".
  983. match_func, match_args, match_kwargs = resolve(path)
  984. self.assertEqual(match_func, func)
  985. self.assertEqual(match_args, args)
  986. self.assertEqual(match_kwargs, kwargs)
  987. # ResolverMatch capabilities.
  988. match = resolve(path)
  989. self.assertEqual(match.__class__, ResolverMatch)
  990. self.assertEqual(match.url_name, url_name)
  991. self.assertEqual(match.app_name, app_name)
  992. self.assertEqual(match.namespace, namespace)
  993. self.assertEqual(match.view_name, view_name)
  994. self.assertEqual(match.func, func)
  995. self.assertEqual(match.args, args)
  996. self.assertEqual(match.kwargs, kwargs)
  997. # and for legacy purposes:
  998. self.assertEqual(match[0], func)
  999. self.assertEqual(match[1], args)
  1000. self.assertEqual(match[2], kwargs)
  1001. def test_resolver_match_on_request(self):
  1002. response = self.client.get('/resolver_match/')
  1003. resolver_match = response.resolver_match
  1004. self.assertEqual(resolver_match.url_name, 'test-resolver-match')
  1005. def test_resolver_match_on_request_before_resolution(self):
  1006. request = HttpRequest()
  1007. self.assertIsNone(request.resolver_match)
  1008. @override_settings(ROOT_URLCONF='urlpatterns_reverse.erroneous_urls')
  1009. class ErroneousViewTests(SimpleTestCase):
  1010. def test_noncallable_view(self):
  1011. # View is not a callable (explicit import; arbitrary Python object)
  1012. with self.assertRaisesMessage(TypeError, 'view must be a callable'):
  1013. url(r'uncallable-object/$', views.uncallable)
  1014. def test_invalid_regex(self):
  1015. # Regex contains an error (refs #6170)
  1016. msg = '(regex_error/$" is not a valid regular expression'
  1017. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1018. reverse(views.empty_view)
  1019. class ViewLoadingTests(SimpleTestCase):
  1020. def test_view_loading(self):
  1021. self.assertEqual(get_callable('urlpatterns_reverse.views.empty_view'), empty_view)
  1022. # passing a callable should return the callable
  1023. self.assertEqual(get_callable(empty_view), empty_view)
  1024. def test_exceptions(self):
  1025. # A missing view (identified by an AttributeError) should raise
  1026. # ViewDoesNotExist, ...
  1027. with self.assertRaisesMessage(ViewDoesNotExist, "View does not exist in"):
  1028. get_callable('urlpatterns_reverse.views.i_should_not_exist')
  1029. # ... but if the AttributeError is caused by something else don't
  1030. # swallow it.
  1031. with self.assertRaises(AttributeError):
  1032. get_callable('urlpatterns_reverse.views_broken.i_am_broken')
  1033. class IncludeTests(SimpleTestCase):
  1034. url_patterns = [
  1035. url(r'^inner/$', views.empty_view, name='urlobject-view'),
  1036. url(r'^inner/(?P<arg1>[0-9]+)/(?P<arg2>[0-9]+)/$', views.empty_view, name='urlobject-view'),
  1037. url(r'^inner/\+\\\$\*/$', views.empty_view, name='urlobject-special-view'),
  1038. ]
  1039. app_urls = URLObject('inc-app')
  1040. def test_include_urls(self):
  1041. self.assertEqual(include(self.url_patterns), (self.url_patterns, None, None))
  1042. def test_include_namespace(self):
  1043. msg = (
  1044. 'Specifying a namespace in include() without providing an '
  1045. 'app_name is not supported.'
  1046. )
  1047. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1048. include(self.url_patterns, 'namespace')
  1049. def test_include_4_tuple(self):
  1050. msg = 'Passing a 4-tuple to include() is not supported.'
  1051. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1052. include((self.url_patterns, 'app_name', 'namespace', 'blah'))
  1053. def test_include_3_tuple(self):
  1054. msg = 'Passing a 3-tuple to include() is not supported.'
  1055. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1056. include((self.url_patterns, 'app_name', 'namespace'))
  1057. def test_include_3_tuple_namespace(self):
  1058. msg = 'Cannot override the namespace for a dynamic module that provides a namespace.'
  1059. with self.assertRaisesMessage(ImproperlyConfigured, msg):
  1060. include((self.url_patterns, 'app_name', 'namespace'), 'namespace')
  1061. def test_include_2_tuple(self):
  1062. self.assertEqual(
  1063. include((self.url_patterns, 'app_name')),
  1064. (self.url_patterns, 'app_name', 'app_name')
  1065. )
  1066. def test_include_2_tuple_namespace(self):
  1067. self.assertEqual(
  1068. include((self.url_patterns, 'app_name'), namespace='namespace'),
  1069. (self.url_patterns, 'app_name', 'namespace')
  1070. )
  1071. def test_include_app_name(self):
  1072. self.assertEqual(
  1073. include(self.app_urls),
  1074. (self.app_urls, 'inc-app', 'inc-app')
  1075. )
  1076. def test_include_app_name_namespace(self):
  1077. self.assertEqual(
  1078. include(self.app_urls, 'namespace'),
  1079. (self.app_urls, 'inc-app', 'namespace')
  1080. )
  1081. @override_settings(ROOT_URLCONF='urlpatterns_reverse.urls')
  1082. class LookaheadTests(SimpleTestCase):
  1083. def test_valid_resolve(self):
  1084. test_urls = [
  1085. '/lookahead-/a-city/',
  1086. '/lookbehind-/a-city/',
  1087. '/lookahead+/a-city/',
  1088. '/lookbehind+/a-city/',
  1089. ]
  1090. for test_url in test_urls:
  1091. with self.subTest(url=test_url):
  1092. self.assertEqual(resolve(test_url).kwargs, {'city': 'a-city'})
  1093. def test_invalid_resolve(self):
  1094. test_urls = [
  1095. '/lookahead-/not-a-city/',
  1096. '/lookbehind-/not-a-city/',
  1097. '/lookahead+/other-city/',
  1098. '/lookbehind+/other-city/',
  1099. ]
  1100. for test_url in test_urls:
  1101. with self.subTest(url=test_url):
  1102. with self.assertRaises(Resolver404):
  1103. resolve(test_url)
  1104. def test_valid_reverse(self):
  1105. test_urls = [
  1106. ('lookahead-positive', {'city': 'a-city'}, '/lookahead+/a-city/'),
  1107. ('lookahead-negative', {'city': 'a-city'}, '/lookahead-/a-city/'),
  1108. ('lookbehind-positive', {'city': 'a-city'}, '/lookbehind+/a-city/'),
  1109. ('lookbehind-negative', {'city': 'a-city'}, '/lookbehind-/a-city/'),
  1110. ]
  1111. for name, kwargs, expected in test_urls:
  1112. with self.subTest(name=name, kwargs=kwargs):
  1113. self.assertEqual(reverse(name, kwargs=kwargs), expected)
  1114. def test_invalid_reverse(self):
  1115. test_urls = [
  1116. ('lookahead-positive', {'city': 'other-city'}),
  1117. ('lookahead-negative', {'city': 'not-a-city'}),
  1118. ('lookbehind-positive', {'city': 'other-city'}),
  1119. ('lookbehind-negative', {'city': 'not-a-city'}),
  1120. ]
  1121. for name, kwargs in test_urls:
  1122. with self.subTest(name=name, kwargs=kwargs):
  1123. with self.assertRaises(NoReverseMatch):
  1124. reverse(name, kwargs=kwargs)