はじめに
インストールとプロジェクト作成
Django は pip でインストールします。プロジェクトが設定と URL を保持し、アプリはモデルとビューを持つ再利用可能なモジュールです。
pip install django
django-admin startproject myproject
cd myproject
python manage.py startapp myapp開発サーバーの起動
自動リロード付きの組み込み開発サーバーを起動します。本番では絶対に使わないでください。
python manage.py runserver
# Default: http://127.0.0.1:8000
python manage.py runserver 8080
python manage.py runserver 0.0.0.0:8000マイグレーションとスーパーユーザー
makemigrations がモデルの変更からマイグレーションファイルを生成します。migrate が DB に適用し、createsuperuser が管理者アカウントを作成します。
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuserプロジェクト構成
manage.py が CLI ツールです。内側のパッケージがプロジェクト設定を保持し、アプリディレクトリがアプリレベルのコードを保持します。
myproject/
manage.py # CLI utility
myproject/
settings.py # Configuration
urls.py # Root URL dispatcher
wsgi.py # WSGI entry point
asgi.py # ASGI entry point
myapp/
models.py # Database models
views.py # View functions
admin.py # Admin registration設定の基本
INSTALLED_APPS が有効なアプリを列挙します。本番では DEBUG=False にし、ALLOWED_HOSTS を設定しましょう。
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'myapp',
]
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
DEBUG = True
ALLOWED_HOSTS = []モデルフィールド
モデルの定義
各モデルクラスは DB テーブルに対応します。各フィールドが 1 つの列に対応し、__str__ が表示名を定義します。
from django.db import models
class Article(models.Model):
title = models.CharField(max_length=200)
body = models.TextField()
published = models.DateTimeField(auto_now_add=True)
def __str__(self):
return self.titleよく使うフィールドタイプ
CharField には max_length が必要です。auto_now_add は作成時に設定し、auto_now は保存のたびに更新します。EmailField/URLField はバリデーションを追加します。
name = models.CharField(max_length=100)
description = models.TextField(blank=True)
price = models.DecimalField(max_digits=10, decimal_places=2)
quantity = models.IntegerField(default=0)
is_active = models.BooleanField(default=True)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
email = models.EmailField(unique=True)
url = models.URLField(blank=True)フィールドのオプション
null は DB レベル、blank はバリデーションレベルです。choices でフォームと管理画面にドロップダウンを作れます。
title = models.CharField(
max_length=200,
null=True, # DB allows NULL
blank=True, # Form allows empty
default='',
choices=[('draft', 'Draft'), ('pub', 'Published')],
help_text='Article title',
verbose_name='Article Title',
)Meta オプション
ordering がデフォルトのソート順を設定します。db_table が自動生成されたテーブル名を上書きし、constraints が DB レベルのルールを強制します。
class Meta:
ordering = ['-created_at']
db_table = 'articles'
verbose_name_plural = 'Articles'
constraints = [
models.UniqueConstraint(
fields=['title', 'author'],
name='unique_title_per_author',
)
]モデルメソッドとプロパティ
保存前のロジックには save() をオーバーライドします。@property で計算された属性を追加でき、必ず super().save() を呼びましょう。
class Article(models.Model):
title = models.CharField(max_length=200)
views = models.IntegerField(default=0)
def __str__(self):
return self.title
def save(self, *args, **kwargs):
self.title = self.title.strip()
super().save(*args, **kwargs)
@property
def is_popular(self):
return self.views > 1000モデルのリレーション
ForeignKey(多対一)
ForeignKey は多対一のリレーションを作ります。related_name で逆参照クエリが可能になります:author.books.all()。
class Author(models.Model):
name = models.CharField(max_length=100)
class Book(models.Model):
author = models.ForeignKey(
Author,
on_delete=models.CASCADE,
related_name='books',
)
title = models.CharField(max_length=200)OneToOneField
OneToOneField は一対一のリンクを作ります。user.profile や profile.user でアクセスします。
class Profile(models.Model):
user = models.OneToOneField(
User,
on_delete=models.CASCADE,
)
bio = models.TextField()ManyToManyField
ManyToManyField は中間テーブルを自動的に作ります。追加/削除は course.students.add(student) のようにします。
class Student(models.Model):
name = models.CharField(max_length=100)
class Course(models.Model):
students = models.ManyToManyField(Student, blank=True)
title = models.CharField(max_length=200)on_delete のオプション
CASCADE は親が削除されたとき子も削除します。SET_NULL には null=True が必要で、PROTECT は ProtectedError を発生させます。
# CASCADE - delete related objects
author = models.ForeignKey(Author, on_delete=models.CASCADE)
# SET_NULL - set to NULL (field must be nullable)
author = models.ForeignKey(Author, on_delete=models.SET_NULL, null=True)
# PROTECT - prevent deletion
author = models.ForeignKey(Author, on_delete=models.PROTECT)
# SET_DEFAULT - set to default value
author = models.ForeignKey(Author, on_delete=models.SET_DEFAULT, default=1)関連オブジェクトのクエリ
順方向アクセスにはフィールド名を使い、逆方向アクセスには related_name(デフォルトは modelname_set)を使います。
# Forward query
book.author.name
# Reverse query (uses related_name)
author.books.all()
author.books.filter(title__contains='Django')
# Add/remove in M2M
course.students.add(student1, student2)
course.students.remove(student1)
course.students.clear()
# Check membership
student in course.students.all()ORM QuerySet
オブジェクトの作成と保存
create() は即座に保存します。get_or_create は (object, created_bool) を返します — 取得または作成をアトミックに行います。
# Method 1: Create and save separately
article = Article(title='Hello', body='World')
article.save()
# Method 2: Create in one step
article = Article.objects.create(title='Hello', body='World')
# Method 3: get_or_create
obj, created = Article.objects.get_or_create(
title='Hello', defaults={'body': 'World'}
)単一オブジェクトの取得
get() は見つからなければ DoesNotExist、複数あれば MultipleObjectsReturned を発生させます。安全に 1 つ取るには first() を使いましょう。
# Get by primary key
article = Article.objects.get(pk=1)
# Get by field
article = Article.objects.get(title='Hello')
# First/last (returns None if empty)
first = Article.objects.first()
last = Article.objects.last()
# Latest/earliest by field
latest = Article.objects.latest('created_at')Filter と Exclude
filter() は QuerySet(遅延評価)を返します。チェーンすると AND ロジックになります。QuerySet は反復されたときにだけ評価されます。
# Filter
Article.objects.filter(title__contains='Django')
Article.objects.filter(published=True)
# Exclude
Article.objects.exclude(views__lt=100)
# Chain filters (AND)
Article.objects.filter(author=1).exclude(draft=True)フィールドルックアップ
ルックアップはダブルアンダースコアの構文を使います。よく使うもの:exact、contains、icontains、gt、gte、lt、lte、in、startswith、range。
Article.objects.filter(title__icontains='django') # case-insensitive
Article.objects.filter(views__gte=100) # >=
Article.objects.filter(views__in=[100, 200, 300]) # IN
Article.objects.filter(created_at__year=2024) # date lookup
Article.objects.filter(title__startswith='Hello') # LIKE 'Hello%'
Article.objects.filter(title__isnull=True) # IS NULLソートとスライス
スライスは DB レベルで LIMIT を適用します。QuerySet では負のインデックスはサポートされていません。
# Order by
Article.objects.order_by('-created_at') # descending
Article.objects.order_by('author', '-views')
# Slice (LIMIT/OFFSET)
Article.objects.all()[:5] # first 5
Article.objects.all()[5:10] # offset 5, limit 5
Article.objects.order_by('-views')[:3] # top 3
# Distinct
Article.objects.values('author').distinct()更新と削除
update() は一括変更に効率的です。save(update_fields=[...]) で競合状態を避けられます。delete() はデフォルトでカスケードします。
# Bulk update
Article.objects.filter(draft=True).update(draft=False)
# Single update (only save this field)
article.title = 'New Title'
article.save(update_fields=['title'])
# Delete
article.delete() # returns (count, {model: count})
Article.objects.filter(views=0).delete() # bulk deleteORM 応用
F 式
F() は DB の列の値を参照し、オブジェクトを Python にロードせずにアトミックな更新を可能にします。
from django.db.models import F
# Atomic increment (no race condition)
Article.objects.filter(pk=1).update(views=F('views') + 1)
# Compare two fields
Article.objects.filter(views__gt=F('min_views'))
# Arithmetic on fields
Article.objects.annotate(ratio=F('views') / F('likes'))複雑なクエリのための Q オブジェクト
Q オブジェクトで OR(|)、AND(&)、NOT(~)のロジックが書けます。Q なしでは、複数の filter() 呼び出しは AND のみです。
from django.db.models import Q
# OR
Article.objects.filter(Q(title__contains='Django') | Q(title__contains='Flask'))
# AND with NOT
Article.objects.filter(Q(published=True) & ~Q(views=0))
# OR + AND
Article.objects.filter(
(Q(author=1) | Q(author=2)) & Q(published=True)
)集計
aggregate() は合計の辞書を返します。annotate() はオブジェクトごとの計算値を追加します。
from django.db.models import Count, Sum, Avg, Max, Min
# Single aggregate
total = Article.objects.aggregate(total=Count('id'))
avg_views = Article.objects.aggregate(Avg('views'))
# Per-group aggregate
Author.objects.annotate(
article_count=Count('article'),
total_views=Sum('article__views'),
)Annotate
annotate() はオブジェクトごとに計算フィールドを追加します。annotate されたフィールドに対して filter() や order_by() も使えます。
from django.db.models import Count, Avg
# Add computed field to each object
authors = Author.objects.annotate(article_count=Count('book'))
# Filter on annotated field
Author.objects.annotate(
avg_rating=Avg('book__rating')
).filter(avg_rating__gte=4.0)select_related と prefetch_related
select_related は SQL JOIN を使います(順方向 FK)。prefetch_related は 2 つ目のクエリを使います(逆方向/M2M)。どちらも N+1 クエリを防ぎます。
# select_related (FK/OneToOne - single query with JOIN)
books = Book.objects.select_related('author').all()
# book.author.name -> no extra query
# prefetch_related (M2M/reverse - second query)
authors = Author.objects.prefetch_related('books').all()
# author.books.all() -> no extra query
# Deep prefetch
Author.objects.prefetch_related('books', 'books__reviews').all()関数ベースのビュー
基本の関数ビュー
ビューは HttpRequest を受け取り HttpResponse を返します。render() がテンプレートをロードし、context で埋めます。
from django.shortcuts import render
from django.http import HttpResponse
def hello(request):
return HttpResponse("Hello, World!")
def home(request):
context = {'title': 'Home', 'items': [1, 2, 3]}
return render(request, 'home.html', context)HttpRequest オブジェクト
request.GET/POST は QueryDict です(安全のため .get() を使う)。request.user は認証済みユーザーか AnonymousUser です。
def my_view(request):
method = request.method # 'GET' or 'POST'
get_data = request.GET.get('q') # query param
post_data = request.POST.get('name')
path = request.path # '/articles/1/'
user = request.user # current user
files = request.FILES # uploaded files
meta = request.META.get('HTTP_HOST')HttpResponse の種類
JsonResponse は JSON へシリアライズします。redirect() は URL パスか、引数付きの名前付き URL を受け取ります。
from django.http import HttpResponse, JsonResponse
from django.shortcuts import redirect
def json_view(request):
return JsonResponse({'status': 'ok', 'count': 42})
def redirect_view(request):
return redirect('/home/')
return redirect('article_detail', pk=1)
def csv_view(request):
response = HttpResponse(content_type='text/csv')
response['Content-Disposition'] = 'attachment; filename="data.csv"'
return responseビューのデコレータ
login_required は未認証ユーザーを LOGIN_URL へリダイレクトします。require_POST/GET が HTTP メソッドを制限します。
from django.contrib.auth.decorators import login_required
from django.views.decorators.http import require_POST, require_GET
@login_required
def dashboard(request):
return render(request, 'dashboard.html')
@require_POST
def submit(request):
pass # Only accepts POST
@require_GET
def search(request):
pass # Only accepts GETファイルアップロードのビュー
request.FILES にアップロードされたファイルが入ります。大きなファイルでは .chunks() を使い、全体をメモリへロードするのを避けましょう。
def upload_file(request):
if request.method == 'POST':
uploaded = request.FILES['file']
Document.objects.create(file=uploaded)
# Or save manually
with open(f'media/{uploaded.name}', 'wb') as f:
for chunk in uploaded.chunks():
f.write(chunk)
return redirect('success')
return render(request, 'upload.html')クラスベースのビュー
TemplateView
TemplateView は静的なテンプレートを描画します。追加の context には get_context_data() をオーバーラ イドします。
from django.views.generic import TemplateView
class AboutView(TemplateView):
template_name = 'about.html'
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['title'] = 'About Us'
return contextListView
ListView は自動でページネーションし、context に object_list と page_obj を提供します。フィルタリングには get_queryset() をオーバーライドしましょう。
from django.views.generic import ListView
class ArticleListView(ListView):
model = Article
template_name = 'article_list.html'
context_object_name = 'articles'
paginate_by = 10
def get_queryset(self):
return Article.objects.filter(published=True)DetailView
DetailView は URL から pk か slug で単一のオブジェクトを取得します。カスタムの取得には get_object() をオーバーライドします。
from django.views.generic import DetailView
class ArticleDetailView(DetailView):
model = Article
template_name = 'article_detail.html'
context_object_name = 'article'
def get_object(self):
return Article.objects.get(
slug=self.kwargs['slug'], published=True
)CreateView と UpdateView
CreateView/UpdateView はフォームの表示、バリデーション、保存を処理します。保存前のロジックには form_valid() をオーバーライドします。
from django.views.generic.edit import CreateView, UpdateView
class ArticleCreateView(CreateView):
model = Article
fields = ['title', 'body', 'author']
template_name = 'article_form.html'
success_url = '/articles/'
class ArticleUpdateView(UpdateView):
model = Article
fields = ['title', 'body']
template_name = 'article_form.html'Mixins
Mixin はクラスベースビューに再利用可能な振る舞いを加えます。Django には LoginRequiredMixin、PermissionRequiredMixin が用意されています。
from django.contrib.auth.mixins import LoginRequiredMixin
class OwnerRequiredMixin:
def get_queryset(self):
return super().get_queryset().filter(owner=self.request.user)
class ArticleListView(LoginRequiredMixin, OwnerRequiredMixin, ListView):
model = Article
paginate_by = 10URL ルーティング
基本の URL 設定
path() が URL パターンをビューへ対応させます。name= で逆 URL 参照が可能になり、<int:pk> が整数を取り込みます。
from django.urls import path
from myapp import views
urlpatterns = [
path('', views.home, name='home'),
path('about/', views.about, name='about'),
path('article/<int:pk>/', views.article_detail, name='article_detail'),
]アプリ URL の取り込み
include() は URL マッチングをアプリの urls.py に委譲します。app_name が URL 逆参照のための名前空間を作ります。
# myproject/urls.py
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('blog/', include('blog.urls')),
path('api/', include('api.urls')),
]
# blog/urls.py
app_name = 'blog'
urlpatterns = [
path('', views.list, name='list'),
path('<int:pk>/', views.detail, name='detail'),
]パスコンバーター
パスコンバーターは URL セグメントの型変換を自動化します。複雑な正規表現パターンには re_path を使いましょう。
path('article/<int:pk>/') # integer
path('article/<slug:slug>/') # slug string
path('article/<str:title>/') # non-slash string
path('user/<uuid:user_id>/') # UUID
path('file/<path:filepath>/') # any string including /
# Regex path (re_path)
from django.urls import re_path
re_path(r'^article/(?P<year>[0-9]{4})/$', views.year_archive)名前付き URL と reverse()
名前付き URL により、パスをハードコードせず名前でルートを参照できます。reverse() は Python 内で URL を生成します。
# urls.py
path('article/<int:pk>/', views.detail, name='article_detail')
# In views.py
from django.urls import reverse
url = reverse('article_detail', kwargs={'pk': 42})
# Returns '/article/42/'
# In templates
<a href="{% url 'article_detail' pk=article.pk %}">Read</a>URL 名前空間
名前空間がアプリ間の名前衝突を防ぎます。名前空間はアプリの app_name と一致させる必要があります。
# myproject/urls.py
path('blog/', include(('blog.urls', 'blog'), namespace='blog'))
# blog/urls.py
app_name = 'blog'
urlpatterns = [
path('<int:pk>/', views.detail, name='detail'),
]
# Usage
reverse('blog:detail', kwargs={'pk': 1})
# Template: {% url 'blog:detail' pk=1 %}テンプレート(DTL)
テンプレートの継承
extends でベーステンプレートを継承します。ブロックが上書き可能な領域を定義します。1 つのテンプレートが継承できる親は 1 つです。
{# base.html #}
<html>
<body>
{% block content %}{% endblock %}
{% block sidebar %}{% endblock %}
</body>
</html>
{# article.html #}
{% extends 'base.html' %}
{% block content %}
<h1>{{ article.title }}</h1>
{% endblock %}変数とタグ
{{ }} が変数を出力し、{% %} がタグを実行します。forloop.counter は 1 から、forloop.counter0 は 0 から始まります。
{# Variables #}
{{ article.title }}
{{ user.get_full_name }}
{{ article.tags.0 }}
{# Tags #}
{% if article.published %}
Published
{% elif article.draft %}
Draft
{% else %}
Archived
{% endif %}
{% for item in items %}
{{ forloop.counter }}: {{ item }}
{% empty %}
No items
{% endfor %}テンプレートフィルタ
フィルタはパイプ | の構文で変数の出力を変更します。引数を取るものはコロンの後ろに置きます。フィルタはチェーンできます。
{{ name|lower }}
{{ text|truncatewords:30 }}
{{ date|date:"Y-m-d" }}
{{ value|default:"N/A" }}
{{ list|length }}
{{ text|striptags }}
{{ price|floatformat:2 }}
{{ value|add:5 }}組み込みテンプレートタグ
csrf_token はすべての POST フォームで必須です。include がサブテンプレートを描画し、load がカスタムタグライブラリをインポートします。
{% url 'article_detail' pk=1 %}
{% csrf_token %}
{% load static %}
{% include 'header.html' %}
{% with total=items|length %}
{{ total }}
{% endwith %}
{% now "Y-m-d" %}
{% blocktrans %}Hello{% endblocktrans %}カスタムテンプレートタグ
タグは app/templatetags/ ディレクトリに置きます。関数には @register.simple_tag、値の変更には @register.filter を使います。
# templatetags/my_tags.py
from django import template
register = template.Library()
@register.simple_tag
def multiply(a, b):
return a * b
@register.filter
def cut(value, arg):
return value.replace(arg, '')
# In template:
{% load my_tags %}
{% multiply 3 4 %}
{{ "hello world"|cut:" " }}フォーム
フォームの定義
forms.Form で独立したフォームを作れます。各フィールドは HTML ウィジェットを自動生成し、フィールドタイプがバリデーションを提供します。
from django import forms
class ContactForm(forms.Form):
name = forms.CharField(max_length=100)
email = forms.EmailField()
message = forms.CharField(widget=forms.Textarea)
subject = forms.ChoiceField(
choices=[('general', 'General'), ('bug', 'Bug Report')],
)ModelForm
ModelForm はモデルからフォームを自動生成します。fields/exclude がどのフィールドを出すか制御し、widgets が HTML をカスタマイズします。
class ArticleForm(forms.ModelForm):
class Meta:
model = Article
fields = ['title', 'body', 'author']
# Or: fields = '__all__'
# Or: exclude = ['created_at']
widgets = {
'body': forms.Textarea(attrs={'rows': 10}),
}
labels = {'title': 'Article Title'}フォームバリデーション
clean_<field>() は単一のフィールドを検証し、clean() はフォーム全体を検証します。失敗したら ValidationError を発生させましょう。
class SignupForm(forms.Form):
username = forms.CharField(max_length=50)
password = forms.CharField(widget=forms.PasswordInput)
def clean_username(self):
username = self.cleaned_data['username']
if User.objects.filter(username=username).exists():
raise forms.ValidationError("Username taken.")
return username
def clean(self):
cleaned = super().clean()
# Cross-field validation
return cleanedテンプレートへのフォーム描画
as_p/as_table/as_ul がすべてのフィールドを自動描画します。カスタムレイアウトにはフィールドを個別に描画します。POST には csrf_token が必須です。
<form method="post">
{% csrf_token %}
{{ form.as_p }}
{{ form.as_table }}
{{ form.as_ul }}
{# Manual rendering #}
{{ form.title.label_tag }}
{{ form.title }}
{{ form.title.errors }}
<button type="submit">Submit</button>
</form>ビューでのフォーム処理
request.POST を渡すとフォームが束縛されます。is_valid() がバリデーションを実行し、save(commit=False) は未保存のオブジェクトを返します。
def article_create(request):
if request.method == 'POST':
form = ArticleForm(request.POST)
if form.is_valid():
article = form.save(commit=False)
article.author = request.user
article.save()
form.save_m2m()
return redirect('article_detail', pk=article.pk)
else:
form = ArticleForm()
return render(request, 'form.html', {'form': form})フォームのウィジェット
widgets が HTML 描画を制御します。CSS クラス、プレースホルダー、HTML5 の入力タイプには attrs の辞書を渡しましょう。
class UploadForm(forms.Form):
title = forms.CharField(
widget=forms.TextInput(attrs={'class': 'form-control'})
)
file = forms.FileField(widget=forms.ClearableFileInput)
date = forms.DateField(widget=forms.DateInput(attrs={'type': 'date'}))
tags = forms.MultipleChoiceField(
choices=TAG_CHOICES,
widget=forms.CheckboxSelectMultiple,
)管理サイト
管理画面へのモデル登録
@admin.register が admin.site.register より推奨です。モデルは管理インターフェースに現れるよう登録する必要があります。
from django.contrib import admin
from .models import Article
# Simple registration
admin.site.register(Article)
# With custom ModelAdmin
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
list_display = ('title', 'author', 'published')ModelAdmin のカスタマイズ
list_display が一覧ビューの列を表示し、list_filter がサイドバーのフィルタを追加し、search_fields が検索ボックスを有効にします。
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
list_display = ('title', 'author', 'status')
list_filter = ('status', 'author', 'created_at')
search_fields = ('title', 'body')
ordering = ('-created_at',)
list_editable = ('status',)
list_per_page = 25
date_hierarchy = 'created_at'
readonly_fields = ('views', 'created_at')インライン管理
Inline は親と同じページで関連モデルを編集します。extra=1 でデフォルトの空行を 1 つ表示します。
class ReviewInline(admin.TabularInline):
model = Review
extra = 1
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
inlines = [ReviewInline]
# TabularInline: compact table format
# StackedInline: full form fields stackedカスタム管理アクション
アクションは一覧ページのドロップダウンに現れます。request と queryset を受け取り、message_user がフラッシュメッセージを表示します。
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
actions = ['publish_selected']
@admin.action(description='Publish selected')
def publish_selected(self, request, queryset):
updated = queryset.update(published=True)
self.message_user(request, f'{updated} articles published.')管理サイトの設定
ブランディングには site_header/site_title をオーバーライドしましょう。複数の管理サイトにはカスタム AdminSite インスタンスを作ります。
admin.site.site_header = 'My Site Admin'
admin.site.site_title = 'Admin Portal'
admin.site.index_title = 'Dashboard'
# Custom admin site
from django.contrib.admin import AdminSite
my_site = AdminSite(name='myadmin')
my_site.register(Article, ArticleAdmin)
# urls.py
path('myadmin/', my_site.urls)認証
組み込み User モデル
Django の User モデルには username、password(ハッシュ化)、email、first_name、last_name、権限フラグがあります。
from django.contrib.auth.models import User
user = User.objects.get(username='admin')
user.is_staff # can access admin
user.is_superuser # has all permissions
user.is_active # account enabled
user.set_password('newpass') # hash password
user.save()
user.check_password('secret') # returns True/Falseログインとログアウト
authenticate() が認証情報を検証します(User か None を返す)。login() がセッションを作り、logout() が消去します。
from django.contrib.auth import authenticate, login, logout
def login_view(request):
user = authenticate(request, username='admin', password='pass')
if user is not None:
login(request, user)
return redirect('dashboard')
return render(request, 'login.html')
def logout_view(request):
logout(request)
return redirect('home')ユーザー登録
UserCreationForm が組み込みのバリデーション付きで、username、パスワード、パスワード確認を処理します。
from django.contrib.auth.forms import UserCreationForm
def register(request):
if request.method == 'POST':
form = UserCreationForm(request.POST)
if form.is_valid():
user = form.save()
login(request, user) # auto-login after register
return redirect('home')
else:
form = UserCreationForm()
return render(request, 'register.html', {'form': form})Login Required デコレータ
login_required は LOGIN_URL(デフォルト /accounts/login/)へリダイレクトします。CBV では LoginRequiredMixin を使いましょう。
from django.contrib.auth.decorators import login_required
@login_required
def profile(request):
return render(request, 'profile.html')
@login_required(login_url='/custom-login/')
def settings(request):
return render(request, 'settings.html')
# Class-based view mixin
from django.contrib.auth.mixins import LoginRequiredMixin
class DashboardView(LoginRequiredMixin, ListView):
login_url = '/login/'
model = Articleパスワード管理
update_session_auth_hash でパスワード変更後のログアウトを防げます。パスワードバリデーターがサイト全体でルールを強制します。
from django.contrib.auth import update_session_auth_hash
# Change password
user.set_password('newpass123')
user.save()
update_session_auth_hash(request, user) # keep user logged in
# Using form
from django.contrib.auth.forms import PasswordChangeForm
form = PasswordChangeForm(user, request.POST)
if form.is_valid():
form.save()カスタム User モデル
AbstractUser を継承してフィールドを追加します。AUTH_USER_MODEL は早い段階で設定しましょう — 後から変えるのは困難です。
from django.contrib.auth.models import AbstractUser
class CustomUser(AbstractUser):
bio = models.TextField(blank=True)
avatar = models.ImageField(upload_to='avatars/', blank=True)
phone = models.CharField(max_length=20, blank=True)
# settings.py
AUTH_USER_MODEL = 'myapp.CustomUser'
# Admin
from django.contrib.auth.admin import UserAdmin
@admin.register(CustomUser)
class CustomUserAdmin(UserAdmin):
passミドルウェア
組み込みミドルウェア
順序が重要です!最初に SecurityMiddleware、次にセッション、次に auth。CSRF のチェックはビュー処理の前に実行されます。
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]カスタム関数ミドルウェア
関数ミドルウェアは新式のファクトリパターンを使います。get_response が次のミドルウェアかビューを呼びます。
def simple_middleware(get_response):
def middleware(request):
# Code before view (request phase)
response = get_response(request)
# Code after view (response phase)
return response
return middleware
# Example: timing middleware
import time
def timing_middleware(get_response):
def middleware(request):
start = time.time()
response = get_response(request)
response['X-Duration'] = str(time.time() - start)
return response
return middlewareクラスベースのミドルウェア
__init__ は起動時に 1 回、__call__ はリクエストごとに実行されます。process_view はビューをバイパスするレスポンスを返せます。
class MyMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
# Request phase (before view)
response = self.get_response(request)
# Response phase (after view)
return response
def process_view(self, request, view_func, args, kwargs):
return None # or HttpResponse to short-circuitミドルウェアの順序とフロー
リクエストは上から下へミドルウェアを通り、レスポンスは下から上へ泡のように上がります。セキュリティミドルウ ェアは最初に置きましょう。
# Request phase: top to bottom
# Response phase: bottom to top
MIDDLEWARE = [
'A', # req: 1st -> resp: last
'B', # req: 2nd -> resp: 2nd
'C', # req: 3rd -> resp: 1st
]
# Request flows: A -> B -> C -> view
# Response flows: view -> C -> B -> Aミドルウェアのユースケース
ミドルウェアは短絡できます(早い段階で HttpResponse を返す)か、ビューで使うため request にデータを付加できます。
# IP restriction
class IPBlockMiddleware:
BLOCKED_IPS = ['192.168.1.100']
def __call__(self, request):
if request.META['REMOTE_ADDR'] in self.BLOCKED_IPS:
return HttpResponseForbidden('Blocked')
return self.get_response(request)
# Add context to request
class UserPrefMiddleware:
def __call__(self, request):
request.is_mobile = 'Mobile' in request.META.get('HTTP_USER_AGENT', '')
return self.get_response(request)静的ファイルとメディアファイル
静的ファイルの設定
STATIC_URL が URL の接頭辞です。STATICFILES_DIRS がソースの場所(開発用)で、STATIC_ROOT が本番の収集先です。
# settings.py
STATIC_URL = '/static/'
STATICFILES_DIRS = [BASE_DIR / 'static'] # dev location
STATIC_ROOT = BASE_DIR / 'staticfiles' # collectstatic output
# Project structure:
# static/
# css/style.css
# js/app.js
# img/logo.png開発での静的ファイル提供
Django が静的ファイルを自動提供するのは DEBUG=True のときだけです。本番では Web サーバー(nginx)か WhiteNoise を使いましょう。
# urls.py (dev only)
from django.conf import settings
from django.conf.urls.static import static
urlpatterns = [
path('admin/', admin.site.urls),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
# Only active when DEBUG=Trueテンプレートでの静的ファイル使用
{% load static %} が必要です。{% static %} は、ManifestStaticFilesStorage を使った本番ではハッシュ化されたファイル名に解決されます。
{% load static %}
<link rel="stylesheet" href="{% static 'css/style.css' %}">
<img src="{% static 'img/logo.png' %}" alt="Logo">
<script src="{% static 'js/app.js' %}"></script>
{# Dynamic static path #}
{% get_static_prefix as STATIC_URL %}
<img src="{{ STATIC_URL }}img/{{ theme }}.png">メディアファイルの設定
MEDIA_ROOT がファイルシステムのパスで、MEDIA_URL が URL 接頭辞です 。upload_to はパス文字列か呼び出し可能オブジェクトにできます。
# settings.py
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'
# urls.py (dev)
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
# Model with file upload
class Document(models.Model):
file = models.FileField(upload_to='documents/')
image = models.ImageField(upload_to='images/')
# Access
doc.file.url # '/media/documents/file.pdf'
doc.file.path # '/full/path/to/file.pdf'collectstatic コマンド
デプロイ前に collectstatic を実行しましょう。WhiteNoise があれば、nginx なしで Django 自身が本番の静的ファイルを提供できます。
# Collect all static files into STATIC_ROOT
python manage.py collectstatic
# With clearing
python manage.py collectstatic --clear
# Production with WhiteNoise
# pip install whitenoise
MIDDLEWARE = [..., 'whitenoise.middleware.WhiteNoiseMiddleware', ...]
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'シグナル
組み込みシグナル
シグナルにより、分離されたアプリがアクションに反応できます。post_save は save() の完了後に発火し、pre_save はその前に発火します。
from django.db.models.signals import (
post_save, pre_save, post_delete, pre_delete,
m2m_changed,
)
from django.contrib.auth.signals import (
user_logged_in, user_logged_out,
)
# Common signals:
# pre_save / post_save - before/after model save
# pre_delete / post_delete - before/after model delete
# m2m_changed - M2M relationship changes
# user_logged_in / user_logged_outシグナルレシーバーの接続
@receiver が関数をシグナルへ接続します。sender で特定のモデルに限定でき、created は新しいオブジェクトのときだけ True です。
from django.db.models.signals import post_save
from django.dispatch import receiver
@receiver(post_save, sender=User)
def create_profile(sender, instance, created, **kwargs):
if created:
Profile.objects.create(user=instance)
@receiver(post_save, sender=User)
def save_profile(sender, instance, **kwargs):
instance.profile.save()シグナルの切断
disconnect() はテストやカスケードするアクションを止めたいときに有用です。receiver と sender の両方を必ず指定しましょう。
from django.db.models.signals import post_save
# Disconnect
post_save.disconnect(
receiver=create_profile,
sender=User,
)
# Temporarily disconnect in tests
post_save.disconnect(handler, sender=Article)
# ... do stuff without signal ...
post_save.connect(handler, sender=Article)カスタムシグナル
シグナルはモジュールレベルで定義します。send() がすべてのレシーバーへ通知し、kwargs が接続されたすべてのレシーバーへ渡されます。
from django.dispatch import Signal, receiver
# Define a custom signal
order_created = Signal()
# Send the signal
order_created.send(
sender=Order,
order=order_instance,
user=request.user,
)
# Receive
@receiver(order_created, sender=Order)
def send_notification(sender, order, user, **kwargs):
pass # Send email notificationシグナルのユースケースと注意点
シグナルハンドラは起動時に確実に接続されるよう、AppConfig.ready() でインポートしましょう。遅い操作は避けます — 非同期処理には Celery を。
# Good: Profile auto-creation
@receiver(post_save, sender=User)
def ensure_profile(sender, instance, created, **kwargs):
if created:
Profile.objects.get_or_create(user=instance)
# Register in AppConfig.ready()
# apps.py
class MyAppConfig(AppConfig):
name = 'myapp'
def ready(self):
from . import signals # noqaキャッシュ
キャッシュの設定
本番には Redis が推奨です。LocMemCache はプロセスローカルです(ワーカー間で共有できません)。
# settings.py - Memcached
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.PyMemcacheCache',
'LOCATION': '127.0.0.1:11211',
}
}
# Redis
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.redis.RedisCache',
'LOCATION': 'redis://127.0.0.1:6379',
}
}
# Local memory (dev)
CACHES = {
'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}
}低レベルキャッシュ API
cache.get() は存在しないキーに対して None を返します。存在しない場合だけ設定するアトミックな操作には get_or_set を使います。
from django.core.cache import cache
# Set
cache.set('key', 'value', timeout=300) # 5 minutes
cache.set_many({'a': 1, 'b': 2}, timeout=60)
# Get
value = cache.get('key') # None if missing
value = cache.get('key', 'default') # with default
data = cache.get_many(['a', 'b']) # dict
# Delete
cache.delete('key')
cache.clear() # delete all
# get_or_set (atomic)
value = cache.get_or_set('key', 'value', 300)テンプレートキャッシュ
{% cache %} は描画済みの HTML 断片を保存します。誤ったキャッシュ内容を避けるため、変動する引数(ユーザー ID、ページ)を加えましょう。
{% load cache %}
{# Cache block for 500 seconds #}
{% cache 500 sidebar %}
<div class="sidebar">
{{ expensive_data }}
</div>
{% endcache %}
{# Cache with varying key #}
{% cache 500 user_sidebar request.user.id %}
Welcome, {{ request.user.username }}
{% endcache %}ビューごとのキャッシュ
cache_page は HttpResponse 全体をキャッシュします。キャッシュキーは URL を含むため、URL ごとに個別のキャッシュエントリができます。
from django.views.decorators.cache import cache_page
@cache_page(60 * 15)
def article_list(request):
return render(request, 'list.html', {'articles': Article.objects.all()})
# With cache key prefix
@cache_page(60 * 15, key_prefix='articles')
def article_detail(request, pk):
...
# Class-based view
from django.utils.decorators import method_decorator
class ArticleListView(ListView):
@method_decorator(cache_page(60 * 15))
def dispatch(self, *args, **kwargs):
return super().dispatch(*args, **kwargs)キャッシュの戦略
vary_on_headers はヘッダー値ごとに個別のキャッシュエントリを作ります。API では Accept-Language や Authorization で vary させましょう。
# Per-view cache with Vary headers
from django.views.decorators.vary import vary_on_headers
@cache_page(60 * 15)
@vary_on_headers('User-Agent')
def api_data(request):
...
# Model-level caching
def get_articles():
articles = cache.get('all_articles')
if articles is None:
articles = list(Article.objects.all())
cache.set('all_articles', articles, 300)
return articlesテスト
テストの作成
TestCase はテ ストを DB トランザクション(ロールバック)で包みます。SimpleTestCase は DB アクセスなしのテスト用(より高速)です。
from django.test import TestCase, SimpleTestCase
from .models import Article
class ArticleModelTest(TestCase):
def setUp(self):
self.article = Article.objects.create(
title='Test', body='Content'
)
def test_str(self):
self.assertEqual(str(self.article), 'Test')
def test_field_default(self):
self.assertEqual(self.article.views, 0)
# SimpleTestCase: no DB access
class MathTest(SimpleTestCase):
def test_addition(self):
self.assertEqual(1 + 1, 2)Test Client でのテスト
self.client はサーバーを起動せずに HTTP リクエストをシミュレートします。.login() が後続のリクエストのために認証します。
class ViewTest(TestCase):
def setUp(self):
self.user = User.objects.create_user('test', '[email protected]', 'pass')
def test_login(self):
response = self.client.post('/login/', {
'username': 'test', 'password': 'pass'
})
self.assertEqual(response.status_code, 302)
def test_protected_view(self):
self.client.login(username='test', password='pass')
response = self.client.get('/dashboard/')
self.assertEqual(response.status_code, 200)モデルと QuerySet のテスト
テストデータは setUp() で作成され、各テストの後でロールバックされます。結果の検証には .count() とインデックスを使いましょう。
class ArticleQuerySetTest(TestCase):
def setUp(self):
Article.objects.create(title='A', views=100, published=True)
Article.objects.create(title='B', views=50, published=False)
def test_published_filter(self):
published = Article.objects.filter(published=True)
self.assertEqual(published.count(), 1)
def test_ordering(self):
articles = Article.objects.order_by('-views')
self.assertEqual(articles[0].title, 'A')URL とフォームのテスト
reverse() が名前から URL を組み立て、resolve() が URL がどのビューに対応するか確認します。フォームのテストには data= の辞書を渡します。
from django.urls import reverse, resolve
class URLTest(TestCase):
def test_article_list_url(self):
url = reverse('article_list')
response = self.client.get(url)
self.assertEqual(response.status_code, 200)
def test_resolve(self):
url = reverse('article_detail', kwargs={'pk': 1})
self.assertEqual(resolve(url).func, views.article_detail)
class FormTest(TestCase):
def test_valid_form(self):
form = ArticleForm(data={'title': 'Hi', 'body': '...'})
self.assertTrue(form.is_valid())Fixtures とテストコマンド
Fixture は JSON ファイルからテストデータを読み込みます。特定のテストはアプリ、クラス、メソッドのパスで実行できます。
# Create fixture
python manage.py dumpdata myapp.Article --indent=2 > fixtures/articles.json
# Use in test
class FixtureTest(TestCase):
fixtures = ['articles.json']
def test_data_loaded(self):
self.assertEqual(Article.objects.count(), 10)
# Run tests
python manage.py test
python manage.py test myapp
python manage.py test myapp.tests.ArticleModelTestDjango REST Framework
DRF のインストールと設定
INSTALLED_APPS に rest_framework を加えます。デフォルトの認証/権限は REST_FRAMEWORK 設定の辞書で構成します。
pip install djangorestframework
# settings.py
INSTALLED_APPS = [..., 'rest_framework', 'rest_framework.authtoken']
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
],
}Serializer
ModelSerializer はモデルからフィールドを自動生成します。関連オブジェクトからの取得には source= を使い、バリデーションの追加には validate_<field>() を。
from rest_framework import serializers
class ArticleSerializer(serializers.ModelSerializer):
author_name = serializers.CharField(source='author.username', read_only=True)
class Meta:
model = Article
fields = ['id', 'title', 'body', 'author', 'author_name']
read_only_fields = ['id', 'author_name']
def validate_title(self, value):
if len(value) < 5:
raise serializers.ValidationError("Title too short.")
return valueViewSet
ModelViewSet は CRUD(list、create、retrieve、update、destroy)を提供します。フィルタリングには get_queryset() をオーバーライドします。
from rest_framework import viewsets, permissions
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
permission_classes = [permissions.IsAuthenticatedOrReadOnly]
def get_queryset(self):
qs = super().get_queryset()
author = self.request.query_params.get('author')
if author:
qs = qs.filter(author__username=author)
return qs
def perform_create(self, serializer):
serializer.save(author=self.request.user)Router
DefaultRouter が URL パターンと API ルートビューを自動生成します。queryset が動的な場合、URL 名には basename が使われます。
from rest_framework.routers import DefaultRouter
from .views import ArticleViewSet
router = DefaultRouter()
router.register(r'articles', ArticleViewSet, basename='article')
# router.register(r'users', UserViewSet)
# urls.py
urlpatterns = [
path('api/', include(router.urls)),
]
# Generates: /api/articles/, /api/articles/{id}/認証
トークン認証は単一の静的トークンを使います。JWT はアクセス + リフレッシュトークンを発行し、SimpleJWT が最も人気のある JWT ライブラリです。
# Token Authentication
from rest_framework.authtoken.views import obtain_auth_token
urlpatterns = [
path('api/token/', obtain_auth_token),
]
# JWT Authentication (pip install djangorestframework-simplejwt)
from rest_framework_simplejwt.views import (
TokenObtainPairView, TokenRefreshView,
)
urlpatterns = [
path('api/token/', TokenObtainPairView.as_view()),
path('api/token/refresh/', TokenRefreshView.as_view()),
]権限
SAFE_METHODS は GET/HEAD/OPTIONS です。has_object_permission がオブジェクトごとのアクセスを確認し、get_permissions() がアクションごとのルールを可能にします。
from rest_framework import permissions
class IsOwnerOrReadOnly(permissions.BasePermission):
def has_object_permission(self, request, view, obj):
if request.method in permissions.SAFE_METHODS:
return True # GET, HEAD, OPTIONS
return obj.author == request.user
# Built-in: IsAuthenticated, IsAdminUser,
# IsAuthenticatedOrReadOnly, AllowAny
# Per-action
class ArticleViewSet(viewsets.ModelViewSet):
permission_classes = [IsOwnerOrReadOnly]
def get_permissions(self):
if self.action == 'create':
return [permissions.IsAuthenticated()]
return super().get_permissions()デプロイとセキュリティ
本番設定
SECRET_KEY をバージョン管理にコミットしてはいけません。環境変数を使いましょう。DEBUG=False がエラーページからの情報漏洩を防ぎます。
# settings.py
DEBUG = False
ALLOWED_HOSTS = ['example.com', 'www.example.com']
SECRET_KEY = os.environ['SECRET_KEY']
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'mydb',
'USER': os.environ['DB_USER'],
'PASSWORD': os.environ['DB_PASS'],
'HOST': 'localhost',
'PORT': '5432',
}
}本番での静的ファイル
collectstatic がすべての静的ファイルを STATIC_ROOT へ集めます。WhiteNoise が gzip 化されハッシュ化されたファイルを Django 自身から提供します。
# Collect static files
python manage.py collectstatic --noinput
# WhiteNoise for serving static
MIDDLEWARE = [..., 'whitenoise.middleware.WhiteNoiseMiddleware', ...]
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
# Or with nginx:
# location /static/ { alias /path/to/staticfiles/; }セキュリティ設定
SSL_REDIRECT が HTTPS を強制します。HSTS はブラウザに常に HTTPS を使わせ、X_FRAME_OPTIONS がクリックジャッキングを防ぎます。
# settings.py
SECURE_SSL_REDIRECT = True
SESSION_COOKIE_SECURE = True
CSRF_COOKIE_SECURE = True
SECURE_HSTS_SECONDS = 31536000
SECURE_HSTS_INCLUDE_SUBDOMAINS = True
SECURE_HSTS_PRELOAD = True
SECURE_CONTENT_TYPE_NOSNIFF = True
X_FRAME_OPTIONS = 'DENY'
CSRF_TRUSTED_ORIGINS = ['https://example.com']WSGI/ASGI デプロイ
Gunicorn は同期式です(従来の Django)。Uvicorn は ASGI に対応します(非同期ビュー、WebSockets)。プロセスマネージャーを使いましょう。
# Gunicorn (WSGI)
# pip install gunicorn
gunicorn myproject.wsgi:application --bind 0.0.0.0:8000 --workers 3
# Uvicorn (ASGI, for async/websockets)
# pip install uvicorn
uvicorn myproject.asgi:application --host 0.0.0.0 --port 8000 --workers 4
# Supervisor config
[program:django]
command=gunicorn myproject.wsgi:application
directory=/app
autostart=true
autorestart=true本番チェックリスト
check --deploy が Django のデプロイチェックリストを実行します。不足しているセキュリティ設定や本番準備の問題を指摘してくれます。
# Run security check
python manage.py check --deploy
# Key items:
# - DEBUG = False
# - ALLOWED_HOSTS set
# - SECRET_KEY from env
# - HTTPS enabled (SECURE_SSL_REDIRECT)
# - HSTS configured
# - collectstatic run
# - Database (PostgreSQL/MySQL)
# - Caching (Redis/Memcached)
# - Error monitoring (Sentry)関連する Django スニペット
Copy-paste ready code for common tasks.
Model Definition
Define a Django model with field types and meta options.
ORM QuerySet
Filter, exclude, annotate and chain QuerySets.
Class-Based Views
Use generic class-based views for common CRUD flows.
URL Routing
Wire URLs to views with path converters and includes.
ModelForms
Build forms from models with validation and widgets.
Template Tags
Use built-in tags and filters in Django templates.
Admin Customization
Customize the Django admin with list_display and actions.
Authentication
Login, logout, and protect views with auth decorators.
Was this helpful?