Including app URLs in Django - Step-by-Step Execution

Concept Flow - Including app URLs

Start: Project urls.py

↓

Import include()

↓

Define urlpatterns

↓

Use path() with include('app.urls')

↓

Request to app URL

↓

Django routes to app.urls

↓

App urls.py handles request

↓

Return response

The main project urls.py file includes app-specific urls.py files using include(), so requests to app URLs are routed to the app's URL patterns.

Execution Sample

Django

from django.urls import path, include

urlpatterns = [
    path('blog/', include('blog.urls')),
]

This code includes the URL patterns from the 'blog' app under the 'blog/' path prefix.

Execution Table

Step	Action	Code Line	Result
1	Start project urls.py	from django.urls import path, include	include() function imported
2	Define urlpatterns list	urlpatterns = [path('blog/', include('blog.urls'))]	urlpatterns contains path with include
3	Incoming request to /blog/post/1	Request URL: /blog/post/1	Matches 'blog/' prefix
4	Django calls include('blog.urls')	include('blog.urls')	Loads blog/urls.py patterns
5	blog.urls.py matches 'post/1'	path('post/<int:id>/', views.post_detail)	Matched view: post_detail with id=1
6	View returns response	views.post_detail(request, id=1)	Response sent to client

💡 Request handled by blog app urls.py after matching 'blog/' prefix and app URL patterns

Variable Tracker

Variable	Start	After Step 2	After Step 4	After Step 5	Final
urlpatterns	[]	[path('blog/', include('blog.urls'))]	[path('blog/', include('blog.urls'))]	[path('blog/', include('blog.urls'))]	[path('blog/', include('blog.urls'))]
request_path	''	''	'post/1'	'post/1'	'post/1'
matched_view	None	None	None	post_detail	post_detail

Key Moments - 2 Insights

Why does Django look inside blog.urls after matching 'blog/' in the project urls.py?

Because the path uses include('blog.urls'), Django delegates routing to the blog app's urls.py for any URL starting with 'blog/'. This is shown in execution_table step 4.

What happens if the request URL does not start with 'blog/'?

Django will not use the blog.urls patterns and will continue checking other urlpatterns in the project urls.py or return 404 if no match is found. This is implied by the matching in step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'request_path' after step 4?

A '/blog/post/1'

B ''

C 'post/1'

D None

💡 Hint

Check variable_tracker row for 'request_path' after step 4

At which step does Django load the app's urls.py patterns?

A Step 3

B Step 4

C Step 2

D Step 5

💡 Hint

Look at execution_table action descriptions for when include('blog.urls') is called

If the project urls.py did not include path('blog/', include('blog.urls')), what would happen to a request to '/blog/post/1'?

A Django would return a 404 error

B It would be routed to blog.urls anyway

C It would match another app automatically

D The request would be redirected to '/'

💡 Hint

Consider what happens if no matching path is found in urlpatterns

Concept Snapshot

Including app URLs in Django:
- Use include() in project urls.py to add app urls
- Syntax: path('prefix/', include('app.urls'))
- Requests matching prefix go to app.urls
- App urls.py defines detailed routes
- Keeps project urls.py clean and modular

Full Transcript

In Django, the main project urls.py file includes URL patterns from apps using the include() function. This means when a request URL starts with a prefix like 'blog/', Django passes routing to the blog app's urls.py. The app urls.py then matches the rest of the URL and calls the appropriate view. This modular approach helps organize URLs clearly. The execution trace shows importing include(), defining urlpatterns with include(), matching a request URL, delegating to app urls.py, and finally returning a response from the matched view.

Practice

1. What is the main purpose of including app URLs in a Django project?

easy

A. To speed up the server response time

B. To connect the database with the views

C. To automatically generate HTML templates

D. To organize URL patterns by app for better project structure

Solution

1. Step 1: Understand URL organization in Django

   Including app URLs helps keep URL patterns separated by app, making the project easier to manage.

2. Step 2: Identify the main benefit

   This separation improves project structure and maintainability, not server speed or template generation.

3. Final Answer:

   To organize URL patterns by app for better project structure -> Option D

