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

1from typing import List, Optional 10 ctx1abcdefghij

2 

3from fastapi import Depends, 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 

42def get_session(): 10 ctx1abcdefghij

43 with Session(engine) as session: 10 ctx1abcdefghij

44 yield session 10 ctx1abcdefghij

45 

46 

47app = FastAPI() 10 ctx1abcdefghij

48 

49 

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

51def on_startup(): 10 ctx1abcdefghij

52 create_db_and_tables() 10 ctx1abcdefghij

53 

54 

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

56def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 10 ctx1abcdefghij

57 db_hero = Hero.model_validate(hero) 10 ctx1abcdefghij

58 session.add(db_hero) 10 ctx1abcdefghij

59 session.commit() 10 ctx1abcdefghij

60 session.refresh(db_hero) 10 ctx1abcdefghij

61 return db_hero 10 ctx1abcdefghij

62 

63 

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

65def read_heroes( 10 ctx1abcdefghij

66 *, 

67 session: Session = Depends(get_session), 

68 offset: int = 0, 

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

70): 

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

72 return heroes 10 ctx1abcdefghij

73 

74 

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

76def read_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

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

78 if not hero: 10 ctx1abcdefghij

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

80 return hero 10 ctx1abcdefghij

81 

82 

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

84def update_hero( 10 ctx1abcdefghij

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

86): 

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

88 if not db_hero: 10 ctx1abcdefghij

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

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

91 db_hero.sqlmodel_update(hero_data) 10 ctx1abcdefghij

92 session.add(db_hero) 10 ctx1abcdefghij

93 session.commit() 10 ctx1abcdefghij

94 session.refresh(db_hero) 10 ctx1abcdefghij

95 return db_hero 10 ctx1abcdefghij

96 

97 

98@app.delete("/heroes/{hero_id}") 10 ctx1abcdefghij

99def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

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

101 if not hero: 10 ctx1abcdefghij

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

103 session.delete(hero) 10 ctx1abcdefghij

104 session.commit() 10 ctx1abcdefghij

105 return {"ok": True} 10 ctx1abcdefghij