В предишна публикация разбрахме как да създадем бот, инициализирахме екземпляр на класа Bot и се запознах с методите за изпращане на съобщения чрез него.

В тази статия продължавам тази тема, така че препоръчвам да започнете да четете тази статия само след като я прочетете първата част.

Този път ще разберем как да съживим нашия бот и да добавим поддръжка на команди към него, а също така ще се запознаем с класа Updater.

По време на статията ще напишем няколко прости бота, като последните ще определят на базата на дадена дата и код на държавата дали даден ден в дадена държава е уикенд или работен ден според производствения календар. Но, както и преди, целта на статията е да ви запознае с интерфейса на пакета telegram.bot за да разрешите собствените си проблеми.

Всички статии от поредицата “Писане на телеграм бот в R”

1. Ние създаваме бот и го използваме за изпращане на съобщения в telegram
2. Добавете поддръжка на команди и филтри за съобщения към бота

Съдържание

Ако се интересувате от анализ на данни, може да се интересувате от моя телеграма и YouTube канали. По-голямата част от съдържанието на който е посветено на езика R.

1. Клас на актуализатор
2. Хендлери - манипулатори
3. Добавете първата команда към бота, манипулатор на команди
4. Процесор и филтри за текстови съобщения
5. Добавяне на команди с параметри
6. Стартирайте бота във фонов режим
7. Заключение

Клас на актуализатор

Updater е клас, който ви улеснява да разработите бот за телеграма и използва класа под капака Dispetcher. Задание на класа Updater е да получавате актуализации от бота (в предишната статия използвахме метода за тази цел getUpdates()), и ги прехвърлете по-нататък към Dispetcher.

На свой ред Dispetcher съдържа манипулаторите, които сте създали, т.е. клас обекти Handler.

Хендлери - манипулатори

С манипулатори, към които добавяте Dispetcher реакции на бот към различни събития. Към момента на писане на тази статия в telegram.bot Добавени са следните типове манипулатори:

• MessageHandler — Манипулатор на съобщения
• CommandHandler — Манипулатор на команди
• CallbackQueryHandler — Обработчик на данни за клавиатури, изпратени от Inline
• ErrorHandler — Обработчик на грешка при искане на актуализации от бота

Добавете първата команда към бота, манипулатор на команди

Ако никога преди не сте използвали ботове и не знаете какво е команда, тогава командите към бота трябва да се изпращат с наклонена черта / като префикс.

Ще започнем с прости команди, т.е. нека научим нашия бот да казва здравей при команда /hi.

Код 1: Обучаване на бота да казва здравей

library(telegram.bot)

# создаём экземпляр класса Updater
updater <- Updater('ТОКЕН ВАШЕГО БОТА')

# Пишем метод для приветсвия
say_hello <- function(bot, update) {

  # Имя пользователя с которым надо поздароваться
  user_name <- update$message$from$first_name

  # Отправка приветственного сообщения
  bot$sendMessage(update$message$chat_id, 
                  text = paste0("Моё почтение, ", user_name, "!"), 
                  parse_mode = "Markdown")

}

# создаём обработчик 
hi_hendler <- CommandHandler('hi', say_hello)

# добаляем обработчик в диспетчер
updater <- updater + hi_hendler

# запускаем бота
updater$start_polling()

Стартирайте примерния код по-горе, след като замените „YOUR BOT TOKEN“ с истинския токен, който сте получили при създаването на бота чрез Бот баща (Говорих за създаване на бот в първа статия).

метод start_polling() клас Updater, който се използва в края на кода, стартира безкраен цикъл на искане и обработка на актуализации от бота.

Сега нека отворим Telegram и напишем първата команда на нашия бот /hi.

Сега нашият бот разбира командата /hi, и знае как да ни поздрави.

Схематично процесът на изграждане на такъв прост бот може да бъде изобразен по следния начин.

