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

1from fastapi import Depends, FastAPI, HTTPException, Query 8 ctx1abcdefgh

2from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 8 ctx1abcdefgh

3 

4 

5class TeamBase(SQLModel): 8 ctx1abcdefgh

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

7 headquarters: str 8 ctx1abcdefgh

8 

9 

10class Team(TeamBase, table=True): 8 ctx1abcdefgh

11 id: int | None = Field(default=None, primary_key=True) 8 ctx1abcdefgh

12 

13 heroes: list["Hero"] = Relationship(back_populates="team") 8 ctx1abcdefgh

14 

15 

16class TeamCreate(TeamBase): 8 ctx1abcdefgh

17 pass 8 ctx1abcdefgh

18 

19 

20class TeamPublic(TeamBase): 8 ctx1abcdefgh

21 id: int 8 ctx1abcdefgh

22 

23 

24class TeamUpdate(SQLModel): 8 ctx1abcdefgh

25 id: int | None = None 8 ctx1abcdefgh

26 name: str | None = None 8 ctx1abcdefgh

27 headquarters: str | None = None 8 ctx1abcdefgh

28 

29 

30class HeroBase(SQLModel): 8 ctx1abcdefgh

31 name: str = Field(index=True) 8 ctx1abcdefgh

32 secret_name: str 8 ctx1abcdefgh

33 age: int | None = Field(default=None, index=True) 8 ctx1abcdefgh

34 

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

36 

37 

38class Hero(HeroBase, table=True): 8 ctx1abcdefgh

39 id: int | None = Field(default=None, primary_key=True) 8 ctx1abcdefgh

40 

41 team: Team | None = Relationship(back_populates="heroes") 8 ctx1abcdefgh

42 

43 

44class HeroPublic(HeroBase): 8 ctx1abcdefgh

45 id: int 8 ctx1abcdefgh

46 

47 

48class HeroCreate(HeroBase): 8 ctx1abcdefgh

49 pass 8 ctx1abcdefgh

50 

51 

52class HeroUpdate(SQLModel): 8 ctx1abcdefgh

53 name: str | None = None 8 ctx1abcdefgh

54 secret_name: str | None = None 8 ctx1abcdefgh

55 age: int | None = None 8 ctx1abcdefgh

56 team_id: int | None = None 8 ctx1abcdefgh

57 

58 

59class HeroPublicWithTeam(HeroPublic): 8 ctx1abcdefgh

60 team: TeamPublic | None = None 8 ctx1abcdefgh

61 

62 

63class TeamPublicWithHeroes(TeamPublic): 8 ctx1abcdefgh

64 heroes: list[HeroPublic] = [] 8 ctx1abcdefgh

65 

66 

67sqlite_file_name = "database.db" 8 ctx1abcdefgh

68sqlite_url = f"sqlite:///{sqlite_file_name}" 8 ctx1abcdefgh

69 

70connect_args = {"check_same_thread": False} 8 ctx1abcdefgh

71engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 8 ctx1abcdefgh

72 

73 

74def create_db_and_tables(): 8 ctx1abcdefgh

75 SQLModel.metadata.create_all(engine) 8 ctx1ijklmnop

76 

77 

78def get_session(): 8 ctx1abcdefgh

79 with Session(engine) as session: 8 ctx1ijklmnop

80 yield session 8 ctx1ijklmnop

81 

82 

83app = FastAPI() 8 ctx1abcdefgh

84 

85 

86@app.on_event("startup") 8 ctx1abcdefgh

87def on_startup(): 8 ctx1abcdefgh

88 create_db_and_tables() 8 ctx1ijklmnop

89 

90 

91@app.post("/heroes/", response_model=HeroPublic) 8 ctx1abcdefgh

92def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 8 ctx1abcdefgh

93 db_hero = Hero.model_validate(hero) 8 ctx1ijklmnop

94 session.add(db_hero) 8 ctx1ijklmnop

95 session.commit() 8 ctx1ijklmnop

96 session.refresh(db_hero) 8 ctx1ijklmnop

97 return db_hero 8 ctx1ijklmnop

98 

99 

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

