Merge pull request #154 from Birdi7/keyboards-example

Add keyboards usage examples

examples/inline_keyboard_example.py

@@ -0,0 +1,56 @@
+"""
+This bot is created for the demonstration of a usage of inline keyboards.
+"""
+
+import logging
+
+from aiogram import Bot, Dispatcher, executor, types
+
+API_TOKEN = 'BOT_TOKEN_HERE'
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+# Initialize bot and dispatcher
+bot = Bot(token=API_TOKEN)
+dp = Dispatcher(bot)
+
+
+@dp.message_handler(commands=['start'])
+async def start_cmd_handler(message: types.Message):
+    keyboard_markup = types.InlineKeyboardMarkup(row_width=3)
+    # default row_width is 3, so here we can omit it actually
+    # kept for clearness
+
+    keyboard_markup.row(types.InlineKeyboardButton("Yes!", callback_data='yes'),
+                        # in real life for the callback_data the callback data factory should be used
+                        # here the raw string is used for the simplicity
+                        types.InlineKeyboardButton("No!", callback_data='no'))
+
+    keyboard_markup.add(types.InlineKeyboardButton("aiogram link",
+                                                   url='https://github.com/aiogram/aiogram'))
+    # url buttons has no callback data
+
+    await message.reply("Hi!\nDo you love aiogram?", reply_markup=keyboard_markup)
+
+
+@dp.callback_query_handler(lambda cb: cb.data in ['yes', 'no'])  # if cb.data is either 'yes' or 'no'
+# @dp.callback_query_handler(text='yes') # if cb.data == 'yes'
+async def inline_kb_answer_callback_handler(query: types.CallbackQuery):
+    await query.answer()  # send answer to close the rounding circle
+
+    answer_data = query.data
+    logger.debug(f"answer_data={answer_data}")
+    # here we can work with query.data
+    if answer_data == 'yes':
+        await bot.send_message(query.from_user.id, "That's great!")
+    elif answer_data == 'no':
+        await bot.send_message(query.from_user.id, "Oh no...Why so?")
+    else:
+        await bot.send_message(query.from_user.id, "Invalid callback data!")
+
+
+if __name__ == '__main__':
+    executor.start_polling(dp, skip_updates=True)

examples/regular_keyboard_example.py

@@ -0,0 +1,61 @@
+"""
+This bot is created for the demonstration of a usage of regular keyboards.
+"""
+
+import logging
+
+from aiogram import Bot, Dispatcher, executor, types
+
+API_TOKEN = 'BOT_TOKEN_HERE'
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+# Initialize bot and dispatcher
+bot = Bot(token=API_TOKEN)
+dp = Dispatcher(bot)
+
+
+@dp.message_handler(commands=['start'])
+async def start_cmd_handler(message: types.Message):
+    keyboard_markup = types.ReplyKeyboardMarkup(row_width=3)
+    # default row_width is 3, so here we can omit it actually
+    # kept for clearness
+
+    keyboard_markup.row(types.KeyboardButton("Yes!"),
+                        types.KeyboardButton("No!"))
+    # adds buttons as a new row to the existing keyboard
+    # the behaviour doesn't depend on row_width attribute
+
+    keyboard_markup.add(types.KeyboardButton("I don't know"),
+                        types.KeyboardButton("Who am i?"),
+                        types.KeyboardButton("Where am i?"),
+                        types.KeyboardButton("Who is there?"))
+    # adds buttons. New rows is formed according to row_width parameter
+
+    await message.reply("Hi!\nDo you love aiogram?", reply_markup=keyboard_markup)
+
+
+@dp.message_handler()
+async def all_msg_handler(message: types.Message):
+    # pressing of a KeyboardButton is the same as sending the regular message with the same text
+    # so, to handle the responses from the keyboard, we need to use a message_handler
+    # in real bot, it's better to define message_handler(text="...") for each button
+    # but here for the simplicity only one handler is defined
+
+    text_of_button = message.text
+    logger.debug(text_of_button) # print the text we got
+
+    if text_of_button == 'Yes!':
+        await message.reply("That's great", reply_markup=types.ReplyKeyboardRemove())
+    elif text_of_button == 'No!':
+        await message.reply("Oh no! Why?", reply_markup=types.ReplyKeyboardRemove())
+    else:
+        await message.reply("Keep calm...Everything is fine", reply_markup=types.ReplyKeyboardRemove())
+    # with message, we send types.ReplyKeyboardRemove() to hide the keyboard
+
+
+if __name__ == '__main__':
+    executor.start_polling(dp, skip_updates=True)