seatools-starter-server-uvicorn 1.0.2

Seatools Starter Server Uvicorn

seatools uvicorn 服务器启动器

该框架在uvicorn层完成seatools.ioc的加载, 使用该项目后无需在每个进程额外执行seatools.ioc.run函数, 仅在启动时传递一个ioc启动的函数即可

使用指南

1. 安装, poetry add seatools-starter-server-uvicorn
2. 这里以fastapi为例, 假设xxx.boot模块存在start的自定义启动ioc函数

from seatools.ioc import run


def start():
    run(scan_package_names='xxx', config_dir='./config')

命令行启动uvicorn xxx.boot:start xxx.fastapi.app:app, 其他参数与官方uvicorn一致, 在uvicorn基础上增加了一个ioc_app的参数, 需要指明ioc应用启动的函数 若配置application.yml或application-[*].yml中存在seatools.server.uvicorn.app配置, 则可不传递uvicorn的app仅传递ioc_app即可, 示例uvicorn xxx.boot:start 若同时使用了seatools-starter-web-*的web启动包, 则uvicorn的app直接可省略 3. 程序直接调用

from xxx.boot import start
from seatools.ioc.server import uvicorn


def main():
    uvicorn.run(
        start,
        'xxx.fastapi.app:app' # 配置中seatools.server.uvicorn.app存在 或 安装了seatools-starter-web-fastapi 此处可不填
    )


if __name__ == '__main__':
    main()

4. 支持配置config/application.yml

seatools:
  server:
    uvicorn:
      # 配置该参数后启动参数可忽略app参数, 配置与官方uvicorn.run一致, 若安装 seatools-starter-web-fastapi可省略app配置 
      app: xxx.fastapi.app:app
      host: 127.0.0.1
      port: 8000
      workers: 1
      # ...