SQLAlchemyのモデルをJSONに変換!

SQLAlchemyのモデルを入力するとサンプルJSONを作ります!SQLAlchemy ORM 対応。API ドキュメントやテスト用のリクエストボディ(sample JSON)に。
SQLAlchemy
結果
 

SQLAlchemyのモデルをJSONに変換!

SQLAlchemy のモデルクラスを貼り付けると、カラム属性の名前をキーにした例の JSON が得られます。2.0 スタイルの mapped_column() 付き Mapped[...]、1.x スタイルの Column()、Flask-SQLAlchemy の db.Column() を読み取り、mixin や親クラスのカラムもまとめます。

SQLAlchemy のモデルはそのまま json.dumps に渡せないため、FastAPI や Flask のアプリでは Pydantic や Marshmallow のスキーマを追加します。そのスキーマを書く前にモデルがどのフィールドを公開するかを整理したり、テスト用のリクエストボディを作ったりするのに使ってください。

使い方

  1. SQLAlchemy 欄にモデルファイルを貼り付けます。継承したカラムや enum の値が解決されるよう、Base、mixin、enum.Enum のクラスも同じ入力に入れておいてください。
  2. モデルとして扱うのは __tablename__ を持つクラスだけです。複数のモデルは { "User": {...}, "Team": {...} } のようにクラス名ごとに出力されます。
  3. 結果をコピーします。

例

入力 (Python · Flask-SQLAlchemy)
class TimestampMixin:
    created_at = db.Column(db.DateTime, default=datetime.utcnow)


class Plan(enum.Enum):
    FREE = "free"
    PRO = "pro"


class Subscription(TimestampMixin, db.Model):
    __tablename__ = "subscriptions"

    id = db.Column(db.Integer, primary_key=True)
    plan = db.Column(db.Enum(Plan), nullable=False)
    seats = db.Column(db.SmallInteger, default=1)
    trial_ends = db.Column(db.Date)
    user_id = db.Column(db.Integer, db.ForeignKey("users.id"))
    user = db.relationship("User", backref="subscriptions")
出力 (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

TimestampMixin の created_at が継承の順序に従って先頭に来て、relationship() はカラムではないので user は除外されます。db.Enum(Plan) は enum の最初の値 "free" を取り、db.Date は 1970-01-01 になります。seats は default=1 により 1 を示しますが、datetime.utcnow は関数なので created_at は仮の値のままです。

対応機能

  • Mapped[int]、Mapped[Optional[str]]、Mapped[str | None] のような Python の型ヒントで値を決めます。
  • 型ヒントがない場合は、Column(String(50)) や db.Column(db.Numeric) のように SQL の型の引数で決めます。
  • DateTime → 1970-01-01T00:00:00、Date → 1970-01-01、Time → 00:00:00、JSON/JSONB → {}、Uuid → すべてゼロの UUID。
  • ARRAY(String) や Mapped[list[str]] は要素1つの配列になります。
  • Enum(Plan) や Mapped[Plan] で使われる enum.Enum 継承クラスは、最初のメンバーの値を出力します。
  • relationship()、column_property()、普通のクラス変数、__table_args__ のようなダンダー属性は除外します。
  • mixin や親モデルのカラムは、子自身のカラムより前に並べます。

利用シーン

Pydantic のレスポンスモデルの下書き

FastAPI の response_model に使う Pydantic クラスを書く前に、モデルが JSON として公開するフィールドと型を確認できます。その JSON を JSON → Python のページに入れれば、Pydantic の下書きも得られます。

Flask API のテストペイロード

モデルの属性と一致するキーで client.post("/subscriptions", json=...) のボディを作れます。先に自動採番の id や作成日時を取り除いてください。

注意点と制限

  • リテラルの default=("new"、1、True、None)はサンプル値として使いますが、datetime.utcnow や dict のような呼び出し可能オブジェクトは実行しません。server_default= と nullable= は読み取りません。
  • Column("user_name", String) のようにカラムにデータベース上の別名を付けていても、JSON のキーは Python の属性名のままです。
  • relationship で読み込む関連オブジェクトは含まれません。レスポンスに埋め込んでいるなら、ネストしたオブジェクトを自分で追加してください。
  • hybrid_property や @property のような計算属性は出力に含まれません。

よくある質問

Mapped[Optional[str]] が null ではなく空文字列なのはなぜですか?

Optional は None を許可するという意味で、例では値がある場合を示すので、内側の str を使います。その場合が必要なら、出力で null に変えてください。

日時に Z やオフセットが付かないのはなぜですか?

DateTime のカラムは既定でタイムゾーンを持たない naive な値で、isoformat() はオフセットなしで出力します。DateTime(timezone=True) を使っているなら、+00:00 付きの例のほうが実際に目にするものに近くなります。

Django のモデルも変換できますか?

できません。このページが理解するのは SQLAlchemy の Column、mapped_column、Mapped の構文だけで、models.CharField のような Django のフィールドは認識しません。