Template configuration and directories in Django

Introduction

Templates help you create the HTML pages your website shows. Configuring templates tells Django where to find these HTML files.

When you want to separate your website design (HTML) from your Python code.

When you need to organize your HTML files in folders for easy management.

When you want to reuse the same layout for many pages.

When you want Django to automatically find your HTML templates.

When you add new apps and want their templates to be found.

Syntax

Django

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

DIRS is a list of folders where Django looks for templates outside apps.

APP_DIRS=True tells Django to look inside each app's templates folder automatically.

Examples

Django will only look inside app folders for templates.

Django

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],  # No extra folders
        'APP_DIRS': True,
        'OPTIONS': {},
    },
]

Django looks only in the custom_templates folder, not inside apps.

Django

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'custom_templates'],
        'APP_DIRS': False,
        'OPTIONS': {},
    },
]

Django looks in multiple folders and inside apps for templates.

Django

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates', BASE_DIR / 'extra_templates'],
        'APP_DIRS': True,
        'OPTIONS': {},
    },
]

Sample Program

This example shows how to set up the template folders and print them out. It uses BASE_DIR to find the main project folder and adds a templates folder there. It also enables looking inside app folders.

Django

from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent.parent

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

print("Template directories:")
for d in TEMPLATES[0]['DIRS']:
    print(d)
print("App directories enabled:", TEMPLATES[0]['APP_DIRS'])

Important Notes

Always create a templates folder in your project root or inside each app for Django to find your HTML files.

If APP_DIRS is True, Django looks inside each app's templates folder automatically.

You can add many folders in DIRS if you want to organize templates in different places.

Summary

Templates are HTML files that Django uses to show pages.

Configure TEMPLATES in settings.py to tell Django where to find these files.

Use DIRS for custom folders and APP_DIRS=True to find templates inside apps.

Practice

1. What is the purpose of the TEMPLATES['DIRS'] setting in Django?

easy

A. To specify additional directories where Django looks for templates outside apps

B. To list all installed apps in the project

C. To enable debugging mode for templates

D. To define the default template engine

Solution

1. Step 1: Understand the role of TEMPLATES['DIRS']

   This setting tells Django where to find templates that are not inside app folders.

2. Step 2: Differentiate from other settings

   Other options like installed apps or debugging are unrelated to template directories.

3. Final Answer:

   To specify additional directories where Django looks for templates outside apps -> Option A

4. Quick Check:

   Template directories = TEMPLATES['DIRS'] [OK]

Hint: Remember: DIRS means extra folders for templates [OK]

Common Mistakes:

• Confusing DIRS with installed apps list
• Thinking DIRS enables debugging
• Assuming DIRS defines the template engine

2. Which of the following is the correct way to enable Django to automatically find templates inside app folders?

easy

A. Set APP_DIRS=False in the TEMPLATES setting

B. Add app template paths manually to TEMPLATES['DIRS']

C. Set APP_DIRS=True in the TEMPLATES setting

D. Include app names in INSTALLED_APPS only

Solution

1. Step 1: Identify the setting for automatic app template discovery

   Setting APP_DIRS=True tells Django to look inside each app's templates folder automatically.

2. Step 2: Understand why other options are incorrect

   Setting APP_DIRS=False disables this feature; manually adding paths is not automatic; installed apps list alone doesn't find templates.

3. Final Answer:

   Set APP_DIRS=True in the TEMPLATES setting -> Option C

4. Quick Check:

   Automatic app templates = APP_DIRS=True [OK]

Hint: APP_DIRS=True means auto-find app templates [OK]

Common Mistakes:

• Setting APP_DIRS to False expecting auto-discovery
• Adding app templates manually instead of using APP_DIRS
• Confusing INSTALLED_APPS with template directories

3. Given this settings.py snippet:

 TEMPLATES = [{
    'BACKEND': 'django.template.backends.django.DjangoTemplates',
    'DIRS': ['templates'],
    'APP_DIRS': True,
    'OPTIONS': {},
}]

Where will Django look for templates when rendering?

medium

A. Only in the 'templates' folder at project root

B. Only inside each app's 'templates' folder

C. Nowhere, because 'DIRS' must be empty to work

D. Both in the 'templates' folder and inside each app's 'templates' folder

Solution

1. Step 1: Analyze the DIRS setting

   The 'DIRS' list includes 'templates', so Django looks there first.

2. Step 2: Analyze the APP_DIRS setting

   Since APP_DIRS=True, Django also searches inside each app's 'templates' folder.

3. Final Answer:

   Both in the 'templates' folder and inside each app's 'templates' folder -> Option D

4. Quick Check:

   DIRS + APP_DIRS = both locations searched [OK]

Hint: DIRS + APP_DIRS=True means search both places [OK]

Common Mistakes:

• Thinking DIRS disables app templates
• Assuming APP_DIRS=True ignores DIRS
• Believing DIRS must be empty for app templates

4. You set APP_DIRS=False but your templates inside app folders are not found. What is the best fix?

medium

A. Add app template paths manually to TEMPLATES['DIRS']

B. Set APP_DIRS=True to enable automatic app template loading

C. Remove the 'DIRS' setting completely

D. Restart the Django server without changing settings

Solution

1. Step 1: Understand the effect of APP_DIRS=False

   With APP_DIRS=False, Django does not look inside app template folders automatically.

2. Step 2: Choose the fix to enable automatic app template discovery

   Setting APP_DIRS=True tells Django to find templates inside app folders without manual paths.

3. Final Answer:

   Set APP_DIRS=True to enable automatic app template loading -> Option B

4. Quick Check:

   APP_DIRS=True fixes app template loading [OK]

Hint: APP_DIRS=True enables automatic app template search [OK]

Common Mistakes:

• Forgetting to set APP_DIRS=True
• Only restarting server without config change
• Removing DIRS thinking it fixes app templates

5. You want to organize templates so that some are shared across the project and others are app-specific. How should you configure TEMPLATES to achieve this?

hard

A. Set APP_DIRS=True and add the shared templates folder path to DIRS

B. Set APP_DIRS=False and put all templates in one shared folder listed in DIRS

C. Put all templates inside app folders and leave DIRS empty

D. Disable APP_DIRS and duplicate shared templates inside each app

Solution

1. Step 1: Enable automatic app template loading

   Setting APP_DIRS=True allows Django to find templates inside each app's templates folder.

2. Step 2: Add shared templates folder to DIRS

   Adding the shared folder path to DIRS lets Django find templates used across the whole project.

3. Final Answer:

   Set APP_DIRS=True and add the shared templates folder path to DIRS -> Option A

4. Quick Check:

   APP_DIRS + DIRS for shared + app templates [OK]

Hint: Use APP_DIRS=True plus shared folder in DIRS [OK]

Common Mistakes:

• Disabling APP_DIRS and expecting app templates found
• Duplicating shared templates inside apps
• Leaving DIRS empty and missing shared templates