URL namespacing in Django - Step-by-Step Execution

Concept Flow - URL namespacing

Define app URLs with app_name

↓

Include app URLs in project URLs with namespace

↓

Use {% url 'namespace:name' %} in templates or reverse() in views

↓

Django resolves URL by looking up namespace and name

↓

Correct URL returned or error if not found

This flow shows how Django uses URL namespacing to organize URLs by app and resolve them correctly.

Execution Sample

Django

app_name = 'blog'
urlpatterns = [path('post/', views.post, name='post')]

# In project urls.py
path('blog/', include(('blog.urls', 'blog'), namespace='blog'))

# In template
{% url 'blog:post' %}

Defines a URL named 'post' in the 'blog' app and uses the 'blog' namespace to refer to it.

Execution Table

Step	Action	Input	Result	Notes
1	Define app_name in blog.urls	app_name = 'blog'	App URLs tagged with 'blog' namespace	Sets namespace for included URLs
2	Define URL pattern	path('post/', views.post, name='post')	URL named 'post' under 'blog' namespace	Name used for reverse lookup
3	Include app URLs in project	include(('blog.urls', 'blog'), namespace='blog')	Project URLs include blog URLs under 'blog' namespace	Namespace links app URLs to project
4	Use {% url 'blog:post' %} in template	Request URL for 'blog:post'	Django finds 'post' in 'blog' namespace	Correct URL '/blog/post/' returned
5	Use reverse('blog:post') in view	Reverse lookup for 'blog:post'	Returns '/blog/post/'	Same as template URL resolution
6	Use wrong namespace or name	e.g. 'shop:post'	NoReverseMatch error	Namespace or name must match exactly

💡 Execution stops after URL is resolved or error raised if namespace/name not found

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	Final
app_name	undefined	'blog'	'blog'	'blog'	'blog'	'blog'
urlpatterns	empty	[path('post/', views.post, name='post')]	[same]	[included in project URLs]	[same]	[same]
namespace	undefined	undefined	undefined	'blog'	'blog'	'blog'
URL resolved	undefined	undefined	undefined	undefined	'/blog/post/'	'/blog/post/'

Key Moments - 3 Insights

Why do we need to set app_name in the app's urls.py?

Setting app_name defines the namespace for that app's URLs. Without it, Django cannot link the included URLs to the namespace used in the project URLs (see execution_table step 1).

What happens if the namespace in include() does not match app_name?

Django will not find the URL when using the namespace:name pattern and will raise a NoReverseMatch error (see execution_table step 6). The namespace in include() must match app_name.

How does Django resolve {% url 'blog:post' %}?

Django looks up the 'blog' namespace, then finds the URL named 'post' inside it, returning the correct URL path (see execution_table step 4).

Visual Quiz - 3 Questions

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

A NoReverseMatch error

B '/blog/post/'

C '/post/'

D undefined

💡 Hint

Check the 'URL resolved' variable in variable_tracker after step 4

At which step does Django raise an error if the namespace or name is wrong?

A Step 2

B Step 4

C Step 6

D Step 1

💡 Hint

See execution_table row describing error on wrong namespace or name

If app_name is missing in blog.urls, what will happen when using {% url 'blog:post' %}?

A NoReverseMatch error occurs

B URL resolves correctly

C URL resolves but without namespace

D Django ignores the namespace

💡 Hint

Refer to key_moments about importance of app_name and execution_table step 1

Concept Snapshot

URL namespacing in Django:
- Define app_name in app's urls.py
- Use include() with namespace in project urls.py
- Refer URLs as 'namespace:name' in templates and views
- Ensures URL names are unique across apps
- Missing or mismatched namespaces cause errors

Full Transcript

URL namespacing in Django helps organize URLs by app. First, you set app_name in the app's urls.py file. This tags all URLs in that file with a namespace. Then, in the project urls.py, you include the app's URLs using include() and specify the same namespace. When you want to link to a URL, you use the pattern 'namespace:name' in templates or reverse() in views. Django looks up the namespace and then the URL name to find the correct path. If the namespace or name is wrong or missing, Django raises a NoReverseMatch error. This system keeps URLs organized and avoids conflicts between apps.