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

1from typing import List, Optional 10 ctx1abcdefghij

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 10 ctx1abcdefghij

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 10 ctx1abcdefghij

5 

6 

7class TeamBase(SQLModel): 10 ctx1abcdefghij

8 name: str = Field(index=True) 10 ctx1abcdefghij

9 headquarters: str 10 ctx1abcdefghij

10 

11 

12class Team(TeamBase, table=True): 10 ctx1abcdefghij

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

14 

15 heroes: List["Hero"] = Relationship(back_populates="team") 10 ctx1abcdefghij

16 

17 

18class TeamCreate(TeamBase): 10 ctx1abcdefghij

19 pass 10 ctx1abcdefghij

20 

21 

22class TeamPublic(TeamBase): 10 ctx1abcdefghij

23 id: int 10 ctx1abcdefghij

24 

25 

26class TeamUpdate(SQLModel): 10 ctx1abcdefghij

27 id: Optional[int] = None 10 ctx1abcdefghij

28 name: Optional[str] = None 10 ctx1abcdefghij

29 headquarters: Optional[str] = None 10 ctx1abcdefghij

30 

31 

32class HeroBase(SQLModel): 10 ctx1abcdefghij

33 name: str = Field(index=True) 10 ctx1abcdefghij

34 secret_name: str 10 ctx1abcdefghij

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

36 

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

38 

39 

40class Hero(HeroBase, table=True): 10 ctx1abcdefghij

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

42 

43 team: Optional[Team] = Relationship(back_populates="heroes") 10 ctx1abcdefghij

44 

45 

46class HeroPublic(HeroBase): 10 ctx1abcdefghij

47 id: int 10 ctx1abcdefghij

48 

49 

50class HeroCreate(HeroBase): 10 ctx1abcdefghij

51 pass 10 ctx1abcdefghij

52 

53 

54class HeroUpdate(SQLModel): 10 ctx1abcdefghij

55 name: Optional[str] = None 10 ctx1abcdefghij

56 secret_name: Optional[str] = None 10 ctx1abcdefghij

57 age: Optional[int] = None 10 ctx1abcdefghij

58 team_id: Optional[int] = None 10 ctx1abcdefghij

59 

60 

61class HeroPublicWithTeam(HeroPublic): 10 ctx1abcdefghij

62 team: Optional[TeamPublic] = None 10 ctx1abcdefghij

63 

64 

65class TeamPublicWithHeroes(TeamPublic): 10 ctx1abcdefghij

66 heroes: List[HeroPublic] = [] 10 ctx1abcdefghij

67 

68 

69sqlite_file_name = "database.db" 10 ctx1abcdefghij

70sqlite_url = f"sqlite:///{sqlite_file_name}" 10 ctx1abcdefghij

71 

72connect_args = {"check_same_thread": False} 10 ctx1abcdefghij

73engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 10 ctx1abcdefghij

74 

75 

76def create_db_and_tables(): 10 ctx1abcdefghij

77 SQLModel.metadata.create_all(engine) 10 ctx1abcdefghij

78 

79 

80def get_session(): 10 ctx1abcdefghij

81 with Session(engine) as session: 10 ctx1abcdefghij

82 yield session 10 ctx1abcdefghij

83 

84 

85app = FastAPI() 10 ctx1abcdefghij

86 

87 

88@app.on_event("startup") 10 ctx1abcdefghij

89def on_startup(): 10 ctx1abcdefghij

90 create_db_and_tables() 10 ctx1abcdefghij

91 

92 

93@app.post("/heroes/", response_model=HeroPublic) 10 ctx1abcdefghij

94def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 10 ctx1abcdefghij

95 db_hero = Hero.model_validate(hero) 10 ctx1abcdefghij

96 session.add(db_hero) 10 ctx1abcdefghij

97 session.commit() 10 ctx1abcdefghij

98 session.refresh(db_hero) 10 ctx1abcdefghij

99 return db_hero 10 ctx1abcdefghij

100 

101 

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

103def read_heroes( 10 ctx1abcdefghij

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() 10 ctx1abcdefghij

110 return heroes 10 ctx1abcdefghij

111 

112 

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

114def read_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

115 hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

116 if not hero: 10 ctx1abcdefghij

117 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

118 return hero 10 ctx1abcdefghij

119 

120 

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

122def update_hero( 10 ctx1abcdefghij

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

124): 

125 db_hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

126 if not db_hero: 10 ctx1abcdefghij

127 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

128 hero_data = hero.model_dump(exclude_unset=True) 10 ctx1abcdefghij

129 db_hero.sqlmodel_update(hero_data) 10 ctx1abcdefghij

130 session.add(db_hero) 10 ctx1abcdefghij

131 session.commit() 10 ctx1abcdefghij

132 session.refresh(db_hero) 10 ctx1abcdefghij

133 return db_hero 10 ctx1abcdefghij

134 

135 

136@app.delete("/heroes/{hero_id}") 10 ctx1abcdefghij

137def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

138 hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

139 if not hero: 10 ctx1abcdefghij

140 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

141 session.delete(hero) 10 ctx1abcdefghij

142 session.commit() 10 ctx1abcdefghij

143 return {"ok": True} 10 ctx1abcdefghij

144 

145 

146@app.post("/teams/", response_model=TeamPublic) 10 ctx1abcdefghij

147def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 10 ctx1abcdefghij

148 db_team = Team.model_validate(team) 10 ctx1abcdefghij

149 session.add(db_team) 10 ctx1abcdefghij

150 session.commit() 10 ctx1abcdefghij

151 session.refresh(db_team) 10 ctx1abcdefghij

152 return db_team 10 ctx1abcdefghij

153 

154 

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

156def read_teams( 10 ctx1abcdefghij

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() 10 ctx1abcdefghij

163 return teams 10 ctx1abcdefghij

164 

165 

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

167def read_team(*, team_id: int, session: Session = Depends(get_session)): 10 ctx1abcdefghij

168 team = session.get(Team, team_id) 10 ctx1abcdefghij

169 if not team: 10 ctx1abcdefghij

170 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

171 return team 10 ctx1abcdefghij

172 

173 

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

175def update_team( 10 ctx1abcdefghij

176 *, 

177 session: Session = Depends(get_session), 

178 team_id: int, 

179 team: TeamUpdate, 

180): 

181 db_team = session.get(Team, team_id) 10 ctx1abcdefghij

182 if not db_team: 10 ctx1abcdefghij

183 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

184 team_data = team.model_dump(exclude_unset=True) 10 ctx1abcdefghij

185 db_team.sqlmodel_update(team_data) 10 ctx1abcdefghij

186 session.add(db_team) 10 ctx1abcdefghij

187 session.commit() 10 ctx1abcdefghij

188 session.refresh(db_team) 10 ctx1abcdefghij

189 return db_team 10 ctx1abcdefghij

190 

191 

192@app.delete("/teams/{team_id}") 10 ctx1abcdefghij

193def delete_team(*, session: Session = Depends(get_session), team_id: int): 10 ctx1abcdefghij

194 team = session.get(Team, team_id) 10 ctx1abcdefghij

195 if not team: 10 ctx1abcdefghij

196 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

197 session.delete(team) 10 ctx1abcdefghij

198 session.commit() 10 ctx1abcdefghij

199 return {"ok": True} 10 ctx1abcdefghij