lifespan works not predictable, I think it should add some hooks.

[lyha23]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google "How to X in FastAPI" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from fastapi import Depends, Request, FastAPI
from contextlib import asynccontextmanager
from core import settings
from starlette.middleware.authentication import AuthenticationMiddleware
from middleware.jwt_auth_middleware import JwtAuthMiddleware


@asynccontextmanager
async def register_init(app: FastAPI):
    yield

def create_app() -> FastAPI:
    app = FastAPI(
        debug=settings.DEBUG,
        title=settings.TITLE,
        description=settings.DESCRIPTION,
        docs_url=settings.DOCS_URL,
        redoc_url=settings.REDOC_URL,
        lifespan=register_init,
    )
    init_connect(app)
    register_middleware(app)
    register_router(app)
    register_exception(app)
    return app

def init_connect(app: FastAPI):
    register_tortoise(
        app,
        config=settings.DATABASE_CONFIG,
        generate_schemas=True,  # True 表示连接数据库的时候同步创建表
        add_exception_handlers=True,
    )
    logger.info("start server and register_tortoise")

def register_middleware(app: FastAPI) -> None:
    app.add_middleware(
        AuthenticationMiddleware,
        backend=JwtAuthMiddleware(),
        on_error=JwtAuthMiddleware.auth_exception_handler,
    )

Description

I use a tortoise model in AuthenticationMiddleware, where JwtAuthMiddleware is customed by myself. But it report wrong as below.
I read some answer that says my tortoise-orm has not been initialized.

