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

1from fastapi import Depends, FastAPI, HTTPException, Query 3 ctx1abc

2from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 3 ctx1abc

3 

4 

5class TeamBase(SQLModel): 3 ctx1abc

6 name: str = Field(index=True) 3 ctx1abc

7 headquarters: str 3 ctx1abc

8 

9 

10class Team(TeamBase, table=True): 3 ctx1abc

11 id: int | None = Field(default=None, primary_key=True) 3 ctx1abc

12 

13 heroes: list["Hero"] = Relationship(back_populates="team") 3 ctx1abc

14 

15 

16class TeamCreate(TeamBase): 3 ctx1abc

17 pass 3 ctx1abc

18 

19 

20class TeamPublic(TeamBase): 3 ctx1abc

21 id: int 3 ctx1abc

22 

23 

24class TeamUpdate(SQLModel): 3 ctx1abc

25 id: int | None = None 3 ctx1abc

26 name: str | None = None 3 ctx1abc

27 headquarters: str | None = None 3 ctx1abc

28 

29 

30class HeroBase(SQLModel): 3 ctx1abc

31 name: str = Field(index=True) 3 ctx1abc

32 secret_name: str 3 ctx1abc

33 age: int | None = Field(default=None, index=True) 3 ctx1abc

34 

35 team_id: int | None = Field(default=None, foreign_key="team.id") 3 ctx1abc

36 

37 

38class Hero(HeroBase, table=True): 3 ctx1abc

39 id: int | None = Field(default=None, primary_key=True) 3 ctx1abc

40 

41 team: Team | None = Relationship(back_populates="heroes") 3 ctx1abc

42 

43 

44class HeroPublic(HeroBase): 3 ctx1abc

45 id: int 3 ctx1abc

46 

47 

48class HeroCreate(HeroBase): 3 ctx1abc

49 pass 3 ctx1abc

50 

51 

52class HeroUpdate(SQLModel): 3 ctx1abc

53 name: str | None = None 3 ctx1abc

54 secret_name: str | None = None 3 ctx1abc

55 age: int | None = None 3 ctx1abc

56 team_id: int | None = None 3 ctx1abc

57 

58 

59class HeroPublicWithTeam(HeroPublic): 3 ctx1abc

60 team: TeamPublic | None = None 3 ctx1abc

61 

62 

63class TeamPublicWithHeroes(TeamPublic): 3 ctx1abc

64 heroes: list[HeroPublic] = [] 3 ctx1abc

65 

66 

67sqlite_file_name = "database.db" 3 ctx1abc

68sqlite_url = f"sqlite:///{sqlite_file_name}" 3 ctx1abc

69 

70connect_args = {"check_same_thread": False} 3 ctx1abc

71engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 3 ctx1abc

72 

73 

74def create_db_and_tables(): 3 ctx1abc

75 SQLModel.metadata.create_all(engine) 3 ctx1abc

76 

77 

78def get_session(): 3 ctx1abc

79 with Session(engine) as session: 3 ctx1abc

80 yield session 3 ctx1abc

81 

82 

83app = FastAPI() 3 ctx1abc

84 

85 

86@app.on_event("startup") 3 ctx1abc

87def on_startup(): 3 ctx1abc

88 create_db_and_tables() 3 ctx1abc

89 

90 

91@app.post("/heroes/", response_model=HeroPublic) 3 ctx1abc

92def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 3 ctx1abc

93 db_hero = Hero.model_validate(hero) 3 ctx1abc

94 session.add(db_hero) 3 ctx1abc

95 session.commit() 3 ctx1abc

96 session.refresh(db_hero) 3 ctx1abc

97 return db_hero 3 ctx1abc

98 

99 

100@app.get("/heroes/", response_model=list[HeroPublic]) 3 ctx1abc

101def read_heroes( 3 ctx1abc

102 *, 

103 session: Session = Depends(get_session), 

104 offset: int = 0, 

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

106): 

107 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 3 ctx1abc

108 return heroes 3 ctx1abc

109 

110 

111@app.get("/heroes/{hero_id}", response_model=HeroPublicWithTeam) 3 ctx1abc

