Starlette 中提出了一種配置的方案，封裝了簡單的 Environ 環(huán)境變量類和 Config 配置文件類。
而這種方案在FastAPI中沒有被沿用，其選擇了Pydantic中的專用配置方案。
https://fastapi.tiangolo.com/advanced/settings/
https://pydantic-docs.helpmanual.io/usage/settings/
列一個簡單的例子
.env
ADMIN_EMAIL="deadpool@example.com"
APP_NAME="ChimichangApp"
settings.py
from pydantic import BaseSettings
class Settings(BaseSettings):
app_name: str = "Awesome API"
admin_email: str
items_per_user: int = 50
class Config:
env_file = ".env"
settings = Settings()
print(settings.app_name)
得到結果"ChimichangApp"
Pydantic 的好處是可以進行類型驗證，我們在.env加一條items_per_user="str"
而類型標注中items_per_user為int類型，我們會得到如下錯誤
pydantic.error_wrappers.ValidationError: 1 validation error for Settings
items_per_user
value is not a valid integer (type=type_error.integer)
但如果我們將其改為items_per_user="123"，即便是str類型，但是Pydantic 還是會嘗試將其解析為int，且順利通過。
這里我們必須要實例化
這些類都是經(jīng)過metaclass的操作的，"表里不一" 是他們的特點，實際上例如Settings.app_name并不存在。
您可以在包中實例化一個出來(如上)，在外部只需引入settings即可。
在此之外還有第二種使用方式
FastAPI 官方的案例是:
@lru_cache()
def get_settings():
return config.Settings()
@app.get("/info")
async def info(settings: config.Settings = Depends(get_settings)):
return {
"app_name": settings.app_name,
"admin_email": settings.admin_email,
"items_per_user": settings.items_per_user,
}
這里開了個工廠函數(shù)用作依賴，而@lru_cache()是為了防止每次調用都要生成一個實例，浪費資源。這樣settings實例會根據(jù)不同情況進行定制化。
例如在main.py中，admin_email為.env文件中的值。如果在其他模塊中的settings，期望可以不用.env的值。我們就可以在模塊中寫一個新的get_settings()
@lru_cache()
def get_settings_override():
return config.Settings(admin_email="testing_admin@example.com")
下面寫個例子
settings.py
class APISettings(BaseSettings):
server_host: str = "127.0.0.1"
server_port: int = 8000
debug: bool = False
routes: Optional[List[BaseRoute]] = None
title: str = "FastAPI"
description: str = ""
version: str = "0.0.1"
openapi_url: Optional[str] = "/openapi.json"
openapi_tags: Optional[List[Dict[str, Any]]] = None
servers: Optional[List[Dict[str, Union[str, Any]]]] = None
default_response_class: Type[Response] = ORJSONResponse
docs_url: Optional[str] = "/docs"
redoc_url: Optional[str] = "/redoc"
swagger_ui_oauth2_redirect_url: Optional[str] = "/docs/oauth2-redirect"
swagger_ui_init_oauth: Optional[dict] = None
middleware: Optional[Sequence[Middleware]] = None
exception_handlers: Optional[Dict[Union[int, Type[Exception]], Callable]] = None
on_startup: Optional[Sequence[Callable]] = None
on_shutdown: Optional[Sequence[Callable]] = None
openapi_prefix: str = ""
root_path: str = ""
root_path_in_servers: bool = True
class Config:
env_file = ".env"
env_file_encoding = 'utf-8'
.env
SERVER_HOST="127.0.0.1"
SERVER_PORT=8888
TITLE="OhhhhAPI"
VERSION="1.1.4"
main.py
settings = APISettings()
app = FastAPI(
version=settings.version,
title=settings.title,
default_response_class=settings.default_response_class
)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, host=settings.server_host, port=settings.server_port)
總結
.env文件擁有pydantic很好的支持，是FastAPI官方推薦的格式。它相比其他格式的配置文件，優(yōu)缺點都很明顯。例如其對復雜數(shù)據(jù)結構的支持，不如py，json，yaml等格式。但其簡潔明了的優(yōu)點也十分明顯。
