Coverage for docs_src/tutorial/fastapi/relationships/tutorial001.py: 100%

1from typing import List, Optional 6 ctx1abcdef

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 6 ctx1abcdef

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 6 ctx1abcdef

5 

6 

7class TeamBase(SQLModel): 6 ctx1abcdef

8 name: str = Field(index=True) 6 ctx1abcdef

9 headquarters: str 6 ctx1abcdef

10 

11 

12class Team(TeamBase, table=True): 6 ctx1abcdef

13 id: Optional[int] = Field(default=None, primary_key=True) 6 ctx1abcdef

14 

15 heroes: List["Hero"] = Relationship(back_populates="team") 6 ctx1abcdef

16 

17 

18class TeamCreate(TeamBase): 6 ctx1abcdef

19 pass 6 ctx1abcdef

20 

21 

22class TeamPublic(TeamBase): 6 ctx1abcdef

23 id: int 6 ctx1abcdef

24 

25 

26class TeamUpdate(SQLModel): 6 ctx1abcdef

27 id: Optional[int] = None 6 ctx1abcdef

28 name: Optional[str] = None 6 ctx1abcdef

29 headquarters: Optional[str] = None 6 ctx1abcdef

30 

31 

32class HeroBase(SQLModel): 6 ctx1abcdef

33 name: str = Field(index=True) 6 ctx1abcdef

34 secret_name: str 6 ctx1abcdef

35 age: Optional[int] = Field(default=None, index=True) 6 ctx1abcdef

36 

37 team_id: Optional[int] = Field(default=None, foreign_key="team.id") 6 ctx1abcdef

38 

39 

40class Hero(HeroBase, table=True): 6 ctx1abcdef

41 id: Optional[int] = Field(default=None, primary_key=True) 6 ctx1abcdef

42 

43 team: Optional[Team] = Relationship(back_populates="heroes") 6 ctx1abcdef

44 

45 

46class HeroPublic(HeroBase): 6 ctx1abcdef

47 id: int 6 ctx1abcdef

48 

49 

50class HeroCreate(HeroBase): 6 ctx1abcdef

51 pass 6 ctx1abcdef

52 

53 

54class HeroUpdate(SQLModel): 6 ctx1abcdef

55 name: Optional[str] = None 6 ctx1abcdef

56 secret_name: Optional[str] = None 6 ctx1abcdef

57 age: Optional[int] = None 6 ctx1abcdef

58 team_id: Optional[int] = None 6 ctx1abcdef

59 

60 

61class HeroPublicWithTeam(HeroPublic): 6 ctx1abcdef

62 team: Optional[TeamPublic] = None 6 ctx1abcdef

63 

64 

65class TeamPublicWithHeroes(TeamPublic): 6 ctx1abcdef

66 heroes: List[HeroPublic] = [] 6 ctx1abcdef

67 

68 

69sqlite_file_name = "database.db" 6 ctx1abcdef

70sqlite_url = f"sqlite:///{sqlite_file_name}" 6 ctx1abcdef

71 

72connect_args = {"check_same_thread": False} 6 ctx1abcdef

73engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 6 ctx1abcdef

74 

75 

76def create_db_and_tables(): 6 ctx1abcdef

77 SQLModel.metadata.create_all(engine) 6 ctx1abcdef

78 

79 

80def get_session(): 6 ctx1abcdef

81 with Session(engine) as session: 6 ctx1abcdef

82 yield session 6 ctx1abcdef

83 

84 

85app = FastAPI() 6 ctx1abcdef

86 

87 

88@app.on_event("startup") 6 ctx1abcdef

89def on_startup(): 6 ctx1abcdef

90 create_db_and_tables() 6 ctx1abcdef

91 

92 

93@app.post("/heroes/", response_model=HeroPublic) 6 ctx1abcdef

94def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 6 ctx1abcdef

95 db_hero = Hero.model_validate(hero) 6 ctx1abcdef

96 session.add(db_hero) 6 ctx1abcdef

97 session.commit() 6 ctx1abcdef

98 session.refresh(db_hero) 6 ctx1abcdef

99 return db_hero 6 ctx1abcdef

100 

101 

102@app.get("/heroes/", response_model=List[HeroPublic]) 6 ctx1abcdef