112def read_hero(*, session: Session = Depends(get_session), hero_id: int): 3 ctx1abc

113 hero = session.get(Hero, hero_id) 3 ctx1abc

114 if not hero: 3 ctx1abc

115 raise HTTPException(status_code=404, detail="Hero not found") 3 ctx1abc

116 return hero 3 ctx1abc

117 

118 

119@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 3 ctx1abc

120def update_hero( 3 ctx1abc

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

122): 

123 db_hero = session.get(Hero, hero_id) 3 ctx1abc

124 if not db_hero: 3 ctx1abc

125 raise HTTPException(status_code=404, detail="Hero not found") 3 ctx1abc

126 hero_data = hero.model_dump(exclude_unset=True) 3 ctx1abc

127 for key, value in hero_data.items(): 3 ctx1abc

128 setattr(db_hero, key, value) 3 ctx1abc

129 session.add(db_hero) 3 ctx1abc

130 session.commit() 3 ctx1abc

131 session.refresh(db_hero) 3 ctx1abc

132 return db_hero 3 ctx1abc

133 

134 

135@app.delete("/heroes/{hero_id}") 3 ctx1abc

136def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 3 ctx1abc

137 hero = session.get(Hero, hero_id) 3 ctx1abc

138 if not hero: 3 ctx1abc

139 raise HTTPException(status_code=404, detail="Hero not found") 3 ctx1abc

140 session.delete(hero) 3 ctx1abc

141 session.commit() 3 ctx1abc

142 return {"ok": True} 3 ctx1abc

143 

144 

145@app.post("/teams/", response_model=TeamPublic) 3 ctx1abc

146def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 3 ctx1abc

147 db_team = Team.model_validate(team) 3 ctx1abc

148 session.add(db_team) 3 ctx1abc

149 session.commit() 3 ctx1abc

150 session.refresh(db_team) 3 ctx1abc

151 return db_team 3 ctx1abc

152 

153 

154@app.get("/teams/", response_model=list[TeamPublic]) 3 ctx1abc

155def read_teams( 3 ctx1abc

156 *, 

157 session: Session = Depends(get_session), 

158 offset: int = 0, 

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

160): 

161 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 3 ctx1abc

162 return teams 3 ctx1abc

163 

164 

165@app.get("/teams/{team_id}", response_model=TeamPublicWithHeroes) 3 ctx1abc

166def read_team(*, team_id: int, session: Session = Depends(get_session)): 3 ctx1abc

167 team = session.get(Team, team_id) 3 ctx1abc

168 if not team: 3 ctx1abc

169 raise HTTPException(status_code=404, detail="Team not found") 3 ctx1abc

170 return team 3 ctx1abc

171 

172 

173@app.patch("/teams/{team_id}", response_model=TeamPublic) 3 ctx1abc

174def update_team( 3 ctx1abc

175 *, 

176 session: Session = Depends(get_session), 

177 team_id: int, 

178 team: TeamUpdate, 

179): 

180 db_team = session.get(Team, team_id) 3 ctx1abc

181 if not db_team: 3 ctx1abc

182 raise HTTPException(status_code=404, detail="Team not found") 3 ctx1abc

183 team_data = team.model_dump(exclude_unset=True) 3 ctx1abc

184 for key, value in team_data.items(): 3 ctx1abc

185 setattr(db_team, key, value) 3 ctx1abc

186 session.add(db_team) 3 ctx1abc

187 session.commit() 3 ctx1abc

188 session.refresh(db_team) 3 ctx1abc

189 return db_team 3 ctx1abc

190 

191 

192@app.delete("/teams/{team_id}") 3 ctx1abc

193def delete_team(*, session: Session = Depends(get_session), team_id: int): 3 ctx1abc

194 team = session.get(Team, team_id) 3 ctx1abc

195 if not team: 3 ctx1abc

196 raise HTTPException(status_code=404, detail="Team not found") 3 ctx1abc

197 session.delete(team) 3 ctx1abc

198 session.commit() 3 ctx1abc

199 return {"ok": True} 3 ctx1abc