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

124 statements  

« prev     ^ index     » next       coverage.py v7.7.1, created at 2025-03-24 00:02 +0000

1from fastapi import Depends, FastAPI, HTTPException, Query 1abcd

2from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1abcd

3 

4 

5class TeamBase(SQLModel): 1abcd

6 name: str = Field(index=True) 1abcd

7 headquarters: str 1abcd

8 

9 

10class Team(TeamBase, table=True): 1abcd

11 id: int | None = Field(default=None, primary_key=True) 1abcd

12 

13 heroes: list["Hero"] = Relationship(back_populates="team") 1abcd

14 

15 

16class TeamCreate(TeamBase): 1abcd

17 pass 1abcd

18 

19 

20class TeamPublic(TeamBase): 1abcd

21 id: int 1abcd

22 

23 

24class TeamUpdate(SQLModel): 1abcd

25 id: int | None = None 1abcd

26 name: str | None = None 1abcd

27 headquarters: str | None = None 1abcd

28 

29 

30class HeroBase(SQLModel): 1abcd

31 name: str = Field(index=True) 1abcd

32 secret_name: str 1abcd

33 age: int | None = Field(default=None, index=True) 1abcd

34 

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

36 

37 

38class Hero(HeroBase, table=True): 1abcd

39 id: int | None = Field(default=None, primary_key=True) 1abcd

40 

41 team: Team | None = Relationship(back_populates="heroes") 1abcd

42 

43 

44class HeroPublic(HeroBase): 1abcd

45 id: int 1abcd

46 

47 

48class HeroCreate(HeroBase): 1abcd

49 pass 1abcd

50 

51 

52class HeroUpdate(SQLModel): 1abcd

53 name: str | None = None 1abcd

54 secret_name: str | None = None 1abcd

55 age: int | None = None 1abcd

56 team_id: int | None = None 1abcd

57 

58 

59class HeroPublicWithTeam(HeroPublic): 1abcd

60 team: TeamPublic | None = None 1abcd

61 

62 

63class TeamPublicWithHeroes(TeamPublic): 1abcd

64 heroes: list[HeroPublic] = [] 1abcd

65 

66 

67sqlite_file_name = "database.db" 1abcd

68sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcd

69 

70connect_args = {"check_same_thread": False} 1abcd

71engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcd

72 

73 

74def create_db_and_tables(): 1abcd

75 SQLModel.metadata.create_all(engine) 1abcd

76 

77 

78def get_session(): 1abcd

79 with Session(engine) as session: 1abcd

80 yield session 1abcd

81 

82 

83app = FastAPI() 1abcd

84 

85 

86@app.on_event("startup") 1abcd

87def on_startup(): 1abcd

88 create_db_and_tables() 1abcd

89 

90 

91@app.post("/heroes/", response_model=HeroPublic) 1abcd

92def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 1abcd

93 db_hero = Hero.model_validate(hero) 1abcd

94 session.add(db_hero) 1abcd

95 session.commit() 1abcd

96 session.refresh(db_hero) 1abcd

97 return db_hero 1abcd

98 

99 

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

101def read_heroes( 1abcd

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() 1abcd

108 return heroes 1abcd

109 

110 

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

112def read_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcd

113 hero = session.get(Hero, hero_id) 1abcd

114 if not hero: 1abcd

115 raise HTTPException(status_code=404, detail="Hero not found") 1abcd

116 return hero 1abcd

117 

118 

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

120def update_hero( 1abcd

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

122): 

123 db_hero = session.get(Hero, hero_id) 1abcd

124 if not db_hero: 1abcd

125 raise HTTPException(status_code=404, detail="Hero not found") 1abcd

126 hero_data = hero.model_dump(exclude_unset=True) 1abcd

127 for key, value in hero_data.items(): 1abcd

128 setattr(db_hero, key, value) 1abcd

129 session.add(db_hero) 1abcd

130 session.commit() 1abcd

131 session.refresh(db_hero) 1abcd

132 return db_hero 1abcd

133 

134 

135@app.delete("/heroes/{hero_id}") 1abcd

136def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcd

137 hero = session.get(Hero, hero_id) 1abcd

138 if not hero: 1abcd

139 raise HTTPException(status_code=404, detail="Hero not found") 1abcd

140 session.delete(hero) 1abcd

141 session.commit() 1abcd

142 return {"ok": True} 1abcd

143 

144 

145@app.post("/teams/", response_model=TeamPublic) 1abcd

146def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 1abcd

147 db_team = Team.model_validate(team) 1abcd

148 session.add(db_team) 1abcd

149 session.commit() 1abcd

150 session.refresh(db_team) 1abcd

151 return db_team 1abcd

152 

153 

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

155def read_teams( 1abcd

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() 1abcd

162 return teams 1abcd

163 

164 

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

166def read_team(*, team_id: int, session: Session = Depends(get_session)): 1abcd

167 team = session.get(Team, team_id) 1abcd

168 if not team: 1abcd

169 raise HTTPException(status_code=404, detail="Team not found") 1abcd

170 return team 1abcd

171 

172 

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

174def update_team( 1abcd

175 *, 

176 session: Session = Depends(get_session), 

177 team_id: int, 

178 team: TeamUpdate, 

179): 

180 db_team = session.get(Team, team_id) 1abcd

181 if not db_team: 1abcd

182 raise HTTPException(status_code=404, detail="Team not found") 1abcd

183 team_data = team.model_dump(exclude_unset=True) 1abcd

184 for key, value in team_data.items(): 1abcd

185 setattr(db_team, key, value) 1abcd

186 session.add(db_team) 1abcd

187 session.commit() 1abcd

188 session.refresh(db_team) 1abcd

189 return db_team 1abcd

190 

191 

192@app.delete("/teams/{team_id}") 1abcd

193def delete_team(*, session: Session = Depends(get_session), team_id: int): 1abcd

194 team = session.get(Team, team_id) 1abcd

195 if not team: 1abcd

196 raise HTTPException(status_code=404, detail="Team not found") 1abcd

197 session.delete(team) 1abcd

198 session.commit() 1abcd

199 return {"ok": True} 1abcd