🔥Pyrogram🔥 - что это такое и с чем его едят?

🔥😉😛😍🙃😅😍😀😇 (в простонародье "Пирог") — это мощная библиотека для создания так называемых User Ботов для 😀 телеграмма.

🤖 ЮзерБоты - это скрипты которые работают от лица личного аккаунта и могут выполнять все тоже что и человек.

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

✅ Но в основном ЮзерБоты используют как дополнения к телеграму, например, встроенный калькулятор. Вы скорее всего уже видели их. Кто-то пишет комманду, скажем, .calc 2+2, а скрипт все считает и, изменяя сообщение, выводит ответ.

😀 Именно такого юзербота мы и будет создавать в следующих постах, так что 📣подписывайся на канал, и включай 🔔уведомления!

🔥Чтож, поехали! 🎉

😉🟣😍🙃😅😍😀😇🤪🥶🤨

📦 Начнем с самой базы - установки. В Консоли пишем

python -m pip install pyrogram

🚀 Для быстрой работы пирога лучше еще установить

python -m pip install TgCrypto

⌨️Теперь можно и код писать😉

#️⃣Импорт
Импорт тут максимально простой. Просто из pyrogram импортируем модули через from / import:

from pyrogram import Client # потом ещё будем добавлять

#️⃣Создание объекта бота
Как и в любом другом боте нам нужен объект, с помощью которого уже и осуществляется работа.
В пироге это екземпляр принято называть app.
В него нужно передать
🌝Название, строка
🌝API_ID, строка либо число (int)
🌝API_HASH, строка
Про API_ID и API_HASH поговорим чуток позже.

app = Client("MyFirstUserBot", api_id, api_hash)

#️⃣Обработчики
Обработчики (хендлеры, handler) — это функции, которые срабатывают при определенном событии, например, при новом сообщении.
В Pyrogram они в виде декорратора который начинается на "on" (с англ - при), наример @app.on_message, @app.on_chat_join_request.
В декоратор следует передать фильтр, по которому будут выбираться случаи когда нужно чтобы обработчик сработал.
В библиотеке есть встроенные фильтры, их надо импортировать, но их можно и самому написать (научимся позже)


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

@app.on_message(filters.command(["start"], prefixes=".") & filters.me)
async def start(_, msg):
    pass

⚠У обработчиков должен быть строгий порядок - от конкретных (например, команды), до более общих (всех сообщений)

Правильный порядок хендлеров сообщений должен выглядеть так:
⚫ Команды
⚫ Сообщения с какими-то триггерами (например, если в слове есть слово "привет")
⚫ Все сообщения


#️⃣Запуск
Обработчики прописали, теперь пора это все дело запустить!
Тут всё просто:

app.run()

#️⃣API_ID / API_HASH
И, самое главное, без чего наш код ни в коем случае не заработает - данные телеграмма.
Как я говорил выше, ЮзерБота, как бы входит в твой аккаунт. Ему конечно же нужны данные. Это и есть api_id и api_hash

✈️ Заходим на сайт https://my.telegram.org/apps
пишем свой номер телефона, на котором тг, и вводим код.
‼️Это безопасно, это сайт телеграмма
Далее там будет бланк, вы его заполняете. Данные можете писать какие угодно, они ни на что не влияют. Вы должны дойти то страницы с конфигурацией приложение (App Configuration). Там копируете app api_id и app api_hash, и вставляете в код, там где создавали екземпляр бота (app = ...)

👩‍💻👩‍💻👩‍💻👩‍💻
👩‍💻👩‍💻👩‍💻👩‍💻

from pyrogram import Client, filters

app = Client("тут", "ваши", "данные")

@app.on_message(filters.commands(["start"], prefixes=".") & filters.me)
async def start(_, msg):
    pass

app.run()

#️⃣Итоги
Сегодня мы разобрались в базовой структуре ЮзерБота: поговорили про нужные классы, обработчики, их порядок, API данные. В следующем посте поговорим про отправку сообщений, редактирование, итп, так что 📣подписывайся на канал, и включай 🔔уведомления!

🔄: для тех кто не понял - 🔥 это лого пайрограма

🔥😉🟣😍🙃😅😍😀😇#️⃣🧐

⚡️Так, мы уже умеем создавать обработчики, теперь надо научится что-то делать, а не только принимать.

🟢В пироге функции отправки чего-либо начинаются на "send" - app.send_message, например.

🖥Чтобы детально разобраться в какой-то функции - надо заглянуть в документацию! Кстати, у pyrogram она очень удобная и понятная

🔗 https://docs.pyrogram.org 🔗

🔍 Нам нужен метод который отвечает за отправку сообщения.💬 В документации слева в менюшке ищем Available Methods (Доступные методы) - далее - send_message (отправить сообщение).

👀 И видим полное описание этого метода, что он делает, какие параметры принимает, что возвращает, и еще и пример есть.

Сразу под названием видим описание метода, то что он делает

Send text messages.

перевод:

(отправляет текстовое сообщение)

📃Ниже список параметров которые нужно в него передать. Давайте его разберем.

chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

перевод:

(chat_id (int | str) — уникальный идентификатор (int) или имя пользователя (str) целевого чата. Для вашего личного облака (сохраненных сообщений) вы можете просто использовать «me» или «self». Для контакта, который существует в вашей адресной книге Telegram, вы можете использовать его номер телефона (str))

В самое первое — название параметра далее в скобках тип данных. "|" - это "или", "либо". Если в скобках есть оptional, то это значит что этот аргумент не обязательный.
И последнее - описание.

🧑‍⚕️Из цитаты нам становится понятно, что chat_id принимает ID чата в виде строки либо числа, либо номер телефона, либо "me"|"self" если надо отправить себе в избранное.

Второй параметр разберите сами

text (str) – Text of the message to be sent.

text (str) – Текст отправляемого сообщения.

🌱тут совсем легко, так что, думаю, все справились, сюда надо передать строку с отправляемым текстом

В итоге, отправлять сообщения надо так:

await app.send_message(chat_id, "text")

‼️ Обратите внимание, что в начале я поставил await. Если вы новичок - то просто ставьте перед методами await и все, а если вы уже что-то знаете, то объяснять не надо 🔮

🟠Bound Methods
🔍Самые внимательные заметили, что в документации крок Available Methods есть еще Bound Methods (Связанные методы)
Их фишка в том, что это методы сообщений которые мы получаем из хендлера (параметр msg). Например, чтобы изменить сообщение, не обязательно писать
app.edit-бла-бла-бла, а можно просто msg.edit(). В него просто передаем строку и готово!

📝 Задание: Пользуясь документацией, выясните что делает msg.reply() и какие параметры он принимает.

🧠 Вернёмся в редактор кода
Теперь вспоминаем все что учили и соберём знания вместе. Сделаем так, чтобы при написании команды .start сообщение изменялось на Python Pyrogram!

🐍🔥

from pyrogram import Client, filters

app = Client("UserBot", 123, "abc")

@app.on_message(filters.command(["start"], prefixes=".") & filters.me)
async def start(_, msg):
    await msg.edit("Python Pyrogram!")

app.run()

😶Итоги
Сегодня мы научились работать с документацией, и научились изменять сообщения. А следующем посте научимся получать из сообщения данные - его текст, отправитель, итп. Так что 📣подписывайся на канал, и включай 🔔уведомления!

🏆Первая история на канале 😊

https://t.me/pythonhub001/s/1

Хотите больше сторисов? Голосуйте за наш канал:
t.me/pythonhub001?boost