Django models チートシート

from django.db import models

class Article(models.Model):
    title = models.CharField(max_length=200, verbose_name="記事タイトル")
    content = models.TextField(verbose_name="記事内容", help_text="ここに記事の内容を入力します。")
    published_date = models.DateTimeField(auto_now_add=True, verbose_name="公開日")
    updated_date = models.DateTimeField(auto_now=True, verbose_name="更新日")
    is_public = models.BooleanField(default=True, verbose_name="公開フラグ")

    def __str__(self):
        return self.title

# 例
Product.objects.filter(name__icontains='app') # 名前に 'app' (大文字小文字問わず) を含む
Product.objects.filter(added_date__year=2024) # 2024年に追加された
Product.objects.filter(stock__in=[10, 20, 30]) # 在庫が10, 20, 30 のいずれか
Product.objects.filter(price__range=(1.00, 2.00)) # 価格が1.00から2.00の間

# Post モデル (author は User への ForeignKey, category は Category への ForeignKey)
# 'admin' というユーザー名の著者が書いた投稿
Post.objects.filter(author__username='admin')

# 'News' という名前のカテゴリに属する投稿
Post.objects.filter(category__name='News')

# 'admin' というユーザー名の著者が書いた 'News' カテゴリの投稿
Post.objects.filter(author__username='admin', category__name='News')

# Entry モデル (tags は Tag への ManyToManyField)
# 'python' という名前のタグを持つエントリー
Entry.objects.filter(tags__name='python')

# 'python' または 'django' という名前のタグを持つエントリー
Entry.objects.filter(tags__name__in=['python', 'django']).distinct() # distinct() で重複を除く

# 逆参照 (User モデルから Post を絞り込む)
# 2024年以降に公開された投稿を持つユーザー
from django.contrib.auth.models import User
User.objects.filter(posts__published_date__year__gte=2024).distinct() # related_name='posts' を使用

from django.db.models import Q

# 名前が 'A' で始まる または 価格が 1.00 未満の商品
Product.objects.filter(Q(name__startswith='A') | Q(price__lt=1.00))

# 名前が 'A' で始まり かつ 価格が 1.00 未満の商品 (通常の filter と同じ)
Product.objects.filter(Q(name__startswith='A') & Q(price__lt=1.00))
# または
Product.objects.filter(name__startswith='A', price__lt=1.00)

# 名前が 'Apple' ではない商品
Product.objects.filter(~Q(name='Apple'))
# または
Product.objects.exclude(name='Apple')

# 複雑な組み合わせ: (名前が 'A' で始まる AND 在庫が 100 以上) OR (価格が 5.00 以上)
Product.objects.filter(
    (Q(name__startswith='A') & Q(stock__gte=100)) | Q(price__gte=5.00)
)

from django.db.models import Avg, Max, Min, Sum, Count, StdDev, Variance

# 全商品の平均価格、最高価格、最低価格
aggregation_result = Product.objects.aggregate(
    avg_price=Avg('price'),
    max_price=Max('price'),
    min_price=Min('price')
)
print(aggregation_result) # {'avg_price': Decimal('...'), 'max_price': Decimal('...'), 'min_price': Decimal('...')}

# 商品の総数
total_products = Product.objects.aggregate(total=Count('id')) # または Count('*')
print(total_products) # {'total': ...}

# 在庫の合計
total_stock = Product.objects.aggregate(total_stock=Sum('stock'))
print(total_stock) # {'total_stock': ...}

# 価格の標準偏差と分散
price_stats = Product.objects.aggregate(price_stddev=StdDev('price'), price_variance=Variance('price'))
print(price_stats)

from django.db.models import Count, Avg

# 各カテゴリに属する投稿の数をアノテーションとして追加
categories = Category.objects.annotate(num_posts=Count('posts')) # related_name='posts'
for category in categories:
    print(f"{category.name}: {category.num_posts}")

# 各著者ごとの投稿の平均文字数 (TextFieldはAvgできないので注意、例として示す)
# User.objects.annotate(avg_post_length=Avg('posts__content_length_field')) # posts__ は User から Post への逆参照

# 各商品に、自分より価格が高い商品の数をアノテーション (サブクエリ使用例)
from django.db.models import OuterRef, Subquery, IntegerField
higher_priced_count_subquery = Product.objects.filter(price__gt=OuterRef('price')).values('id')
products_with_rank = Product.objects.annotate(
    num_more_expensive=Count(Subquery(higher_priced_count_subquery))
).order_by('-num_more_expensive')

