fix: update FastAPI to 0.112.2 (#1736)

* refactor: new FastAPI integration syntax * lint: fix confluent topic mypy * docs: generate API References * docs: fix FastAPI integration section * docs: make annotation private * chore: update FastAPI * lint: fix precommit * chore: trigger CI * chore: revert CI triggers --------- Co-authored-by: Lancetnik <[email protected]> Co-authored-by: Davor Runje <[email protected]>
airtai · Aug 30, 2024 · 79c7b78 · 79c7b78
1 parent 4944180
commit 79c7b78
Show file tree

Hide file tree

Showing 42 changed files with 108 additions and 136 deletions.
diff --git a/README.md b/README.md
@@ -318,7 +318,7 @@ class Incoming(BaseModel):
 async def hello(m: Incoming):
     return {"response": "Hello, world!"}
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
 ```
 

diff --git a/docs/create_api_docs.py b/docs/create_api_docs.py
@@ -346,7 +346,7 @@ def create_api_docs(
 
 def on_page_markdown(markdown, *, page, config, files):
     """Mkdocs hook to update the edit URL for the public API pages."""
-    if "public_api" in page.edit_url:
+    if page.edit_url and "public_api" in page.edit_url:
         page.edit_url = page.edit_url.replace("public_api", "api")
 
 

diff --git a/docs/docs/en/getting-started/integrations/fastapi/index.md b/docs/docs/en/getting-started/integrations/fastapi/index.md
@@ -26,6 +26,9 @@ Just import a **StreamRouter** you need and declare the message handler in the s
 
 {! includes/getting_started/integrations/fastapi/1.md !}
 
+!!! warning
+    If you are using **fastapi < 0.102.2** version, you should setup lifespan manually `#!python FastAPI(lifespan=router.lifespan_context)`
+
 When processing a message from a broker, the entire message body is placed simultaneously in both the `body` and `path` request parameters. You can access them in any way convenient for you. The message header is placed in `headers`.
 
 Also, this router can be fully used as an `HttpRouter` (of which it is the inheritor). So, you can
@@ -100,7 +103,7 @@ This way the core router collects all nested routers publishers and subscribers
 
 ### Custom lifespan
 
-Otherwise, if you want to has multiple connections to different broker instances, you should start routers independently in your custom lifespan
+Otherwise, if you want to has multiple connections to different broker instances, you can just include them separately to the app (each router has own broker and connection in this case)
 
 {! includes/getting_started/integrations/fastapi/multiple_lifespan.md !}
 

diff --git a/docs/docs/en/release.md b/docs/docs/en/release.md
@@ -18,7 +18,7 @@ hide:
 
 The current release is planned as a latest feature release before **0.6.0**. All other **0.5.19+** releases will contain only minor bugfixes and all the team work will be focused on next major one.
 
-There a lot of changes we want to present you now though!
+There's a lot of changes we want to present you now though!
 
 #### New RPC feature
 

diff --git a/docs/docs_src/integrations/fastapi/confluent/base.py b/docs/docs_src/integrations/fastapi/confluent/base.py
@@ -21,5 +21,5 @@ async def hello(m: Incoming, logger: Logger, d=Depends(call)):
 async def hello_http():
     return "Hello, HTTP!"
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/confluent/depends.py b/docs/docs_src/integrations/fastapi/confluent/depends.py
@@ -5,7 +5,7 @@
 
 router = fastapi.KafkaRouter("localhost:9092")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 def broker():

diff --git a/docs/docs_src/integrations/fastapi/confluent/multiple.py b/docs/docs_src/integrations/fastapi/confluent/multiple.py
@@ -14,5 +14,5 @@ async def nested_handler():
 
 core_router.include_router(nested_router)
 
-app = FastAPI(lifespan=core_router.lifespan_context)
+app = FastAPI()
 app.include_router(core_router)
diff --git a/docs/docs_src/integrations/fastapi/confluent/multiple_lifespan.py b/docs/docs_src/integrations/fastapi/confluent/multiple_lifespan.py
@@ -1,19 +1,11 @@
-from contextlib import asynccontextmanager
-
 from fastapi import FastAPI
 from faststream.confluent.fastapi import KafkaRouter
 
-core_router = KafkaRouter()
-nested_router = KafkaRouter()
+one_router = KafkaRouter()
+another_router = KafkaRouter()
 
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    async with (
-        core_router.lifespan_context(app),
-        nested_router.lifespan_context(app),
-    ):
-        yield
+...
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(core_router)
-app.include_router(nested_router)
+app = FastAPI()
+app.include_router(one_router)
+app.include_router(another_router)
diff --git a/docs/docs_src/integrations/fastapi/confluent/send.py b/docs/docs_src/integrations/fastapi/confluent/send.py
@@ -4,7 +4,7 @@
 
 router = KafkaRouter("localhost:9092")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 @router.get("/")

diff --git a/docs/docs_src/integrations/fastapi/confluent/startup.py b/docs/docs_src/integrations/fastapi/confluent/startup.py
@@ -15,5 +15,5 @@ async def test(app: FastAPI):
     await router.broker.publish("Hello!", "test")
 
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/kafka/base.py b/docs/docs_src/integrations/fastapi/kafka/base.py
@@ -21,5 +21,5 @@ async def hello(m: Incoming, logger: Logger, d=Depends(call)):
 async def hello_http():
     return "Hello, HTTP!"
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/kafka/depends.py b/docs/docs_src/integrations/fastapi/kafka/depends.py
@@ -5,7 +5,7 @@
 
 router = fastapi.KafkaRouter("localhost:9092")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 def broker():

diff --git a/docs/docs_src/integrations/fastapi/kafka/multiple.py b/docs/docs_src/integrations/fastapi/kafka/multiple.py
@@ -14,5 +14,5 @@ async def nested_handler():
 
 core_router.include_router(nested_router)
 
-app = FastAPI(lifespan=core_router.lifespan_context)
+app = FastAPI()
 app.include_router(core_router)
diff --git a/docs/docs_src/integrations/fastapi/kafka/multiple_lifespan.py b/docs/docs_src/integrations/fastapi/kafka/multiple_lifespan.py
@@ -1,19 +1,11 @@
-from contextlib import asynccontextmanager
-
 from fastapi import FastAPI
 from faststream.kafka.fastapi import KafkaRouter
 
-core_router = KafkaRouter()
-nested_router = KafkaRouter()
+one_router = KafkaRouter()
+another_router = KafkaRouter()
 
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    async with (
-        core_router.lifespan_context(app),
-        nested_router.lifespan_context(app),
-    ):
-        yield
+...
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(core_router)
-app.include_router(nested_router)
+app = FastAPI()
+app.include_router(one_router)
+app.include_router(another_router)
diff --git a/docs/docs_src/integrations/fastapi/kafka/send.py b/docs/docs_src/integrations/fastapi/kafka/send.py
@@ -4,7 +4,7 @@
 
 router = KafkaRouter("localhost:9092")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 @router.get("/")

diff --git a/docs/docs_src/integrations/fastapi/kafka/startup.py b/docs/docs_src/integrations/fastapi/kafka/startup.py
@@ -15,5 +15,5 @@ async def test(app: FastAPI):
     await router.broker.publish("Hello!", "test")
 
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/nats/base.py b/docs/docs_src/integrations/fastapi/nats/base.py
@@ -21,5 +21,5 @@ async def hello(m: Incoming, logger: Logger, d=Depends(call)):
 async def hello_http():
     return "Hello, HTTP!"
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/nats/depends.py b/docs/docs_src/integrations/fastapi/nats/depends.py
@@ -5,7 +5,7 @@
 
 router = fastapi.NatsRouter("nats://localhost:4222")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 def broker():

diff --git a/docs/docs_src/integrations/fastapi/nats/multiple.py b/docs/docs_src/integrations/fastapi/nats/multiple.py
@@ -14,5 +14,5 @@ async def nested_handler():
 
 core_router.include_router(nested_router)
 
-app = FastAPI(lifespan=core_router.lifespan_context)
+app = FastAPI()
 app.include_router(core_router)
diff --git a/docs/docs_src/integrations/fastapi/nats/multiple_lifespan.py b/docs/docs_src/integrations/fastapi/nats/multiple_lifespan.py
@@ -1,19 +1,11 @@
-from contextlib import asynccontextmanager
-
 from fastapi import FastAPI
 from faststream.nats.fastapi import NatsRouter
 
-core_router = NatsRouter()
-nested_router = NatsRouter()
+one_router = NatsRouter()
+another_router = NatsRouter()
 
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    async with (
-        core_router.lifespan_context(app),
-        nested_router.lifespan_context(app),
-    ):
-        yield
+...
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(core_router)
-app.include_router(nested_router)
+app = FastAPI()
+app.include_router(one_router)
+app.include_router(another_router)
diff --git a/docs/docs_src/integrations/fastapi/nats/send.py b/docs/docs_src/integrations/fastapi/nats/send.py
@@ -4,7 +4,7 @@
 
 router = NatsRouter("nats://localhost:4222")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 @router.get("/")

diff --git a/docs/docs_src/integrations/fastapi/nats/startup.py b/docs/docs_src/integrations/fastapi/nats/startup.py
@@ -15,5 +15,5 @@ async def test(app: FastAPI):
     await router.broker.publish("Hello!", "test")
 
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/rabbit/base.py b/docs/docs_src/integrations/fastapi/rabbit/base.py
@@ -21,5 +21,5 @@ async def hello(m: Incoming, logger: Logger, d=Depends(call)):
 async def hello_http():
     return "Hello, HTTP!"
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/rabbit/depends.py b/docs/docs_src/integrations/fastapi/rabbit/depends.py
@@ -5,7 +5,7 @@
 
 router = fastapi.RabbitRouter("amqp://guest:guest@localhost:5672/")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 def broker():

diff --git a/docs/docs_src/integrations/fastapi/rabbit/multiple.py b/docs/docs_src/integrations/fastapi/rabbit/multiple.py
@@ -14,5 +14,5 @@ async def nested_handler():
 
 core_router.include_router(nested_router)
 
-app = FastAPI(lifespan=core_router.lifespan_context)
+app = FastAPI()
 app.include_router(core_router)
diff --git a/docs/docs_src/integrations/fastapi/rabbit/multiple_lifespan.py b/docs/docs_src/integrations/fastapi/rabbit/multiple_lifespan.py
@@ -1,19 +1,11 @@
-from contextlib import asynccontextmanager
-
 from fastapi import FastAPI
 from faststream.rabbit.fastapi import RabbitRouter
 
-core_router = RabbitRouter()
-nested_router = RabbitRouter()
+one_router = RabbitRouter()
+another_router = RabbitRouter()
 
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    async with (
-        core_router.lifespan_context(app),
-        nested_router.lifespan_context(app),
-    ):
-        yield
+...
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(core_router)
-app.include_router(nested_router)
+app = FastAPI()
+app.include_router(one_router)
+app.include_router(another_router)
diff --git a/docs/docs_src/integrations/fastapi/rabbit/send.py b/docs/docs_src/integrations/fastapi/rabbit/send.py
@@ -4,7 +4,7 @@
 
 router = RabbitRouter("amqp://guest:guest@localhost:5672/")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 @router.get("/")

diff --git a/docs/docs_src/integrations/fastapi/rabbit/startup.py b/docs/docs_src/integrations/fastapi/rabbit/startup.py
@@ -15,5 +15,5 @@ async def test(app: FastAPI):
     await router.broker.publish("Hello!", "test")
 
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/redis/base.py b/docs/docs_src/integrations/fastapi/redis/base.py
@@ -21,5 +21,5 @@ async def hello(m: Incoming, logger: Logger, d=Depends(call)):
 async def hello_http():
     return "Hello, HTTP!"
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)
diff --git a/docs/docs_src/integrations/fastapi/redis/depends.py b/docs/docs_src/integrations/fastapi/redis/depends.py
@@ -5,7 +5,7 @@
 
 router = fastapi.RedisRouter("redis://localhost:6379")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 def broker():

