urlpatterns list structure in Django

Introduction

The urlpatterns list tells Django which web pages to show for different website addresses. It connects web addresses to the code that shows the page.

When you want to make a new page on your website.

When you want to connect a web address to a specific function or page.

When you want to organize your website's pages in a clear way.

When you want to add links to other apps inside your Django project.

When you want to handle errors or special pages like login or logout.

Syntax

Django

from django.urls import path

urlpatterns = [
    path('url-pattern/', view_function, name='url_name'),
    path('another-url/', AnotherView.as_view(), name='another_name'),
]

The urlpatterns is a Python list that holds all the URL patterns.

Each path() connects a URL pattern to a view function or class.

Examples

This example shows the home page URL pattern with an empty string for the root URL.

Django

from django.urls import path
from . import views

urlpatterns = [
    path('', views.home, name='home'),  # Home page
]

This example uses a dynamic URL with an integer parameter id to show different articles.

Django

from django.urls import path
from .views import ArticleDetailView

urlpatterns = [
    path('article/<int:id>/', ArticleDetailView.as_view(), name='article_detail'),
]

An empty urlpatterns list means no pages are connected yet.

Django

from django.urls import path
from . import views

urlpatterns = []  # Empty list means no URLs are defined yet

This example shows how to include URL patterns from another app called 'blog'.

Django

from django.urls import path, include

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

Sample Program

This complete example shows a simple URL pattern that connects the root URL to a function that returns a greeting.

Django

from django.urls import path
from django.http import HttpResponse

# Simple view function

def hello_world(request):
    return HttpResponse('Hello, world!')

urlpatterns = [
    path('', hello_world, name='home'),
]

# To test this, run Django server and visit http://localhost:8000/ to see 'Hello, world!'

Important Notes

The urlpatterns list is checked in order from top to bottom to find a matching URL.

Time complexity is generally fast because Django uses efficient matching behind the scenes.

Common mistake: forgetting to import the view or misspelling the URL pattern.

Use include() to keep URLs organized when your project grows.

Summary

urlpatterns is a list that connects website addresses to code that shows pages.

Use path() to add each URL pattern with a view function or class.

Keep your URLs organized by including other URL lists from apps.

Practice

1. What is the main purpose of the urlpatterns list in a Django project?

easy

A. To store user data in the database

B. To connect website addresses (URLs) to the code that shows pages

C. To define the style of the website pages

D. To manage user login and authentication

Solution

1. Step 1: Understand the role of urlpatterns

   The urlpatterns list holds URL patterns that link URLs to views (code that shows pages).

2. Step 2: Compare with other options

   Storing user data uses models, defining styles uses templates/CSS, and managing authentication uses Django's auth system -- none of these are handled by urlpatterns.

3. Final Answer:

   To connect website addresses (URLs) to the code that shows pages -> Option B

4. Quick Check:

   urlpatterns connects URLs to views [OK]

Hint: Remember: urlpatterns links URLs to views [OK]

Common Mistakes:

• Thinking urlpatterns stores data
• Confusing urlpatterns with styling or authentication

2. Which of the following is the correct way to add a URL pattern to the urlpatterns list?

easy

A. link('home/', views.home_view)

B. url('home/', views.home_view)

C. path('home/', views.home_view)

D. route('home/', views.home_view)

Solution

1. Step 1: Identify the correct function for URL patterns

   Django uses path() to define URL patterns in urlpatterns.

2. Step 2: Check other options

   url() was used in older Django versions but is deprecated; route() and link() are not Django functions.

3. Final Answer:

   path('home/', views.home_view) -> Option C

4. Quick Check:

   Use path() for URL patterns [OK]

Hint: Use path() to add URLs in urlpatterns [OK]

Common Mistakes:

• Using deprecated url() instead of path()
• Trying non-existent functions like route() or link()

3. Given this urlpatterns list, what URL will show the about_view page?

from django.urls import path
from . import views

urlpatterns = [
    path('about/', views.about_view),
    path('contact/', views.contact_view),
]

medium

A. /contact/

B. /about-us/

C. /home/

D. /about/

Solution

1. Step 1: Read the urlpatterns entries

   The list has path('about/', views.about_view) which means the URL /about/ shows about_view.

2. Step 2: Match URLs to views

   /contact/ shows contact_view, others like /home/ or /about-us/ are not defined.

3. Final Answer:

   /about/ -> Option D

4. Quick Check:

   path('about/', views.about_view) means URL is /about/ [OK]

Hint: Match the string in path() to the URL [OK]

Common Mistakes:

• Confusing URL strings with view names
• Assuming URL ends without trailing slash

4. Identify the error in this urlpatterns list:

from django.urls import path
from . import views

urlpatterns = [
    path('home/', views.home_view),
    path('about/', views.about_view
]

medium

A. Missing closing parenthesis in second path()

B. Using views instead of view functions

C. Incorrect import statement

D. urlpatterns should be a dictionary, not a list

Solution

1. Step 1: Check syntax of each path() call

   The second path('about/', views.about_view is missing a closing parenthesis.

2. Step 2: Verify other parts

   Imports and list structure are correct; views is correctly used to reference functions.

3. Final Answer:

   Missing closing parenthesis in second path() -> Option A

4. Quick Check:

   Every path() needs matching parentheses [OK]

Hint: Count parentheses in each path() call [OK]

Common Mistakes:

• Forgetting closing parenthesis
• Thinking urlpatterns is a dictionary

5. You want to include URL patterns from an app called blog inside your main urlpatterns. Which is the correct way to do this?

hard

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

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

C. include('blog.urls')

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

Solution

1. Step 1: Understand how to include app URLs

   Use include() inside path() to add app URL patterns under a prefix.

2. Step 2: Check other options

   include('blog.urls') misses the path() wrapper; path('blog/', blog.urls) misses include(); path('blog/', 'blog.urls') passes a string instead of include().

3. Final Answer:

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

4. Quick Check:

   Use include() inside path() for app URLs [OK]

Hint: Use include() inside path() to add app URLs [OK]

Common Mistakes:

• Forgetting to use include()
• Passing string directly without include()
• Not wrapping include() inside path()