retoor/snekbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: refactor bot event handlers to accept flat parameters and add join/leave auto-replies

Browse Source
This commit is contained in:
retoor
2025-02-10 13:16:55 +00:00
parent 756e26eb42
commit 4f4ae87b7a
3 changed files with 146 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+64 -28
View File
@@ -1,6 +1,6 @@
# Snekbot API
This is the Snekbot API. This document describes how to create a bot responding to "hey", "hello", "bye" and "@username-of-bot".
This is the Snekbot API. This document describes how to create a bot responding to "hello", "bye" and "@username-of-bot".
## 5 minute tutorial
@@ -32,52 +32,73 @@ Make sure you have this information right now:
Open a file ending with the `.py` extension and pase this content.
```python
import asyncio
import asyncio
from snekbot.bot import Bot
class ExampleBot(Bot):
async def on_join(self, data):
print(f"I joined {data.channel_uid}!")
async def on_leave(self, data):
print(f"I left {data.channel_uid}!")
async def on_ping(self, data):
print(f"Ping from {data.user_nick}")
async def on_join(self, channel_uid):
print(f"I joined!")
await self.send_message(
data.channel_uid,
"I should respond with Bong according to BordedDev. So here, bong!",
channel_uid,
f"Hello, i'm actively part of the conversation in channel {channel_uid} now, you don't have to mention me anymore. "
)
async def on_leave(self, channel_uid):
print(f"I left!!")
await self.send_message(
channel_uid,
"I stop actively being part of the conversation now. Bye!"
)
async def on_ping(self,username, user_nick, channel_uid, message):
print(f"Ping from {user_nick} in channel {channel_uid}: {message}")
await self.send_message(
channel_uid,
"pong " + message
)
async def on_own_message(self, data):
print(f"Received my own message: {data.message}")
async def on_mention(self, data):
message = data.message[len(self.username) + 2 :]
print(f"Mention from {data.user_nick}: {message}")
async def on_mention(self, username, user_nick, channel_uid, message):
result = f'Hey {data.user_nick}, Thanks for mentioning me "{message}".'
await self.send_message(data.channel_uid, result)
message = message[len(self.username) + 2 :]
print(f"Mention from {user_nick}: {message}")
async def on_message(self, data):
print(f"Message from {data.user_nick}: {data.message}")
message = data.message.lower()
if "source" in message:
with open(__file__) as f:
result = f.read()
result = result.replace(f'"{self.username}"', '"example username"')
result = result.replace(self.password, "example password")
result = (
"This is the actual source code running me now. Fresh from the bakery:\n\n```python\n"
+ result
+ "\n```"
)
await self.send_message(channel_uid, result)
else:
await self.send_message(channel_uid, f'Hey {user_nick}, Thanks for mentioning me "{message}".')
async def on_message(self, sender_username, sender_nick, channel_uid, message):
print(f"Message from {sender_nick}: {message}")
if not self.has_joined(channel_uid):
print(f"Probably not for me since i'm not mentioned and not joined yet")
return
message = message.lower()
result = None
if "hey" in message or "hello" in message:
result = f"Hi {data.user_nick}"
if "hello" in message:
result = f"Hi @{sender_nick}"
elif "bye" in message:
result = f"Bye {data.user_nick}"
result = f"Bye @{sender_nick}"
if result:
await self.send_message(data.channel_uid, result)
await self.send_message(channel_uid, result)
bot = ExampleBot(username="Your username", password="Your password",url="wss://your-snek-instance.com/rpc.ws")
bot = ExampleBot(url="ws://snek.molodetz.nl/rpc.ws", username="example", password="example")
asyncio.run(bot.run())
```
@@ -86,4 +107,19 @@ Make sure you have (still) activated your virtual env.
```bash
python [your-script].py
```
If you get the error 'python not found' or 'aiohttp not found', run `source .venv/bin/activate` again and run `python [your script].py` again.
If you get the error 'python not found' or 'aiohttp not found', run `source .venv/bin/activate` again and run `python [your script].py` again.
#### Debugging
Add `import logging` and `logging.BasicConfig(level=logging.DEBUG)`.
#### Summary
The `ExampleBot` class inherits from a base `Bot` class and implements several event handlers:
- `on_join`: Sends a welcome message when the bot joins a channel.
- `on_leave`: Sends a goodbye message when the bot leaves.
- `on_ping`: Responds with "pong" when it receives a ping message.
- `on_own_message`: Logs messages sent by the bot itself.
- `on_mention`: Handles mentions; if "source" is in the message, it replies with its own source code, with sensitive data disguised.
- `on_message`: Responds to "hello" and "bye" messages if the bot has joined the channel.
The bot will be instantiated and runs asynchronously.