for p in products_with_rank:
    print(f"{p.name}: {p.num_more_expensive} items are more expensive")

# F() オブジェクトと組み合わせる
# 各商品の価格に10%の税を加えた 'price_with_tax' をアノテーション
from django.db.models import F, DecimalField
from django.db.models.functions import Cast

products_with_tax = Product.objects.annotate(
    price_with_tax=Cast(F('price') * 1.1, output_field=DecimalField(max_digits=10, decimal_places=2))
)
for p in products_with_tax:
    print(f"{p.name}: Price={p.price}, Price with Tax={p.price_with_tax}")

# 順序付け (ordering)
products_by_name = Product.objects.order_by('name') # 名前昇順
products_by_price_desc = Product.objects.order_by('-price') # 価格降順
products_by_name_then_price = Product.objects.order_by('name', '-price') # 名前昇順、同じ名前なら価格降順

# スライシング (LIMIT と OFFSET)
first_five_products = Product.objects.all()[:5] # 最初の5件
products_from_6_to_10 = Product.objects.all()[5:10] # 6件目から10件目 (0ベース)

# 順序付けとスライシングの組み合わせ (よく使うパターン)
top_5_expensive_products = Product.objects.order_by('-price')[:5]

注意: order_by() なしでのスライシングは、データベースによっては順序が保証されない場合があります。

# 商品名と価格だけを辞書のリストとして取得
product_data = Product.objects.values('name', 'price')
# [{'name': 'Apple', 'price': Decimal('1.60')}, {'name': 'Banana', 'price': Decimal('0.80')}, ...]

# 商品名だけをタプルのリストとして取得
product_names_tuple = Product.objects.values_list('name')
# [('Apple',), ('Banana',), ...]

# flat=True で単一フィールドの値を直接リストで取得
product_names_list = Product.objects.values_list('name', flat=True)
# ['Apple', 'Banana', ...]

# アノテーションと組み合わせる
category_post_counts = Category.objects.annotate(num_posts=Count('posts')).values('name', 'num_posts')
# [{'name': 'News', 'num_posts': 15}, {'name': 'Tech', 'num_posts': 22}, ...]

# N+1 問題の例 (ループ内で関連オブジェクトにアクセスするたびにクエリが発生)
posts = Post.objects.all()
for post in posts:
    print(post.title, post.author.username) # post ごとに User を取得するクエリが走る
    print(post.category.name)              # post ごとに Category を取得するクエリが走る

# select_related(): ForeignKey, OneToOneField (単一オブジェクト) を JOIN して取得
posts_optimized = Post.objects.select_related('author', 'category').all()
for post in posts_optimized:
    print(post.title, post.author.username) # JOIN済みなので追加クエリ不要
    print(post.category.name)              # JOIN済みなので追加クエリ不要

# prefetch_related(): ManyToManyField, 逆参照 ForeignKey/OneToOneField (複数オブジェクト) を別クエリでまとめて取得
entries = Entry.objects.prefetch_related('tags').all()
for entry in entries:
    print(entry.headline)
    # entry.tags.all() を実行しても、事前に取得したデータを使うため追加クエリ不要
    print([tag.name for tag in entry.tags.all()])

# ネストした関連も取得可能
users = User.objects.prefetch_related('posts__category').all() # User -> Posts -> Category
for user in users:
    print(user.username)
    for post in user.posts.all(): # posts は prefetch 済み
        print(f"  - {post.title} (Category: {post.category.name})") # category も prefetch 済み

select_related は SQL JOIN を使用。prefetch_related は Python 側で結合を行うための追加クエリ（通常は IN 句を使用）を発行。

# defer(): 指定したフィールドを遅延読み込み (アクセス時に追加クエリが発生)
# 大量のテキストデータなど、すぐには不要なフィールドを除外する
products = Product.objects.defer('description', 'specifications')
for p in products:
    print(p.name) # description や specifications へのアクセスがない限り、それらは読み込まれない
    # print(p.description) # ここで description を取得するための追加クエリが発生

# only(): 指定したフィールドのみを即時読み込み (他のフィールドは遅延読み込み)
products = Product.objects.only('name', 'price')
for p in products:
    print(p.name, p.price) # name と price は読み込み済み
    # print(p.stock) # ここで stock を取得するための追加クエリが発生

