URL parameter type converters in Django

Introduction

URL parameter type converters help Django understand what kind of data to expect in a URL. This makes your web app handle URLs more safely and clearly.

When you want to get a number from the URL and use it in your view.

When you want to accept only certain types of text in a URL, like a slug or a UUID.

When you want to make sure the URL parameter matches a pattern before your view runs.

When you want to convert URL parts directly to Python types like int or UUID.

When you want to avoid errors by validating URL inputs automatically.

Syntax

Django

path('route/<converter:name>/', view_function, name='route_name')

The converter tells Django what type to expect (like int, str, slug, uuid, or path).

The name is the variable name your view will receive.

Examples

This expects an integer called id from the URL and passes it to the view.

Django

path('article/<int:id>/', views.article_detail, name='article_detail')

This expects a slug (letters, numbers, hyphens, underscores) called username.

Django

path('user/<slug:username>/', views.user_profile, name='user_profile')

This accepts a full path including slashes as file_path.

Django

path('files/<path:file_path>/', views.show_file, name='show_file')

This expects a UUID string as order_id.

Django

path('order/<uuid:order_id>/', views.order_detail, name='order_detail')

Sample Program

This Django URL pattern uses an int converter to get an article ID from the URL. The view shows the ID in the response.

Django

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

def show_article(request, id):
    return HttpResponse(f"Article ID is {id}")

urlpatterns = [
    path('article/<int:id>/', show_article, name='show_article'),
]

Important Notes

If the URL part does not match the converter type, Django returns a 404 error automatically.

You can create custom converters if needed by defining a class with regex, to_python(), and to_url() methods.

The str converter matches any text except slashes, so it is the default if no converter is given.

Summary

URL parameter type converters tell Django what kind of data to expect in URLs.

They help validate and convert URL parts automatically before your view runs.

Common converters include int, str, slug, uuid, and path.

Practice

1. What does the int converter do in a Django URL pattern?

easy

A. It matches any string including letters and symbols.

B. It matches only integer values and converts them to Python int type.

C. It matches UUID strings only.

D. It matches file paths including slashes.

Solution

1. Step 1: Understand the role of converters

   Converters tell Django what type of data to expect and convert URL parts accordingly.

2. Step 2: Identify the behavior of int converter

   The int converter matches only digits and converts them to Python integers.

3. Final Answer:

   It matches only integer values and converts them to Python int type. -> Option B

4. Quick Check:

   int converter = matches integers [OK]

Hint: int converter matches digits only, converts to int [OK]

Common Mistakes:

• Thinking int matches strings with letters
• Confusing int with slug or str converters
• Assuming int matches UUIDs

2. Which of the following is the correct syntax to capture a slug parameter named post_slug in a Django URL pattern?

easy

A. path('post//', views.post_detail)

B. path('post//', views.post_detail)

C. path('post//', views.post_detail)

D. path('post//', views.post_detail)

Solution

1. Step 1: Identify the correct converter for slugs

   The slug converter matches letters, numbers, underscores, and hyphens.

2. Step 2: Match syntax with converter and parameter name

   The syntax is <slug:post_slug> inside the path string.

3. Final Answer:

   path('post/<slug:post_slug>/', views.post_detail) -> Option A

4. Quick Check:

   slug converter syntax = <slug:name> [OK]

Hint: Use for slug parameters in URL patterns [OK]

Common Mistakes:

• Using int converter for slug parameters
• Mixing UUID or path converters incorrectly
• Missing colon between converter and parameter name

3. Given the URL pattern path('user//', views.profile) and the URL /user/42/, what will be the type and value of user_id in the view?

medium

A. A string '42'

B. A path string including slashes

C. A UUID object

D. An integer 42

Solution

1. Step 1: Analyze the URL pattern converter

   The int converter converts the URL part to an integer.

2. Step 2: Check the URL segment matched

   The URL segment '42' matches the int converter and becomes integer 42.

3. Final Answer:

   An integer 42 -> Option D

4. Quick Check:

   int converter converts to int type [OK]

Hint: int converter converts URL part to integer type [OK]

Common Mistakes:

• Assuming user_id is a string
• Confusing int with uuid or path converters
• Thinking the value includes slashes

4. What is wrong with this URL pattern? path('article//', views.detail) when the URL /article/abc/ is requested.

medium

A. No error, the view receives id='abc' as a string.

B. The pattern should use to accept 'abc'.

C. URL does not match because 'abc' is not an integer, causing a 404 error.

D. The view will raise a ValueError automatically.

Solution

1. Step 1: Understand the int converter behavior

   The int converter only matches digits; 'abc' is not digits.

2. Step 2: Check URL matching result

   Since 'abc' does not match int, Django returns a 404 error (no match).

3. Final Answer:

   URL does not match because 'abc' is not an integer, causing a 404 error. -> Option C

4. Quick Check:

   int converter rejects non-digit URL parts [OK]

Hint: int converter rejects non-digit URL parts, causing 404 [OK]

Common Mistakes:

• Thinking view gets string 'abc' anyway
• Expecting automatic type conversion errors in view
• Confusing 404 with server error

5. You want to capture a URL parameter that can include slashes, such as a file path, in Django. Which converter should you use and why?

hard

A. Use path converter because it matches any string including slashes.

B. Use str converter because it matches strings without slashes.

C. Use slug converter because it matches letters and hyphens.

D. Use uuid converter because it matches unique identifiers.

Solution

1. Step 1: Identify the need to match slashes in URL parameter

   Regular str converter stops at slashes, so it cannot capture paths with slashes.

2. Step 2: Choose the converter that allows slashes

   The path converter matches any string including slashes, perfect for file paths.

3. Final Answer:

   Use path converter because it matches any string including slashes. -> Option A

4. Quick Check:

   path converter = matches strings with slashes [OK]

Hint: Use path converter to capture URL parts with slashes [OK]

Common Mistakes:

• Using str converter which stops at slashes
• Confusing slug or uuid converters for paths
• Expecting int converter to match strings