Garmelon/yaboli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename event functions

Browse source
This commit is contained in:
Joscha 2018-07-29 15:26:45 +00:00
parent 46cd20ac74
commit 339d3ca516
2 changed files with 22 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

7
examplebot.py
View file

@ -12,7 +12,7 @@ logging.getLogger("yaboli").setLevel(logging.DEBUG)
class ExampleBot(yaboli.Bot): class ExampleBot(yaboli.Bot):
async def send(self, room, message): async def on_send(self, room, message):
ping = "ExamplePong!" ping = "ExamplePong!"
short_help = "Example bot for the yaboli bot library" short_help = "Example bot for the yaboli bot library"
long_help = ( long_help = (
@ -28,11 +28,6 @@ class ExampleBot(yaboli.Bot):
await self.botrulez_kill(room, message, text="/me dies spectacularly") await self.botrulez_kill(room, message, text="/me dies spectacularly")
await self.botrulez_restart(room, message, text="/me restarts spectacularly") await self.botrulez_restart(room, message, text="/me restarts spectacularly")
if message.content == "!!!":
await room._connection._ws.close()
forward = send # should work without modifications for most bots
def main(): def main():
bot = ExampleBot("ExampleBot", "examplebot.cookie") bot = ExampleBot("ExampleBot", "examplebot.cookie")
join_rooms(bot) join_rooms(bot)

42
yaboli/room.py
View file

@ -61,7 +61,7 @@ class Room:
cookiejar cookiejar
) )
asyncio.ensure_future(self._inhabitant.created(self)) asyncio.ensure_future(self._inhabitant.on_created(self))
async def exit(self): async def exit(self):
self._status = Room.CLOSED self._status = Room.CLOSED
@ -168,7 +168,7 @@ class Room:
if self._forwarding is not None: if self._forwarding is not None:
self._forwarding.cancel() self._forwarding.cancel()
await self._inhabitant.disconnected(self) await self._inhabitant.on_disconnected(self)
async def _receive_packet(self, ptype, data, error, throttled): async def _receive_packet(self, ptype, data, error, throttled):
# Ignoring errors and throttling for now # Ignoring errors and throttling for now
@ -226,7 +226,7 @@ class Room:
async def _event_join(self, data): async def _event_join(self, data):
session = Session.from_dict(data) session = Session.from_dict(data)
self.listing.add(session) self.listing.add(session)
await self._inhabitant.join(self, session) await self._inhabitant.on_join(self, session)
async def _event_network(self, data): async def _event_network(self, data):
server_id = data.get("server_id") server_id = data.get("server_id")
@ -235,7 +235,7 @@ class Room:
sessions = self.listing.remove_combo(server_id, server_era) sessions = self.listing.remove_combo(server_id, server_era)
for session in sessions: for session in sessions:
await self._inhabitant.part(self, session) asyncio.ensure_future(self._inhabitant.on_part(self, session))
async def _event_nick(self, data): async def _event_nick(self, data):
sid = data.get("session_id") sid = data.get("session_id")
@ -247,12 +247,12 @@ class Room:
if session: if session:
session.nick = to_nick session.nick = to_nick
await self._inhabitant.nick(self, sid, uid, from_nick, to_nick) await self._inhabitant.on_nick(self, sid, uid, from_nick, to_nick)
async def _event_part(self, data): async def _event_part(self, data):
session = Session.from_dict(data) session = Session.from_dict(data)
self.listing.remove(session.sid) self.listing.remove(session.sid)
await self._inhabitant.part(self, session) await self._inhabitant.on_part(self, session)
async def _event_ping(self, data): async def _event_ping(self, data):
try: try:
@ -267,7 +267,7 @@ class Room:
from_room = data.get("from_room") from_room = data.get("from_room")
pm_id = data.get("pm_id") pm_id = data.get("pm_id")
await self._inhabitant.pm(self, from_uid, from_nick, from_room, pm_id) await self._inhabitant.on_pm(self, from_uid, from_nick, from_room, pm_id)
async def _event_send(self, data): async def _event_send(self, data):
message = Message.from_dict(data) message = Message.from_dict(data)
@ -277,7 +277,7 @@ class Room:
self._forward_new.append(message) self._forward_new.append(message)
else: else:
self._last_known_mid = message.mid self._last_known_mid = message.mid
await self._inhabitant.send(self, message) await self._inhabitant.on_send(self, message)
# TODO: Figure out a way to bring fast-forwarding into this # TODO: Figure out a way to bring fast-forwarding into this
@ -325,7 +325,7 @@ class Room:
self._connected_future.set_result(None) self._connected_future.set_result(None)
# Let's let the inhabitant know. # Let's let the inhabitant know.
await self._inhabitant.connected(self, log) await self._inhabitant.on_connected(self, log)
# TODO: Figure out a way to bring fast-forwarding into this # TODO: Figure out a way to bring fast-forwarding into this
# Should probably happen where this comment is # Should probably happen where this comment is
@ -368,10 +368,10 @@ class Room:
logger.info(f"&{self.roomname}:Reached last known message, forwarding through messages") logger.info(f"&{self.roomname}:Reached last known message, forwarding through messages")
for message in reversed(old_messages): for message in reversed(old_messages):
self._last_known_mid = message.mid self._last_known_mid = message.mid
asyncio.ensure_future(self._inhabitant.forward(self, message)) asyncio.ensure_future(self._inhabitant.on_forward(self, message))
for message in self._forward_new: for message in self._forward_new:
self._last_known_mid = message.mid self._last_known_mid = message.mid
asyncio.ensure_future(self._inhabitant.forward(self, message)) asyncio.ensure_future(self._inhabitant.on_forward(self, message))
logger.info(f"&{self.roomname}:Forwarding complete, fully connected") logger.info(f"&{self.roomname}:Forwarding complete, fully connected")
self._forward_new = [] self._forward_new = []
@ -399,29 +399,29 @@ class Inhabitant:
# They're launched via asyncio.ensure_future(), so they don't block execution of the room. # They're launched via asyncio.ensure_future(), so they don't block execution of the room.
# Just overwrite the events you need (make sure to keep the arguments the same though). # Just overwrite the events you need (make sure to keep the arguments the same though).
async def created(self, room): async def on_created(self, room):
pass pass
async def connected(self, room, log): async def on_connected(self, room, log):
pass pass
async def disconnected(self, room): async def on_disconnected(self, room):
pass pass
async def join(self, room, session): async def on_join(self, room, session):
pass pass
async def part(self, room, session): async def on_part(self, room, session):
pass pass
async def nick(self, room, sid, uid, from_nick, to_nick): async def on_nick(self, room, sid, uid, from_nick, to_nick):
pass pass
async def send(self, room, message): async def on_send(self, room, message):
pass pass
async def fast_forward(self, room, message): async def on_forward(self, room, message):
pass await self.on_send(room, message)
async def pm(self, room, from_uid, from_nick, from_room, pm_id): async def on_pm(self, room, from_uid, from_nick, from_room, pm_id):
pass pass