2024-05-01 01:53:10.682 | ERROR    | middleware.jwt_auth_middleware:authenticate:88 - 'NoneType' object is not iterable
Traceback (most recent call last):

  File "<string>", line 1, in <module>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/multiprocessing/spawn.py", line 116, in spawn_main
    exitcode = _main(fd, parent_sentinel)
               │     │   └ 5
               │     └ 11
               └ <function _main at 0x7f44ac1f0700>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/multiprocessing/spawn.py", line 129, in _main
    return self._bootstrap(parent_sentinel)
           │    │          └ 5
           │    └ <function BaseProcess._bootstrap at 0x7f44acd93760>
           └ <SpawnProcess name='SpawnProcess-20' parent=827779 started>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/multiprocessing/process.py", line 314, in _bootstrap
    self.run()
    │    └ <function BaseProcess.run at 0x7f44acd92dd0>
    └ <SpawnProcess name='SpawnProcess-20' parent=827779 started>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/multiprocessing/process.py", line 108, in run
    self._target(*self._args, **self._kwargs)
    │    │        │    │        │    └ {'config': <uvicorn.config.Config object at 0x7f44acda1a20>, 'target': <bound method Server.run of <uvicorn.server.Server obj...
    │    │        │    │        └ <SpawnProcess name='SpawnProcess-20' parent=827779 started>
    │    │        │    └ ()
    │    │        └ <SpawnProcess name='SpawnProcess-20' parent=827779 started>
    │    └ <function subprocess_started at 0x7f44a5fda560>
    └ <SpawnProcess name='SpawnProcess-20' parent=827779 started>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/uvicorn/_subprocess.py", line 76, in subprocess_started
    target(sockets=sockets)
    │              └ [<socket.socket fd=4, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=0, laddr=('0.0.0.0', 3000)>]
    └ <bound method Server.run of <uvicorn.server.Server object at 0x7f44acda19c0>>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/uvicorn/server.py", line 61, in run
    return asyncio.run(self.serve(sockets=sockets))
           │       │   │    │             └ [<socket.socket fd=4, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=0, laddr=('0.0.0.0', 3000)>]
           │       │   │    └ <function Server.serve at 0x7f44a5fa4a60>
           │       │   └ <uvicorn.server.Server object at 0x7f44acda19c0>
           │       └ <function run at 0x7f44ac0f1f30>
           └ <module 'asyncio' from '/home/li/anaconda3/envs/3dprint/lib/python3.10/asyncio/__init__.py'>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
           │    │                  └ <coroutine object Server.serve at 0x7f44a5eefa00>
           │    └ <method 'run_until_complete' of 'uvloop.loop.Loop' objects>
           └ <uvloop.Loop running=True closed=False debug=False>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/uvicorn/protocols/http/httptools_impl.py", line 435, in run_asgi
    result = await app(  # type: ignore[func-returns-value]
                   └ <uvicorn.middleware.proxy_headers.ProxyHeadersMiddleware object at 0x7f44a5d6bd60>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/uvicorn/middleware/proxy_headers.py", line 78, in __call__
    return await self.app(scope, receive, send)
                 │    │   │      │        └ <bound method RequestResponseCycle.send of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959451...
                 │    │   │      └ <bound method RequestResponseCycle.receive of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959...
                 │    │   └ {'type': 'http', 'asgi': {'version': '3.0', 'spec_version': '2.3'}, 'http_version': '1.1', 'server': ('192.168.0.105', 3000),...
                 │    └ <fastapi.applications.FastAPI object at 0x7f44a59ff040>
                 └ <uvicorn.middleware.proxy_headers.ProxyHeadersMiddleware object at 0x7f44a5d6bd60>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/fastapi/applications.py", line 1054, in __call__
    await super().__call__(scope, receive, send)
                           │      │        └ <bound method RequestResponseCycle.send of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959451...
                           │      └ <bound method RequestResponseCycle.receive of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959...
                           └ {'type': 'http', 'asgi': {'version': '3.0', 'spec_version': '2.3'}, 'http_version': '1.1', 'server': ('192.168.0.105', 3000),...
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/starlette/applications.py", line 123, in __call__
    await self.middleware_stack(scope, receive, send)
          │    │                │      │        └ <bound method RequestResponseCycle.send of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959451...
          │    │                │      └ <bound method RequestResponseCycle.receive of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959...
          │    │                └ {'type': 'http', 'asgi': {'version': '3.0', 'spec_version': '2.3'}, 'http_version': '1.1', 'server': ('192.168.0.105', 3000),...
          │    └ <starlette.middleware.errors.ServerErrorMiddleware object at 0x7f449592ace0>
          └ <fastapi.applications.FastAPI object at 0x7f44a59ff040>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/starlette/middleware/errors.py", line 164, in __call__
    await self.app(scope, receive, _send)
          │    │   │      │        └ <function ServerErrorMiddleware.__call__.<locals>._send at 0x7f44958bfc70>
          │    │   │      └ <bound method RequestResponseCycle.receive of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959...
          │    │   └ {'type': 'http', 'asgi': {'version': '3.0', 'spec_version': '2.3'}, 'http_version': '1.1', 'server': ('192.168.0.105', 3000),...
          │    └ <starlette.middleware.cors.CORSMiddleware object at 0x7f449592b340>
          └ <starlette.middleware.errors.ServerErrorMiddleware object at 0x7f449592ace0>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/starlette/middleware/cors.py", line 85, in __call__
    await self.app(scope, receive, send)
          │    │   │      │        └ <function ServerErrorMiddleware.__call__.<locals>._send at 0x7f44958bfc70>
          │    │   │      └ <bound method RequestResponseCycle.receive of <uvicorn.protocols.http.httptools_impl.RequestResponseCycle object at 0x7f44959...
          │    │   └ {'type': 'http', 'asgi': {'version': '3.0', 'spec_version': '2.3'}, 'http_version': '1.1', 'server': ('192.168.0.105', 3000),...
          │    └ <starlette.middleware.authentication.AuthenticationMiddleware object at 0x7f449592a980>
          └ <starlette.middleware.cors.CORSMiddleware object at 0x7f449592b340>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/starlette/middleware/authentication.py", line 37, in __call__
    auth_result = await self.backend.authenticate(conn)
                        │    │       │            └ <starlette.requests.HTTPConnection object at 0x7f449592b2b0>
                        │    │       └ <function JwtAuthMiddleware.authenticate at 0x7f4495c7db40>
                        │    └ <middleware.jwt_auth_middleware.JwtAuthMiddleware object at 0x7f4495888bb0>
                        └ <starlette.middleware.authentication.AuthenticationMiddleware object at 0x7f449592a980>

> File "/home/li/PythonProject/3dprint_background/middleware/jwt_auth_middleware.py", line 80, in authenticate
    user = await TblUser.get_or_none(id=payload.get("userid"))
                 │       │              │       └ <method 'get' of 'dict' objects>
                 │       │              └ {'exp': 1717115018, 'userid': 2}
                 │       └ <classmethod(<function Model.get_or_none at 0x7f44a4835750>)>
                 └ <class 'apps.user.model.TblUser'>

  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/tortoise/models.py", line 1348, in get_or_none
    db = using_db or cls._choose_db()
         │           │   └ <classmethod(<function Model._choose_db at 0x7f44a4834dc0>)>
         │           └ <class 'apps.user.model.TblUser'>
         └ None
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/tortoise/models.py", line 1034, in _choose_db
    db = router.db_for_read(cls)
         │      │           └ <class 'apps.user.model.TblUser'>
         │      └ <function ConnectionRouter.db_for_read at 0x7f44a47e6b90>
         └ <tortoise.router.ConnectionRouter object at 0x7f44a47f2260>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/tortoise/router.py", line 36, in db_for_read
    return self._db_route(model, "db_for_read")
           │    │         └ <class 'apps.user.model.TblUser'>
           │    └ <function ConnectionRouter._db_route at 0x7f44a47e6b00>
           └ <tortoise.router.ConnectionRouter object at 0x7f44a47f2260>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/tortoise/router.py", line 31, in _db_route
    return connections.get(self._router_func(model, action))
           │           │   │    │            │      └ 'db_for_read'
           │           │   │    │            └ <class 'apps.user.model.TblUser'>
           │           │   │    └ <function ConnectionRouter._router_func at 0x7f44a47e6a70>
           │           │   └ <tortoise.router.ConnectionRouter object at 0x7f44a47f2260>
           │           └ <function ConnectionHandler.get at 0x7f44a47c60e0>
           └ <tortoise.connection.ConnectionHandler object at 0x7f44a47bd930>
  File "/home/li/anaconda3/envs/3dprint/lib/python3.10/site-packages/tortoise/router.py", line 18, in _router_func
    for r in self._routers:
             │    └ None
             └ <tortoise.router.ConnectionRouter object at 0x7f44a47f2260>

But if I delete the lifespan, it will works well. The code is below:

def create_app() -> FastAPI:
    app = FastAPI(
        debug=settings.DEBUG,
        title=settings.TITLE,
        description=settings.DESCRIPTION,
        docs_url=settings.DOCS_URL,
        redoc_url=settings.REDOC_URL,
        # lifespan=register_init,
    )
    init_connect(app)
    register_middleware(app)
    # 注册路由
    register_router(app)
    # 注册捕获全局异常
    register_exception(app)
    return app

I study it seriously.
Reason:
Although My lifespan have not defined some logical. As the next generation of @app.on_event, the lifespan will change implement order:
before use lifespan:
init_connect(app) → register_middleware(app) → register_router(app) → register_exception(app)
after add lifespan parameter:
register_middleware(app) → register_router(app) →register_exception(app) → lifespan{ init_connect(app) }

That means lifespan function is executed after create_app().The serious problem is it will change @app.on_event("startup") functions execution time, which caused that the normal code will function unnormal.
register_tortoise is defined as below:

    @app.on_event("startup")
    async def init_orm() -> None:  # pylint: disable=W0612
        await Tortoise.init(config=config, config_file=config_file, db_url=db_url, modules=modules)
        logger.info("Tortoise-ORM started, %s, %s", connections._get_storage(), Tortoise.apps)
        if generate_schemas:
            logger.info("Tortoise-ORM generating schema")
            await Tortoise.generate_schemas()

Operating System

Linux

Operating System Details

Ubuntu=20.04
tortoise-orm==0.20.0
fastapi==0.110.1

FastAPI Version

0.110.1

Pydantic Version

2.7.0

Python Version

3.10.14

Additional Context

I think lifespan should designed more exectact. I can add my logic at here, here.

[YuriiMotov]

The serious problem is it will change @app.on_event("startup") functions execution time

Don't use lifespan and startup and shutdown events at one app. There is a remark about this in the FastAPI docs:

If you provide a lifespan parameter, startup and shutdown event handlers will no longer be called. It's all lifespan or all events, not both.

So, you need to move all you initialization logic into lifespan if you want to use it.

There is a code example of intagration tortoise with FastAPI using lifespan in the documentation of tortoise: https://tortoise.github.io/examples/fastapi.html#main-py
Is that what you need?

[lyha23]

I will try it after holiday, 5.6 I reply you. Thank you.
（Actually, I think it can not work together with middleware）

[lyha23]

I can not apply this documentation of tortoise: https://tortoise.github.io/examples/fastapi.html#main-py
Although my package is the latest, this project can not find the RegisterTortoise class.

$ pip list | grep tortoise
casbin-tortoise-adapter 2.0.0
pypika-tortoise         0.1.6
tortoise-orm            0.20.1

[YuriiMotov]

The latest version of tortoise-orm is 0.21

And there are changes about FastAPI lifespan support there

[lyha23]

I refined my opinion in that issue, maybe it can help you understand.
tortoise/tortoise-orm#1576 (comment)

[lyha23]

It has not been published?

In addition, I have found an issue similar with mine. another issue.

[YuriiMotov]

Yes, I see they haven't published that release yet.