PART 02 — 画面一覧表
URL設計・遷移フロー・画面種別・認証要件で定義すべきこと

"""
Djangoプロジェクトのルーティングを一覧出力して画面一覧表の作成に活用する。
Django管理コマンドとして実行: python manage.py show_urls --format=csv
または直接実行する場合は下記スクリプトを使用。

pip install django
"""
import os
import sys
import csv


def get_django_urls(settings_module: str) -> list[dict]:
    """
    Django URLパターンを再帰的に収集する。
    settings_module: 'myproject.settings' などの設定モジュールパス
    """
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
    import django
    django.setup()

    from django.urls import URLPattern, URLResolver
    from django.urls import get_resolver

    result = []

    def collect(patterns, prefix=""):
        for p in patterns:
            if isinstance(p, URLResolver):
                collect(p.url_patterns, prefix + str(p.pattern))
            elif isinstance(p, URLPattern):
                url = prefix + str(p.pattern)
                name = p.name or "(no name)"
                callback = getattr(p.callback, "__name__", str(p.callback))
                module = getattr(p.callback, "__module__", "")
                result.append({
                    "URLパス": "/" + url.lstrip("^").rstrip("$").lstrip("/"),
                    "View名": callback,
                    "URLName": name,
                    "モジュール": module,
                })

    collect(get_resolver().url_patterns)
    return result


if __name__ == "__main__":
    SETTINGS = "myproject.settings"  # 自プロジェクトの設定モジュールに変更

    urls = get_django_urls(SETTINGS)

    # コンソール出力
    for u in urls:
        print(f"{u['URLパス']:<40} {u['URLName']:<30} {u['View名']}")

    # CSV出力
    with open("screen_list.csv", "w", newline="", encoding="utf-8-sig") as f:
        writer = csv.DictWriter(f, fieldnames=["URLパス", "View名", "URLName", "モジュール"])
        writer.writeheader()
        writer.writerows(urls)

    print(f"\nscreen_list.csv に {len(urls)}件 出力しました")