Merge pull request #21 from mahenzon/update-docstrings

update docstrings and typing

Author: spikeninja

taskiq_fastapi/initializator.py

@@ -7,19 +7,22 @@
 from taskiq import AsyncBroker, TaskiqEvents, TaskiqState
 from taskiq.cli.utils import import_object
 
+PathOrAppOrFactory = str | FastAPI | Callable[[], FastAPI]
+
 
 def startup_event_generator(
     broker: AsyncBroker,
-    app_or_path: str | FastAPI,
+    app_or_path: PathOrAppOrFactory,
 ) -> Callable[[TaskiqState], Awaitable[None]]:
     """
-    Generate shutdown event.
+    Generate startup event handler.
 
     This function takes FastAPI application path
     and runs startup event on broker's startup.
 
     :param broker: current broker.
-    :param app_path: fastapi application path.
+    :param app_or_path: application path or fastapi instance
+        or callable that creates fastapi app instance.
     :returns: startup handler.
     """
 
@@ -50,7 +53,7 @@ def shutdown_event_generator(
     broker: AsyncBroker,
 ) -> Callable[[TaskiqState], Awaitable[None]]:
     """
-    Generate shutdown event.
+    Generate shutdown event handler.
 
     This function takes FastAPI application
     and runs shutdown event on broker's shutdown.
@@ -68,7 +71,7 @@ async def shutdown(state: TaskiqState) -> None:
     return shutdown
 
 
-def init(broker: AsyncBroker, app_or_path: str | FastAPI) -> None:
+def init(broker: AsyncBroker, app_or_path: PathOrAppOrFactory) -> None:
     """
     Add taskiq startup events.
 
@@ -80,7 +83,8 @@ def init(broker: AsyncBroker, app_or_path: str | FastAPI) -> None:
     startup events will run.
 
     :param broker: current broker to use.
-    :param app_path: path to fastapi application.
+    :param app_or_path: application path or fastapi instance
+        or callable that creates fastapi app instance.
     """
     broker.add_event_handler(
         TaskiqEvents.WORKER_STARTUP,
@@ -104,7 +108,7 @@ def populate_dependency_context(
     This function injects the Request and HTTPConnection
     into the broker's dependency context.
 
-    It may be need to be called manually if you are using InMemoryBroker.
+    It may be needed to be called manually if you are using InMemoryBroker.
 
     :param broker: current broker to use.
     :param app: current application.