Convertir JSON en un schéma SQLAlchemy !

Entrez JSON et convertissez-le en schéma SQLAlchemy ! Compatible avec SQLAlchemy 2.0 ORM, Mapped, mapped_column, Flask, FastAPI.
JSON
Résultat
 

Convertir JSON en un schéma SQLAlchemy !

Convertit du JSON en modèle déclaratif SQLAlchemy 2.0 prêt à l'emploi : une classe Base(DeclarativeBase), des annotations Mapped[...] avec mapped_column(), des indicateurs nullable, __tablename__ et une clé primaire Integer.

Un bon point de départ quand un backend FastAPI ou Flask doit stocker le JSON d'une requête, ou des données récupérées d'un autre système, dans une table qui n'a pas encore de modèle.

Mode d'emploi

  1. Collez un objet JSON représentant une ligne de table. Si certaines lignes ont des valeurs vides, collez plusieurs lignes sous forme de tableau pour que nullable=True soit détecté.
  2. Saisissez le nom de la classe dans Nom du modèle (par défaut MyModel) ; __tablename__ correspond à ce nom en upper snake case.
  3. Enregistrez la sortie sous models.py. Si votre projet a déjà une Base, supprimez celle générée et importez la vôtre, pour que tous les modèles partagent le même metadata.

Exemple

Entrée (JSON)
{
  "isbn": "978-0-13-468599-1",
  "title": "The Pragmatic Programmer",
  "pages": 352,
  "rating": 4.7,
  "available": true,
  "published_at": "2019-09-13"
}
Sortie (SQLAlchemy 2.0)
from datetime import date

from sqlalchemy import Boolean, Date, Float, Integer, String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column


class Base(DeclarativeBase):
    pass


class Book(Base):
    __tablename__ = "BOOK"

    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    isbn: Mapped[str] = mapped_column(String(255), nullable=False)
    title: Mapped[str] = mapped_column(String(255), nullable=False)
    pages: Mapped[int] = mapped_column(Integer, nullable=False)
    rating: Mapped[float] = mapped_column(Float, nullable=False)
    available: Mapped[bool] = mapped_column(Boolean, nullable=False)
    published_at: Mapped[date] = mapped_column(Date, nullable=False)

L'isbn avec tirets reste String(255), pages devient Integer, rating Float, et published_at, une date sans heure, Date avec une annotation date. Toutes les valeurs sont présentes : toutes les colonnes sont donc nullable=False.

Fonctionnalités prises en charge

  • Définit class Base(DeclarativeBase): pass et n'importe que les types SQLAlchemy et noms datetime réellement utilisés.
  • Correspondance des types : entiers → Integer/int (BigInteger pour les grandes valeurs), décimaux → Float, booléens → Boolean, YYYY-MM-DD → Date/date, dates-heures → DateTime/datetime, objets et tableaux → JSON avec dict/list.
  • Les chaînes sont String(255), ou Text quand une valeur d'exemple dépasse 255 caractères, pour que la table puisse aussi être créée sur MySQL.
  • Les attributs sont en snake_case. Quand la clé JSON diffère (publishedAt, home-url), la clé d'origine est passée comme nom de colonne : mapped_column("publishedAt", ...). Les mots-clés Python et metadata reçoivent un _ final.
  • Les colonnes nullables sont annotées Mapped[str | None] en plus de nullable=True.
  • La clé primaire est un Integer, auto-incrémenté aussi sur SQLite ; un id chaîne dans votre JSON devient une clé String(255), et un grand id entier utilise BigInteger().with_variant(Integer, "sqlite").

Cas d'utilisation

Modèles de persistance pour des endpoints FastAPI

Si vous avez déjà le JSON de requête d'exemple d'un schéma Pydantic, générez le modèle SQLAlchemy à partir du même JSON et écrivez tout de suite le flux session.add(Book(**payload)).

Migrations Alembic autogénérées

Une fois le modèle enregistré sur Base.metadata, alembic revision --autogenerate produit une migration create_table à partir de cette classe.

Remarques et limites

  • Les annotations str | None nécessitent Python 3.10+. Sur les versions antérieures, écrivez Optional[str] avec from typing import Optional.
  • __tablename__ est en majuscules (BOOK). PostgreSQL exige alors des guillemets en SQL brut, et beaucoup de projets le remplacent par books.
  • Avec Flask-SQLAlchemy, héritez de db.Model au lieu de la Base générée.
  • Float est un flottant binaire ; utilisez Numeric(10, 2) avec Decimal pour les prix.

FAQ

Pourquoi id utilise-t-il Integer plutôt que BigInteger ?

SQLite n'auto-incrémente qu'une colonne déclarée exactement INTEGER PRIMARY KEY : Integer garantit donc le même comportement en tests locaux et en production. La clé ne passe à BigInteger avec une variante SQLite que si vos données contiennent déjà des ids au-delà de 32 bits.

Y a-t-il un réglage de schéma (__table_args__) ?

Non. La table va dans le schéma par défaut de la connexion. Pour cibler un autre schéma PostgreSQL, ajoutez vous-même __table_args__ = {"schema": "billing"}.

Puis-je obtenir la syntaxe Column() de SQLAlchemy 1.4 ?

La sortie est uniquement en style 2.0 (Mapped, mapped_column, DeclarativeBase). Pour la 1.4, utilisez declarative_base() et réécrivez chaque ligne sous la forme title = Column(String(255), nullable=False).