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

122 statements  

« prev     ^ index     » next       coverage.py v7.13.0, created at 2026-11-09 00:02 +0000

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

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

3 

4 

5class TeamBase(SQLModel): 1abcdefghi

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

7 headquarters: str 1abcdefghi

8 

9 

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

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

12 

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

14 

15 

16class TeamCreate(TeamBase): 1abcdefghi

17 pass 1abcdefghi

18 

19 

20class TeamPublic(TeamBase): 1abcdefghi

21 id: int 1abcdefghi

22 

23 

24class TeamUpdate(SQLModel): 1abcdefghi

25 id: int | None = None 1abcdefghi

26 name: str | None = None 1abcdefghi

27 headquarters: str | None = None 1abcdefghi

28 

29 

30class HeroBase(SQLModel): 1abcdefghi

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

32 secret_name: str 1abcdefghi

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

34 

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

36 

37 

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

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

40 

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

42 

43 

44class HeroPublic(HeroBase): 1abcdefghi

45 id: int 1abcdefghi

46 

47 

48class HeroCreate(HeroBase): 1abcdefghi

49 pass 1abcdefghi

50 

51 

52class HeroUpdate(SQLModel): 1abcdefghi

53 name: str | None = None 1abcdefghi

54 secret_name: str | None = None 1abcdefghi

55 age: int | None = None 1abcdefghi

56 team_id: int | None = None 1abcdefghi

57 

58 

59class HeroPublicWithTeam(HeroPublic): 1abcdefghi

60 team: TeamPublic | None = None 1abcdefghi

61 

62 

63class TeamPublicWithHeroes(TeamPublic): 1abcdefghi

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

65 

66 

67sqlite_file_name = "database.db" 1abcdefghi

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

69 

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

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

72 

73 

74def create_db_and_tables(): 1abcdefghi

75 SQLModel.metadata.create_all(engine) 1jklmnopqr

76 

77 

78def get_session(): 1abcdefghi

79 with Session(engine) as session: 1jklmnopqr

80 yield session 1jklmnopqr

81 

82 

83app = FastAPI() 1abcdefghi

84 

85 

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

87def on_startup(): 1abcdefghi

88 create_db_and_tables() 1jklmnopqr

89 

90 

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

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

93 db_hero = Hero.model_validate(hero) 1jklmnopqr

94 session.add(db_hero) 1jklmnopqr

95 session.commit() 1jklmnopqr

96 session.refresh(db_hero) 1jklmnopqr

97 return db_hero 1jklmnopqr

98 

99 

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

101def read_heroes( 1abcdefghi

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

108 return heroes 1jklmnopqr

109 

110 

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

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

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

114 if not hero: 1jklmnopqr

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

116 return hero 1jklmnopqr

117 

118 

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

120def update_hero( 1abcdefghi

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

122): 

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

124 if not db_hero: 1jklmnopqr

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

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

127 db_hero.sqlmodel_update(hero_data) 1jklmnopqr

128 session.add(db_hero) 1jklmnopqr

129 session.commit() 1jklmnopqr

130 session.refresh(db_hero) 1jklmnopqr

131 return db_hero 1jklmnopqr

132 

133 

134@app.delete("/heroes/{hero_id}") 1abcdefghi

135def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcdefghi

136 hero = session.get(Hero, hero_id) 1jklmnopqr

137 if not hero: 1jklmnopqr

138 raise HTTPException(status_code=404, detail="Hero not found") 1jklmnopqr

139 session.delete(hero) 1jklmnopqr

140 session.commit() 1jklmnopqr

141 return {"ok": True} 1jklmnopqr

142 

143 

144@app.post("/teams/", response_model=TeamPublic) 1abcdefghi

145def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 1abcdefghi

146 db_team = Team.model_validate(team) 1jklmnopqr

147 session.add(db_team) 1jklmnopqr

148 session.commit() 1jklmnopqr

149 session.refresh(db_team) 1jklmnopqr

150 return db_team 1jklmnopqr

151 

152 

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

154def read_teams( 1abcdefghi

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

161 return teams 1jklmnopqr

162 

163 

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

165def read_team(*, team_id: int, session: Session = Depends(get_session)): 1abcdefghi

166 team = session.get(Team, team_id) 1jklmnopqr

167 if not team: 1jklmnopqr

168 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

169 return team 1jklmnopqr

170 

171 

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

173def update_team( 1abcdefghi

174 *, 

175 session: Session = Depends(get_session), 

176 team_id: int, 

177 team: TeamUpdate, 

178): 

179 db_team = session.get(Team, team_id) 1jklmnopqr

180 if not db_team: 1jklmnopqr

181 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

182 team_data = team.model_dump(exclude_unset=True) 1jklmnopqr

183 db_team.sqlmodel_update(team_data) 1jklmnopqr

184 session.add(db_team) 1jklmnopqr

185 session.commit() 1jklmnopqr

186 session.refresh(db_team) 1jklmnopqr

187 return db_team 1jklmnopqr

188 

189 

190@app.delete("/teams/{team_id}") 1abcdefghi

191def delete_team(*, session: Session = Depends(get_session), team_id: int): 1abcdefghi

192 team = session.get(Team, team_id) 1jklmnopqr

193 if not team: 1jklmnopqr

194 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

195 session.delete(team) 1jklmnopqr

196 session.commit() 1jklmnopqr

197 return {"ok": True} 1jklmnopqr