如何初始化全局对象或变量并在每个 FastAPI 端点中重用它?

2024-12-09 08:30:00
admin
原创
249
摘要:问题描述:我有一个用于发送通知的类。初始化时,它涉及与通知服务器建立连接,这很耗时。我使用 FastAPI 中的后台任务来发送通知,因为我不想由于通知而延迟响应。以下是示例代码。file1.py: noticlient = NotificationClient() @app.post("/{dat...

问题描述:

我有一个用于发送通知的类。初始化时,它涉及与通知服务器建立连接,这很耗时。我使用 FastAPI 中的后台任务来发送通知,因为我不想由于通知而延迟响应。以下是示例代码。

file1.py:
noticlient = NotificationClient()

@app.post("/{data}")
def send_msg(somemsg: str, background_tasks: BackgroundTasks):
    result = add_some_tasks(data, background_tasks, noticlient)
    return result

file2.py:
def add_some_tasks(data, background_tasks: BackgroundTasks, noticlient):
    background_tasks.add_task(noticlient.send, param1, param2)
    result = some_operation
    return result

file2.py这里,通知客户端是全局声明的。我可以在下初始化它add_some_tasks,但每次收到请求时它都会被初始化,这需要一些时间。有没有办法使用中间件在每次收到请求时重新使用它,这样就不需要每次都初始化它了。

或方法二:在 class def 中初始化通知

file1.py:
class childFastApi(FastAPI):
    noticlient = NotificationClient()

app = childFastApi()

@app.post("/{data}")
def send_msg(somemsg: str, background_tasks: BackgroundTasks):
    result = add_some_tasks(data, background_tasks, app.noticlient)
    return result

解决方案 1:

选项 1

您可以将自定义类对象存储到应用程序实例中,这样您就可以使用通用属性存储任意额外状态,如此处以及此处和此处app.state所示。要访问主文件外部的属性,然后访问对象(例如,从使用 的子模块),您可以使用对象,如此答案中所示(即使用)。您可以使用事件(如此处所示)来初始化对象,但由于它现在已被弃用(并且可能会在未来版本中删除),因此您可以改用函数。app.state`routersAPIRouterRequestrequest.app.statestartup`lifespan

例子

from fastapi import FastAPI, Request
from contextlib import asynccontextmanager


@asynccontextmanager
async def lifespan(app: FastAPI):
    ''' Run at startup
        Initialize the Client and add it to app.state
    '''
    app.state.n_client = NotificationClient()
    yield
    ''' Run on shutdown
        Close the connection
        Clear variables and release the resources
    '''
    app.state.n_client.close()


app = FastAPI(lifespan=lifespan)


@app.get('/')
async def main(request: Request):
    n_client = request.app.state.n_client
    # ...

选项 2

自从引入了 Starlette 的lifespan处理程序以来,它与startup事件shutdown处理程序类似,允许定义在应用程序启动前或应用程序关闭时需要运行的代码,还可以定义可从 访问的对象request.state。根据Starlette 的文档:

有的lifespan概念state,它是一个字典,可以用来在生命周期和请求之间共享对象。

state请求上接收到的是生命周期处理程序上接收到的状态的浅表副本。

因此,在生命周期处理程序中实例化类对象后,您可以将其添加到字典(即state),并使用在端点内访问它 - 即使是在APIRouter主应用程序文件之外的 s中定义的端点request.state

例子

from fastapi import FastAPI, Request
from contextlib import asynccontextmanager


@asynccontextmanager
async def lifespan(app: FastAPI):
    ''' Run at startup
        Initialize the Client and add it to request.state
    '''
    n_client = NotificationClient()
    yield {'n_client': n_client}
    ''' Run on shutdown
        Close the connection
        Clear variables and release the resources
    '''
    n_client.close()


app = FastAPI(lifespan=lifespan)


@app.get('/')
async def main(request: Request):
    n_client = request.state.n_client
    # ...
相关推荐
  政府信创国产化的10大政策解读一、信创国产化的背景与意义信创国产化,即信息技术应用创新国产化,是当前中国信息技术领域的一个重要发展方向。其核心在于通过自主研发和创新,实现信息技术应用的自主可控,减少对外部技术的依赖,并规避潜在的技术制裁和风险。随着全球信息技术竞争的加剧,以及某些国家对中国在科技领域的打压,信创国产化显...
工程项目管理   1590  
  为什么项目管理通常仍然耗时且低效?您是否还在反复更新电子表格、淹没在便利贴中并参加每周更新会议?这确实是耗费时间和精力。借助软件工具的帮助,您可以一目了然地全面了解您的项目。如今,国内外有足够多优秀的项目管理软件可以帮助您掌控每个项目。什么是项目管理软件?项目管理软件是广泛行业用于项目规划、资源分配和调度的软件。它使项...
项目管理软件   1361  
  信创产品在政府采购中的占比分析随着信息技术的飞速发展以及国家对信息安全重视程度的不断提高,信创产业应运而生并迅速崛起。信创,即信息技术应用创新,旨在实现信息技术领域的自主可控,减少对国外技术的依赖,保障国家信息安全。政府采购作为推动信创产业发展的重要力量,其对信创产品的采购占比情况备受关注。这不仅关系到信创产业的发展前...
信创和国产化的区别   18  
  信创,即信息技术应用创新产业,旨在实现信息技术领域的自主可控,摆脱对国外技术的依赖。近年来,国货国用信创发展势头迅猛,在诸多领域取得了显著成果。这一发展趋势对科技创新产生了深远的推动作用,不仅提升了我国在信息技术领域的自主创新能力,还为经济社会的数字化转型提供了坚实支撑。信创推动核心技术突破信创产业的发展促使企业和科研...
信创工作   18  
  信创技术,即信息技术应用创新产业,旨在实现信息技术领域的自主可控与安全可靠。近年来,信创技术发展迅猛,对中小企业产生了深远的影响,带来了诸多不可忽视的价值。在数字化转型的浪潮中,中小企业面临着激烈的市场竞争和复杂多变的环境,信创技术的出现为它们提供了新的发展机遇和支撑。信创技术对中小企业的影响技术架构变革信创技术促使中...
信创国产化   19  
热门文章
项目管理软件有哪些?
云禅道AD
禅道项目管理软件

云端的项目管理软件

尊享禅道项目软件收费版功能

无需维护,随时随地协同办公

内置subversion和git源码管理

每天备份,随时转为私有部署

免费试用