One place for hosting & domains

      бота

      Создание бота Discord Bot с помощью Node.js


      Автор выбрал фонд Free and Open Source Fund для получения пожертвования в рамках программы Write for DOnations.

      Введение

      Discord — это приложение чата, позволяющее миллионам пользователей со всего мира обмениваться сообщениями и общаться в голосовом чате в сообществах, называемых «гильдии» или «серверы». Discord также включает функциональный API, который разработчики смогут использовать для построения мощных ботов Discord. Боты могут выполнять разнообразные действия, в том числе отправлять сообщения на серверы, отправлять пользователям сообщения DM, модерировать серверы и воспроизводить звук в голосовых чатах. Это позволяет разработчикам создавать мощных ботов со сложными и продвинутыми функциями, включая инструменты модерирования и даже игры. Например, служебный бот Dyno обслуживает миллионы гильдий и содержит множество полезных функций, включая защиту от спама, музыкальный проигрыватель и другие служебные функции. Научившись создавать боты Discord, вы получите множество возможностей, с которыми тысячи людей смогут взаимодействовать каждый день.

      В этом обучающем модуле мы создадим бот Discord с нуля, используя Node.js и библиотеку Discord.js, позволяющую пользователям взаимодействовать с Discord API напрямую. Мы настроим профиль бота Discord, получим токены аутентификации для бота и запрограммируем бот для обработки отправляемых пользователями команд с аргументами.

      Предварительные требования

      Для начала вам потребуется следующее:

      Шаг 1 — Настройка бота Discord

      На этом шаге вы будете использовать графический интерфейс разработчиков Discord для настройки бота Discord и получения токена бота, который вы передадите в свою программу.

      Чтобы зарегистрировать бота на платформе Discord, используйте панель приложений Discord. Здесь разработчики могут создавать приложения Discord, включая ботов Discord.

      Изображение панели приложений Discord после первого посещения сайта https://discord.com/developers/applications

      Для начала нажмите New Application (Новое приложение). Discord предложит вам ввести имя нового приложения. Затем нажмите Create (Создать) для создания приложения.

      Изображение командной строки для создания приложения с введенным именем приложения

      Примечание. Имя приложения не связано с именем бота, и эти имена могут не совпадать.

      Теперь откройте свою панель приложения. Чтобы добавить бота в приложение, откройте вкладку Bot (Бот) на панели навигации слева.

      Изображение вкладки Bot на панели приложений

      Нажмите кнопку Add Bot (Добавить бота), чтобы добавить бота в приложение. Нажмите кнопку Yes, do it! (Да, сделать это!) в диалоге запроса подтверждения. Откроется панель с подробными сведениями об имени вашего бота, токене аутентификации и изображении в профиле.

      Панель с подробными сведениями о боте

      На этой панели вы можете изменить имя бота или изображение профиля. Также необходимо скопировать токен аутентификации бота, нажав Click to Reveal Token (Нажмите для показа токена) и скопировав отображаемый токен.

      Предупреждение. Никогда не публикуйте и не выгружайте в сеть свой токен бота, поскольку это позволит любому пользователю выполнить вход в бот.

      Теперь нужно создать приглашение, которое позволяет добавить гильдии ботов Discord, где вы можете протестировать бот. Вначале перейдите на вкладку OAuth2 на панели приложения. Чтобы создать приглашения, прокрутите страницу и выберите бота в разделе scopes. Также необходимо установить разрешения, чтобы определить, какие действия бот может выполнять в гильдиях. Для целей этого обучающего модуля выберите пункт Administrator (Администратор), которые дадут вашему боту разрешения для выполнения в гильдиях практически любых действий. Скопируйте ссылку с помощью кнопки Copy.

      Вкладка OAuth2 с установленной сферой действия bot и уровнем разрешений administator

      Затем добавьте бот на сервер. Перейдите по созданной ссылке с приглашением. Вы можете добавить бот на любой сервер, который вам принадлежит или на котором у вас есть права администратора, используя выпадающее меню.

      Страница после перехода по ссылке с приглашением, что позволяет пользователям добавлять бот на серверы

      Теперь нажмите кнопку Continue (Продолжить). Обязательно установите отметку рядом с полем Administrator, чтобы предоставить боту разрешения администратора. Затем нажмите Authorize (Авторизация). Discord предложит вам решить головоломку CAPTCHA, прежде чем бот сможет подключиться к серверу. Теперь наш бот Discord отображается в списке пользователей сервера, на который вы добавили бота, со статусом offline (не в сети).

      Список пользователей сервера Discord с новым ботом в разделе offline списка пользователей

      Вы успешно создали бота Discord и добавили его на сервер. Далее мы напишем программу для входа в бот.

      Шаг 2 — Создание проекта

      На этом шаге мы настроим базовую среду программирования, где выполним сборку бота и войдем в него программным путем.

      Вначале необходимо настроить папку проекта и необходимые файлы проекта для бота.

      Создайте папку проекта:

      Перейдите в только что созданную папку проекта:

      Далее используйте текстовый редактор для создания файла с именем config.json для сохранения токена аутентификации вашего бота:

      Затем добавьте в файл конфигурации следующий код, заменяя выделенный текст токеном аутентификации вашего бота:

      config.json

      {
          "BOT_TOKEN": "YOUR BOT TOKEN"
      }
      

      Сохраните и закройте файл.

      Затем мы создадим файл package.json, где будут храниться детали нашего проекта и информация о зависимостях, используемых в проекте. Для создания файла package.json запустите следующую команду npm:

      npm запросит различные детали вашего проекта. Если вам нужны указания по ответам на эти запросы, воспользуйтесь руководством «Использование модулей Node.js с npm и package.json».

      Сейчас мы установим пакет discord.js, который будем использовать для взаимодействия с Discord API. Вы можете установить discord.js через npm с помощью следующей команды:

      Мы настроили файл конфигурации, установили необходимую зависимость и теперь можем начать сборку бота. В реальном приложении мы бы разделили код большого бота на несколько файлов, но в этом обучающем модуле мы поместим весь код бота в один файл.

      Вначале создайте файл с именем index.js в папке discord-bot для кода:

      Начните программирование бота, запросив зависимость discord.js и файл конфигурации с токеном бота:

      index.js

      const Discord = require("discord.js");
      const config = require("./config.json");
      

      После этого добавьте следующие две строки кода:

      index.js

      ...
      const client = new Discord.Client();
      
      client.login(config.BOT_TOKEN);
      

      Сохраните и закройте файл.

      Первая строка кода создает новый клиент Discord.Client и назначает его как значение константы client. Этот клиент частично обеспечивает взаимодействие с Discord API и получает уведомления Discord о событиях, например, о новых сообщениях. Фактически клиент представляет бот Discord.

      Во второй строке кода метод login используется на клиенте для входа в созданный бот Discord с использованием токена в файле config.json в качестве пароля. Токен сообщает Discord API, для какого бота предназначена программа, а также подтверждает вашу аутентификацию для использования бота.

      Теперь запустите файл index.js с помощью Node:

      Теперь статус вашего бота на сервере Discord, куда вы его добавили, изменится на online (в сети).

      Изображение бота со статусом online

      Мы успешно настроили среду программирования и создали базовый код для входа в бот Discord. На следующем шаге мы займемся пользовательскими командами и заставим бота выполнить определенные действия, например, отправить сообщения.

      Шаг 3 — Обработка первой команды пользователя

      На этом шаге мы создадим бот, который может обрабатывать команды пользователя. Вы запустите свою первую команду ping, на которую будет отправлен ответ pong с указанием времени ответа на команду.

      Сначала необходимо обеспечить обнаружение и получение любых отправляемых пользователями сообщений, чтобы бот мог обрабатывать любые команды. Используя метод on клиента Discord, Discord будет отправлять вам уведомления о новых событиях. Метод on принимает два аргумента: название ожидаемого события и функцию, которая будет запускаться каждый раз, когда будет возникать это событие. С этим методом вы можете ожидать события message, которое будет возникать каждый раз при отправке сообщения в гильдию, где у бота имеется разрешение на просмотр сообщений. Поэтому мы создадим функцию, которая будет запускаться для обработки команд каждый раз при отправке сообщения.

      Вначале откройте свой файл:

      Добавьте в файл следующий код:

      index.js

      ...
      const client = new Discord.Client();
      
      
      client.on("message", function(message) { 
                                               
      });                                      
      
      client.login(config.BOT_TOKEN);
      

      Эта функция, выполняемая для события message, принимает параметр message. Параметр message имеет значение экземпляра Discord.js message, содержащее информацию об отправленном сообщении и методах, которые помогут боту ответить на него.

      Добавьте следующую строку кода в функцию обработки команд:

      index.js

      ...
      client.on("message", function(message) {
        if (message.author.bot) return;
      });
      ...
      

      Эта строка проверяет, является ли автор сообщения ботом, и если это так, останавливает обработку команды. Это важно, поскольку обычно нам не нужно обрабатывать сообщения ботов или отвечать на них. Другим ботам обычно не требуется использовать наш бот, и поэтому игнорирование их сообщений позволит нам сэкономить вычислительную мощность и предотвратить случайные ответы.

      Теперь мы напишем обработчик команд. Для этого важно понимать обычный формат команды Discord. Обычно структура команды Discord содержит три части в следующем порядке: префикс, имя команды и (иногда) аргументы команды.

      Изображение типичной команды Discord

      • Префикс: префикс может быть любым, но обычно это знак пунктуации или абстрактная фраза, которая обычно не может располагаться в начале сообщения. Это означает, что при добавлении префикса в начало сообщения бот будет знать, что это команда, которую ему необходимо обработать.

      • Имя команды: имя команды, которое пользователь хочет использовать. Это означает, что бот может поддерживать несколько команд с разными функциями и разрешать пользователям выбирать между ними, используя разные имена команд.

      • Аргументы: иногда команда запрашивает или использует дополнительную информацию от пользователя, и пользователь может указывать аргументы после имени команды, разделяя их пробелами.

      Примечание. Принудительно устанавливаемой структуры команд нет, и боты могут обрабатывать команды как угодно, однако здесь мы описываем эффективную структуру, которую использует большинство ботов.

      Чтобы начать создание синтаксического анализатора команд, поддерживающего этот формат, добавьте следующие строки кода в функцию обработки сообщений:

      index.js

      ...
      const prefix = "!";
      
      client.on("message", function(message) {
        if (message.author.bot) return;
        if (!message.content.startsWith(prefix)) return;
      });
      ...
      

      Первая строка кода добавляется, чтобы присвоить значение "!" константе prefix, которую мы будем использовать в качестве префикса бота.

      Вторая строка кода проверяет, начинается ли содержание обрабатываемого ботом сообщения с заданного префикса, и останавливает дальнейшую обработку сообщения, если префикса нет.

      Теперь необходимо конвертировать остальную часть сообщения в название команды и любые аргументы, которые могут присутствовать в сообщении. Добавьте следующие выделенные строки:

      index.js

      ...
      client.on("message", function(message) {
        if (message.author.bot) return;
        if (!message.content.startsWith(prefix)) return;
      
        const commandBody = message.content.slice(prefix.length);
        const args = commandBody.split(' ');
        const command = args.shift().toLowerCase();
      });
      ...
      

      Первая строка используется для удаления префикса из содержания сообщения и назначения результата константе commandBody. Это необходимо, поскольку нам не нужно, чтобы префикс входил в обработанное имя команды.

      Вторая строка принимает сообщение с удаленным префиксом и использует на нем метод split с пробелом в качестве разделителя. Он разделяет команду на массив субстрок, проводя разделение после каждого пробела. В результате получается массив, содержащий имя команды, за которым идут аргументы (если они содержатся в сообщении). Мы назначаем этот массив константе args.

      Третья строка удаляет первый элемент из массива args (это будет имя команды), конвертирует его в нижний регистр и назначает константе command. Это позволяет изолировать имя команды и оставить в массиве только аргументы. Также мы используем метод toLowerCase, поскольку команды в ботах Discord обычно не учитывают регистр.

      Мы завершили построение синтаксического анализатора команд с реализацией обязательного префикса и получением имени команды и всех аргументов из сообщений. Теперь мы реализуем и создадим код для определенных команд.

      Добавьте следующий код, чтобы начать реализацию команды ping:

      index.js

      ...
        const args = commandBody.split(' ');
        const command = args.shift().toLowerCase();
      
        if (command === "ping") {
                                 
        }                        
      });
      ...
      

      Это выражение if проверяет соответствие обработанного имени команды (назначенного константе command) значению "ping". Такое соответствие означает, что пользователь хочет использовать команду "ping". Мы вложим код определенной команды в блок выражения if. Впоследствии вы сможете использовать этот шаблон для других команд.

      Теперь вы можете реализовать код для команды "ping":

      index.js

      ...
        if (command === "ping") {
          const timeTaken = Date.now() - message.createdTimestamp;
          message.reply(`Pong! This message had a latency of ${timeTaken}ms.`);
        }
      ...
      

      Сохраните и закройте файл.

      Мы добавляем блок команды "ping", который рассчитывает разницу между текущим временем, определяемым с помощью метода now объекта Date, и временной меткой создания сообщения, выражаемую в миллисекундах. Таким образом рассчитывается время обработки сообщения и ответа бота на команду "ping".

      Вторая строка отвечает на команду пользователя, используя метод reply с константой message. Метод reply отправляет запрос ping (уведомляющий пользователя и выделяющий сообщение для указанного пользователя) пользователю, который отправил команду, добавляя после запроса содержание, указанное в качестве первого аргумента метода. Мы указали литераль шаблона, содержащую сообщение и рассчитанное значение ping, в качестве ответа, который будет использоваться методом reply.

      На этом мы завершаем реализацию команды "ping".

      Запустите свой бот с помощью следующей команды (в той же папке, что и index.js):

      Теперь вы можете использовать команду "! ping" на любом канале, где бот может просматривать и принимать сообщения, а также отправлять ответы.

      Изображение бота, отвечающего в Discord на запрос

      Вы успешно создали бот, который может обрабатывать команды пользователей, и реализовали свою первую команду. На следующем шаге мы продолжим разработку бота, реализовав команду sum.

      Шаг 4 — Реализация команды Sum

      Теперь мы расширим нашу программу, реализовав команду "! sum". Эта команда принимает любое количество аргументов, складывает их и возвращает пользователю сумму всех аргументов.

      Если ваш бот Discord еще работает, вы можете остановить его процессы, нажав CTRL + C.

      Откройте файл index.js снова:

      Чтобы начать реализацию команды "! sum", мы используем блок else-if. После проверки имени команды ping бот будет проверять, имеет ли имя команды значение "sum". Мы используем блок else-if, потому что одновременно будет обрабатываться только одна команда, и если программа определит совпадение с именем команды "ping", ей не нужно будет проводить проверку на совпадение с именем команды "sum". Добавьте в файл следующие выделенные строки:

      index.js

      ...
        if (command === "ping") {
          const timeTaken = Date.now() - message.createdTimestamp;
          message.reply(`Ping! This message had a latency of ${timeTaken}ms.`);
        }
      
        else if (command === "sum") {
                                     
        }                            
      });
      ...
      

      Теперь вы можете начать реализацию кода для команды "sum". Код команды "sum" будет размещен в только что созданном нами блоке else-if. Теперь добавьте следующий код:

      index.js

      ...
        else if (command === "sum") {
          const numArgs = args.map(x => parseFloat(x));
          const sum = numArgs.reduce((counter, x) => counter += x);
          message.reply(`The sum of all the arguments you provided is ${sum}!`);
        }
      ...
      

      Мы используем метод map для списка аргументов, чтобы создать новый список, используя функцию parseFloat для каждого элемента в массиве args. При этом создается новый массив (назначенный константе numArgs), где все элементы являются числами, а не строками. Это означает, что в дальнейшем вы можете определить сумму чисел, выполнив операцию сложения.

      Вторая строка использует метод reduce на константе numArgs, предоставляя функцию, суммирующую все элементы в списке. Мы назначаем сумму всех элементов в numArgs как значение константы sum.

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

      Это завершает реализацию команды "sum". Теперь запустите бот, используя следующую команду (в той же папке, что и index.js):

      Теперь вы можете использовать команду "! sum" на любом канале, где бот может просматривать и отправлять сообщения.

      Изображение бота, отвечающего

      Далее приведена законченная версия скрипта бота index.js:

      index.js

      const Discord = require("discord.js");
      const config = require("./config.json");
      
      const client = new Discord.Client();
      
      const prefix = "!";
      
      client.on("message", function(message) {
        if (message.author.bot) return;
        if (!message.content.startsWith(prefix)) return;
      
        const commandBody = message.content.slice(prefix.length);
        const args = commandBody.split(' ');
        const command = args.shift().toLowerCase();
      
        if (command === "ping") {
          const timeTaken = Date.now() - message.createdTimestamp;
          message.reply(`Pong! This message had a latency of ${timeTaken}ms.`);
        }
      
        else if (command === "sum") {
          const numArgs = args.map(x => parseFloat(x));
          const sum = numArgs.reduce((counter, x) => counter += x);
          message.reply(`The sum of all the arguments you provided is ${sum}!`);
        }
      });
      
      client.login(config.BOT_TOKEN);
      

      На этом шаге мы дополнили наш бот Discord, реализовав в нем команду sum.

      Заключение

      Мы успешно создали бот Discord, который может обрабатывать разные команды пользователей и аргументы команд. Если вы хотите расширить возможности вашего бота, вы можете реализовать дополнительные команды или использовать другие части Discord API для построения мощного бота Discord. Вы можете ознакомиться с документацией по Discord.js или Discord API, чтобы узнать больше о Discord API.

      При создании ботов Discord всегда помните об условиях обслуживания Discord API, определяющих требования к использованию Discord API разработчиками. Также вам может быть полезен этот набор рекомендаций, показывающий наилучшие способы построения бота Discord и содержащий советы по проектированию ботов Discord. Если вы хотите узнать больше о Node.js, ознакомьтесь с нашей серией материалов «Программирование в Node.js».



      Source link

      Создание бота Slackbot на Python в Ubuntu 20.04


      Автор выбрал Tech Education Fund для получения пожертвования в рамках программы Write for DOnations.

      Введение

      Slack — это коммуникационная платформа, предназначенная для продуктивной связи на рабочем месте. Она поддерживает прямую отправку сообщений, публичные и частные каналы, телефонию, видеосвязь и интеграцию ботов. Бот Slackbot — это автоматизированная программа, которая может выполнять в Slack разнообразные функции, от отправки сообщений до активации задач и отправки оповещений об определенных событиях.

      В этом обучающем модуле мы создадим бот Slackbot на языке программирования Python. Python — это популярный язык программирования, отличающийся простотой и удобством чтения синтаксиса. В Slack имеется функциональный Python Slack API для интеграции со Slack с целью выполнения распространенных задач, в том числе отправки сообщений, добавления эмодзи в сообщения и т. д. Также в Slack имеется Python Slack Events API для интеграции с событиями в Slack, позволяющий выполнять действия при определенных событиях, например отправлять сообщения и делать упоминания.

      В качестве интересного концептуального испытания, которое покажет возможности Python и его Slack API, мы создадим CoinBot — бот Slackbot, отслеживающий канал и бросающий монетку при активации. После этого вы сможете модифицировать свой бот CoinBot для выполнения любого количества _немного _более практичных задач.

      Обратите внимание, что в этом обучающем модуле используется Python 3, и что он не совместим с Python 2.

      Предварительные требования

      Для выполнения этого обучающего руководства вам потребуется следующее:

      • Рабочее пространство Slack Workspace, куда вы можете устанавливать приложения. Если вы создали рабочее пространство, такая возможность у вас есть. Если вы еще не сделали этого, вы можете создать рабочее пространство на сайте Slack.

      • (Необязательно) Сервер или компьютер с публичным IP-адресом для разработки. Мы рекомендуем использовать сервер со свежеустановленной ОС Ubuntu 20.04, пользователем без прав root с привилегиями sudo и поддержкой SSH. Вы можете воспользоваться этим руководством для инициализации сервера и выполнения этих шагов.

      Вы можете проверить этот обучающий модуль на сервере с публичным IP-адресом. Slack потребуется возможность отправлять вашему боту события, в том числе сообщения. Если вы выполняете тестирование на локальном компьютере, вам потребуется порт для пересылки трафика через брандмауэр на локальный компьютер. Если вы ищете способ разработки на облачном сервере, ознакомьтесь с обучающим модулем «Использование Visual Studio Code для удаленной разработки через плагин Remote-SSH».

      Шаг 1 — Создание бота Slackbot в пользовательском интерфейсе Slack

      Для начала создайте приложение Slack в панели управления Slack API. Войдите в рабочее пространство Slack через браузер и перейдите в панель управления API. Нажмите кнопку Create an App (Создать приложение).

      Создание вашего приложения Slack

      Далее вам будет предложено указать название приложения и выбрать рабочее пространство Slack для разработки. Для целей этого обучающего модуля назовите свое приложение CoinBot и выберите рабочее пространство, к которому у вас есть доступ с правами администратора. После этого нажмите кнопку Create App (Создать приложение).

      Именование вашего приложения Slack и выбор рабочего пространства

      После создания вашего приложения вам будет представлена следующая информационная панель приложения по умолчанию. На этой информационной панели вы будете управлять приложением, устанавливая разрешения, подписываясь на события, устанавливая приложение в рабочие пространства и т. д.

      Панель приложения Slack по умолчанию

      Чтобы ваше приложение могло отправлять сообщения на канал, вы должны предоставить ему разрешения на отправку сообщений. Для этого нажмите кнопку Permissions (Разрешения) на панели управления.

      Кнопка Permissions (Разрешения) на панели управления

      Прокрутите вниз страницу OAuth & Permissions (OAuth и разрешения), пока не найдете раздел Scopes (Области действия). Найдите подраздел Bot Token Scopes (Области действия токена бота) в области действия и нажмите кнопку Add an OAuth Scope (Добавить область действия OAuth).

      Кнопка Add an OAuth Scope (Добавить область действия OAuth)

      Нажмите кнопку и введите chat:write. Выберите это разрешение, чтобы добавить его для вашего бота. Это позволит приложению отправлять сообщения на каналы, к которым у него есть доступ. Дополнительную информацию о доступных разрешениях можно найти в документации Slack.

      Добавление разрешения chat:write

      Мы добавили необходимое разрешение и теперь можем установить приложение в рабочее пространство Slack. Прокрутите страницу OAuth & Permissions (OAuth и разрешения) вверх и нажмите кнопку Install App to Workspace (Установить приложение в рабочее пространство) сверху.

      Установка приложения в рабочее пространство

      Нажмите эту кнопку и посмотрите, какие действия приложение может выполнять на канале. После этого нажмите кнопку Allow (Разрешить) для завершения установки.

      Установка приложения в рабочее пространство

      После установки бота вы получите для вашего приложения токен доступа Bot User OAuth Access Token, который оно сможет использовать для выполнения действий в рабочем пространстве. Скопируйте этот токен, поскольку позднее он вам потребуется.

      Сохранение токена доступа

      В заключение добавьте новый бот в канал внутри вашего рабочего пространства. Если вы еще не создали канала, используйте канал #general, который создается по умолчанию в вашем рабочем пространстве Slack. Найдите приложение в разделе Apps (Приложения) на панели навигации клиента Slack и нажмите на него. Затем откройте меню Details (Сведения) в правом верхнем углу. Если ваш клиент Slack открыт не в полноэкранном режиме, значок этого меню будет выглядеть как буква i внутри окружности.

      Значок App Details (Сведения о приложении)

      Чтобы завершить добавление приложения на канал, нажмите кнопку More (Дополнительно) со значком трех точек на странице сведений и выберите Add this app to a channel… (Добавить это приложение в канал…). Введите название канала в открытое модальное окно и нажмите Add (Добавить).

      Добавление приложения в канал

      Вы успешно создали приложение и добавили его в канал в своем рабочем пространстве Slack. Когда вы напишете код своего приложения, оно сможет отправлять сообщения в этот канал. В следующем разделе мы начнем писать код Python, на основе которого будет работать CoinBot.

      Шаг 2 — Настройка среды разработки Python

      Вначале настроим среду разработки Python, чтобы вы могли заняться разработкой Slackbot.

      Откройте терминал и установите в свою систему python3 и необходимые инструменты:

      • sudo apt install python3 python3-venv

      Далее нужно создать виртуальную среду, чтобы изолировать ваши пакеты Python от системной установки Python. Для этого создайте каталог, где вы создадите свою виртуальную среду. Создайте новый каталог ~/.venvs:

      Затем создайте виртуальную среду Python:

      • python3 -m venv ~/.venvs/slackbot

      Затем активируйте виртуальную среду, чтобы использовать установленную версию Python и установочные пакеты:

      • source ~/.venvs/slackbot/bin/activate

      В заголовке командной строки теперь будет отображаться название виртуальной среды (в скобках). Оно будет выглядеть примерно так:

      Используйте pip для установки необходимых пакетов Python в вашу виртуальную среду:

      • pip install slackclient slackeventsapi Flask

      slackclient и slackeventsapi упрощают взаимодействие Python с API Slack. Flask — популярная веб-микроструктура, которую мы используем для развертывания приложения:

      Мы настроили среду разработки и теперь можем приступить к написанию бота Python Slackbot:

      Шаг 3 — Создание класса сообщений Slackbot в Python

      Сообщения в Slack отправляются через полезную нагрузку JSON в определенном формате. Вот пример кода JSON, составляемого Slackbot и отправляемого как сообщение:

      {
         "channel":"channel",
         "blocks":[
            {
               "type":"section",
               "text":{
                  "type":"mrkdwn",
                  "text":"Sure! Flipping a coin....nn"
               }
            },
            {
               "type":"section",
               "text":{
                  "type":"mrkdwn",
                  "text":"*flips coin* The result is Tails."
               }
            }
         ]
      }
      

      Вы можете вручную создать этот код JSON и отправить его, но вместо этого мы создадим класс Python, который не только создает эту полезную нагрузку, но также моделирует бросок монеты.

      Для начала используйте команду touch, чтобы создать файл с именем coinbot.py:

      Затем откройте этот файл с помощью nano или своего любимого редактора:

      Добавьте следующие строки кода, чтобы импортировать необходимые библиотеки для вашего приложения. Для этого класса вам потребуется только библиотека random из числа стандартных библиотек Python. Эта библиотека позволяет моделировать бросок монеты.

      Добавьте в файл coinbot.py следующие строки, чтобы импортировать все необходимые библиотеки:

      coinbot.py

      # import the random library to help us generate the random numbers
      import random
      

      Затем создайте класс CoinBot и экземпляр этого класса для создания полезной нагрузки сообщения. Добавьте в файл coinbot.py следующие строки, чтобы создать класс CoinBot:

      coinbot.py

      ...
      class CoinBot:
      

      Затем сделайте один отступ и создайте константы, конструкторы и методы, необходимые для вашего класса. Для начала создадим константу, где будет храниться база полезной нагрузки сообщения. В этом разделе указывается, что эта константа относится к типу раздела, и что текст отформатирован через разметку. Также в нем указывается, какой текст вы хотите вывести. Вы можете найти дополнительную информацию о разных вариантах полезной нагрузки в официальной документации по полезной нагрузке сообщений Slack.

      Добавьте в файл coinbot.py следующие строки, чтобы создать базовый шаблон полезной нагрузки:

      coinbot.py

      ...
          # Create a constant that contains the default text for the message
          COIN_BLOCK = {
              "type": "section",
              "text": {
                  "type": "mrkdwn",
                  "text": (
                      "Sure! Flipping a coin....nn"
                  ),
              },
          }
      

      Затем создайте конструктор вашего класса, чтобы иметь возможность создавать отдельный экземпляр вашего бота для каждого запроса. Не беспокойтесь об издержках памяти, сборщик мусора Python будет очищать эти экземпляры, когда они больше не будут нужны. Этот код устанавливает канал получателя на базе параметра, передаваемого конструктору.

      Добавьте в файл coinbot.py следующие строки для создания конструктора:

      coinbot.py

      ...
          # The constructor for the class. It takes the channel name as the a
          # parameter and sets it as an instance variable.
          def __init__(self, channel):
              self.channel = channel
      

      Теперь напишите код, моделирующий бросок монеты. Мы будем случайным образом генерировать единицу или ноль, представляющие орел и решку соответственно.

      Добавьте в файл coinbot.py следующие строки, чтобы моделировать бросок монеты и возвращать подготовленную полезную нагрузку:

      coinbot.py

      ...
          # Generate a random number to simulate flipping a coin. Then return the
          # crafted slack payload with the coin flip message.
          def _flip_coin(self):
              rand_int =  random.randint(0,1)
              if rand_int == 0:
                  results = "Heads"
              else:
                  results = "Tails"
      
              text = f"The result is {results}"
      
              return {"type": "section", "text": {"type": "mrkdwn", "text": text}},
      

      В заключение создайте метод, который строит и возвращает всю полезную нагрузку сообщения, включая данные вашего конструктора, вызывая метод _flip_coin.

      Добавьте в файл coinbot.py следующие строки, чтобы создать метод, который будет генерировать готовую полезную нагрузку:

      coinbot.py

      ...
          # Craft and return the entire message payload as a dictionary.
          def get_message_payload(self):
              return {
                  "channel": self.channel,
                  "blocks": [
                      self.COIN_BLOCK,
                      *self._flip_coin(),
                  ],
              }
      

      Мы завершили создание класса CoinBot, и теперь он готов к тестированию. Прежде чем продолжить, убедитесь, что готовый файл coinbot.py содержит следующие строки:

      coinbot.py

      # import the random library to help us generate the random numbers
      import random
      
      # Create the CoinBot Class
      class CoinBot:
      
          # Create a constant that contains the default text for the message
          COIN_BLOCK = {
              "type": "section",
              "text": {
                  "type": "mrkdwn",
                  "text": (
                      "Sure! Flipping a coin....nn"
                  ),
              },
          }
      
          # The constructor for the class. It takes the channel name as the a
          # parameter and then sets it as an instance variable
          def __init__(self, channel):
              self.channel = channel
      
          # Generate a random number to simulate flipping a coin. Then return the
          # crafted slack payload with the coin flip message.
          def _flip_coin(self):
              rand_int =  random.randint(0,1)
              if rand_int == 0:
                  results = "Heads"
              else:
                  results = "Tails"
      
              text = f"The result is {results}"
      
              return {"type": "section", "text": {"type": "mrkdwn", "text": text}},
      
          # Craft and return the entire message payload as a dictionary.
          def get_message_payload(self):
              return {
                  "channel": self.channel,
                  "blocks": [
                      self.COIN_BLOCK,
                      *self._flip_coin(),
                  ],
              }
      

      Сохраните и закройте файл.

      У нас есть класс Python, готовый выполнять работу для бота Slackbot, и теперь мы сделаем так, чтобы этот класс создавал полезную нагрузку сообщений, и чтобы у вас была возможность отправлять ее в ваше рабочее пространство.

      Шаг 4 — Тестирование вашего сообщения

      Протестируем этот класс и убедимся, что он создает надлежащую полезную нагрузку. Создайте файл с именем coinbot_test.py:

      Добавьте в него следующий код. Обязательно измените имя канала в экземпляре класса coinbot coin_bot = coinbot("#YOUR_CHANNEL_HERE "). Этот код создаст в Python клиент Slack, который будет отправлять сообщение на указанный вами канал, куда вы уже установили приложение:

      coinbot_test.py

      from slack import WebClient
      from coinbot import CoinBot
      import os
      
      # Create a slack client
      slack_web_client = WebClient(token=os.environ.get("SLACK_TOKEN"))
      
      # Get a new CoinBot
      coin_bot = CoinBot("#YOUR_CHANNEL_HERE")
      
      # Get the onboarding message payload
      message = coin_bot.get_message_payload()
      
      # Post the onboarding message in Slack
      slack_web_client.chat_postMessage(**message)
      

      Сохраните и закройте файл.

      Прежде чем вы сможете запустить этот файл, вам нужно будет экспортировать токен Slack, сохраненный на шаге 1, как переменную среды:

      • export SLACK_TOKEN="your_bot_user_token"

      Протестируйте этот файл и запустите в терминале следующий скрипт, чтобы проверить создание и отправку полезной нагрузки. Убедитесь, что ваша виртуальная среда активирована. Чтобы проверить это, посмотрите, отображается ли текст (slackbot) в заголовке командной строки bash. Запустите эту команду, чтобы получить от бота Slackbot сообщение с результатами броска монеты:

      Проверьте канал, на который вы установили приложение, и убедитесь, что ваш бот действительно отправил сообщение о броске монеты. Результатом будет орел или решка.

      Тест броска монеты

      Мы убедились, что наш бот Slackbot может бросить монету, создать сообщение и доставить его. Теперь мы создадим Flask для постоянного выполнения этого приложения и сделаем так, чтобы он моделировал бросок монеты и публиковал результаты, когда увидит в сообщениях на канале определенный текст.

      Шаг 5 — Создание приложения Flask для запуска бота Slackbot

      У нас есть работающее приложение, которое может отправлять сообщения в рабочее пространство Slack, и теперь необходимо создать долгосрочный процесс, чтобы бот мог прослушивать отправляемые в канал сообщения и отвечать на них, если их текст соответствует определенным критериям. Мы используем веб-инфраструктуру Python Flask для запуска этого процесса и прослушивания событий на канале.

      В этом разделе мы запустим приложение Flask с сервера с публичным IP-адресом, чтобы API Slack мог отправлять нам события. В случае локального запуска на персональной рабочей станции необходимо подключить переадресацию порта персонального брандмауэра на порт, который будет использоваться на рабочей станции. Это может быть один и тот же порт, в этом обучающем модуле мы используем порт 3000.

      Настроите брандмауэр, чтобы разрешить трафик через порт 3000:

      Проверьте статус ufw:

      Результат должен будет выглядеть следующим образом:

      Output

      Status: active To Action From -- ------ ---- OpenSSH ALLOW Anywhere 3000 ALLOW Anywhere OpenSSH (v6) ALLOW Anywhere (v6) 3000 (v6) ALLOW Anywhere (v6)

      Создайте файл для вашего приложения Flask и присвойте ему имя app.py:

      Откройте этот файл в предпочитаемом текстовом редакторе:

      Добавьте следующие statements импорта. Мы импортируем следующие библиотеки по следующим причинам:

      • import os — доступ к переменным среды
      • import logging — регистрация событий приложения
      • from flask import Flask — создание приложения Flask
      • from slack import WebClient — отправка сообщений через Slack
      • from slackeventsapi import SlackEventAdapter — получение событий Slack и их обработка
      • from coinbot import CoinBot — создание экземпляра CoinBot и генерирование полезной нагрузки сообщения.

      Добавьте в файл app.py следующие строки, чтобы импортировать все необходимые библиотеки:

      app.py

      import os
      import logging
      from flask import Flask
      from slack import WebClient
      from slackeventsapi import SlackEventAdapter
      from coinbot import CoinBot
      

      Теперь создайте приложение Flask и зарегистрируйте в вашем приложении Slack адаптер Slack Event Adapter с конечной точкой /slack/events. В вашем приложении Slack будет создан маршрут для отправки и обработки событий Slack. Для этого вам нужно будет получить от приложения Slack еще один токен, что мы сделаем на следующих шагах этого обучающего модуля. После получения этой переменной мы экспортируем ее как переменную среды с именем SLACK_EVENTS_TOKEN. Теперь напишите код, чтобы прочитать его при создании адаптера SlackEventAdapter, хотя вы еще не задали токен.

      Добавьте в файл app.py следующие строки, чтобы создать приложение Flask и зарегистрировать адаптер событий в этом приложении:

      app.py

      ...
      # Initialize a Flask app to host the events adapter
      app = Flask(__name__)
      
      # Create an events adapter and register it to an endpoint in the slack app for event ingestion.
      slack_events_adapter = SlackEventAdapter(os.environ.get("SLACK_EVENTS_TOKEN"), "/slack/events", app)
      

      Затем создайте объект веб-клиента, который позволит вашему приложению выполнять в рабочем пространстве различные действия, в том числе отправлять сообщения. Это похоже на то, что мы делали ранее при тестировании файла coinbot.py.

      Добавьте в файл app.py следующую строку для создания slack_web_client:

      app.py

      ...
      # Initialize a Web API client
      slack_web_client = WebClient(token=os.environ.get("SLACK_TOKEN"))
      

      Теперь создайте вызываемую функцию, которая будет создавать экземпляр CoinBot, а затем использовать этот экземпляр для создания полезной нагрузки сообщения и ее передачи в веб-клиент Slack для доставки. Эта функция будет принимать единственный параметр, channel, который будет определять канал, куда будет доставляться сообщение.

      Добавьте в файл app.py следующие строки для создания этой функции:

      app.py

      ...
      def flip_coin(channel):
          """Craft the CoinBot, flip the coin and send the message to the channel
          """
          # Create a new CoinBot
          coin_bot = CoinBot(channel)
      
          # Get the onboarding message payload
          message = coin_bot.get_message_payload()
      
          # Post the onboarding message in Slack
          slack_web_client.chat_postMessage(**message)
      

      Мы создали функцию приложения для работы с сообщениями, а теперь создадим функцию, которая будет отслеживать события Slack на предмет определенных действий, а затем запускать бота. Мы настроим приложение так, чтобы оно отправляло результаты броска монеты в ответ на фразу «Hey Sammy, Flip a coin». Приложение будет отвечать на эту фразу в любом виде независимо от регистра.

      Вначале добавьте в функцию синтаксис @slack_events_adapter.on, позволяющий функции получать события. Укажите, что хотите получать только события message, и разрешите функции принимать параметр полезной нагрузки, содержащий всю необходимую информацию Slack. После получения полезной нагрузки функция будет выполнять синтаксический анализ извлеченного текста, а при обнаружении активирующей фразы приложение будет отправлять результаты броска монеты.

      Добавьте в файл app.py следующий код, чтобы получать и анализировать входящие сообщения и реагировать на них:

      app.py

      # When a 'message' event is detected by the events adapter, forward that payload
      # to this function.
      @slack_events_adapter.on("message")
      def message(payload):
          """Parse the message event, and if the activation string is in the text,
          simulate a coin flip and send the result.
          """
      
          # Get the event data from the payload
          event = payload.get("event", {})
      
          # Get the text from the event that came through
          text = event.get("text")
      
          # Check and see if the activation phrase was in the text of the message.
          # If so, execute the code to flip a coin.
          if "hey sammy, flip a coin" in text.lower():
              # Since the activation phrase was met, get the channel ID that the event
              # was executed on
              channel_id = event.get("channel")
      
              # Execute the flip_coin function and send the results of
              # flipping a coin to the channel
              return flip_coin(channel_id)
      

      В заключение создайте раздел main, создающий регистратор для просмотра внутренних данных приложения и запускающий приложение с внешнего IP-адреса через порт 3000. Чтобы обрабатывать события Slack (например, при отправке нового сообщения), необходимо протестировать приложение на общедоступном IP-адресе.

      Добавьте в файл app.py следующие строки для настройки раздела main:

      app.py

      if __name__ == "__main__":
          # Create the logging object
          logger = logging.getLogger()
      
          # Set the log level to DEBUG. This will increase verbosity of logging messages
          logger.setLevel(logging.DEBUG)
      
          # Add the StreamHandler as a logging handler
          logger.addHandler(logging.StreamHandler())
      
          # Run your app on your externally facing IP address on port 3000 instead of
          # running it on localhost, which is traditional for development.
          app.run(host="0.0.0.0", port=3000)
      

      Мы завершили создание приложения Flask, и теперь оно готово к тестированию. Прежде чем двигаться дальше, убедитесь, что готовый файл app.py содержит следующие строки:

      app.py

      import os
      import logging
      from flask import Flask
      from slack import WebClient
      from slackeventsapi import SlackEventAdapter
      from coinbot import CoinBot
      
      # Initialize a Flask app to host the events adapter
      app = Flask(__name__)
      # Create an events adapter and register it to an endpoint in the slack app for event injestion.
      slack_events_adapter = SlackEventAdapter(os.environ.get("SLACK_EVENTS_TOKEN"), "/slack/events", app)
      
      # Initialize a Web API client
      slack_web_client = WebClient(token=os.environ.get("SLACK_TOKEN"))
      
      def flip_coin(channel):
          """Craft the CoinBot, flip the coin and send the message to the channel
          """
          # Create a new CoinBot
          coin_bot = CoinBot(channel)
      
          # Get the onboarding message payload
          message = coin_bot.get_message_payload()
      
          # Post the onboarding message in Slack
          slack_web_client.chat_postMessage(**message)
      
      
      # When a 'message' event is detected by the events adapter, forward that payload
      # to this function.
      @slack_events_adapter.on("message")
      def message(payload):
          """Parse the message event, and if the activation string is in the text,
          simulate a coin flip and send the result.
          """
      
          # Get the event data from the payload
          event = payload.get("event", {})
      
          # Get the text from the event that came through
          text = event.get("text")
      
          # Check and see if the activation phrase was in the text of the message.
          # If so, execute the code to flip a coin.
          if "hey sammy, flip a coin" in text.lower():
              # Since the activation phrase was met, get the channel ID that the event
              # was executed on
              channel_id = event.get("channel")
      
              # Execute the flip_coin function and send the results of
              # flipping a coin to the channel
              return flip_coin(channel_id)
      
      if __name__ == "__main__":
          # Create the logging object
          logger = logging.getLogger()
      
          # Set the log level to DEBUG. This will increase verbosity of logging messages
          logger.setLevel(logging.DEBUG)
      
          # Add the StreamHandler as a logging handler
          logger.addHandler(logging.StreamHandler())
      
          # Run our app on our externally facing IP address on port 3000 instead of
          # running it on localhost, which is traditional for development.
          app.run(host="0.0.0.0", port=3000)
      

      Сохраните и закройте файл.

      Приложение Flask теперь готово обслуживать ваше приложение, и сейчас мы протестируем это.

      Шаг 6 — Запуск приложения Flask

      В заключение мы соединим все элементы и запустим наше приложение.

      Прежде всего, добавьте работающее приложение как авторизованный обработчик Slackbot.

      Перейдите в раздел Basic Information (Базовая информация) вашего приложения в пользовательском интерфейсе Slack. Прокручивайте экран вниз, пока не найдете раздел App Credentials (Полномочия приложения).

      Секретная подпись Slack

      Скопируйте секретную подпись (Signing Secret) и экспортируйте ее в переменную среды SLACK_EVENTS_TOKEN:

      • export SLACK_EVENTS_TOKEN="MY_SIGNING_SECRET_TOKEN"

      Теперь у вас имеются все необходимые токены API для запуска вашего приложения. Обратитесь к шагу 1, если вам потребуется напоминание о том, как экспортировать SLACK_TOKEN. Теперь вы можете запустить свое приложение и убедиться, что оно действительно работает. Убедитесь, что виртуальная среда активирована, и выполните следующую команду для запуска приложения Flask:

      Результат должен будет выглядеть следующим образом:

      (slackbot) [20:04:03] sammy:coinbot$ python app.py
       * Serving Flask app "app" (lazy loading)
       * Environment: production
         WARNING: This is a development server. Do not use it in a production deployment.
         Use a production WSGI server instead.
       * Debug mode: off
       * Running on http://0.0.0.0:3000/ (Press CTRL+C to quit)
      

      Чтобы убедиться, что ваше приложение работает, откройте новое окно терминала и запустите команду curl с IP-адресом вашего сервера, указав правильный порт /slack/events:

      • curl http://YOUR_IP_ADDRESS:3000/slack/events

      В результате выполнения curl будет получено следующее:

      Output

      These are not the slackbots you're looking for.

      Получение сообщения These are not the slackbots you're looking for. означает, что ваше приложение запущено и работает.

      Оставьте это приложение Flask работать, пока вы не завершите настройку приложения в пользовательском интерфейсе Slack.

      Предоставьте своему приложению необходимые разрешения для мониторинга сообщений и реагирования на них. Откройте раздел Event Subscriptions (Подписка на события) в боковой панели пользовательского интерфейса и нажмите кнопку Enable Events (Активировать события).

      Кнопка Enable Events (Активировать события)

      После этого введите свой IP-адрес, порт и конечную точку /slack/events в поле Request URL (URL-адрес запроса). Не забудьте указать префикс протокола HTTP. Slack попытается выполнить подключение к указанной конечной точке. После успешного подключения вы увидите зеленую отметку со словом Verified (Проверено).

      URL-адрес запроса подписки на события

      Затем откройте раздел Subscribe to bot events (Подписка на события ботов) и добавьте для вашего приложения разрешение message.channels. Это позволит вашему приложению получать сообщения от канала и обрабатывать их.

      Разрешения на подписку на события ботов

      После этого вы увидите событие в списке в разделе Subscribe to bot events (Подписка на события ботов). Затем нажмите зеленую кнопку Save Changes (Сохранить изменения) в правом нижнем углу.

      Подтверждение и сохранение изменений

      После этого вы увидите на экране желтый баннер, показывающий, что вам нужно переустановить приложение для следующих изменений. При каждом изменении разрешений вам потребуется переустановить приложение. Нажмите ссылку reinstall your app (переустановить приложение) на этом баннере, чтобы переустановить ваше приложение.

      Баннер переустановки приложения

      Вы увидите экран подтверждения со сводной информацией о разрешениях вашего бота и запросом на его установку. Нажмите зеленую кнопку Allow (Разрешить), чтобы завершить процесс установки.

      Подтверждение переустановки

      Теперь ваше приложение должно быть готово к работе. Вернитесь на канал, где вы установили CoinBot, и отправьте сообщение с фразой «Hey Sammy, Flip a coin». Ваш бот смоделирует бросок монеты и ответит с результатами. Поздравляем! Вы создали бота Slackbot!

      Hey Sammy, Flip a coin

      Заключение

      После завершения разработки приложения вам нужно будет развернуть его на сервере для переноса в производственную среду. Это необходимо, потому что сервер разработки Flask не является защищенной производственной средой. Будет лучше, если вы развернете приложение с помощью WSGI и, возможно, закрепите за ним доменное имя и создадите запись DNS для вашего сервера. Существует много вариантов развертывания приложения Flask, некоторые из которых перечислены ниже:

      Помимо этих, существует и много других способов развертывания приложения. Как обычно, при выборе вариантов развертывания и инфраструктуры выбирайте то, что лучше всего подходит именно вам.

      В любом случае теперь у вас есть бот Slackbot, который вы можете использовать для броска монеты для принятия решений, например, при выборе меню на обед.

      Также вы можете взять этот код как основу и изменить его для собственных нужд, будь то автоматизированная поддержка, управление ресурсами, фотографии котиков или что-нибудь еще. Полную документацию по Python Slack API можно посмотреть здесь.



      Source link