Supposed my views.py contain multiple views that are meant to go deeper in the url path.
urlpatterns = [
path('<int:table_pk>/order/', views.menu_category_view, name='menu_category_view'),
path('<str:menu_category>/', views.menu_item_view, name='menu_item_view'),
]
The first view has the path generated as <int:table_pk>/order/.
If I want the second view to have a path as following <int:table_pk>/order/<str:menu_category>/, how should i go about passing the variables (in the view and/or template) in DRY manner?
What if I have more path levels that need to extend the path above it in this same manner?
You can work with an include(…) clause [Django-doc]:
from django.urls import include
urlpatterns = [
path('<int:table_pk>/order/', include([
path('', views.menu_category_view, name='menu_category_view'),
path('<str:menu_category>/', views.menu_item_view, name='menu_item_view'),
]))
]
The path(…) before the include(…) is thus common for both path(…)s in the list wrapped in the include(…).
You can thus construct a hierarchy by using includes where a path(…) can be wrapped in an include(…) of another path(…), etc.
Related
I've Created a view
urlpatterns = [
path('book/<suffix>/', views.bookview, name='bookDetail')`
]
what i want
if someone hits url '127.0.0.1:8000/book/1/2/3/4/5/6/'
i do not want django to raise an error of The current path, book/1/2/3/4/5/6/, didn’t match any of these.
but instead it shows the same view of url book/<suffix>/ which is view.bookview.
and somehow pass, suffix after book/ which is 1/2/3/4/5/6/ as arg so that i can access it in my view.
from django.urls import re_path
urlpatterns = [
re_path(r'^book/(?P<suffix>[\w/]+)$', views.bookview, name='bookDetail')
]
As there can be special characters in the suffix parameter, you need to encode the string. In python you can do it like this
from urllib.parse import quote_plus
suffix = quote_plus('/1/2/3/4/5/6/')
My url patterns look like this:
urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include('api.urls')),
re_path('.*', IndexView.as_view()),
]
This works but it matches all URLs, including those prefixed with admin and api. I want those URLs to still match, and for any unmatched URLs to render IndexView.
Before 2.0 I used this regex for this purpose. I tried using it in re_path but that didn't work, which is what led me to trying the above.
url(r'^(?P<path>.*)/$', HtmlView.as_view())
Use case is a SPA where I handle 404s client side.
Many thanks in advance.
You can use two entries (one for '/', another one for anything else), but using path for both of them, which should be (slightly) more efficient:
urlpatterns = [
path('', IndexView.as_view(), {'resource': ''}),
path('<path:resource>', IndexView.as_view())
]
In this case, I'm using <path:resource> because path catches all resource names, inluding that with / in them. But it does not capture the main index resource, /. That's why the first entry. The dictionary as last argument for it is because we need to provide a resource parameter if we want to use the same view than in the second entry.
That view, of course, should have 'resource' as a paremeter:
def as_view(request, resource):
...
So as I said in the question description, trying the regex I was using before Django 2.0 in re_path did not work. It would basically match for all requests except / (i.e., index path). I fixed this by using both that regex and a second path matching / specifically. Here's the code:
urlpatterns = [
re_path(r'^(?P<path>.*)/$', IndexView.as_view()),
path('', IndexView.as_view()),
]
With these changes my other routes would match and these two routes would account for all other urls.
One Idea to go about this is let the django catch 404.
url.py
from django.conf.urls import handler404
handler404 = 'app_name.views.bad_request'
and in your views.py
views.py
def bad_request(request):
return redirect(reverse('home'))
You can always do some regex thingy to catch unmatched urls. but hey this gets the job done. :)
In Django 1, I used to have the following URL mappings:
...
url(r'^main/', include('main.urls', namespace='main')),
url(r'.*', include('main.urls'))
The r'.*' mapping is always at the last line to take care of all kinds of URLs not mapped.
In Django 2, the following mappings are used instead:
path('main/', include('main.urls', namespace='main')),
re_path('.*', include('main.urls')),
Although it also works, yet Django complains:
?: (urls.W005) URL namespace 'main' isn't unique. You may not be able to reverse all URLs in this namespace
Giving the second mapping another namespace is not working. Any solutions?
try writing a view to redirect to main/ and then include the view in your urls:
re_path('.*', views.redirect_view)
In that case you can use django.views.generic.base.RedirectView to simply redirect to the said url without importing it twice.
urlpatterns = [
path('main', include('main.urls')),
re_path('.*', RedirectView.as_view(url='main/your_default_url_in_main_url'), name='main'),
]
Try to remove the trailing slash of 'main/' and change to 'main'.
Note: If your main.urls looks like this
urlpatterns = [
path('/whatever1', view1),
path('/whatever2', view2),
]
You have to pick where to redirect the default view by supplying RedirectView.as_view(url='main/whatever1') to redirect to view1 as default. use 'main/whatever2' to redirect to view2 as default
reference: RedirectView
I noticed that in Django there are two formats of urlpatterns in file urls.py:
urlpatterns = [
url(...),
url(...),
]
and
urlpatterns = pattern('',
url(...),
url(...),
)
The first is a list of url instances, and the second invokes the pattern module with an empty string and a number of url instances as parameters.
What is the difference between the two?
What is the purpose of an empty string in the second format?
Which one is recommended to use?
In Django 1.8+, urlpatterns should simply be a list of url()s. This new syntax actually works in 1.7 as well.
urlpatterns = [
url(...),
url(...),
]
The old syntax using pattern is deprecated in Django 1.8, and is removed in Django 1.10.
urlpatterns = pattern('',
url(...),
url(...),
)
With the old syntax, you could provide a prefix. The example given in the docs is
urlpatterns = patterns('news.views',
url(r'^articles/([0-9]{4})/$', 'year_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/$', 'month_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', 'article_detail'),
)
However, using strings arguments for the view is now deprecated as well, and you should provide the callable instead.
Per the documentation, patterns is:
A function that takes a prefix, and an arbitrary number of URL
patterns, and returns a list of URL patterns in the format Django
needs.
The first argument to patterns() is a string prefix.
It also provides an example of why you might want to use it:
from django.conf.urls import patterns, url
urlpatterns = patterns('',
url(r'^articles/([0-9]{4})/$', 'news.views.year_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/$', 'news.views.month_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', 'news.views.article_detail'),
)
In this example, each view has a common prefix – 'news.views'.
Instead of typing that out for each entry in urlpatterns, you can
use the first argument to the patterns() function to specify a
prefix to apply to each view function.
With this in mind, the above example can be written more concisely as:
from django.conf.urls import patterns, url
urlpatterns = patterns('news.views',
url(r'^articles/([0-9]{4})/$', 'year_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/$', 'month_archive'),
url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', 'article_detail'),
)
However, note that this function is deprecated:
Deprecated since version 1.8:
urlpatterns should be a plain list of django.conf.urls.url() instances instead.
Note that the explanation as to why includes (with good reason, clearly!):
Thus patterns() serves little purpose and is a burden when teaching
new users (answering the newbie’s question "why do I need this empty
string as the first argument to patterns()?").
If I do that:
urlpatterns += patterns('datasets.views',
url(r'^$', 'home', name="home"),
url(r'^(?P<slug>\w+)/', include(patterns('',#HERE I OMIT THE PREFIX
url(r'^edit/', 'edit_api', name="edit_api"),
))),
)
I will get a ``TypeError at /my-slug-name/ 'str' object is not callable
But If I include the prefix a second time, It's working.
urlpatterns += patterns('datasets.views',
url(r'^$', 'home', name="home"),
url(r'^(?P<slug>\w+)/', include(patterns('datasets.views', #HERE THE PREFIX IS REPEATED
url(r'^edit/', 'edit_api', name="edit_api"),
))),
)
Do I misunderstand how include works ? Should I report this as a bug ?
It's not how include() works, but how patterns works. Without the prefix, edit_api is just a string to pattern, it cannot resolve it to a view. Providing prefix to the first pattern doesn't make it implicitly include in the nested one. The way you are using patterns is a bit ugly. You need to consider each patterns() individually. The prefix is there to make your url configs clean, Consider this -
api_patterns = patterns('datasets.views',
url(r'^edit/', 'edit_api', name="edit_api"),
# --------------^ Here edit_api is actually datasets.views.edit_api
# if you don't want to provide the prefix, you write the full path to the view
# url(r'^edit/', 'datasets.views.edit_api', name="edit_api"),
)
urlpatterns += patterns('datasets.views',
url(r'^$', 'home', name="home"),
url(r'^(?P<slug>\w+)/', include(api_patterns)),
# ------------------------------^
# Here include doesn't use the pattern prefix you used 3 lines above
)
The reason is, include is designed to include patterns from various places like apps etc. And each of them might have individual pattern prefix. So to keep things simple, you either provide a pattern prefix and write relative view names or you omit pattern prefix and write complete view path.