Including App-Level URLs
Splitting URLs Per App
Instead of listing every route for every app in one root urls.py, each app defines its own urls.py, and the project's root urls.py uses include() to delegate a URL prefix to it.
Example: Splitting URLs Per App
Instead of listing every route for every app in one root urls.py, each app defines its own urls.py, and the project's root urls.py uses include() to delegate a URL prefix to it.
# myproject/urls.py
from django.urls import path, include
urlpatterns = [
path('blog/', include('blog.urls')),
]The App's Own urls.py
Inside the app, urls.py defines urlpatterns exactly like a root URLconf, except its paths are relative to the prefix used in the include() call above.
Example: The App's Own urls.py
Inside the app, urls.py defines urlpatterns exactly like a root URLconf, except its paths are relative to the prefix used in the include() call above.
# blog/urls.py
from django.urls import path
from . import views
urlpatterns = [
path('', views.post_list, name='post_list'),
path('<int:pk>/', views.post_detail, name='post_detail'),
]Namespacing with app_name
Setting app_name in the app's urls.py lets you reference its routes unambiguously elsewhere, e.g. reverse('blog:post_detail'), even if another app also has a URL named post_detail.
Example: Namespacing with app_name
Setting app_name in the app's urls.py lets you reference its routes unambiguously elsewhere, e.g. reverse('blog:post_detail'), even if another app also has a URL named post_detail.
# blog/urls.py
app_name = 'blog'
urlpatterns = [
path('<int:pk>/', views.post_detail, name='post_detail'),
]- Forgetting to give each app's urls.py an app_name when using namespaced reverse() lookups.
- Including an app's urls.py without a trailing prefix slash, producing unexpected concatenated paths.
- Duplicating the same route prefix in both the root urls.py and the app's urls.py.
- include() lets the root URLconf delegate an entire URL prefix to an app's own urls.py.
- Each app keeps its routes self-contained, which keeps the project URLconf short and organized.
- app_name plus a namespace in include() enables namespaced {% url %} lookups like 'blog:post_detail'.
Chapter Quiz — Complete all 10 topics to unlock
0/10 topics done
Complete these topics first: