[WIP] Upgrade to support both Pydantic v1 and v2

.github/workflows/test.yml

@@ -20,11 +20,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version:
-          - "3.7"
-          - "3.8"
-          - "3.9"
-          - "3.10"
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        pydantic-version: ["pydantic-v1", "pydantic-v2"]
       fail-fast: false
 
     steps:
@@ -55,8 +52,12 @@ jobs:
       - name: Install Dependencies
         if: steps.cache.outputs.cache-hit != 'true'
         run: python -m poetry install
-      - name: Lint
-        run: python -m poetry run bash scripts/lint.sh
+      - name: Install Pydantic v1
+        if: matrix.pydantic-version == 'pydantic-v1'
+        run: pip install "pydantic>=1.10.0,<2.0.0"
+      - name: Install Pydantic v2
+        if: matrix.pydantic-version == 'pydantic-v2'
+        run: pip install "pydantic>=2.0.2,<3.0.0"
       - run: mkdir coverage
       - name: Test
         run: python -m poetry run bash scripts/test.sh
@@ -68,6 +69,8 @@ jobs:
         with:
           name: coverage
           path: coverage
+      - name: Lint
+        run: python -m poetry run bash scripts/lint.sh
   coverage-combine:
     needs:
       - test

docs/tutorial/fastapi/multiple-models.md

@@ -174,13 +174,13 @@ Now we use the type annotation `HeroCreate` for the request JSON data in the `he
 # Code below omitted 👇
 ```
 
-Then we create a new `Hero` (this is the actual **table** model that saves things to the database) using `Hero.from_orm()`.
+Then we create a new `Hero` (this is the actual **table** model that saves things to the database) using `Hero.model_validate()`.
 
-The method `.from_orm()` reads data from another object with attributes and creates a new instance of this class, in this case `Hero`.
+The method `.model_validate()` reads data from another object with attributes and creates a new instance of this class, in this case `Hero`.
 
 The alternative is `Hero.parse_obj()` that reads data from a dictionary.
 
-But as in this case, we have a `HeroCreate` instance in the `hero` variable. This is an object with attributes, so we use `.from_orm()` to read those attributes.
+But as in this case, we have a `HeroCreate` instance in the `hero` variable. This is an object with attributes, so we use `.model_validate()` to read those attributes.
 
 With this, we create a new `Hero` instance (the one for the database) and put it in the variable `db_hero` from the data in the `hero` variable that is the `HeroCreate` instance we received from the request.
 

docs/tutorial/index.md

@@ -64,6 +64,8 @@ $ cd sqlmodel-tutorial
 
 Make sure you have an officially supported version of Python.
 
+Currently it is **Python 3.7** and above (Python 3.6 was already deprecated).
+
 You can check which version you have with:
 
 <div class="termy">
@@ -79,9 +81,11 @@ There's a chance that you have multiple Python versions installed.
 
 You might want to try with the specific versions, for example with:
 
+* `python3.11`
 * `python3.10`
 * `python3.9`
 * `python3.8`
+* `python3.7`
 
 The code would look like this:
 

docs_src/tutorial/fastapi/app_testing/tutorial001/main.py

@@ -2,6 +2,7 @@
 
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -54,7 +55,10 @@ def on_startup():
 
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate):
-    db_hero = Hero.from_orm(hero)
+    if IS_PYDANTIC_V2:
+        db_hero = Hero.model_validate(hero)
+    else:
+        db_hero = Hero.from_orm(hero)
     session.add(db_hero)
     session.commit()
     session.refresh(db_hero)

docs_src/tutorial/fastapi/delete/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -50,7 +51,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -44,7 +45,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/fastapi/multiple_models/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class Hero(SQLModel, table=True):
@@ -46,7 +47,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/fastapi/multiple_models/tutorial002.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -44,7 +45,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/fastapi/read_one/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI, HTTPException
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -44,7 +45,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/fastapi/relationships/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class TeamBase(SQLModel):
@@ -92,7 +93,10 @@ def on_startup():
 
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate):
-    db_hero = Hero.from_orm(hero)
+    if IS_PYDANTIC_V2:
+        db_hero = Hero.model_validate(hero)
+    else:
+        db_hero = Hero.from_orm(hero)
     session.add(db_hero)
     session.commit()
     session.refresh(db_hero)
@@ -146,7 +150,10 @@ def delete_hero(*, session: Session = Depends(get_session), hero_id: int):
 
 @app.post("/teams/", response_model=TeamRead)
 def create_team(*, session: Session = Depends(get_session), team: TeamCreate):
-    db_team = Team.from_orm(team)
+    if IS_PYDANTIC_V2:
+        db_team = Team.model_validate(team)
+    else:
+        db_team = Team.from_orm(team)
     session.add(db_team)
     session.commit()
     session.refresh(db_team)

docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -54,7 +55,10 @@ def on_startup():
 
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate):
-    db_hero = Hero.from_orm(hero)
+    if IS_PYDANTIC_V2:
+        db_hero = Hero.model_validate(hero)
+    else:
+        db_hero = Hero.from_orm(hero)
     session.add(db_hero)
     session.commit()
     session.refresh(db_hero)

