FastAPI .env配置文件

Starlette 中提出了一种配置的方案，封装了简单的 Environ 环境变量类和 Config 配置文件类。

https://www.starlette.io/config/

而这种方案在FastAPI中没有被沿用，其选择了Pydantic中的专用配置方案。

https://fastapi.tiangolo.com/advanced/settings/
https://pydantic-docs.helpmanual.io/usage/settings/

列一个简单的例子

.env

ADMIN_EMAIL="[email protected]"
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，且顺利通过。

这里我们必须要实例化

这些类都是经过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,
    }

这里开了个工厂函数用作依赖，而@lru_cache()是为了防止每次调用都要生成一个实例，浪费资源。这样settings实例会根据不同情况进行定制化。
例如在main.py中，admin_email为.env文件中的值。如果在其他模块中的settings，期望可以不用.env的值。我们就可以在模块中写一个新的get_settings()

@lru_cache()
def get_settings_override():
    return config.Settings(admin_email="[email protected]")

下面写个例子

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官方推荐的格式。它相比其他格式的配置文件，优缺点都很明显。例如其对复杂数据结构的支持，不如py，json，yaml等格式。但其简洁明了的优点也十分明显。

当然，如果你不想用配置文件也无妨，因为python不需要编译，直接将配置写在代码中并不需要付出什么代价。

将APISetting中的class Config去掉即可