101def read_heroes( 8 ctx1abcdefgh

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() 8 ctx1ijklmnop

108 return heroes 8 ctx1ijklmnop

109 

110 

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

112def read_hero(*, session: Session = Depends(get_session), hero_id: int): 8 ctx1abcdefgh

113 hero = session.get(Hero, hero_id) 8 ctx1ijklmnop

114 if not hero: 8 ctx1ijklmnop

115 raise HTTPException(status_code=404, detail="Hero not found") 8 ctx1ijklmnop

116 return hero 8 ctx1ijklmnop

117 

118 

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

120def update_hero( 8 ctx1abcdefgh

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

122): 

123 db_hero = session.get(Hero, hero_id) 8 ctx1ijklmnop

124 if not db_hero: 8 ctx1ijklmnop

125 raise HTTPException(status_code=404, detail="Hero not found") 8 ctx1ijklmnop

126 hero_data = hero.model_dump(exclude_unset=True) 8 ctx1ijklmnop

127 db_hero.sqlmodel_update(hero_data) 8 ctx1ijklmnop

128 session.add(db_hero) 8 ctx1ijklmnop

129 session.commit() 8 ctx1ijklmnop

130 session.refresh(db_hero) 8 ctx1ijklmnop

131 return db_hero 8 ctx1ijklmnop

132 

133 

134@app.delete("/heroes/{hero_id}") 8 ctx1abcdefgh

135def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 8 ctx1abcdefgh

136 hero = session.get(Hero, hero_id) 8 ctx1ijklmnop

137 if not hero: 8 ctx1ijklmnop

138 raise HTTPException(status_code=404, detail="Hero not found") 8 ctx1ijklmnop

139 session.delete(hero) 8 ctx1ijklmnop

140 session.commit() 8 ctx1ijklmnop

141 return {"ok": True} 8 ctx1ijklmnop

142 

143 

144@app.post("/teams/", response_model=TeamPublic) 8 ctx1abcdefgh

145def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 8 ctx1abcdefgh

146 db_team = Team.model_validate(team) 8 ctx1ijklmnop

147 session.add(db_team) 8 ctx1ijklmnop

148 session.commit() 8 ctx1ijklmnop

149 session.refresh(db_team) 8 ctx1ijklmnop

150 return db_team 8 ctx1ijklmnop

151 

152 

153@app.get("/teams/", response_model=list[TeamPublic]) 8 ctx1abcdefgh

154def read_teams( 8 ctx1abcdefgh

155 *, 

156 session: Session = Depends(get_session), 

157 offset: int = 0, 

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

159): 

160 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 8 ctx1ijklmnop

161 return teams 8 ctx1ijklmnop

162 

163 

164@app.get("/teams/{team_id}", response_model=TeamPublicWithHeroes) 8 ctx1abcdefgh

165def read_team(*, team_id: int, session: Session = Depends(get_session)): 8 ctx1abcdefgh

166 team = session.get(Team, team_id) 8 ctx1ijklmnop

167 if not team: 8 ctx1ijklmnop

168 raise HTTPException(status_code=404, detail="Team not found") 8 ctx1ijklmnop

169 return team 8 ctx1ijklmnop

170 

171 

172@app.patch("/teams/{team_id}", response_model=TeamPublic) 8 ctx1abcdefgh

173def update_team( 8 ctx1abcdefgh

174 *, 

175 session: Session = Depends(get_session), 

176 team_id: int, 

177 team: TeamUpdate, 

178): 

179 db_team = session.get(Team, team_id) 8 ctx1ijklmnop

180 if not db_team: 8 ctx1ijklmnop

181 raise HTTPException(status_code=404, detail="Team not found") 8 ctx1ijklmnop

182 team_data = team.model_dump(exclude_unset=True) 8 ctx1ijklmnop

183 db_team.sqlmodel_update(team_data) 8 ctx1ijklmnop

184 session.add(db_team) 8 ctx1ijklmnop

185 session.commit() 8 ctx1ijklmnop

186 session.refresh(db_team) 8 ctx1ijklmnop

187 return db_team 8 ctx1ijklmnop

188 

189 

190@app.delete("/teams/{team_id}") 8 ctx1abcdefgh

191def delete_team(*, session: Session = Depends(get_session), team_id: int): 8 ctx1abcdefgh

192 team = session.get(Team, team_id) 8 ctx1ijklmnop

193 if not team: 8 ctx1ijklmnop

194 raise HTTPException(status_code=404, detail="Team not found") 8 ctx1ijklmnop

195 session.delete(team) 8 ctx1ijklmnop

196 session.commit() 8 ctx1ijklmnop

197 return {"ok": True} 8 ctx1ijklmnop