docs_src/tutorial/fastapi/teams/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class TeamBase(SQLModel):
@@ -83,7 +84,10 @@ def on_startup():
 
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate):
-    db_hero = Hero.from_orm(hero)
+    if IS_PYDANTIC_V2:
+        db_hero = Hero.model_validate(hero)
+    else:
+        db_hero = Hero.from_orm(hero)
     session.add(db_hero)
     session.commit()
     session.refresh(db_hero)
@@ -137,7 +141,10 @@ def delete_hero(*, session: Session = Depends(get_session), hero_id: int):
 
 @app.post("/teams/", response_model=TeamRead)
 def create_team(*, session: Session = Depends(get_session), team: TeamCreate):
-    db_team = Team.from_orm(team)
+    if IS_PYDANTIC_V2:
+        db_team = Team.model_validate(team)
+    else:
+        db_team = Team.from_orm(team)
     session.add(db_team)
     session.commit()
     session.refresh(db_team)

docs_src/tutorial/fastapi/update/tutorial001.py

@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.compat import IS_PYDANTIC_V2
 
 
 class HeroBase(SQLModel):
@@ -50,7 +51,10 @@ def on_startup():
 @app.post("/heroes/", response_model=HeroRead)
 def create_hero(hero: HeroCreate):
     with Session(engine) as session:
-        db_hero = Hero.from_orm(hero)
+        if IS_PYDANTIC_V2:
+            db_hero = Hero.model_validate(hero)
+        else:
+            db_hero = Hero.from_orm(hero)
         session.add(db_hero)
         session.commit()
         session.refresh(db_hero)

docs_src/tutorial/many_to_many/tutorial003.py

@@ -3,25 +3,12 @@
 from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select
 
 
-class HeroTeamLink(SQLModel, table=True):
-    team_id: Optional[int] = Field(
-        default=None, foreign_key="team.id", primary_key=True
-    )
-    hero_id: Optional[int] = Field(
-        default=None, foreign_key="hero.id", primary_key=True
-    )
-    is_training: bool = False
-
-    team: "Team" = Relationship(back_populates="hero_links")
-    hero: "Hero" = Relationship(back_populates="team_links")
-
-
 class Team(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
     name: str = Field(index=True)
     headquarters: str
 
-    hero_links: List[HeroTeamLink] = Relationship(back_populates="team")
+    hero_links: List["HeroTeamLink"] = Relationship(back_populates="team")
 
 
 class Hero(SQLModel, table=True):
@@ -30,7 +17,20 @@ class Hero(SQLModel, table=True):
     secret_name: str
     age: Optional[int] = Field(default=None, index=True)
 
-    team_links: List[HeroTeamLink] = Relationship(back_populates="hero")
+    team_links: List["HeroTeamLink"] = Relationship(back_populates="hero")
+
+
+class HeroTeamLink(SQLModel, table=True):
+    team_id: Optional[int] = Field(
+        default=None, foreign_key="team.id", primary_key=True
+    )
+    hero_id: Optional[int] = Field(
+        default=None, foreign_key="hero.id", primary_key=True
+    )
+    is_training: bool = False
+
+    team: "Team" = Relationship(back_populates="hero_links")
+    hero: "Hero" = Relationship(back_populates="team_links")
 
 
 sqlite_file_name = "database.db"

docs_src/tutorial/relationship_attributes/back_populates/tutorial003.py

@@ -3,6 +3,21 @@
 from sqlmodel import Field, Relationship, SQLModel, create_engine
 
 
+class Hero(SQLModel, table=True):
+    id: Optional[int] = Field(default=None, primary_key=True)
+    name: str = Field(index=True)
+    secret_name: str
+    age: Optional[int] = Field(default=None, index=True)
+
+    team_id: Optional[int] = Field(default=None, foreign_key="team.id")
+    team: Optional["Team"] = Relationship(back_populates="heroes")
+
+    weapon_id: Optional[int] = Field(default=None, foreign_key="weapon.id")
+    weapon: Optional["Weapon"] = Relationship(back_populates="hero")
+
+    powers: List["Power"] = Relationship(back_populates="hero")
+
+
 class Weapon(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
     name: str = Field(index=True)
@@ -26,21 +41,6 @@ class Team(SQLModel, table=True):
     heroes: List["Hero"] = Relationship(back_populates="team")
 
 
-class Hero(SQLModel, table=True):
-    id: Optional[int] = Field(default=None, primary_key=True)
-    name: str = Field(index=True)
-    secret_name: str
-    age: Optional[int] = Field(default=None, index=True)
-
-    team_id: Optional[int] = Field(default=None, foreign_key="team.id")
-    team: Optional[Team] = Relationship(back_populates="heroes")
-
-    weapon_id: Optional[int] = Field(default=None, foreign_key="weapon.id")
-    weapon: Optional[Weapon] = Relationship(back_populates="hero")
-
-    powers: List[Power] = Relationship(back_populates="hero")
-
-
 sqlite_file_name = "database.db"
 sqlite_url = f"sqlite:///{sqlite_file_name}"