1. Създайте екземпляр на класа Updater;
2. Ние създаваме методи, т.е. функции, които нашият бот ще изпълнява. В примерния код това е функция say_hello(). Функциите, които ще използвате като бот методи, трябва да имат два задължителни аргумента - бот и актуализацияи едно по желание - аргументи. Аргумент бот, това е вашият бот, с негова помощ можете да отговаряте на съобщения, да изпращате съобщения или да използвате всякакви други методи, достъпни за бота. Аргумент актуализация това е, което ботът получи от потребителя, всъщност това, което получихме в първата статия, използвайки метода getUpdates(). Аргумент аргументи ви позволява да обработвате допълнителни данни, изпратени от потребителя заедно с командата, ще се върнем към тази тема малко по-късно;
3. Ние създаваме манипулатори, т.е. Свързваме някои потребителски действия с методите, създадени в предишната стъпка. По същество манипулаторът е тригер, събитие, което извиква някаква функция на бот. В нашия пример такъв тригер е изпращането на команда /hi, и се изпълнява от екипа hi_hendler <- CommandHandler('hi', say_hello). Първи аргумент на функцията CommandHandler() ви позволява да посочите команда, в нашия случай hi, на което ботът ще отговори. Вторият аргумент ви позволява да посочите метода на бота, ние ще извикаме метода say_hello, който ще бъде изпълнен, ако потребителят извика командата, посочена в първия аргумент;
4. След това добавяме създадения манипулатор към диспечера на екземпляра на нашия клас Updater. Можете да добавите манипулатори по няколко начина; в горния пример използвах най-простия, използвайки знака +, това е updater <- updater + hi_hendler. Същото може да се направи и с помощта на метода add_handler(), който принадлежи към класа Dispatcher, можете да намерите този метод по следния начин: updater$dispatcher$add_handler();
5. Стартирайте бота с помощта на командата start_polling().

Процесор и филтри за текстови съобщения

Разбрахме как да изпращаме команди до бота, но понякога имаме нужда ботът да отговаря не само на команди, но и на някои обикновени текстови съобщения. За да направите това, трябва да използвате манипулатори на съобщения − MessageHandler.

обикновен MessageHandler ще отговаря на абсолютно всички входящи съобщения. Следователно манипулаторите на съобщения често се използват заедно с филтри. Нека научим бота да казва здравей не само по команда /hi, но също и когато една от следните думи се появи в съобщението, изпратено до бота: здравей, здравей, поздрав, хай, бонжур.

Засега няма да пишем нови методи, защото... Вече имаме метод, по който ботът ни поздравява. Всичко, което трябва да направим, е да създадем необходимия филтър и манипулатор на съобщения.

Код 2: Добавяне на манипулатор на текстови съобщения и филтър

library(telegram.bot)

# создаём экземпляр класса Updater
updater <- Updater('ТОКЕН ВАШЕГО БОТА')

# Пишем метод для приветсвия
## команда приветвия
say_hello <- function(bot, update) {

  # Имя пользователя с которым надо поздароваться
  user_name <- update$message$from$first_name

  # Отправляем приветсвенное сообщение
  bot$sendMessage(update$message$chat_id, 
                  text = paste0("Моё почтение, ", user_name, "!"),
                  parse_mode = "Markdown",
                  reply_to_message_id = update$message$message_id)

}

# создаём фильтры
MessageFilters$hi <- BaseFilter(function(message) {

  # проверяем, встречается ли в тексте сообщения слова: привет, здравствуй, салют, хай, бонжур
  grepl(x           = message$text, 
        pattern     = 'привет|здравствуй|салют|хай|бонжур',
        ignore.case = TRUE)
  }
)

# создаём обработчик 
hi_hendler <- CommandHandler('hi', say_hello) # обработчик команды hi
hi_txt_hnd <- MessageHandler(say_hello, filters = MessageFilters$hi)

# добаляем обработчики в диспетчер
updater <- updater + 
             hi_hendler +
             hi_txt_hnd

# запускаем бота
updater$start_polling()

Стартирайте примерния код по-горе, след като замените „YOUR BOT TOKEN“ с истинския токен, който сте получили при създаването на бота чрез Бот баща (Говорих за създаване на бот в първа статия).

Сега нека се опитаме да изпратим на бота няколко съобщения, съдържащи поздравителните думи, изброени по-рано:

И така, първо, научихме бота не просто да казва здравей, но и да отговаря на поздрав. Направихме това с помощта на аргумента reply_to_message_id, който е наличен в метода sendMessage(), в който трябва да прехвърлите идентификатора на съобщението, на което искате да отговорите. Можете да получите идентификатора на съобщението по следния начин: update$message$message_id.

Но основното нещо, което направихме, беше да добавим филтър към бота, използвайки функцията BaseFilter():