select_related と併用する場合、関連オブジェクトのフィールドも defer/only の対象に含めることができます (例: only('name', 'author__username'))。

# Manager.raw(): モデルインスタンスを返す生のSQLクエリ
raw_products = Product.objects.raw('SELECT * FROM product_catalog WHERE price > %s', [1.00])
for p in raw_products:
    print(p.name, p.price)

# connection.cursor(): DB API (DB-API 2.0) を直接使用 (モデルを経由しない)
from django.db import connection

with connection.cursor() as cursor:
    cursor.execute("UPDATE product_catalog SET stock = %s WHERE name = %s", [50, 'Apple'])
    cursor.execute("SELECT COUNT(*) FROM product_catalog")
    row = cursor.fetchone()
    product_count = row[0]

print(f"Total products: {product_count}")

注意: 生のSQLはデータベースの種類に依存する可能性があり、SQLインジェクションのリスクがあるため、パラメータは必ずプレースホルダ (%s) を使用してください。

import datetime
from django.db import models
from django.utils import timezone

class Poll(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

    def __str__(self):
        return self.question_text

    def was_published_recently(self):
        """
        最近 (1日以内) に公開されたかどうかを返す
        """
        now = timezone.now()
        return now - datetime.timedelta(days=1) <= self.pub_date <= now

    # 管理サイトでの表示をカスタマイズするための属性
    was_published_recently.admin_order_field = 'pub_date' # ソート可能にする
    was_published_recently.boolean = True                 # アイコン表示にする
    was_published_recently.short_description = 'Published recently?' # 列ヘッダー

    def publish(self):
        """
        投票を公開状態にする (例: publish_dateを設定)
        """
        if self.pub_date is None:
            self.pub_date = timezone.now()
            self.save(update_fields=['pub_date'])

# 利用例
poll = Poll.objects.get(pk=1)
if poll.was_published_recently():
    print(f"'{poll.question_text}' は最近公開されました。")

# 投票を公開
poll.publish()

class BlogPost(models.Model):
    title = models.CharField(max_length=200)
    slug = models.SlugField(max_length=200, unique=True, blank=True)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    def save(self, *args, **kwargs):
        if not self.slug:
            # slug が空の場合、タイトルから自動生成する (例)
            from django.utils.text import slugify
            self.slug = slugify(self.title)[:200] # 200文字に制限

            # スラグが一意であることを確認 (簡易的な例)
            original_slug = self.slug
            counter = 1
            while BlogPost.objects.filter(slug=self.slug).exclude(pk=self.pk).exists():
                self.slug = f"{original_slug}-{counter}"
                counter += 1

        # 親クラスの save() を呼び出して実際の保存処理を行う
        super().save(*args, **kwargs)

    def __str__(self):
        return self.title

注意: save() をオーバーライドする際は、必ず super().save(*args, **kwargs) を呼び出すようにしてください。また、update() や bulk_create() などの QuerySet メソッドでは、オーバーライドした save() は呼び出されません。

class Document(models.Model):
    title = models.CharField(max_length=200)
    file = models.FileField(upload_to='documents/')

    def delete(self, *args, **kwargs):
        # データベースからレコードを削除する前に、関連するファイルを削除する
        self.file.delete(save=False) # save=False でモデルの再保存を防ぐ
        super().delete(*args, **kwargs) # 親クラスの delete() を呼び出してDBレコードを削除

    def __str__(self):
        return self.title

注意: delete() をオーバーライドする際は、必ず super().delete(*args, **kwargs) を呼び出すようにしてください。また、QuerySet の delete() メソッドでは、オーバーライドした delete() は呼び出されません。

from django.db import models
from django.urls import reverse

class Article(models.Model):
    # ... (title, slug, content など)
    slug = models.SlugField(unique=True)

    def get_absolute_url(self):
        # 'article-detail' という名前のURLパターンを逆引きする
        # kwargs={'slug': self.slug} でURLに必要なパラメータを渡す
        return reverse('article-detail', kwargs={'slug': self.slug})

# urls.py での対応するURLパターンの例
# from django.urls import path
# from . import views
# urlpatterns = [
#     path('articles/<slug:slug>/', views.ArticleDetailView.as_view(), name='article-detail'),
# ]