HN 日本語サマリー

← 一覧へ戻る
プログラミング

Djangoの好きなところ

What I love about Django (buttondown.com)

96 pointsby j4mie73 コメント

要約

この記事では、著者がButtondownの開発で長年Djangoを愛用してきた理由が語られています。Djangoの「ちょうど良い」意見の強さと構造化された設計により、フレームワーク自体が開発中に「見えなく」なり、Pythonicなコードやビジネスロジックと自然に融合することが、著者が最も高く評価する点です。特に、ミドルウェア、ベースモデルによる機能追加、アクション、シンプルな関数ベースのビュー、そしてパフォーマンスを重視したテスト戦略といった具体的な機能が、コードの保守性と効率性を高める上でいかに役立っているかが解説されています。

全文翻訳

Djangoの好きなところ

この記事を書くにあたっての私の目標は、Buttondownで長年にわたり非常に役立ち、永続的だと感じているDjangoの側面を称賛することでした。

これを実行する上での課題の一つは、Django自体の根本的な資産とも言える点です。それは、意見が「ちょうど良い」レベルで構造化されており、時間が経つにつれて目に見えなくなるほどです。当初はコードベースを注意深く見て、「いわゆる」Djangoの要素を特定するのが難しいと感じました。なぜなら、アプリケーションのDjango部分は、単にPythonicな側面やビジネスロジックの側面に非常にスムーズに溶け込んでいるからです。

私はButtondownを見て、Djangoアプリだとは思いません。むしろ、私よりも賢い人々によって多くのことが解決されてきた、よく構造化されたコードベースを見ています。これが、何よりも私がDjangoを愛する理由です。

しかし、詩的であることは、短くて退屈なブログ記事になってしまいます。そこで、思考帽とX線ゴーグルを組み合わせて、過去数年間でDjangoのどの部分が最も長期的なテコ入れをもたらしてくれたのかをじっくり見てみました。

1. ミドルウェア

Djangoのミドルウェア抽象化は信じられないほどシンプルであり、それゆえ信じられないほど強力です。私のような、ミドルウェアが関数からクラスへの移行期に成熟した人々は、実際のPythonプリミティブが何であれ、Djangoのミドルウェアはリクエスト/レスポンスのライフサイクルに作用する単純な関数であることを当然のことと考えています。それらはそのプロトコルを採用するだけで、その中でやりたいことを何でも実行できます。この種のリクエストフックが、さまざまなことに非常に役立つことが判明しました。サブドメインに基づいて適切なニュースレターにリクエストをルーティングすること、UTMとリファラーの帰属をキャプチャすること、Content-Security-Policyヘッダーを設定すること、ページビューを記録すること、構造化ログにリクエストコンテキストをバインドすること、そして――以下で説明するように――デプロイされたビルドバージョンをスタンプすることです。

デプロイされたgit SHAをすべてのレスポンスにスタンプする、古いブラウザタブが新しいビルドがリリースされたことに気づけるようにする、というものの全体像を以下に示します。

# app/emails/middlewares/build_version.py
class Middleware:
    def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]) -> None:
        self.get_response = get_response

    def __call__(self, request: HttpRequest) -> HttpResponse:
        response = self.get_response(request)
        if settings.HEROKU_SLUG_COMMIT and not flag_is_active(CIRCUIT_BREAKER_FLAG):
            response[BUILD_VERSION_HEADER] = settings.HEROKU_SLUG_COMMIT
        return response

もし、平均的なDjango開発者がもっと活用すべきだと思うツールがあるとしたら、それはミドルウェアです。

2. モデル(と軽量な継承)

私たちはポリモーフィックモデルを避けています。部分的には、それが少し扱いにくい(footgun)と考えているためですが、より現実的には、それらにうまく適応するユースケースがほとんどないためです。しかし、Buttondownのすべてのモデルは、ベースモデルを継承しています。それをトリムしたバージョンは以下のようになります。

# app/utils/models.py
class BaseModel(models.Model):
    creation_date = models.DateTimeField(auto_now_add=True)
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    objects = TypeIDAwareManager()

    def save(self, *args, **kwargs):
        super().save(*args, **kwargs)
        # 変更された追跡対象フィールドごとに、
        # handle_<field>_change フックを呼び出し、トランジション行を永続化します。
        ...

    class Meta:
        abstract = True
        ordering = ("-creation_date",)