4. Quick Check:

   URL organization = To organize URL patterns by app for better project structure [OK]

Hint: Including app URLs organizes routes by app for clarity [OK]

Common Mistakes:

• Thinking it improves server speed
• Confusing URL inclusion with template creation
• Assuming it connects database automatically

2. Which of the following is the correct syntax to include app URLs under the prefix 'blog/' in the main urls.py?

easy

A. include('blog.urls', path='blog/')

B. path('blog/', include('blog.urls'))

C. path('blog/', url('blog.urls'))

D. include(path('blog/'), 'blog.urls')

Solution

1. Step 1: Recall Django URL inclusion syntax

   The correct way is to use path('prefix/', include('app.urls')).

2. Step 2: Match syntax with options

   path('blog/', include('blog.urls')) matches the correct syntax exactly; others misuse include or path functions.

3. Final Answer:

   path('blog/', include('blog.urls')) -> Option B

4. Quick Check:

   Correct include syntax = path('blog/', include('blog.urls')) [OK]

Hint: Use path('prefix/', include('app.urls')) format [OK]

Common Mistakes:

• Swapping order of path and include
• Using url() instead of include()
• Passing path as argument to include

3. Given the main urls.py includes path('shop/', include('shop.urls')) and the app shop/urls.py has path('items/', views.items_list), what URL path will call items_list view?

medium

A. /shop/items/

B. /items/

C. /shop/

D. /shop/items_list/

Solution

1. Step 1: Combine main and app URL prefixes

   Main URL adds 'shop/' prefix, app URL adds 'items/' path.

2. Step 2: Form full URL path

   Joining them gives '/shop/items/' which calls the items_list view.

3. Final Answer:

   /shop/items/ -> Option A

4. Quick Check:

   Combined URL = /shop/items/ [OK]

Hint: Combine main prefix + app path for full URL [OK]

Common Mistakes:

• Using only app path ignoring main prefix
• Confusing view name with URL path
• Adding extra slashes or missing trailing slash

4. What is wrong with this main urls.py snippet?

from django.urls import path
urlpatterns = [
    path('blog/', 'blog.urls'),
]

medium

A. Missing include() function around 'blog.urls'

B. Should import url instead of path

C. The string 'blog.urls' should be a list

D. The path prefix 'blog/' is invalid

Solution

1. Step 1: Check how to include app URLs

   App URLs must be included using include('app.urls'), not just a string.

2. Step 2: Identify missing include()

   The code uses a string directly without include(), causing an error.

3. Final Answer:

   Missing include() function around 'blog.urls' -> Option A

4. Quick Check:

   Include required for app URLs = Missing include() function around 'blog.urls' [OK]

Hint: Always wrap app URLs with include() [OK]

Common Mistakes:

• Passing string directly without include()
• Confusing path and url imports
• Thinking prefix 'blog/' is invalid

5. You want to include two apps, 'store' and 'accounts', in your project URLs under prefixes 'shop/' and 'user/' respectively. Which is the correct way to do this in the main urls.py?

hard

A. path('shop/', 'store.urls')\npath('user/', 'accounts.urls')

B. include('store.urls', prefix='shop/')\ninclude('accounts.urls', prefix='user/')

C. path('shop/', include('store.urls'))\npath('user/', include('accounts.urls'))

D. path('store/', include('shop.urls'))\npath('accounts/', include('user.urls'))

Solution

1. Step 1: Use path() with include() for each app

   Each app URL must be included with path('prefix/', include('app.urls')).

2. Step 2: Match prefixes and app names correctly

   path('shop/', include('store.urls'))\npath('user/', include('accounts.urls')) correctly uses 'shop/' for 'store.urls' and 'user/' for 'accounts.urls'. Others misuse include or swap names.

3. Final Answer:

   path('shop/', include('store.urls')) path('user/', include('accounts.urls')) -> Option C

4. Quick Check:

   Correct multiple app inclusion = path('shop/', include('store.urls'))\npath('user/', include('accounts.urls')) [OK]

Hint: Use path('prefix/', include('app.urls')) for each app [OK]

Common Mistakes:

• Swapping prefixes and app names
• Using include() without path()
• Passing strings without include()