main.py

# -*- coding: utf-8 -*-
# @version        : 1.0
# @Create Time    : 2021/10/19 15:47
# @File           : main.py
# @IDE            : PyCharm
# @desc           : 主程序入口

"""
FastApi 更新文档：https://github.com/tiangolo/fastapi/releases
FastApi Github：https://github.com/tiangolo/fastapi
Typer 官方文档：https://typer.tiangolo.com/
"""
#FastAPI进行http
from fastapi import FastAPI
import uvicorn
#cors工具
from starlette.middleware.cors import CORSMiddleware #异步的web框架支持 cors
from applicatiion import settings
from applicatiion.urls import urlpatterns
from starlette.staticfiles import StaticFiles  # 依赖安装：pip install aiofiles
from core.docs import custom_api_docs
from core.exception import register_exception
import typer
from scripts.initialize.initialize import InitializeData, Environment
#异步事件循环机制
import asyncio
from scripts.create_app.main import CreateApp
from core.event import lifespan
from utils.tools import import_modules
shell_app = typer.Typer()
def create_app():
    """
    启动项目
    docs_url：配置交互文档的路由地址，如果禁用则为None，默认为 /docs
    redoc_url： 配置 Redoc 文档的路由地址，如果禁用则为None，默认为 /redoc
    openapi_url：配置接口文件json数据文件路由地址，如果禁用则为None，默认为/openapi.json
    """
    app = FastAPI(title="Kinit",description="本项目基于Fastapi与Vue3+Typescript+Vite4+element-plus的基础项目，前端基于vue-element-plus-admin框架开发",
                  version=settings.VERSION,lifespan=lifespan,
                  docs_url=None,redoc_url=None)
    #类似Java中的filter模块功能，就是对请求在进行业务代码之前进行验证
    import_modules(settings.MIDDLEWARES, "中间件", app=app)
    # 全局异常捕捉处理
    register_exception(app) #不同的异常返回不同的消息类型 Json
    # 跨域解决前端和后端通信需要，后端之间不需要
    if settings.CORS_ORIGIN_ENABLE:
        app.add_middleware(CORSMiddleware,allow_origins=settings.ALLOW_ORIGINS,
            allow_credentials=settings.ALLOW_CREDENTIALS,
            allow_methods=settings.ALLOW_METHODS,
            allow_headers=settings.ALLOW_HEADERS
        )
    # 挂在静态目录,类似使用nginx代理文件服务 js css html image file等等 类似tomcat也能实现静态文件的访问
    if settings.STATIC_ENABLE:
        app.mount(settings.STATIC_URL, app=StaticFiles(directory=settings.STATIC_ROOT))
    if settings.TEMP_ENABLE:
        app.mount(settings.TEMP_URL, app=StaticFiles(directory=settings.TEMP_DIR))
    # 引入应用中的路由
    for url in urlpatterns:
        app.include_router(url["ApiRouter"], prefix=url["prefix"], tags=url["tags"])
    # 配置接口文档静态资源
    custom_api_docs(app)
    return app

@shell_app.command()
def run(host: str = typer.Option(default='0.0.0.0', help='监听主机IP，默认开放给本网络所有主机'),port: int = typer.Option(default=9999, help='监听端口')
):
    """
    启动项目
    factory: 在使用 uvicorn.run() 启动 ASGI 应用程序时，可以通过设置 factory 参数来指定应用程序工厂。
    应用程序工厂是一个返回 ASGI 应用程序实例的可调用对象，它可以在启动时动态创建应用程序实例。
    """
    print("host:{host}+port:{port}".format(host=host,port=port))
    uvicorn.run(app='main:create_app', host=host, port=port, lifespan="on", factory=True,reload=True)

@shell_app.command()
def init(env: Environment = Environment.pro):
    """
    初始化数据
    在执行前一定要确认要操作的环境与application/settings.DEBUG 设置的环境是一致的，
    不然会导致创建表和生成数据不在一个数据库中！！！！！！！！！！！！！！！！！！！！！！
    比如要初始化开发环境，那么env参数应该为 dev，并且 application/settings.DEBUG 应该 = True
    比如要初始化生产环境，那么env参数应该为 pro，并且 application/settings.DEBUG 应该 = False
    :param env: 数据库环境
    """
    print("开始初始化数据")
    #data类的初始化实例
    data = InitializeData()
    asyncio.run(data.run(env))

@shell_app.command()
def migrate(env: Environment = Environment.pro):
    print(env)
    """
    将模型迁移到数据库，更新数据库表结构
    :param env: 数据库环境
    """
    print("开始更新数据库表")
    InitializeData.migrate_model(env)

@shell_app.command()
def init_app(path: str):
    """
    自动创建初始化 APP 结构
    命令例子：python main.py init-app vadmin/test
    :param path: app 路径，根目录为apps，填写apps后面路径即可，例子：vadmin/auth
    """
    print(f"开始创建并初始化 {path} APP")
    app = CreateApp(path)
    app.run()

@shell_app.command()
def gen_app():
    # from apps.llm.rag.models.doc import RagDoc
    from apps.llm.agent.models import Agent
    from scripts.crud_generate.main import CrudGenerate
    crud = CrudGenerate(Agent,"智能体文档","llm_agent")
    crud.main()

if __name__ == '__main__':
    shell_app()