# создаём фильтры
MessageFilters$hi <- BaseFilter( 

  # анонимная фильтрующая функция
  function(message) {

    # проверяем, встречается ли в тексте сообщения слова приветствия
    grepl(x           = message$text, 
          pattern     = 'привет|здравствуй|салют|хай|бонжур',
          ignore.case = TRUE)
  }

)

Както може би сте забелязали, към обекта трябва да се добавят филтри MessageFilters, който първоначално вече съдържа малък набор от готови филтри. В нашия пример към обекта MessageFilters добавихме елемент hi, това е нов филтър.

Във функция BaseFilter() трябва да преминете филтърната функция. По същество филтърът е просто функция, която получава екземпляр на съобщение и връща TRUE или FALSE. В нашия пример написахме проста функция, която използвайки основната функция grepl() проверява текста на съобщението и дали съвпада с регулярния израз привет|здравствуй|салют|хай|бонжур се завръща TRUE.

След това създаваме манипулатор на съобщения hi_txt_hnd <- MessageHandler(say_hello, filters = MessageFilters$hi). Първи аргумент на функцията MessageHandler() е методът, който ще извика манипулатора, а вторият аргумент е филтърът, чрез който ще бъде извикан. В нашия случай това е филтърът, който създадохме MessageFilters$hi.

Е, в крайна сметка добавяме към диспечера създадения манипулатор hi_txt_hnd.

updater <- updater + 
             hi_hendler +
             hi_txt_hnd

Както писах по-горе, в опаковката telegram.bot и обект MessageFilters Вече има набор от вградени филтри, които можете да използвате:

• всички — Всички съобщения
• текст — Текстови съобщения
• команда — Команди, т.е. съобщения, които започват с /
• отговор — Съобщения, които са отговор на друго съобщение
• аудио — Съобщения, съдържащи аудио файл
• документ — Съобщения с изпратен документ
• снимка - Съобщения с изпратени изображения
• стикер — Съобщения с изпратен стикер
• видео — Съобщения с видео
• voice - Гласови съобщения
• контакт — Съобщения, съдържащи съдържанието на телеграмата на потребителя
• местоположение — Съобщения с геолокация
• място — Препратени съобщения
• игра — Игри

Ако искате да комбинирате няколко филтри в един манипулатор, просто използвайте знака | - като логично ИЛИ, и подпишете & като логично И. Например, ако искате ботът да извика същия метод, когато получи видео, изображение или документ, използвайте следния пример, за да създадете манипулатор на съобщения:

handler <- MessageHandler(callback, 
  MessageFilters$video | MessageFilters$photo | MessageFilters$document
)

Добавяне на команди с параметри

Вече знаем какви са командите, как да ги създадем и как да принудим бота да изпълни желаната команда. Но в някои случаи, в допълнение към името на командата, трябва да предадем някои данни, за да я изпълним.

По-долу е даден пример за бот, който при дадена дата и държава ви връща типа ден от производствения календар.

Ботът по-долу използва API на производствения календар isdayoff.ru.

Код 3: Бот, който отчита по дата и държава

library(telegram.bot)

# создаём экземпляр класса Updater
updater <- Updater('1165649194:AAFkDqIzQ6Wq5GV0YU7PmEZcv1gmWIFIB_8')

# Пишем метод для приветсвия
## команда приветвия
check_date <- function(bot, update, args) {

  # входящие данные
  day     <- args[1]  # дата
  country <- args[2]  # страна

  # проверка введённых параметров
  if ( !grepl('\d{4}-\d{2}-\d{2}', day) ) {

    # Send Custom Keyboard
    bot$sendMessage(update$message$chat_id, 
                    text = paste0(day, " - некорреткная дата, введите дату в формате ГГГГ-ММ-ДД"),
                    parse_mode = "Markdown")

  } else {
    day <- as.Date(day)
    # переводим в формат POSIXtl
    y <- format(day, "%Y")
    m <- format(day, "%m")
    d <- format(day, "%d")

  }

  # страна для проверки
  ## проверяем задана ли страна
  ## если не задана устанавливаем ru
  if ( ! country %in% c('ru', 'ua', 'by', 'kz', 'us') ) {

    # Send Custom Keyboard
    bot$sendMessage(update$message$chat_id, 
                    text = paste0(country, " - некорретктный код страны, возможнные значения: ru, by, kz, ua, us. Запрошены данные по России."),
                    parse_mode = "Markdown")

    country <- 'ru'

  }

  # запрос данных из API
  # компоновка HTTP запроса
  url <- paste0("https://isdayoff.ru/api/getdata?",
                "year=",  y, "&",
                "month=", m, "&",
                "day=",   d, "&",
                "cc=",    country, "&",
                "pre=1&",
                "covid=1")

  # получаем ответ
  res <- readLines(url)

  # интрепретация ответа
  out <- switch(res, 
                "0"   = "Рабочий день",
                "1"   = "Нерабочий день",
                "2"   = "Сокращённый рабочий день",
                "4"   = "covid-19",
                "100" = "Ошибка в дате",
                "101" = "Данные не найдены",
                "199" = "Ошибка сервиса")

  # отправляем сообщение
  bot$sendMessage(update$message$chat_id, 
                  text = paste0(day, " - ", out),
                  parse_mode = "Markdown")

}

