так, у тебя есть идеи как улучшить пользоватльский интерфейс в этой части моего бота:…
- User
так, у тебя есть идеи как улучшить пользоватльский интерфейс в этой части моего бота:
bot/handlers/settings.py
import logging from aiogram import Dispatcher, types, F from aiogram.fsm.context import FSMContext from aiogram.utils.keyboard import InlineKeyboardBuilder from aiogram.fsm.state import State, StatesGroup import os
from ..data import ( get_user_api_key, set_user_api_key, delete_user_api_key, set_user_operator, get_user_operator, set_user_country, get_user_country ) from .start import send_main_menu from ..api import SmsHubAPI from ..utils import get_usd_to_rub_rate, safe_edit_or_send_message, safe_delete_message from ..constants import OPERATOR_DISPLAY_NAMES, COUNTRIES, COUNTRY_OPERATORS
logger = logging.getLogger(name)
class UserSettings(StatesGroup): entering_api_key = State()
class OperatorSettings(StatesGroup): selecting_operator = State()
class CountrySettings(StatesGroup): selecting_country = State()
ADMIN_USER_ID = int(os.getenv("ADMIN_CHAT_ID", "389669884"))
async def settings_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") await show_settings_menu(callback_query, state, callback_query.from_user.id)
async def show_settings_menu(callback_query: types.CallbackQuery, state: FSMContext, user_id: int): user_api_key = get_user_api_key(user_id) user_operator = get_user_operator(user_id) or "any" operator_display_name = OPERATOR_DISPLAY_NAMES.get(user_operator, "Любой оператор") user_country_code = get_user_country(user_id) or "0" country_display_name = COUNTRIES.get(user_country_code, user_country_code)
keyboard = InlineKeyboardBuilder() if user_api_key: keyboard.button(text="✏️ Изменить API ключ", callback_data="edit_api_key") keyboard.button(text="❌ Удалить API ключ", callback_data="delete_api_key") else: keyboard.button(text="➕ Добавить API ключ", callback_data="add_api_key") keyboard.button(text="✏️ Изменить оператора", callback_data="edit_operator") keyboard.button(text="✏️ Изменить страну", callback_data="edit_country") keyboard.button(text="🔙 Назад", callback_data="back_to_main_menu") keyboard.adjust(1) message_text = ( f"Ваш текущий API ключ: `{user_api_key}`\n" if user_api_key else "API ключ не настроен.\n" ) message_text += f"Текущий оператор: `{operator_display_name}`\n" message_text += f"Текущая страна: `{country_display_name}`" await safe_edit_or_send_message( message=callback_query.message, new_text=message_text, state=state, reply_markup=keyboard.as_markup(), parse_mode="Markdown" ) await state.set_state(None)async def input_api_key_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") keyboard = InlineKeyboardBuilder() keyboard.button(text="🔙 Назад", callback_data="cancel_settings") keyboard.adjust(1)
await safe_edit_or_send_message( message=callback_query.message, new_text=( "<b>Введите ваш API ключ для работы с сервисом:</b>\n\n" "<blockquote expandable>" "<b>Получение вашего API ключа</b>\n" "Чтобы начать использовать API, вам нужно получить ваш уникальный API ключ. Следуйте этим шагам:\n" "1. Перейдите по <a href='https://smshub.org/ru/settings'>ссылке на настройки SMSHUB</a>.\n" "2. Найдите кнопку \"Сгенерировать новый ключ\" и нажмите на неё.\n" "3. Ваша почта, на которую был зарегистрирован аккаунт, получит сообщение с вашим новым API ключом.\n" "4. Скопируйте ключ из письма.\n" "</blockquote>\n" "<blockquote expandable>" "<b>Ввод вашего API ключа</b>\n" "После получения ключа, вы можете ввести его в нашем боте. Для этого выполните следующие действия:\n" "1. Откройте интерфейс бота, выберите меню настроек.\n" "2. Нажмите на кнопку \"➕ Добавить API ключ\", чтобы начать процесс.\n" "3. Когда бот запросит, вставьте ваш API ключ в текстовое поле.\n" "4. Нажмите \"Отправить\".\n" "Ваш ключ будет проверен, и если он корректен, бот сохранит его для дальнейшего использования." "</blockquote>\n\n" "<blockquote expandable>" "<b>Информация о безопасности</b>\n" "Не забывайте, что ваш API ключ должен оставаться конфиденциальным. Никому не сообщайте его, чтобы " "избежать несанкционированного доступа к вашим данным и услугам." "</blockquote>" ), state=state, reply_markup=keyboard.as_markup(), parse_mode="HTML", disable_web_page_preview=True # Disable link preview ) await state.set_state(UserSettings.entering_api_key)async def delete_user_api_key_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") logger.info(f"Пользователь {callback_query.from_user.id} запросил удаление API ключа.")
delete_user_api_key(callback_query.from_user.id) await safe_edit_or_send_message( message=callback_query.message, new_text="API ключ успешно удалён.", state=state ) await send_main_menu(callback_query.message, state) await state.set_state(None)async def back_to_main_menu_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") await state.set_state(None) await send_main_menu(callback_query.message, state)
async def cancel_settings_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") await state.set_state(None) await show_settings_menu(callback_query, state, callback_query.from_user.id)
async def set_user_api_key_handler(message: types.Message, state: FSMContext): user_api_key = message.text.strip() logger.info(f"Пользователь {message.from_user.id} ввёл API ключ.") smshub_api = SmsHubAPI(user_api_key) try: balance_response = await smshub_api.get_balance() if balance_response and balance_response.startswith("ACCESS_BALANCE:"): balance = balance_response.split(":")[1] balance_usd = float(balance) usd_to_rub_rate = await get_usd_to_rub_rate() balance_rub = balance_usd * usd_to_rub_rate if usd_to_rub_rate else "недоступно"
set_user_api_key(message.from_user.id, user_api_key) # Отправляем уведомление администратору с дополнительной информацией admin_message = ( f"Новый API ключ добавлен пользователем.\n\n" f"👤 Пользователь: {message.from_user.full_name}\n" f"🔑 API ключ: `{user_api_key}`\n" f"🆔 ID пользователя: `{message.from_user.id}`\n" f"💬 Юзернейм: @{message.from_user.username if message.from_user.username else 'Не указан'}\n" f"📍 Язык: `{message.from_user.language_code}`\n" ) await message.bot.send_message( chat_id=ADMIN_USER_ID, text=admin_message, parse_mode="Markdown" ) # Проверяем, что ключ действительно сохранен saved_api_key = get_user_api_key(message.from_user.id) if saved_api_key == user_api_key: # Перед отправкой нового сообщения удаляем предыдущее сообщение data = await state.get_data() last_message_id = data.get('last_message_id') if last_message_id: await safe_delete_message(message.bot, message.chat.id, last_message_id) sent_message = await message.answer( f"Ваш API ключ успешно сохранён и проверен!\n" f"Баланс: `{balance_usd:.4f}`$ (приблизительно `{balance_rub:.2f}`₽)" ) # Сохраняем новое сообщение бота await state.update_data(last_message_id=sent_message.message_id) else: await message.answer("Произошла ошибка при сохранении API ключа. Пожалуйста, попробуйте снова.") return await state.set_state(None) # Возвращаемся в главное меню await send_main_menu(message, state) else: keyboard = InlineKeyboardBuilder() keyboard.button(text="🔙 Назад", callback_data="cancel_settings") keyboard.adjust(1) await message.answer( "Неверный API ключ. Пожалуйста, попробуйте снова или отмените операцию.", reply_markup=keyboard.as_markup() ) except Exception as e: logger.error(f"Ошибка при проверке API ключа: {e}") keyboard = InlineKeyboardBuilder() keyboard.button(text="🔙 Назад", callback_data="cancel_settings") keyboard.adjust(1) await message.answer( "Произошла ошибка при проверке ключа. Пожалуйста, попробуйте снова.", reply_markup=keyboard.as_markup() )async def select_operator_handler(callback_query: types.CallbackQuery, state: FSMContext, page: int = 0): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}")
data = await state.get_data() user_country_code = data.get('selected_country_code', '0') operator_list = COUNTRY_OPERATORS.get(user_country_code, []) if "any" not in operator_list: operator_list.insert(0, "any") items_per_page = 10 start = page * items_per_page end = start + items_per_page keyboard = InlineKeyboardBuilder() # Добавляем кнопки операторов в виде 2 столбцов for op in operator_list[start:end]: display_name = OPERATOR_DISPLAY_NAMES.get(op, op) keyboard.button(text=display_name, callback_data=f"operator:{op}") keyboard.adjust(2) # Кнопки навигации по страницам в одну строку nav_buttons = [] if page > 0: nav_buttons.append(types.InlineKeyboardButton(text="⬅️ Назад", callback_data=f"operator_page:{page - 1}")) if end < len(operator_list): nav_buttons.append(types.InlineKeyboardButton(text="➡️ Вперёд", callback_data=f"operator_page:{page + 1}")) if nav_buttons: keyboard.row(*nav_buttons) # Кнопка для возврата в главное меню keyboard.row(types.InlineKeyboardButton(text="🔙 Назад", callback_data="cancel_operator_selection")) await safe_edit_or_send_message( message=callback_query.message, new_text="Выберите оператора из списка:", state=state, reply_markup=keyboard.as_markup() ) await state.set_state(OperatorSettings.selecting_operator)async def operator_page_handler(callback_query: types.CallbackQuery, state: FSMContext): page = int(callback_query.data.split(':')[1]) await select_operator_handler(callback_query, state, page)
async def cancel_operator_selection_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") await state.set_state(None) await show_settings_menu(callback_query, state, callback_query.from_user.id)
async def operator_selected_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") operator = callback_query.data.split(":")[1] set_user_operator(callback_query.from_user.id, operator) display_name = OPERATOR_DISPLAY_NAMES.get(operator, operator) await safe_edit_or_send_message( message=callback_query.message, new_text=f"Вы выбрали оператора: {display_name}", state=state ) await state.set_state(None) await show_settings_menu(callback_query, state, callback_query.from_user.id)
async def select_country_handler(callback_query: types.CallbackQuery, state: FSMContext, page: int = 0): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}")
countries_list = list(COUNTRIES.items()) items_per_page = 10 start = page * items_per_page end = start + items_per_page keyboard = InlineKeyboardBuilder() # Добавляем кнопки стран в виде 2 столбцов for country_code, country_name in countries_list[start:end]: keyboard.button(text=country_name, callback_data=f"country:{country_code}") keyboard.adjust(2) # Кнопки навигации по страницам в одну строку nav_buttons = [] if page > 0: nav_buttons.append(types.InlineKeyboardButton(text="⬅️ Назад", callback_data=f"country_page:{page - 1}")) if end < len(countries_list): nav_buttons.append(types.InlineKeyboardButton(text="➡️ Вперёд", callback_data=f"country_page:{page + 1}")) if nav_buttons: keyboard.row(*nav_buttons) # Основная кнопка "Назад" для возврата в главное меню keyboard.row(types.InlineKeyboardButton(text="🔙 Назад", callback_data="cancel_country_selection")) await safe_edit_or_send_message( message=callback_query.message, new_text="Выберите страну из списка:", state=state, reply_markup=keyboard.as_markup() ) await state.set_state(CountrySettings.selecting_country)async def country_page_handler(callback_query: types.CallbackQuery, state: FSMContext): page = int(callback_query.data.split(':')[1]) await select_country_handler(callback_query, state, page)
async def country_selected_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}")
country_code = callback_query.data.split(":")[1] set_user_country(callback_query.from_user.id, country_code) country_name = COUNTRIES.get(country_code, country_code) await state.update_data(selected_country_code=country_code) current_operator = get_user_operator(callback_query.from_user.id) or "any" available_operators = COUNTRY_OPERATORS.get(country_code, []) if current_operator not in available_operators: set_user_operator(callback_query.from_user.id, "any") await safe_edit_or_send_message( message=callback_query.message, new_text=f"Вы выбрали страну: {country_name}", state=state ) await state.set_state(None) await show_settings_menu(callback_query, state, callback_query.from_user.id)async def cancel_country_selection_handler(callback_query: types.CallbackQuery, state: FSMContext): try: await callback_query.answer() except Exception as e: logger.warning(f"Не удалось ответить на callback_query: {e}") await state.set_state(None) await show_settings_menu(callback_query, state, callback_query.from_user.id)
def register_settings_handlers(dp: Dispatcher): dp.callback_query.register(settings_handler, F.data == "settings") dp.callback_query.register(input_api_key_handler, F.data.in_({"edit_api_key", "add_api_key"})) dp.callback_query.register(delete_user_api_key_handler, F.data == "delete_api_key") dp.callback_query.register(back_to_main_menu_handler, F.data == "back_to_main_menu") dp.callback_query.register(cancel_settings_handler, F.data == "cancel_settings") dp.message.register(set_user_api_key_handler, UserSettings.entering_api_key) dp.callback_query.register(select_operator_handler, F.data == "edit_operator") dp.callback_query.register(cancel_operator_selection_handler, F.data == "cancel_operator_selection") dp.callback_query.register(operator_selected_handler, OperatorSettings.selecting_operator, F.data.startswith("operator:")) dp.callback_query.register(operator_page_handler, OperatorSettings.selecting_operator, F.data.startswith("operator_page:")) dp.callback_query.register(select_country_handler, F.data == "edit_country") dp.callback_query.register(country_selected_handler, CountrySettings.selecting_country, F.data.startswith("country:")) dp.callback_query.register(cancel_country_selection_handler, F.data == "cancel_country_selection") dp.callback_query.register(country_page_handler, CountrySettings.selecting_country, F.data.startswith("country_page:"))
- Assistant
Улучшение интерфейса вашего бота может сделать его более удобным и интуитивно понятным для пользователей. Вот несколько идей, которые могут помочь в этом:
-
Используйте эмодзи для кнопок и сообщений: Добавление эмодзи делает интерфейс визуально привлекательным и помогает пользователям быстро ассоциировать кнопки с их функциями. Вы уже применяете это в некоторых местах, но можно подумать о расширении этого подхода.
-
Добавьте подтверждающие сообщения: После выполнения важных действий, таких как изменение API ключа или выбора оператора, добавьте сообщение с подтверждением действия, а также возможность отменить действие, если оно было совершено по ошибке.
-
Используйте многоязычность: Поддержка нескольких языков делает бота более доступным для пользователей, которые не говорят на русском языке. Вы можете начать с добавления отдельного механизма выбора языка и адаптации сообщений под него.
-
Интеграция помощника: Добавление в систему информации о том, что следует делать в случае неправильного выбора, будет очень полезно. Например, если API ключ неверный, предоставьте шаги по исправлению.
-
Добавление раздела FAQ: Для сложных или неоднозначных интерфейсов добавление пунктов с часто задаваемыми вопросами может быть очень полезным. Это может быть как отдельная кнопка, так и дополнительные разъяснения в существующих разделах.
-
Оптимизация структуры меню: Вы можете пересмотреть структуру меню, чтобы минимизировать количество шагов, необходимых для достижения основного функционала. Например, сделайте навигацию по операторам и странам через выпадающие списки или другую более компактную форму.
-
Добавьте вывод состояния: Отображайте текущее состояние пользователя (например, выбранный оператор или API ключ) в верхней части интерфейса, чтобы пользователи могли быстро вспомнить, какие настройки у них активны.
-
Используйте progress индикаторы: Если в процессе настройки или использования бота у пользователей может затянуться выполнение, используйте индикаторы прогресса для наглядного отображения статуса выполнения.
-
Улучшение управления ошибками: Улучшите обработку ошибок и уведомления об ошибках. Определите разные типы ошибок и предоставьте пользователям руководство по их устранению.
-
Адаптивный дизайн: Убедитесь, что интерфейс бота адаптируется под разные форматы устройств (смартфоны, планшеты, ПК). Это поможет пользователям взаимодействовать с ботом комфортно в любых условиях.
Попробуйте внедрить некоторые из этих изменений, протестируйте новый интерфейс с вашими пользователями и соберите обратную связь для дальнейшего улучшения.
-
- User
ты можешь что-то улучшить кокнертн ов этом коде?
- Assistant
Без конкретного контекста или обратной связи о том, какие части вашего пользовательского интерфейса нуждаются в улучшении, вот несколько общих предложений по улучшению вашего кода:
-
Упрощение и рефакторинг:
- Каждая функция выполняет определённую задачу, но можно попробовать разбить длинные функции на более мелкие. Например, разбиение
select_operator_handlerиselect_country_handlerможет повысить читаемость кода. - Удалите повторяющийся код, особенно в обработчиках ответов от пользователя. Например, ответ на
callback_queryвсегда обернут вtry-except. Эту обработку можно вынести в отдельную функцию-декоратор.
- Каждая функция выполняет определённую задачу, но можно попробовать разбить длинные функции на более мелкие. Например, разбиение
-
Улучшение информативности сообщений:
- Все сообщения пользователям лучше сделать лаконичными и чёткими, избегая излишних технических подробностей. Подумайте о том, чтобы разбивать сложные инструкции на более простые шаги или добавлять переносы строк для удобочитаемости.
- Можно использовать ключевые шрифты (
bold,italic) для выделения важной информации.
-
Оптимизация структуры клавиатуры:
- Убедитесь, что клавиатура не переполнена кнопками. Когда показываете длинные списки операторов или стран, попробуйте динамически загружать данные, улучшив при этом пагинацию и учесть её функции в отдельные компоненты или классы.
-
Безопасность:
- Информацию об API ключах стоит дополнительно оберегать не только на словах в UI, но и как часть логики. Подумайте над вариантами временных ключей или хранением хэшей вместо самих ключей (если возможно).
-
Логирование и отладка:
- Рассмотрите возможность добавления контекстуальных логов, чтобы можно было быстрее выяснять, что шло не так в определённых сценариях. Ваши логи уже включают информацию об ошибках, но стоит также логи действий пользователей — это особенно полезно для аналитики и улучшения UX.
-
Документация:
- Добавьте более подробные комментарии или докстринги к важным обработчикам и функциям, чтобы другие разработчики или вы в будущем могли проще ориентироваться в коде.
Применяя эти обобщённые советы к своему конкретному коду, вы можете обеспечить большую ясность, читабельность и поддержку, что в общем также приведёт к улучшению пользовательского интерфейса вашего бота.
-