20251005

help/class_desc/models/action_state_message.md

@@ -0,0 +1,55 @@
+# Класс модели `ActionStateMessage`
+
+Модель `ActionStateMessage` предназначена для формирования сообщений о состоянии выполненных действий в рамках проекта.
+Она содержит основную информацию о результате выполненного действия, включая тип сообщения, текстовое описание и флаги (
+мета-данные).
+
+## Основная информация
+
+- **Имя файла**: anb_python_components\models\action_state_message.py
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0.0
+- **Дата начала поддержки**: с версии 1.0
+
+## Атрибуты и конструктор
+
+### Конструктор (`__init__`)
+
+Принимает три необязательных параметра:
+
+- **`message_type`**: Тип сообщения, использующий перечисление `MessageType` (по умолчанию `INFO`).
+- **`message`**: Сам текст сообщения (по умолчанию пустая строка).
+- **`flags`**: Дополнительные метаданные или признаки сообщения (по умолчанию пустой словарь).
+
+**Пример использования конструктора**:
+
+```python
+from anb_python_components.models.action_state_message import ActionStateMessage, MessageType
+
+state_message = ActionStateMessage(MessageType.SUCCESS, "Действие выполнено успешно.", {"has_errors": False})
+```
+
+## Пример полного использования
+
+Вот пример использования класса `ActionStateMessage`:
+
+```python
+from anb_python_components.models.action_state_message import ActionStateMessage, MessageType
+
+# Создание сообщения успешного действия
+success_message = ActionStateMessage(MessageType.SUCCESS, "Операция завершилась успешно.")
+
+# Создание сообщения с дополнительной информацией
+info_message = ActionStateMessage(MessageType.INFO, "Начало обработки данных.", {"in_progress": False})
+
+# Печать сообщений
+print(success_message.message)  # Операция завершилась успешно.
+print(info_message.message)  # Начало обработки данных.
+```
+
+## Заключение
+
+Модель `ActionStateMessage` полезна для унификации способов оповещения пользователей или администратора о ходе
+выполнения тех или иных процессов. Четкая структура сообщений облегчает чтение и дальнейшее развитие приложения.
+
+[На главную](../../index.md)