From 00f7a7ebc561b12f0fbbaf06ff510ad995cdccb6 Mon Sep 17 00:00:00 2001 From: Suren Khorenyan Date: Sun, 6 Jul 2025 15:07:28 +0300 Subject: [PATCH 1/2] update docstrings --- taskiq_fastapi/initializator.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/taskiq_fastapi/initializator.py b/taskiq_fastapi/initializator.py index 5b8fff2..e395e2b 100644 --- a/taskiq_fastapi/initializator.py +++ b/taskiq_fastapi/initializator.py @@ -7,19 +7,21 @@ 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 +52,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 +70,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 +82,7 @@ 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 +106,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. From 01b4ec3a854f97889f8cd1b9af51df5fffc399ea Mon Sep 17 00:00:00 2001 From: Suren Khorenyan Date: Thu, 2 Apr 2026 14:05:12 +0300 Subject: [PATCH 2/2] update docstring --- taskiq_fastapi/initializator.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/taskiq_fastapi/initializator.py b/taskiq_fastapi/initializator.py index e395e2b..12e980b 100644 --- a/taskiq_fastapi/initializator.py +++ b/taskiq_fastapi/initializator.py @@ -21,7 +21,8 @@ def startup_event_generator( and runs startup event on broker's startup. :param broker: current broker. - :param app_or_path: application path or fastapi instance or callable that creates fastapi app instance. + :param app_or_path: application path or fastapi instance + or callable that creates fastapi app instance. :returns: startup handler. """ @@ -82,7 +83,8 @@ def init(broker: AsyncBroker, app_or_path: PathOrAppOrFactory) -> None: startup events will run. :param broker: current broker to use. - :param app_or_path: application path or fastapi instance or callable that creates fastapi app instance. + :param app_or_path: application path or fastapi instance + or callable that creates fastapi app instance. """ broker.add_event_handler( TaskiqEvents.WORKER_STARTUP,