Coverage for docs_src/tutorial/fastapi/relationships/tutorial001.py: 100%
123 statements
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-16 00:02 +0000
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-16 00:02 +0000
1from typing import Annotated 1abcdefghijklm
3from fastapi import Depends, FastAPI, HTTPException, Query 1abcdefghijklm
4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1abcdefghijklm
7class TeamBase(SQLModel): 1abcdefghijklm
8 name: str = Field(index=True) 1abcdefghijklm
9 headquarters: str 1abcdefghijklm
12class Team(TeamBase, table=True): 1abcdefghijklm
13 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm
15 heroes: list["Hero"] = Relationship(back_populates="team") 1abcdefghijklm
18class TeamCreate(TeamBase): 1abcdefghijklm
19 pass 1abcdefghijklm
22class TeamPublic(TeamBase): 1abcdefghijklm
23 id: int 1abcdefghijklm
26class TeamUpdate(SQLModel): 1abcdefghijklm
27 id: int | None = None 1abcdefghijklm
28 name: str | None = None 1abcdefghijklm
29 headquarters: str | None = None 1abcdefghijklm
32class HeroBase(SQLModel): 1abcdefghijklm
33 name: str = Field(index=True) 1abcdefghijklm
34 secret_name: str 1abcdefghijklm
35 age: int | None = Field(default=None, index=True) 1abcdefghijklm
37 team_id: int | None = Field(default=None, foreign_key="team.id") 1abcdefghijklm
40class Hero(HeroBase, table=True): 1abcdefghijklm
41 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm
43 team: Team | None = Relationship(back_populates="heroes") 1abcdefghijklm
46class HeroPublic(HeroBase): 1abcdefghijklm
47 id: int 1abcdefghijklm
50class HeroCreate(HeroBase): 1abcdefghijklm
51 pass 1abcdefghijklm
54class HeroUpdate(SQLModel): 1abcdefghijklm
55 name: str | None = None 1abcdefghijklm
56 secret_name: str | None = None 1abcdefghijklm
57 age: int | None = None 1abcdefghijklm
58 team_id: int | None = None 1abcdefghijklm
61class HeroPublicWithTeam(HeroPublic): 1abcdefghijklm
62 team: TeamPublic | None = None 1abcdefghijklm
65class TeamPublicWithHeroes(TeamPublic): 1abcdefghijklm
66 heroes: list[HeroPublic] = [] 1abcdefghijklm
69sqlite_file_name = "database.db" 1abcdefghijklm
70sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcdefghijklm
72connect_args = {"check_same_thread": False} 1abcdefghijklm
73engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcdefghijklm
76def create_db_and_tables(): 1abcdefghijklm
77 SQLModel.metadata.create_all(engine) 1nopqrstuvwxyz
80def get_session(): 1abcdefghijklm
81 with Session(engine) as session: 1nopqrstuvwxyz
82 yield session 1nopqrstuvwxyz
85app = FastAPI() 1abcdefghijklm
88@app.on_event("startup") 1abcdefghijklm
89def on_startup(): 1abcdefghijklm
90 create_db_and_tables() 1nopqrstuvwxyz
93@app.post("/heroes/", response_model=HeroPublic) 1abcdefghijklm
94def create_hero(session: Annotated[Session, Depends(get_session)], hero: HeroCreate): 1abcdefghijklm
95 db_hero = Hero.model_validate(hero) 1nopqrstuvwxyz
96 session.add(db_hero) 1nopqrstuvwxyz
97 session.commit() 1nopqrstuvwxyz
98 session.refresh(db_hero) 1nopqrstuvwxyz
99 return db_hero 1nopqrstuvwxyz
102@app.get("/heroes/", response_model=list[HeroPublic]) 1abcdefghijklm
103def read_heroes( 1abcdefghijklm
104 session: Annotated[Session, Depends(get_session)],
105 offset: int = 0,
106 limit: Annotated[int, Query(le=100)] = 100,
107):
108 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 1nopqrstuvwxyz
109 return heroes 1nopqrstuvwxyz
112@app.get("/heroes/{hero_id}", response_model=HeroPublicWithTeam) 1abcdefghijklm
113def read_hero(session: Annotated[Session, Depends(get_session)], hero_id: int): 1abcdefghijklm
114 hero = session.get(Hero, hero_id) 1nopqrstuvwxyz
115 if not hero: 1nopqrstuvwxyz
116 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz
117 return hero 1nopqrstuvwxyz
120@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 1abcdefghijklm
121def update_hero( 1abcdefghijklm
122 session: Annotated[Session, Depends(get_session)], hero_id: int, hero: HeroUpdate
123):
124 db_hero = session.get(Hero, hero_id) 1nopqrstuvwxyz
125 if not db_hero: 1nopqrstuvwxyz
126 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz
127 hero_data = hero.model_dump(exclude_unset=True) 1nopqrstuvwxyz
128 db_hero.sqlmodel_update(hero_data) 1nopqrstuvwxyz
129 session.add(db_hero) 1nopqrstuvwxyz
130 session.commit() 1nopqrstuvwxyz
131 session.refresh(db_hero) 1nopqrstuvwxyz
132 return db_hero 1nopqrstuvwxyz
135@app.delete("/heroes/{hero_id}") 1abcdefghijklm
136def delete_hero(session: Annotated[Session, Depends(get_session)], hero_id: int): 1abcdefghijklm
137 hero = session.get(Hero, hero_id) 1nopqrstuvwxyz
138 if not hero: 1nopqrstuvwxyz
139 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz
140 session.delete(hero) 1nopqrstuvwxyz
141 session.commit() 1nopqrstuvwxyz
142 return {"ok": True} 1nopqrstuvwxyz
145@app.post("/teams/", response_model=TeamPublic) 1abcdefghijklm
146def create_team(session: Annotated[Session, Depends(get_session)], team: TeamCreate): 1abcdefghijklm
147 db_team = Team.model_validate(team) 1nopqrstuvwxyz
148 session.add(db_team) 1nopqrstuvwxyz
149 session.commit() 1nopqrstuvwxyz
150 session.refresh(db_team) 1nopqrstuvwxyz
151 return db_team 1nopqrstuvwxyz
154@app.get("/teams/", response_model=list[TeamPublic]) 1abcdefghijklm
155def read_teams( 1abcdefghijklm
156 session: Annotated[Session, Depends(get_session)],
157 offset: int = 0,
158 limit: Annotated[int, Query(le=100)] = 100,
159):
160 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 1nopqrstuvwxyz
161 return teams 1nopqrstuvwxyz
164@app.get("/teams/{team_id}", response_model=TeamPublicWithHeroes) 1abcdefghijklm
165def read_team(team_id: int, session: Annotated[Session, Depends(get_session)]): 1abcdefghijklm
166 team = session.get(Team, team_id) 1nopqrstuvwxyz
167 if not team: 1nopqrstuvwxyz
168 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz
169 return team 1nopqrstuvwxyz
172@app.patch("/teams/{team_id}", response_model=TeamPublic) 1abcdefghijklm
173def update_team( 1abcdefghijklm
174 session: Annotated[Session, Depends(get_session)],
175 team_id: int,
176 team: TeamUpdate,
177):
178 db_team = session.get(Team, team_id) 1nopqrstuvwxyz
179 if not db_team: 1nopqrstuvwxyz
180 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz
181 team_data = team.model_dump(exclude_unset=True) 1nopqrstuvwxyz
182 db_team.sqlmodel_update(team_data) 1nopqrstuvwxyz
183 session.add(db_team) 1nopqrstuvwxyz
184 session.commit() 1nopqrstuvwxyz
185 session.refresh(db_team) 1nopqrstuvwxyz
186 return db_team 1nopqrstuvwxyz
189@app.delete("/teams/{team_id}") 1abcdefghijklm
190def delete_team(session: Annotated[Session, Depends(get_session)], team_id: int): 1abcdefghijklm
191 team = session.get(Team, team_id) 1nopqrstuvwxyz
192 if not team: 1nopqrstuvwxyz
193 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz
194 session.delete(team) 1nopqrstuvwxyz
195 session.commit() 1nopqrstuvwxyz
196 return {"ok": True} 1nopqrstuvwxyz