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

119 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 name: str | None = None 1abcd

26 headquarters: str | None = None 1abcd

27 

28 

29class HeroBase(SQLModel): 1abcd

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

31 secret_name: str 1abcd

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

33 

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

35 

36 

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

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

39 

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

41 

42 

43class HeroPublic(HeroBase): 1abcd

44 id: int 1abcd

45 

46 

47class HeroCreate(HeroBase): 1abcd

48 pass 1abcd

49 

50 

51class HeroUpdate(SQLModel): 1abcd

52 name: str | None = None 1abcd

53 secret_name: str | None = None 1abcd

54 age: int | None = None 1abcd

55 team_id: int | None = None 1abcd

56 

57 

58sqlite_file_name = "database.db" 1abcd

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

60 

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

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

63 

64 

65def create_db_and_tables(): 1abcd

66 SQLModel.metadata.create_all(engine) 1abcd

67 

68 

69def get_session(): 1abcd

70 with Session(engine) as session: 1abcd

71 yield session 1abcd

72 

73 

74app = FastAPI() 1abcd

75 

76 

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

78def on_startup(): 1abcd

79 create_db_and_tables() 1abcd

80 

81 

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

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

84 db_hero = Hero.model_validate(hero) 1abcd

85 session.add(db_hero) 1abcd

86 session.commit() 1abcd

87 session.refresh(db_hero) 1abcd

88 return db_hero 1abcd

89 

90 

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

92def read_heroes( 1abcd

93 *, 

94 session: Session = Depends(get_session), 

95 offset: int = 0, 

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

97): 

98 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 1abcd

99 return heroes 1abcd

100 

101 

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

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

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

105 if not hero: 1abcd

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

107 return hero 1abcd

108 

109 

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

111def update_hero( 1abcd

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

113): 

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

115 if not db_hero: 1abcd

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

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

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

119 setattr(db_hero, key, value) 1abcd

120 session.add(db_hero) 1abcd

121 session.commit() 1abcd

122 session.refresh(db_hero) 1abcd

123 return db_hero 1abcd

124 

125 

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

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

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

129 if not hero: 1abcd

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

131 session.delete(hero) 1abcd

132 session.commit() 1abcd

133 return {"ok": True} 1abcd

134 

135 

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

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

138 db_team = Team.model_validate(team) 1abcd

139 session.add(db_team) 1abcd

140 session.commit() 1abcd

141 session.refresh(db_team) 1abcd

142 return db_team 1abcd

143 

144 

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

146def read_teams( 1abcd

147 *, 

148 session: Session = Depends(get_session), 

149 offset: int = 0, 

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

151): 

152 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 1abcd

153 return teams 1abcd

154 

155 

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

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

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

159 if not team: 1abcd

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

161 return team 1abcd

162 

163 

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

165def update_team( 1abcd

166 *, 

167 session: Session = Depends(get_session), 

168 team_id: int, 

169 team: TeamUpdate, 

170): 

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

172 if not db_team: 1abcd

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

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

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

176 setattr(db_team, key, value) 1abcd

177 session.add(db_team) 1abcd

178 session.commit() 1abcd

179 session.refresh(db_team) 1abcd

180 return db_team 1abcd

181 

182 

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

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

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

186 if not team: 1abcd

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

188 session.delete(team) 1abcd

189 session.commit() 1abcd

190 return {"ok": True} 1abcd