Merge pull request #525 from Tishka17/feature/global_getter

Add global `getter` to `setup_dialogs`

Author: Tishka17

docs/widgets/passing_data/index.rst

@@ -11,7 +11,7 @@ You have access to the following dynamic data:
 * ``start_data`` - data that was passed when the current dialog was started. These data is stored in the aiogram FSM storage.
 * ``dialog_data`` - you can use this dict to store dialog-related data. It will be accessible at all windows of current dialog. These data is stored in the aiogram FSM storage.
 
-In addition you can specify getter-functions for dialog and window.
+In addition you can specify getter-functions for ``Dialog``, ``Window`` or globally in ``setup_dialogs``.
 Getter-function has to return a dictionary.
 
 Library collects all the data above into one dictionary object and passes this object to widgets.
@@ -28,7 +28,7 @@ Result:
 
 .. image:: /resources/passing_data_example.png
 
-In event handlers you don't have access to that dictionary, but you can acess ``event``, ``middleware_data``, ``start_data``, ``dialog_data`` via dialog_manager:
+In event handlers you don't have access to that dictionary, but you can access ``event``, ``middleware_data``, ``start_data``, ``dialog_data`` via dialog_manager:
 
 .. literalinclude:: ./data_in_handlers.py
 

src/aiogram_dialog/manager/manager.py

@@ -44,6 +44,7 @@
     EVENT_SIMULATED,
     STACK_KEY,
     STORAGE_KEY,
+    DataGetter,
     FakeChat,
     FakeUser,
 )
@@ -77,6 +78,7 @@ def __init__(
             registry: DialogRegistryProtocol,
             router: Router,
             data: dict,
+            getter: DataGetter | None,
     ):
         self.disabled = False
         self.message_manager = message_manager
@@ -86,6 +88,7 @@ def __init__(
         self._show_mode: ShowMode = ShowMode.AUTO
         self._registry = registry
         self._router = router
+        self._getter = getter
 
     @property
     def show_mode(self) -> ShowMode:
@@ -126,11 +129,16 @@ def check_disabled(self):
 
     async def load_data(self) -> dict:
         context = self.current_context()
+        if self._getter:
+            data = await self._getter(**self.middleware_data)
+        else:
+            data = {}
         return {
             "dialog_data": context.dialog_data,
             "start_data": context.start_data,
             "middleware_data": self._data,
             "event": self.event,
+            **data,
         }
 
     def is_preview(self) -> bool:

src/aiogram_dialog/manager/manager_factory.py

@@ -1,7 +1,7 @@
 from aiogram import Router
 
 from aiogram_dialog.api.entities import ChatEvent
-from aiogram_dialog.api.internal import DialogManagerFactory
+from aiogram_dialog.api.internal import DataGetter, DialogManagerFactory
 from aiogram_dialog.api.protocols import (
     DialogManager,
     DialogRegistryProtocol,
@@ -16,9 +16,11 @@ def __init__(
             self,
             message_manager: MessageManagerProtocol,
             media_id_storage: MediaIdStorageProtocol,
+            getter: DataGetter | None,
     ) -> None:
         self.message_manager = message_manager
         self.media_id_storage = media_id_storage
+        self.getter = getter
 
     def __call__(
             self, event: ChatEvent, data: dict,
@@ -32,4 +34,5 @@ def __call__(
             media_id_storage=self.media_id_storage,
             registry=registry,
             router=router,
+            getter=self.getter,
         )

src/aiogram_dialog/setup.py

@@ -8,7 +8,7 @@
 
 from aiogram_dialog.api.entities import DIALOG_EVENT_NAME
 from aiogram_dialog.api.exceptions import UnregisteredDialogError
-from aiogram_dialog.api.internal import DialogManagerFactory
+from aiogram_dialog.api.internal import DataGetter, DialogManagerFactory
 from aiogram_dialog.api.protocols import (
     BgManagerFactory,
     DialogProtocol,
@@ -174,6 +174,7 @@ def _prepare_dialog_manager_factory(
         dialog_manager_factory: DialogManagerFactory | None,
         message_manager: MessageManagerProtocol | None,
         media_id_storage: MediaIdStorageProtocol | None,
+        getter: DataGetter | None,
 ) -> DialogManagerFactory:
     if dialog_manager_factory is not None:
         return dialog_manager_factory
@@ -184,6 +185,7 @@ def _prepare_dialog_manager_factory(
     return DefaultManagerFactory(
         message_manager=message_manager,
         media_id_storage=media_id_storage,
+        getter=getter,
     )
 
 
@@ -224,6 +226,7 @@ def setup_dialogs(
         media_id_storage: MediaIdStorageProtocol | None = None,
         stack_access_validator: StackAccessValidator | None = None,
         events_isolation: BaseEventIsolation | None = None,
+        getter: DataGetter | None = None,
 ) -> BgManagerFactory:
     _setup_event_observer(router)
     _register_event_handler(router, handle_update)
@@ -233,6 +236,7 @@ def setup_dialogs(
         dialog_manager_factory=dialog_manager_factory,
         message_manager=message_manager,
         media_id_storage=media_id_storage,
+        getter=getter,
     )
     stack_access_validator = _prepare_stack_access_validator(
         stack_access_validator,