103def read_heroes( 6 ctx1abcdef

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() 6 ctx1abcdef

110 return heroes 6 ctx1abcdef

111 

112 

113@app.get("/heroes/{hero_id}", response_model=HeroPublicWithTeam) 6 ctx1abcdef

114def read_hero(*, session: Session = Depends(get_session), hero_id: int): 6 ctx1abcdef

115 hero = session.get(Hero, hero_id) 6 ctx1abcdef

116 if not hero: 6 ctx1abcdef

117 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1abcdef

118 return hero 6 ctx1abcdef

119 

120 

121@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 6 ctx1abcdef

122def update_hero( 6 ctx1abcdef

123 *, session: Session = Depends(get_session), hero_id: int, hero: HeroUpdate 

124): 

125 db_hero = session.get(Hero, hero_id) 6 ctx1abcdef

126 if not db_hero: 6 ctx1abcdef

127 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1abcdef

128 hero_data = hero.model_dump(exclude_unset=True) 6 ctx1abcdef

129 db_hero.sqlmodel_update(hero_data) 6 ctx1abcdef

130 session.add(db_hero) 6 ctx1abcdef

131 session.commit() 6 ctx1abcdef

132 session.refresh(db_hero) 6 ctx1abcdef

133 return db_hero 6 ctx1abcdef

134 

135 

136@app.delete("/heroes/{hero_id}") 6 ctx1abcdef

137def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 6 ctx1abcdef

138 hero = session.get(Hero, hero_id) 6 ctx1abcdef

139 if not hero: 6 ctx1abcdef

140 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1abcdef

141 session.delete(hero) 6 ctx1abcdef

142 session.commit() 6 ctx1abcdef

143 return {"ok": True} 6 ctx1abcdef

144 

145 

146@app.post("/teams/", response_model=TeamPublic) 6 ctx1abcdef

147def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 6 ctx1abcdef

148 db_team = Team.model_validate(team) 6 ctx1abcdef

149 session.add(db_team) 6 ctx1abcdef

150 session.commit() 6 ctx1abcdef

151 session.refresh(db_team) 6 ctx1abcdef

152 return db_team 6 ctx1abcdef

153 

154 

155@app.get("/teams/", response_model=List[TeamPublic]) 6 ctx1abcdef

156def read_teams( 6 ctx1abcdef

157 *, 

158 session: Session = Depends(get_session), 

159 offset: int = 0, 

160 limit: int = Query(default=100, le=100), 

161): 

162 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 6 ctx1abcdef

163 return teams 6 ctx1abcdef

164 

165 

166@app.get("/teams/{team_id}", response_model=TeamPublicWithHeroes) 6 ctx1abcdef

167def read_team(*, team_id: int, session: Session = Depends(get_session)): 6 ctx1abcdef

168 team = session.get(Team, team_id) 6 ctx1abcdef

169 if not team: 6 ctx1abcdef

170 raise HTTPException(status_code=404, detail="Team not found") 6 ctx1abcdef

171 return team 6 ctx1abcdef

172 

173 

174@app.patch("/teams/{team_id}", response_model=TeamPublic) 6 ctx1abcdef

175def update_team( 6 ctx1abcdef

176 *, 

177 session: Session = Depends(get_session), 

178 team_id: int, 

179 team: TeamUpdate, 

180): 

181 db_team = session.get(Team, team_id) 6 ctx1abcdef

182 if not db_team: 6 ctx1abcdef

183 raise HTTPException(status_code=404, detail="Team not found") 6 ctx1abcdef

184 team_data = team.model_dump(exclude_unset=True) 6 ctx1abcdef

185 db_team.sqlmodel_update(team_data) 6 ctx1abcdef

186 session.add(db_team) 6 ctx1abcdef

187 session.commit() 6 ctx1abcdef

188 session.refresh(db_team) 6 ctx1abcdef

189 return db_team 6 ctx1abcdef

190 

191 

192@app.delete("/teams/{team_id}") 6 ctx1abcdef

193def delete_team(*, session: Session = Depends(get_session), team_id: int): 6 ctx1abcdef

194 team = session.get(Team, team_id) 6 ctx1abcdef

195 if not team: 6 ctx1abcdef

196 raise HTTPException(status_code=404, detail="Team not found") 6 ctx1abcdef

197 session.delete(team) 6 ctx1abcdef

198 session.commit() 6 ctx1abcdef

199 return {"ok": True} 6 ctx1abcdef