# создаём обработчик 
date_hendler <- CommandHandler('check_date', check_date, pass_args = TRUE)

# добаляем обработчик в диспетчер
updater <- updater + date_hendler

# запускаем бота
updater$start_polling()

Стартирайте примерния код по-горе, след като замените „YOUR BOT TOKEN“ с истинския токен, който сте получили при създаването на бота чрез Бот баща (Говорих за създаване на бот в първа статия).

Създадохме бот, който има само един метод в своя арсенал check_date, този метод се извиква от едноименната команда.

Но в допълнение към името на командата, този метод изисква да въведете два параметъра, кода на държавата и датата. След това ботът проверява дали даден ден в посочената държава е уикенд, съкратен ден или работен ден според официалния производствен календар.

За да може методът, който създаваме, да приема допълнителни параметри заедно с командата, използвайте аргумента pass_args = TRUE във функция CommandHandler(), и при създаване на метод, в допълнение към задължителните аргументи бот, актуализация създайте незадължителен - аргументи. Създаденият по този начин метод ще приеме параметрите, които предавате на бота след името на командата. Параметрите трябва да бъдат разделени с интервал; те ще бъдат изпратени на метода като текстов вектор.

Нека стартираме и тестваме нашия бот.

Стартирайте бота във фонов режим

Последната стъпка, която трябва да изпълним, е да стартираме бота във фонов режим.

За да направите това, следвайте алгоритъма, описан по-долу:

1. Запазете кода на бота във файл с разширение R. При работа в RStudio това става през менюто досие, екип Запази като.
2. Добавете пътя към папката bin, която от своя страна се намира в папката, в която сте инсталирали езика R, към променливата Path, инструкции тук.
3. Създайте обикновен текстов файл, в който напишете 1 ред: R CMD BATCH C:UsersAlseyDocumentsmy_bot.R... Вместо C:UsersAlseyDocumentsmy_bot.R напишете пътя до вашия бот скрипт. В същото време е важно да няма кирилски знаци или интервали по пътя, т.к това може да причини проблеми при стартиране на бота. Запазете го и заменете разширението му с TXT на НДНТ.
4. Отворете Windows Task Scheduler, има много начини да направите това, например отворете която и да е папка и въведете адреса %windir%system32taskschd.msc /s. Могат да бъдат намерени и други методи за стартиране тук.
5. В горното дясно меню на планировчика щракнете върху „Създаване на задача...“.
6. В раздела „Общи“ дайте потребителско име на задачата си и превключете превключвателя в състояние „Изпълни за всички потребители“.
7. Отидете в раздела „Действия“, щракнете върху „Създаване“. В полето "Програма или скрипт" щракнете върху "Преглед", намерете създадения във втората стъпка НДНТ файл и щракнете върху OK.
8. Щракнете върху OK и, ако е необходимо, въведете паролата за вашия акаунт в операционната система.
9. Намерете създадената задача в планировчика, изберете я и щракнете върху бутона „Изпълни“ в долния десен ъгъл.

Нашият бот работи във фонов режим и ще работи, докато не спрете задачата или не изключите вашия компютър или сървър, на който е стартиран.

Заключение

В тази статия разбрахме как да напишем пълноценен бот, който може не само да изпраща съобщения, но и да отговаря на входящи съобщения и команди. Придобитите знания вече са достатъчни, за да разрешите повечето от вашите проблеми.

Следващата статия ще говори за това как да добавите клавиатура към бота за по-удобна работа.

Абонирайте се за моите телеграма и YouTube канали.

Източник: www.habr.com