fastapi dependencies

[yeomko22]

Dependency Injection

• 아래와 같은 상황에 사용하는 프로그래밍 기법
  • shared logic
  • share database connections
  • security, authentification, role requirements

from typing import Optional

from fastapi import Depends, FastAPI

app = FastAPI()

async def common_parameters(q: Optional[str] = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit}

@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
    return commons

@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters())):
    return commons

• Depends를 이용해서 common_parameters 함수에 의존성을 추가함. 마치 Body, Query 등을 쓰는 것과 똑같음
• items나 users로 새로운 요청이 들어올 경우 먼저 dependency를 호출한다.
• 즉, 특정 path operation 단에서는 이것이 의존하고 있는 것을 지정만 하면 FastAPI가 이를 수행하고, 그 결과값만 해당 path operation에 주입해주게 된다. 이를 의존성 주입이라고 한다.
• dependency injection을 의미하는 다른 용어들로는 아래와 같은 것들이 있다.
  • resources
  • providers
  • services
  • injectables
  • components

[yeomko22]

Classes as Dependencies

• dependency의 핵심은 callable이다.
• python에서는 function 뿐만 아니라 class도 callable하다.
• 따라서 class도 dependency가 될 수 있다.

  
  from typing import Optional

from fastapi import Depends, FastAPI

app = FastAPI()

fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]

class CommonQueryParams: def init(self, q: Optional[str] = None, skip: int = 0, limit: int = 100): self.q = q self.skip = skip self.limit = limit

@app.get("/items/") async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)): response = {} if commons.q: response.update({"q": commons.q}) items = fake_items_db[commons.skip: commons.skip + commons.limit] response.update({"items": items}) return response

- 이 경우에는 의존하는 CommonQueryParams 클래스의 생성자 함수가 read_items 호춟보다 먼저 이루어진다.

[yeomko22]

sub-dependencies

• dependency로 잡혀있는 영역에서 다른 dependency를 다시 호출 가능하다.
• 이를 subdependency라고 부른다.

  
  from typing import Optional

from fastapi import Cookie, Depends, FastAPI

app = FastAPI()

def query_extractor(q: Optional[str] = None): print('query_extractor') return q

def query_or_cookie_extractor(q: str = Depends(query_extractor), last_query: Optional[str] = Cookie(None)): print('query or cookie extractor') if not q: return last_query return q

@app.get("/items/") async def read_query(query_or_default: str = Depends(query_or_cookie_extractor)): print('items') return {"q_or_cookie": query_or_default}

[yeomko22]

Dependencies in path operation decorators

from fastapi import Depends, FastAPI, Header, HTTPException

app = FastAPI()

async def verify_token(x_token: str = Header(...)):
    if x_token != "fake-super-secret-token":
        raise HTTPException(status_code=400, detail="X-Token header invalid")

async def verify_key(x_key: str = Header(...)):
    if x_key != "fake-super-secret-key":
        raise HTTPException(status_code=400, detail="X-Key header invalid")
    return x_key

@app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)])
async def read_items():
    return [{"item": "Foo"}, {"item": "Bar"}]

• url을 지정해주는 곳에 Depends list를 넣어주면 해당 path operation 시작 전에 토큰 검사 등을 수행할 수 있다.
• 사용자 인증 등을 이런 식으로 구현해 줄 수 있을듯