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

1from typing import List, Optional 10 ctx1abcdefghij

2 

3from fastapi import FastAPI, HTTPException, Query 10 ctx1abcdefghij

4from sqlmodel import Field, Session, SQLModel, create_engine, select 10 ctx1abcdefghij

5 

6 

7class HeroBase(SQLModel): 10 ctx1abcdefghij

8 name: str = Field(index=True) 10 ctx1abcdefghij

9 secret_name: str 10 ctx1abcdefghij

10 age: Optional[int] = Field(default=None, index=True) 10 ctx1abcdefghij

11 

12 

13class Hero(HeroBase, table=True): 10 ctx1abcdefghij

14 id: Optional[int] = Field(default=None, primary_key=True) 10 ctx1abcdefghij

15 

16 

17class HeroCreate(HeroBase): 10 ctx1abcdefghij

18 pass 10 ctx1abcdefghij

19 

20 

21class HeroPublic(HeroBase): 10 ctx1abcdefghij

22 id: int 10 ctx1abcdefghij

23 

24 

25class HeroUpdate(SQLModel): 10 ctx1abcdefghij

26 name: Optional[str] = None 10 ctx1abcdefghij

27 secret_name: Optional[str] = None 10 ctx1abcdefghij

28 age: Optional[int] = None 10 ctx1abcdefghij

29 

30 

31sqlite_file_name = "database.db" 10 ctx1abcdefghij

32sqlite_url = f"sqlite:///{sqlite_file_name}" 10 ctx1abcdefghij

33 

34connect_args = {"check_same_thread": False} 10 ctx1abcdefghij

35engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 10 ctx1abcdefghij

36 

37 

38def create_db_and_tables(): 10 ctx1abcdefghij

39 SQLModel.metadata.create_all(engine) 10 ctx1abcdefghij

40 

41 

42app = FastAPI() 10 ctx1abcdefghij

43 

44 

45@app.on_event("startup") 10 ctx1abcdefghij

46def on_startup(): 10 ctx1abcdefghij

47 create_db_and_tables() 10 ctx1abcdefghij

48 

49 

50@app.post("/heroes/", response_model=HeroPublic) 10 ctx1abcdefghij

51def create_hero(hero: HeroCreate): 10 ctx1abcdefghij

52 with Session(engine) as session: 10 ctx1abcdefghij

53 db_hero = Hero.model_validate(hero) 10 ctx1abcdefghij

54 session.add(db_hero) 10 ctx1abcdefghij

55 session.commit() 10 ctx1abcdefghij

56 session.refresh(db_hero) 10 ctx1abcdefghij

57 return db_hero 10 ctx1abcdefghij

58 

59 

60@app.get("/heroes/", response_model=List[HeroPublic]) 10 ctx1abcdefghij

61def read_heroes(offset: int = 0, limit: int = Query(default=100, le=100)): 10 ctx1abcdefghij

62 with Session(engine) as session: 10 ctx1abcdefghij

63 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 10 ctx1abcdefghij

64 return heroes 10 ctx1abcdefghij

65 

66 

67@app.get("/heroes/{hero_id}", response_model=HeroPublic) 10 ctx1abcdefghij

68def read_hero(hero_id: int): 10 ctx1abcdefghij

69 with Session(engine) as session: 10 ctx1abcdefghij

70 hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

71 if not hero: 10 ctx1abcdefghij

72 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

73 return hero 10 ctx1abcdefghij

74 

75 

76@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 10 ctx1abcdefghij

77def update_hero(hero_id: int, hero: HeroUpdate): 10 ctx1abcdefghij

78 with Session(engine) as session: 10 ctx1abcdefghij

79 db_hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

80 if not db_hero: 10 ctx1abcdefghij

81 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

82 hero_data = hero.model_dump(exclude_unset=True) 10 ctx1abcdefghij

83 db_hero.sqlmodel_update(hero_data) 10 ctx1abcdefghij

84 session.add(db_hero) 10 ctx1abcdefghij

85 session.commit() 10 ctx1abcdefghij

86 session.refresh(db_hero) 10 ctx1abcdefghij

87 return db_hero 10 ctx1abcdefghij