その基底クラスは、すべてオプトインかつ追加的なもので、多くのことを静かに行っています。

  • すべてのテーブルにUUIDプライマリキーとcreation_dateが無料で追加されます。
  • 公開された、タイププレフィックス付きID(sub_...、em_...)は、カスタムマネージャーとクエリセットを介してORMが透過的にデコードします。
  • 暗黙的な変更追跡:handle_<field>_changeを定義すると、そのフィールドが変更されるたびに実行されます。シグナルや登録は不要です。
  • 永続的な出所(provenance):フィールドをトランジションテーブルにマッピングすると、すべての変更が独自の行として書き込まれます。
  • フィールドごとの検証フック(validate_<field>)。
  • オプトインのソフトデリートマネージャー、およびデータ整合性チェッカーシステムへのフック。

この投稿で表面化させるのは奇妙なことのように思えるかもしれませんが、Djangoのオブジェクト指向へのアプローチで便利だったのは、これらすべてが断片的だったことです。共通の機能に新しい部分を組み込むのに、多大な労力やマイグレーション、リファクタリングは必要ありませんでした。そして、出所追跡のようなことを新しいフィールドに対して行うのが非常に、非常に簡単であることを意味します。モデルは単一のメソッドでオプトインし、基底クラスが残りを処理します。

# app/emails/models/email/model.py
class Email(BaseModel):
    # 暗黙的な変更追跡:handle_<field>_changeを定義すると、BaseModel
    # はフィールドが実際に変更されるたびにそれを呼び出します。シグナルや配線は不要です。
    def handle_body_change(self, **kwargs) -> None:
        AsynchronousAction.enqueue(sync_snippet_references, [str(self.id)])

    # 永続的な出所:フィールドをトランジションテーブルにマッピングすると、すべての変更
    # が行として永続化されます。追加は1行の辞書エントリです。
    @classmethod
    def tracked_field_to_transition_class(cls) -> dict[str, type[BaseTransition]]:
        return {"status": EmailStatusTransition}

これらはいずれも、基底クラスへのマイグレーションや、呼び出しサイトのリファクタリングを必要としませんでした。

3. アクション

モデルクラスに数十個のメソッドが蓄積するのを避けるために、モデルが実行できるすべての動作は、そのモデルの隣にあるactions/フォルダの下の独自のファイルに格納されています。モジュールごとに1つの動詞があり、それぞれがcall()を公開しています。以下は、「購読者を禁止する」というアクション全体です。これはさらに別のアクションを構成しています。

# app/emails/models/subscriber/actions/ban.py
from emails.models.subscriber.actions import end_premium_subscription
from emails.models.subscriber.model import Subscriber


def call(subscriber: Subscriber) -> None:
    if subscriber.subscriber_type == Subscriber.Type.PREMIUM.value:
        end_premium_subscription.call(str(subscriber.id))

    subscriber.subscriber_type = Subscriber.Type.REMOVED.value
    subscriber.save(update_fields=["subscriber_type", "modification_date"])

4. ビュー

私たちのビューへのアプローチは、非常に教条的で、非常にシンプルです。ビューは以下を行う必要があります。

  1. 独自のファイルに配置する
  2. クラスベースビュー(CBV)ではなく関数ベースにする
  3. その関数をviewという名前で公開する
# app/emails/views/record_lifecycle_email_open.py
def view(request: HttpRequest, compressed_id: str) -> HttpResponse:
    try:
        account_id, email_type = _decode_open_payload(compressed_id)
    except (UnicodeDecodeError, Base64Error, ValueError):
        return HttpResponse(TRANSPARENT_GIF, content_type="image/gif")

    with transaction.atomic():
        LifecycleEmailEvent.objects.create(
            account_id=account_id,
            email_type=email_type,
            event_type=LifecycleEmailEvent.EventType.OPENED,
            timestamp=timezone.now(),
            metadata=_build_metadata(request),
        )
    return HttpResponse(TRANSPARENT_GIF, content_type="image/gif")

なぜこれほど退屈で厳格なのか? 主にコンテキストスイッチの痛みを避けるためです。私の意見では、保守可能なビューコードを書くことは、成功を見つけることよりも失敗を避けることに関係しており、失敗は不必要な間接化とコード再利用の欠如という形で現れる傾向があります。どちらも、ビューを可能な限り「純粋」(関数型プログラミングの観点から)にすることで単純化されます。

5. テスト

私は個人的なブログでテストについて多く書いてきました。過去1年間、個人のコントリビューターとしての時間の多くを、バックエンドのテストスイートが常にボトルネックとなっていたCIパイプラインを可能な限り高速化することに費やしてきました。私たちはpytestとpytest-django、そして膨大な数のpytestプラグインを使用しています。特に、パフォーマンスをさらに引き出すために、Factory Boyのような市販のフィクスチャジェネレーターは実際には使用せず、独自に構築しています。テストは、必要なフィクスチャを受け取り、実際の行に対してアサートを行うプレーンな関数です。

