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