diff --git a/docs/docs_src/integrations/fastapi/redis/multiple.py b/docs/docs_src/integrations/fastapi/redis/multiple.py
@@ -14,5 +14,5 @@ async def nested_handler():
 
 core_router.include_router(nested_router)
 
-app = FastAPI(lifespan=core_router.lifespan_context)
+app = FastAPI()
 app.include_router(core_router)
diff --git a/docs/docs_src/integrations/fastapi/redis/multiple_lifespan.py b/docs/docs_src/integrations/fastapi/redis/multiple_lifespan.py
@@ -1,19 +1,11 @@
-from contextlib import asynccontextmanager
-
 from fastapi import FastAPI
 from faststream.redis.fastapi import RedisRouter
 
-core_router = RedisRouter()
-nested_router = RedisRouter()
+one_router = RedisRouter()
+another_router = RedisRouter()
 
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    async with (
-        core_router.lifespan_context(app),
-        nested_router.lifespan_context(app),
-    ):
-        yield
+...
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(core_router)
-app.include_router(nested_router)
+app = FastAPI()
+app.include_router(one_router)
+app.include_router(another_router)
diff --git a/docs/docs_src/integrations/fastapi/redis/send.py b/docs/docs_src/integrations/fastapi/redis/send.py
@@ -4,7 +4,7 @@
 
 router = RedisRouter("redis://localhost:6379")
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 
 
 @router.get("/")

diff --git a/docs/docs_src/integrations/fastapi/redis/startup.py b/docs/docs_src/integrations/fastapi/redis/startup.py
@@ -15,5 +15,5 @@ async def test(app: FastAPI):
     await router.broker.publish("Hello!", "test")
 
 
-app = FastAPI(lifespan=router.lifespan_context)
+app = FastAPI()
 app.include_router(router)