# app/emails/views/record_lifecycle_email_open--test.py
# `account` は手作りのフィクスチャで、account/model--mock.py に共置され、
# pytest_plugins を介して登録されています。factory_boy や mock.patch は使用していません。
def test_records_open_event(account):
    encoded = encode_open_payload(str(account.pk), "unconfirmed")
    request = RequestFactory().get(f"/lo/{encoded}/")

    response = view(request, encoded)

    assert response.status_code == 200
    event = LifecycleEmailEvent.objects.get(account=account)
    assert event.event_type == LifecycleEmailEvent.EventType.OPENED

省略するもの

Railsが「おまかせ」で有名であるのに対し、Djangoで私が最も好きなことの一つは、上記で言及されていない、私たちが何らかの理由で自分たちに適さないと判断したことです。

例をいくつか挙げます。

シグナル。 私たちはそれらを使用しないというより、乱用しないと言うべきかもしれません。私たちはわずか1つのシグナルしか使用していません。django-allauthへの軽量なリンクです。内部でのシグナルの使用――私たち自身が所有する2つのコード片を接続すること――は、何が起こっているかを理解したり、将来的にパフォーマンスのために改善したりすることをより困難にするアンチパターンであるとわかっています。

クラスベースビュー。 クラスベースビューは、いくつかのコンテキストでは価値があると思いますが、コードベースを飛び回る際に最も対処が難しいことの一つは、関数ベースビューとクラスベースビューの間でのコンテキストスイッチです。そして、CBVがどのようなマイナーな利点を持つとしても、すべてのビューがどのように機能するかについて、非常に教条的で標準化できることと比較すると、それはかすんでしまいます。

アプリ。 Djangoが提案する従来のモジュール式という意味ではアプリを使用していません。主な理由は2つあります。1つは、クロスアプリのマイグレーション、特にそれらを圧縮するのが非常に難しいことです。そして2つ目は、Djangoがほとんど気にしない他の組織化アプローチ――関連するモデルをフォルダにまとめるだけ――よりも、明らかな利点を提供しないことです。このルールには2つの例外があります。1つ目は、コアAPIインフラストラクチャで、その骨格は独自のアプリにありますが、これは私がより洗練されたビューを持つ前にそのように構築したためです。2つ目は、サードパーティパッケージやオープンソースに抽象化したいと考えているもので、アプリはそれとコードベースの残りの部分との境界設定を前もって行うのに役立ちます。

管理画面。 Djangoの管理画面は、立ち上げには驚異的であり、初期の頃はそれに大きく依存していましたが、最終的にはそれを超えて独自の内部ツールを構築しました。

チェック。 チェックは実際には非常にクールだと思いますし、もっと使用しないことを残念に思う部分もあります。システム内のさまざまな制約を強制するために、奇妙なテストを採用する方が簡単な方法だとわかりました。パフォーマンスが少し犠牲になります――技術的にはREPLの方が遅いと言うこともできます――が、これもまた、動く部品が一つ減ります。

フォームとフロントエンド関連。 Djangoのフォーム抽象化は一切使用していません。実際、アプリケーションのフロントエンドを構築する私たちの方法はやや興味深いものです。よりハイドレーションベースのパターンに依存しており、ほとんどの認証済みビューでDjangoの役割は、薄いシェルをレンダリングし、データをシードすることであり、HTMLを生成することではありません。単一のビューがアプリのほぼすべてのページをバックエンドで処理します。セッションを解決し、アカウント(および一部のルートでは関連リソースの最初のページ)をjson_scriptタグにシリアライズし、Vueに引き渡します。VueはAPIラウンドトリップのロード時間を回避するために、そのペイロードから起動してハイドレーションします。Djangoが骨組みをレンダリングし、SPAが残りを処理します。

なぜそもそもDjangoを使ったのか?

ButtondownがDjangoで書かれているのは、退屈だが示唆に富む理由からです。それは、当時私が知っていたものだったからです。2018年当時、私はDjangoとVueのスタックを持つ会社で働いており、Djangoの豊富な経験を持つ人物として採用されました(つまり、古い仲間のために、Southが何であるかを知っていました)。

私の長年の哲学の一つは、イノベーショントークンを制限することです。日々の仕事からサイドプロジェクトに移る際に、フレームワーク間でコンテキストスイッチをしたくありませんでした。それから8年間、フロントエンドフレームワークとしてVueを選択したことを後悔することがありましたが、たとえそれが綿密に計算され、考慮された選択ではなかったとしても、Djangoを使用したことを一度も後悔したことはないと正直に言えます。