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

118 statements  

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

1from typing import Annotated 1abcdefghijklm

2 

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

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1abcdefghijklm

5 

6 

7class TeamBase(SQLModel): 1abcdefghijklm

8 name: str = Field(index=True) 1abcdefghijklm

9 headquarters: str 1abcdefghijklm

10 

11 

12class Team(TeamBase, table=True): 1abcdefghijklm

13 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm

14 

15 heroes: list["Hero"] = Relationship(back_populates="team") 1abcdefghijklm

16 

17 

18class TeamCreate(TeamBase): 1abcdefghijklm

19 pass 1abcdefghijklm

20 

21 

22class TeamPublic(TeamBase): 1abcdefghijklm

23 id: int 1abcdefghijklm

24 

25 

26class TeamUpdate(SQLModel): 1abcdefghijklm

27 name: str | None = None 1abcdefghijklm

28 headquarters: str | None = None 1abcdefghijklm

29 

30 

31class HeroBase(SQLModel): 1abcdefghijklm

32 name: str = Field(index=True) 1abcdefghijklm

33 secret_name: str 1abcdefghijklm

34 age: int | None = Field(default=None, index=True) 1abcdefghijklm

35 

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

37 

38 

39class Hero(HeroBase, table=True): 1abcdefghijklm

40 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm

41 

42 team: Team | None = Relationship(back_populates="heroes") 1abcdefghijklm

43 

44 

45class HeroPublic(HeroBase): 1abcdefghijklm

46 id: int 1abcdefghijklm

47 

48 

49class HeroCreate(HeroBase): 1abcdefghijklm

50 pass 1abcdefghijklm

51 

52 

53class HeroUpdate(SQLModel): 1abcdefghijklm

54 name: str | None = None 1abcdefghijklm

55 secret_name: str | None = None 1abcdefghijklm

56 age: int | None = None 1abcdefghijklm

57 team_id: int | None = None 1abcdefghijklm

58 

59 

60sqlite_file_name = "database.db" 1abcdefghijklm

61sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcdefghijklm

62 

63connect_args = {"check_same_thread": False} 1abcdefghijklm

64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcdefghijklm

65 

66 

67def create_db_and_tables(): 1abcdefghijklm

68 SQLModel.metadata.create_all(engine) 1nopqrstuvwxyz

69 

70 

71def get_session(): 1abcdefghijklm

72 with Session(engine) as session: 1nopqrstuvwxyz

73 yield session 1nopqrstuvwxyz

74 

75 

76app = FastAPI() 1abcdefghijklm

77 

78 

79@app.on_event("startup") 1abcdefghijklm

80def on_startup(): 1abcdefghijklm

81 create_db_and_tables() 1nopqrstuvwxyz

82 

83 

84@app.post("/heroes/", response_model=HeroPublic) 1abcdefghijklm

85def create_hero(session: Annotated[Session, Depends(get_session)], hero: HeroCreate): 1abcdefghijklm

86 db_hero = Hero.model_validate(hero) 1nopqrstuvwxyz

87 session.add(db_hero) 1nopqrstuvwxyz

88 session.commit() 1nopqrstuvwxyz

89 session.refresh(db_hero) 1nopqrstuvwxyz

90 return db_hero 1nopqrstuvwxyz

91 

92 

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

94def read_heroes( 1abcdefghijklm

95 session: Annotated[Session, Depends(get_session)], 

96 offset: int = 0, 

97 limit: Annotated[int, Query(le=100)] = 100, 

98): 

99 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 1nopqrstuvwxyz

100 return heroes 1nopqrstuvwxyz

101 

102 

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

104def read_hero(session: Annotated[Session, Depends(get_session)], hero_id: int): 1abcdefghijklm

105 hero = session.get(Hero, hero_id) 1nopqrstuvwxyz

106 if not hero: 1nopqrstuvwxyz

107 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz

108 return hero 1nopqrstuvwxyz

109 

110 

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

112def update_hero( 1abcdefghijklm

113 session: Annotated[Session, Depends(get_session)], hero_id: int, hero: HeroUpdate 

114): 

115 db_hero = session.get(Hero, hero_id) 1nopqrstuvwxyz

116 if not db_hero: 1nopqrstuvwxyz

117 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz

118 hero_data = hero.model_dump(exclude_unset=True) 1nopqrstuvwxyz

119 db_hero.sqlmodel_update(hero_data) 1nopqrstuvwxyz

120 session.add(db_hero) 1nopqrstuvwxyz

121 session.commit() 1nopqrstuvwxyz

122 session.refresh(db_hero) 1nopqrstuvwxyz

123 return db_hero 1nopqrstuvwxyz

124 

125 

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

127def delete_hero(session: Annotated[Session, Depends(get_session)], hero_id: int): 1abcdefghijklm

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

129 if not hero: 1nopqrstuvwxyz

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

131 session.delete(hero) 1nopqrstuvwxyz

132 session.commit() 1nopqrstuvwxyz

133 return {"ok": True} 1nopqrstuvwxyz

134 

135 

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

137def create_team(session: Annotated[Session, Depends(get_session)], team: TeamCreate): 1abcdefghijklm

138 db_team = Team.model_validate(team) 1nopqrstuvwxyz

139 session.add(db_team) 1nopqrstuvwxyz

140 session.commit() 1nopqrstuvwxyz

141 session.refresh(db_team) 1nopqrstuvwxyz

142 return db_team 1nopqrstuvwxyz

143 

144 

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

146def read_teams( 1abcdefghijklm

147 session: Annotated[Session, Depends(get_session)], 

148 offset: int = 0, 

149 limit: Annotated[int, Query(le=100)] = 100, 

150): 

151 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 1nopqrstuvwxyz

152 return teams 1nopqrstuvwxyz

153 

154 

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

156def read_team(team_id: int, session: Annotated[Session, Depends(get_session)]): 1abcdefghijklm

157 team = session.get(Team, team_id) 1nopqrstuvwxyz

158 if not team: 1nopqrstuvwxyz

159 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz

160 return team 1nopqrstuvwxyz

161 

162 

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

164def update_team( 1abcdefghijklm

165 session: Annotated[Session, Depends(get_session)], 

166 team_id: int, 

167 team: TeamUpdate, 

168): 

169 db_team = session.get(Team, team_id) 1nopqrstuvwxyz

170 if not db_team: 1nopqrstuvwxyz

171 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz

172 team_data = team.model_dump(exclude_unset=True) 1nopqrstuvwxyz

173 db_team.sqlmodel_update(team_data) 1nopqrstuvwxyz

174 session.add(db_team) 1nopqrstuvwxyz

175 session.commit() 1nopqrstuvwxyz

176 session.refresh(db_team) 1nopqrstuvwxyz

177 return db_team 1nopqrstuvwxyz

178 

179 

180@app.delete("/teams/{team_id}") 1abcdefghijklm

181def delete_team(session: Annotated[Session, Depends(get_session)], team_id: int): 1abcdefghijklm

182 team = session.get(Team, team_id) 1nopqrstuvwxyz

183 if not team: 1nopqrstuvwxyz

184 raise HTTPException(status_code=404, detail="Team not found") 1nopqrstuvwxyz

185 session.delete(team) 1nopqrstuvwxyz

186 session.commit() 1nopqrstuvwxyz

187 return {"ok": True} 1nopqrstuvwxyz