Coverage for docs_src/tutorial/fastapi/teams/tutorial001.py: 100%
120 statements
« prev ^ index » next coverage.py v7.6.12, created at 2025-03-07 05:42 +0000
1from typing import List, Optional 1gabcdef
3from fastapi import Depends, FastAPI, HTTPException, Query 1gabcdef
4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1gabcdef
7class TeamBase(SQLModel): 1gabcdef
8 name: str = Field(index=True) 1gabcdef
9 headquarters: str 1gabcdef
12class Team(TeamBase, table=True): 1gabcdef
13 id: Optional[int] = Field(default=None, primary_key=True) 1gabcdef
15 heroes: List["Hero"] = Relationship(back_populates="team") 1gabcdef
18class TeamCreate(TeamBase): 1gabcdef
19 pass 1gabcdef
22class TeamPublic(TeamBase): 1gabcdef
23 id: int 1gabcdef
26class TeamUpdate(SQLModel): 1gabcdef
27 name: Optional[str] = None 1gabcdef
28 headquarters: Optional[str] = None 1gabcdef
31class HeroBase(SQLModel): 1gabcdef
32 name: str = Field(index=True) 1gabcdef
33 secret_name: str 1gabcdef
34 age: Optional[int] = Field(default=None, index=True) 1gabcdef
36 team_id: Optional[int] = Field(default=None, foreign_key="team.id") 1gabcdef
39class Hero(HeroBase, table=True): 1gabcdef
40 id: Optional[int] = Field(default=None, primary_key=True) 1gabcdef
42 team: Optional[Team] = Relationship(back_populates="heroes") 1gabcdef
45class HeroPublic(HeroBase): 1gabcdef
46 id: int 1gabcdef
49class HeroCreate(HeroBase): 1gabcdef
50 pass 1gabcdef
53class HeroUpdate(SQLModel): 1gabcdef
54 name: Optional[str] = None 1gabcdef
55 secret_name: Optional[str] = None 1gabcdef
56 age: Optional[int] = None 1gabcdef
57 team_id: Optional[int] = None 1gabcdef
60sqlite_file_name = "database.db" 1gabcdef
61sqlite_url = f"sqlite:///{sqlite_file_name}" 1gabcdef
63connect_args = {"check_same_thread": False} 1gabcdef
64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1gabcdef
67def create_db_and_tables(): 1gabcdef
68 SQLModel.metadata.create_all(engine) 1gabcdef
71def get_session(): 1gabcdef
72 with Session(engine) as session: 1gabcdef
73 yield session 1gabcdef
76app = FastAPI() 1gabcdef
79@app.on_event("startup") 1gabcdef
80def on_startup(): 1abcdef
81 create_db_and_tables() 1gabcdef
84@app.post("/heroes/", response_model=HeroPublic) 1gabcdef
85def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 1gabcdef
86 db_hero = Hero.model_validate(hero) 1gabcdef
87 session.add(db_hero) 1gabcdef
88 session.commit() 1gabcdef
89 session.refresh(db_hero) 1gabcdef
90 return db_hero 1gabcdef
93@app.get("/heroes/", response_model=List[HeroPublic]) 1gabcdef
94def read_heroes( 1abcdef
95 *,
96 session: Session = Depends(get_session),
97 offset: int = 0,
98 limit: int = Query(default=100, le=100),
99):
100 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 1gabcdef
101 return heroes 1gabcdef
104@app.get("/heroes/{hero_id}", response_model=HeroPublic) 1gabcdef
105def read_hero(*, session: Session = Depends(get_session), hero_id: int): 1gabcdef
106 hero = session.get(Hero, hero_id) 1gabcdef
107 if not hero: 1gabcdef
108 raise HTTPException(status_code=404, detail="Hero not found") 1gabcdef
109 return hero 1gabcdef
112@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 1gabcdef
113def update_hero( 1abcdef
114 *, session: Session = Depends(get_session), hero_id: int, hero: HeroUpdate
115):
116 db_hero = session.get(Hero, hero_id) 1gabcdef
117 if not db_hero: 1gabcdef
118 raise HTTPException(status_code=404, detail="Hero not found") 1gabcdef
119 hero_data = hero.model_dump(exclude_unset=True) 1gabcdef
120 for key, value in hero_data.items(): 1gabcdef
121 setattr(db_hero, key, value) 1gabcdef
122 session.add(db_hero) 1gabcdef
123 session.commit() 1gabcdef
124 session.refresh(db_hero) 1gabcdef
125 return db_hero 1gabcdef
128@app.delete("/heroes/{hero_id}") 1gabcdef
129def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 1gabcdef
130 hero = session.get(Hero, hero_id) 1gabcdef
131 if not hero: 1gabcdef
132 raise HTTPException(status_code=404, detail="Hero not found") 1gabcdef
133 session.delete(hero) 1gabcdef
134 session.commit() 1gabcdef
135 return {"ok": True} 1gabcdef
138@app.post("/teams/", response_model=TeamPublic) 1gabcdef
139def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 1gabcdef
140 db_team = Team.model_validate(team) 1gabcdef
141 session.add(db_team) 1gabcdef
142 session.commit() 1gabcdef
143 session.refresh(db_team) 1gabcdef
144 return db_team 1gabcdef
147@app.get("/teams/", response_model=List[TeamPublic]) 1gabcdef
148def read_teams( 1abcdef
149 *,
150 session: Session = Depends(get_session),
151 offset: int = 0,
152 limit: int = Query(default=100, le=100),
153):
154 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 1gabcdef
155 return teams 1gabcdef
158@app.get("/teams/{team_id}", response_model=TeamPublic) 1gabcdef
159def read_team(*, team_id: int, session: Session = Depends(get_session)): 1gabcdef
160 team = session.get(Team, team_id) 1gabcdef
161 if not team: 1gabcdef
162 raise HTTPException(status_code=404, detail="Team not found") 1gabcdef
163 return team 1gabcdef
166@app.patch("/teams/{team_id}", response_model=TeamPublic) 1gabcdef
167def update_team( 1abcdef
168 *,
169 session: Session = Depends(get_session),
170 team_id: int,
171 team: TeamUpdate,
172):
173 db_team = session.get(Team, team_id) 1gabcdef
174 if not db_team: 1gabcdef
175 raise HTTPException(status_code=404, detail="Team not found") 1gabcdef
176 team_data = team.model_dump(exclude_unset=True) 1gabcdef
177 for key, value in team_data.items(): 1gabcdef
178 setattr(db_team, key, value) 1gabcdef
179 session.add(db_team) 1gabcdef
180 session.commit() 1gabcdef
181 session.refresh(db_team) 1gabcdef
182 return db_team 1gabcdef
185@app.delete("/teams/{team_id}") 1gabcdef
186def delete_team(*, session: Session = Depends(get_session), team_id: int): 1gabcdef
187 team = session.get(Team, team_id) 1gabcdef
188 if not team: 1gabcdef
189 raise HTTPException(status_code=404, detail="Team not found") 1gabcdef
190 session.delete(team) 1gabcdef
191 session.commit() 1gabcdef
192 return {"ok": True} 1gabcdef