کتابخانه را نصب کن
در Termux یا ترمینال سیستم خودت اجرا کن:
python -m pip install --upgrade soroushthon
از اولین پیام در پیوی تا مدیریت گفتگوهای شلوغ؛ سروشتون ابزارهای حساب کاربری سروشپلاس را در یک API ناهمگام و خوانا کنار هم میگذارد.
from soroushthon import SoroushClient client = SoroushClient.for_account("main") @client.on_private_message(pattern=r"^ping$") async def ping(event): await event.reply("Pong!") client.start() client.run_until_disconnected()
برای شروع، پایتون ۳٫۹ یا جدیدتر و یک حساب سروشپلاس کافی است.
در Termux یا ترمینال سیستم خودت اجرا کن:
python -m pip install --upgrade soroushthon
کد زیر را در bot.py ذخیره کن. نام main مشخص میکند نشست کدام حساب استفاده شود؛ برای حساب دوم نام دیگری انتخاب کن.
from soroushthon import SoroushClient
client = SoroushClient.for_account("main")
@client.on_private_message(pattern=r"(?i)^ping$")
async def ping(event):
await event.reply("Pong!")
client.start()
client.run_until_disconnected()در اولین اجرا، مراحل ورود به حساب نمایش داده میشود. بعد از اتصال، از یک حساب دیگر در پیوی کلمهٔ ping را بفرست.
python bot.py
دکوراتورها مسیر دریافت رویداد را مشخص میکنند. فیلترها را با & و | ترکیب کن و با ~ معکوس کن.
گفتگوهای خصوصی حساب.
گروههای معمولی و سوپرگروههای شناختهشده.
فقط کانالهای شناختهشده، بدون پیام گروه.
پاسخ به پیام همین حساب؛ خطای دسترسی به اصل پیام باعث قطع بقیهٔ هندلرها نمیشود.
| نوع گفتگو | filters.group | filters.channel |
|---|---|---|
| گروه و سوپرگروه | ✓ انتخاب میشود | رد میشود |
| کانال انتشار | رد میشود | ✓ انتخاب میشود |
| نوع نامشخص | حدس زده نمیشود | حدس زده نمیشود |
event.is_channel همچنان مفهوم پروتکلی دارد و سوپرگروه را هم شامل میشود. برای انتخاب کانال از filters.channel یا on_channel_message استفاده کن.from soroushthon import filters
@client.on_channel_message(incoming=True)
async def channel_post(event):
print("CHANNEL:", event.raw_text)
@client.on_reply_to_me(filters.group)
async def reply_in_group(event):
await event.reply("I received your reply.")اکثر فیلترها محلیاند. بررسی ریپلای به پیام خودت، اگر نویسندهٔ پیام اصلی در کش نباشد، ممکن است به یک درخواست شبکه نیاز داشته باشد.
این ابزارها از رویدادها و مسیرهای ارسال موجود استفاده میکنند؛ فیلترهای رسانه و دستور درخواست شبکه نمیفرستند.
چند نام و چند پیشوند را انتخاب کن. آرگومانهای داخل نقلقول یک مقدار میمانند.
@client.on_command(["start", "help"], prefix=["/", "!"])
async def command(event):
print(event.command[0], event.command[1:])
# /start "two words" 42
# event.command == ["start", "two words", "42"]@client.on_media(("photo", "video"))
async def received(event):
print(event.media_type)
await event.reply_file("report.pdf")from soroushthon import filters
@client.on_message(filters.regex(r"code: (\d+)"))
async def code(event):
print(event.matches[0].group(1))import asyncio
try:
response = await client.wait_for_message(
chats=123456, from_users=654321, timeout=30
)
print(response.raw_text)
except asyncio.TimeoutError:
print("No matching message arrived.")predicate = filters.all_of(
filters.group,
filters.from_users([123456, 654321]),
filters.any_of(filters.photo, filters.video)
)
@client.on_message(predicate)
async def selected(event):
print(event.chat_id, event.media_type)from_users و chats شناسهٔ عددی یا peer از قبل resolveشده میگیرند؛ نام کاربری را برای هر پیام از شبکه resolve نمیکنند. شناسهٔ کانال و گروه باید marked ID باشد یا بهصورت peer داده شود.
امضای واقعی متدها، پارامترها، مثالها و نامهای کوتاه.
توسعهٔ API بر پایهٔ مسیرهای فعلی سروشتون.
فیلترهای عکس، ویدئو، ویدئوی گرد، ویس، موسیقی، سند، استیکر، گیف، مخاطب، موقعیت و نظرسنجی؛ همراه با from_users، chats، chat_type، all_of و any_of.
فرمان چندنامی و چندپیشوندی، event.command و event.matches؛ همراه با on_command و on_media.
wait_for_message با پاکسازی در timeout و لغو، media_type و شش متد reply_* برای عکس، ویدئو، موسیقی، ویس، فایل و سند.
iter_groups و iter_channels نتایج را پیمایشی میدهند؛ limit روی تعداد نتایج منطبق اعمال میشود. مکث مصنوعی پیشفرض همچنان صفر است.