SQLAlchemy ماڈلز کو JSON میں تبدیل کریں!

SQLAlchemy ماڈلز درج کریں اور مثالی JSON بنائیں! SQLAlchemy ORM سپورٹ۔ API دستاویزات اور ٹیسٹ request body (sample JSON) کے لیے مفید۔
SQLAlchemy
نتیجہ
 

SQLAlchemy ماڈلز کو JSON میں تبدیل کریں!

SQLAlchemy ماڈل کلاسز پیسٹ کریں اور کالم attribute ناموں کو keys بنا کر مثالی JSON حاصل کریں۔ یہ mapped_column() کے ساتھ 2.0 انداز کا Mapped[...]، 1.x انداز کا Column()، اور Flask-SQLAlchemy کا db.Column() پڑھتا ہے، اور mixins اور parent کلاسز کے کالمز بھی ملا دیتا ہے۔

SQLAlchemy ماڈلز براہ راست json.dumps کو نہیں دیے جا سکتے، اس لیے FastAPI اور Flask ایپس Pydantic یا Marshmallow schemas شامل کرتی ہیں۔ وہ schema لکھنے سے پہلے یہ خاکہ بنانے کے لیے کہ ماڈل کون سے فیلڈز ظاہر کرے گا، یا ٹیسٹس کے لیے request bodies بنانے کے لیے اسے استعمال کریں۔

استعمال کا طریقہ

  1. ماڈل فائل SQLAlchemy باکس میں پیسٹ کریں۔ Base، mixins اور enum.Enum کلاسز کو اسی ان پٹ میں رکھیں تاکہ وراثتی کالمز اور enum values حل ہو سکیں۔
  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 وراثت کی ترتیب کے مطابق سب سے پہلے آتا ہے، اور user ہٹا دیا جاتا ہے کیونکہ relationship() کالم نہیں۔ db.Enum(Plan)، enum کی پہلی value "free" لیتا ہے، اور db.Date بنتا ہے 1970-01-01۔ seats، default=1 سے 1 دکھاتا ہے، جبکہ created_at میں placeholder رہتا ہے کیونکہ datetime.utcnow ایک function ہے۔

معاون خصوصیات

  • Mapped[int]، Mapped[Optional[str]] اور Mapped[str | None] جیسے Python type hints value طے کرتے ہیں۔
  • type hint نہ ہو تو SQL type argument فیصلہ کرتا ہے، جیسے Column(String(50)) یا db.Column(db.Numeric) میں۔
  • DateTime → 1970-01-01T00:00:00، Date → 1970-01-01، Time → 00:00:00، JSON/JSONB → {}، Uuid → تمام صفروں والا UUID۔
  • ARRAY(String) اور Mapped[list[str]] ایک عنصر والی arrays بنتے ہیں۔
  • enum.Enum کو extend کرنے والی کلاس، جو Enum(Plan) یا Mapped[Plan] کے ذریعے استعمال ہو، اپنے پہلے member کی value دیتی ہے۔
  • relationship()، column_property()، سادہ class variables اور __table_args__ جیسے dunder attributes خارج کیے جاتے ہیں۔
  • mixins اور parent ماڈلز کے کالمز child کے اپنے کالمز سے پہلے رکھے جاتے ہیں۔

استعمال کے کیس

Pydantic response ماڈل کا ڈرافٹ

FastAPI کے response_model کے لیے Pydantic کلاس لکھنے سے پہلے وہ فیلڈز اور types چیک کریں جو ماڈل JSON کے طور پر ظاہر کرتا ہے۔ وہی JSON، JSON to Python صفحے کو دیں تو Pydantic ڈرافٹ بھی مل جاتا ہے۔

Flask API کے لیے test payloads

client.post("/subscriptions", json=...) کے لیے ایسی body بنائیں جس کی keys ماڈل کے attributes سے میل کھائیں۔ پہلے autoincrement id اور بننے کا وقت ہٹا دیں۔

نوٹس اور حدود

  • literal default= ("new"، 1، True، None) نمونہ value کے طور پر استعمال ہوتا ہے؛ datetime.utcnow یا dict جیسے callables نہیں چلائے جاتے۔ server_default= اور nullable= نہیں پڑھے جاتے۔
  • اگر کسی کالم کو الگ ڈیٹا بیس نام دیا گیا ہو، جیسے Column("user_name", String) میں، تو JSON key پھر بھی Python attribute کا نام ہی ہوتی ہے۔
  • relationship کے ذریعے لوڈ ہونے والے متعلقہ objects شامل نہیں ہوتے۔ اگر آپ کا response انہیں embed کرتا ہے تو nested objects خود شامل کریں۔
  • hybrid_property یا @property جیسے computed attributes آؤٹ پٹ کا حصہ نہیں ہوتے۔

عام سوالات

Mapped[Optional[str]]، null کے بجائے خالی string کیوں ہے؟

Optional کا مطلب ہے کہ None کی اجازت ہے؛ مثال وہ صورت دکھاتی ہے جب value موجود ہو، اس لیے اندرونی str استعمال ہوتا ہے۔ اگر آپ کو وہ صورت چاہیے تو آؤٹ پٹ میں اسے null کر دیں۔

datetimes میں Z یا offset کیوں نہیں؟

DateTime کالمز بطور ڈیفالٹ naive ہوتے ہیں، اور isoformat() انہیں بغیر offset کے لکھتا ہے۔ اگر آپ DateTime(timezone=True) استعمال کرتے ہیں تو +00:00 والی مثال اس کے زیادہ قریب ہے جو آپ اصل میں دیکھیں گے۔

کیا یہ Django ماڈلز تبدیل کر سکتا ہے؟

نہیں۔ یہ صفحہ صرف SQLAlchemy کا Column، mapped_column اور Mapped syntax سمجھتا ہے؛ models.CharField جیسے Django فیلڈز پہچانے نہیں جاتے۔