I-convert ang mga SQLAlchemy model sa JSON!

Maglagay ng mga SQLAlchemy model para gumawa ng halimbawang JSON! Sinusuportahan ang SQLAlchemy ORM. Magagamit sa API docs at test request body (mock request body).
SQLAlchemy
Resulta
 

I-convert ang mga SQLAlchemy model sa JSON!

I-paste ang mga SQLAlchemy model class at makakakuha ka ng halimbawang JSON na naka-key ayon sa mga column attribute name. Binabasa nito ang 2.0-style na Mapped[...] kasama ang mapped_column(), ang 1.x-style na Column(), at ang db.Column() ng Flask-SQLAlchemy, at isinasama ang mga column mula sa mga mixin at parent class.

Hindi direktang maipapasa sa json.dumps ang mga SQLAlchemy model, kaya nagdadagdag ang mga FastAPI at Flask app ng mga Pydantic o Marshmallow schema. Gamitin ito para ilatag kung aling mga field ang ilalantad ng isang model bago isulat ang schema na iyon, o para bumuo ng mga request body para sa mga test.

Paano gamitin

  1. I-paste ang model file sa SQLAlchemy box. Panatilihin sa parehong input ang Base, mga mixin at mga enum.Enum class para ma-resolve ang mga minanang column at enum value.
  2. Ang mga class lang na may __tablename__ ang itinuturing na model. Inilalabas ayon sa class name ang maraming model, gaya ng { "User": {...}, "Team": {...} }.
  3. Kopyahin ang resulta.

Halimbawa

Input (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")
Output (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

Nauuna ang created_at mula sa TimestampMixin, ayon sa pagkakasunod ng inheritance, at tinatanggal ang user dahil hindi column ang relationship(). Kinukuha ng db.Enum(Plan) ang unang value ng enum, "free", at nagiging 1970-01-01 ang db.Date. 1 ang ipinapakita ng seats mula sa default=1, habang nananatiling placeholder ang created_at dahil function ang datetime.utcnow.

Mga sinusuportahang feature

  • Ang mga Python type hint gaya ng Mapped[int], Mapped[Optional[str]] at Mapped[str | None] ang nagpapasya sa value.
  • Kapag walang type hint, ang SQL type argument ang nagpapasya, gaya ng sa Column(String(50)) o db.Column(db.Numeric).
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → UUID na puro zero.
  • Nagiging array na may isang element ang ARRAY(String) at Mapped[list[str]].
  • Ang class na nag-e-extend ng enum.Enum, na ginagamit sa pamamagitan ng Enum(Plan) o Mapped[Plan], ay nag-aambag ng value ng una nitong member.
  • Hindi kasama ang relationship(), column_property(), mga simpleng class variable at mga dunder attribute gaya ng __table_args__.
  • Inilalagay bago ang sariling mga column ng child ang mga column mula sa mga mixin at parent model.

Mga gamit

Pag-draft ng Pydantic response model

Bago isulat ang Pydantic class para sa response_model ng FastAPI, i-check ang mga field at type na inilalantad ng model bilang JSON. Ipasok ang JSON na iyon sa page na JSON to Python para makakuha rin ng Pydantic draft.

Mga test payload para sa isang Flask API

Buuin ang body para sa client.post("/subscriptions", json=...) gamit ang mga key na tugma sa mga attribute ng model. Tanggalin muna ang autoincrement na id at ang oras ng paggawa.

Mga paalala at limitasyon

  • Ginagamit bilang sample value ang literal na default= ("new", 1, True, None); hindi pinapatakbo ang mga callable gaya ng datetime.utcnow o dict. Hindi binabasa ang server_default= at nullable=.
  • Kung binigyan ng hiwalay na database name ang isang column, gaya ng Column("user_name", String), ang Python attribute name pa rin ang JSON key.
  • Hindi kasama ang mga kaugnay na object na nilo-load sa pamamagitan ng relationship. Ikaw na ang magdagdag ng mga nested object kung ine-embed sila ng response mo.
  • Hindi bahagi ng output ang mga computed attribute gaya ng hybrid_property o @property.

Mga madalas itanong

Bakit empty string at hindi null ang Mapped[Optional[str]]?

Ibig sabihin ng Optional na pinapayagan ang None; ipinapakita ng halimbawa ang kasong may value, kaya ginagamit ang inner na str. Palitan ito ng null sa output kung kailangan mo ang kasong iyon.

Bakit walang Z o offset ang mga datetime?

Naive bilang default ang mga DateTime column, at ipinapakita sila ng isoformat() nang walang offset. Kung gumagamit ka ng DateTime(timezone=True), mas malapit sa makikita mo talaga ang halimbawang may +00:00.

Kaya ba nitong i-convert ang mga Django model?

Hindi. Ang syntax na Column, mapped_column at Mapped ng SQLAlchemy lang ang naiintindihan ng page na ito; hindi kinikilala ang mga Django field gaya ng models.CharField.