kolo/Argenta
1
0
Fork 0
mirror of https://github.com/koloideal/Argenta.git synced 2026-06-10 18:15:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation and code snippets

Browse Source
This commit is contained in:
kolo
2025-12-02 10:51:44 +03:00
parent 2a96dfcabe
commit 19906c1b1b
28 changed files with 85 additions and 531 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/root/api/bridge.rst
+11 -9
View File
@@ -3,18 +3,20 @@
DataBridge
==========
`DataBridge` — это сущность, предоставляющая временное хранилище данных, которое существует в рамках одной сессии приложения (от запуска до выхода). Она предназначена для обмена данными между вызовами разных команд.
``DataBridge`` — это сущность, предоставляющая временное хранилище данных, которое существует в рамках одной сессии приложения (от запуска до выхода). Она предназначена для обмена данными между обработчиками.
Основной способ получения доступа к `DataBridge` — через систему внедрения зависимостей (DI).
Основной способ получения доступа к ``DataBridge`` — через ``di``.
.. code-block:: python
:linenos:
from argenta.di import FromDishka
from argenta import DataBridge, Response
# ... setting up router and other
def my_handler(response: Response, data_bridge: FromDishka[DataBridge]):
# ... ваш код
# ... your code
**Практический пример: Аутентификация**
@@ -26,9 +28,9 @@ DataBridge
**Как это работает:**
1. При вызове обработчика `dishka` автоматически внедряет экземпляр `DataBridge`.
2. Команда ``login --username <имя>`` вызывает `login_handler`, который через внедрённый `data_bridge` сохраняет токен.
3. Команда `get-profile` вызывает `get_profile_handler`, который так же получает `data_bridge` и извлекает из него токен.
1. При вызове обработчика ``dishka`` автоматически внедряет экземпляр ``DataBridge``.
2. Команда ``login --username <имя>`` вызывает ``login_handler``, который через внедрённый ``data_bridge`` сохраняет токен.
3. Команда ``get-profile`` вызывает ``get_profile_handler``, который так же получает ``data_bridge`` и извлекает из него токен.
API класса
-----------
@@ -37,7 +39,7 @@ API класса
.. py:method:: __init__(self, initial_data: dict | None = None)
Инициализирует хранилище. При использовании через DI вызывается автоматически.
Инициализирует хранилище. При использовании через ``di`` вызывается автоматически.
.. py:method:: update(self, data: dict) -> None
@@ -49,11 +51,11 @@ API класса
.. py:method:: get_by_key(self, key: str) -> Any
Возвращает значение по ключу или `None`, если ключ не найден.
Возвращает значение по ключу или ``None``, если ключ не найден.
.. py:method:: delete_by_key(self, key: str) -> None
Удаляет значение по ключу. Вызывает `KeyError`, если ключ не найден.
Удаляет значение по ключу. Вызывает ``KeyError``, если ключ не найден.
.. py:method:: clear_all(self) -> None