Switch plugins away from using deprecated function event.async()

Author: linuxdaemon

cloudbot/event.py

@@ -327,7 +327,7 @@ def async_call(self, func, *args, **kwargs):
     if sys.version_info < (3, 7, 0):
         # noinspection PyCompatibility
         @asyncio.coroutine
-        def async(self, function, *args, **kwargs):
+        def async_(self, function, *args, **kwargs):
             warnings.warn(
                 "event.async() is deprecated, use event.async_call() instead.",
                 DeprecationWarning, stacklevel=2
@@ -336,6 +336,13 @@ def async(self, function, *args, **kwargs):
             return result
 
 
+# Silence deprecation warnings about use of the 'async' name as a function
+try:
+    setattr(Event, 'async', getattr(Event, 'async_'))
+except AttributeError:
+    pass
+
+
 class CommandEvent(Event):
     """
     :type hook: cloudbot.plugin.CommandHook

cloudbot/plugin.py

@@ -13,6 +13,8 @@
 import sqlalchemy
 import sys
 
+import time
+
 from cloudbot.event import Event
 from cloudbot.hook import Priority, Action
 from cloudbot.util import database
@@ -649,6 +651,7 @@ def __init__(self, _type, plugin, func_hook):
         if sys.version_info < (3, 7, 0):
             if "async" in self.required_args:
                 logger.warning("Use of deprecated function 'async' in %s", self.description)
+                time.sleep(1)
                 warnings.warn(
                     "event.async() is deprecated, use event.async_call() instead.",
                     DeprecationWarning, stacklevel=2

plugins/autojoin.py

@@ -21,8 +21,8 @@ def get_channels(db, conn):
 
 @asyncio.coroutine
 @hook.irc_raw('004')
-def do_joins(db, conn, async):
-    chans = yield from async(get_channels, db, conn)
+def do_joins(db, conn, async_call):
+    chans = yield from async_call(get_channels, db, conn)
     join_throttle = conn.config.get("join_throttle", 0.4)
     for chan in chans:
         conn.join(chan[1])

plugins/remind.py

@@ -40,26 +40,26 @@
 
 
 @asyncio.coroutine
-def delete_reminder(async, db, network, remind_time, user):
+def delete_reminder(async_call, db, network, remind_time, user):
     query = table.delete() \
         .where(table.c.network == network.lower()) \
         .where(table.c.remind_time == remind_time) \
         .where(table.c.added_user == user.lower())
-    yield from async(db.execute, query)
-    yield from async(db.commit)
+    yield from async_call(db.execute, query)
+    yield from async_call(db.commit)
 
 
 @asyncio.coroutine
-def delete_all(async, db, network, user):
+def delete_all(async_call, db, network, user):
     query = table.delete() \
         .where(table.c.network == network.lower()) \
         .where(table.c.added_user == user.lower())
-    yield from async(db.execute, query)
-    yield from async(db.commit)
+    yield from async_call(db.execute, query)
+    yield from async_call(db.commit)
 
 
 @asyncio.coroutine
-def add_reminder(async, db, network, added_user, added_chan, message, remind_time, added_time):
+def add_reminder(async_call, db, network, added_user, added_chan, message, remind_time, added_time):
     query = table.insert().values(
         network=network.lower(),
         added_user=added_user.lower(),
@@ -68,17 +68,17 @@ def add_reminder(async, db, network, added_user, added_chan, message, remind_tim
         message=message,
         remind_time=remind_time
     )
-    yield from async(db.execute, query)
-    yield from async(db.commit)
+    yield from async_call(db.execute, query)
+    yield from async_call(db.commit)
 
 
 @asyncio.coroutine
 @hook.on_start()
-def load_cache(async, db):
+def load_cache(async_call, db):
     global reminder_cache
     reminder_cache = []
 
-    for network, remind_time, added_time, user, message in (yield from async(_load_cache_db, db)):
+    for network, remind_time, added_time, user, message in (yield from async_call(_load_cache_db, db)):
         reminder_cache.append((network, remind_time, added_time, user, message))
 
 
@@ -89,16 +89,16 @@ def _load_cache_db(db):
 
 @asyncio.coroutine
 @hook.periodic(30, initial_interval=30)
-def check_reminders(bot, async, db):
+def check_reminders(bot, async_call, db):
     current_time = datetime.now()
 
     for reminder in reminder_cache:
         network, remind_time, added_time, user, message = reminder
         if remind_time <= current_time:
             if network not in bot.connections:
                 # connection is invalid
-                yield from add_reminder(async, db, network, remind_time, user)
-                yield from load_cache(async, db)
+                yield from add_reminder(async_call, db, network, remind_time, user)
+                yield from load_cache(async_call, db)
                 continue
 
             conn = bot.connections[network]
@@ -119,13 +119,13 @@ def check_reminders(bot, async, db):
                        " it seems I was unable to deliver it on time)".format(late_time)
                 conn.message(user, colors.parse(late))
 
-            yield from delete_reminder(async, db, network, remind_time, user)
-            yield from load_cache(async, db)
+            yield from delete_reminder(async_call, db, network, remind_time, user)
+            yield from load_cache(async_call, db)
 
 
 @asyncio.coroutine
 @hook.command('remind', 'reminder', 'in')
-def remind(text, nick, chan, db, conn, notice, async):
+def remind(text, nick, chan, db, conn, notice, async_call):
     """<1 minute, 30 seconds>: <do task> -- reminds you to <do task> in <1 minute, 30 seconds>"""
 
     count = len([x for x in reminder_cache if x[0] == conn.name and x[3] == nick.lower()])
@@ -134,8 +134,8 @@ def remind(text, nick, chan, db, conn, notice, async):
         if count == 0:
             return "You have no reminders to delete."
 
-        yield from delete_all(async, db, conn.name, nick)
-        yield from load_cache(async, db)
+        yield from delete_all(async_call, db, conn.name, nick)
+        yield from load_cache(async_call, db)
         return "Deleted all ({}) reminders for {}!".format(count, nick)
 
     # split the input on the first ":"
@@ -171,8 +171,8 @@ def remind(text, nick, chan, db, conn, notice, async):
         return "I can't remind you in the past!"
 
     # finally, add the reminder and send a confirmation message
-    yield from add_reminder(async, db, conn.name, nick, chan, message, remind_time, current_time)
-    yield from load_cache(async, db)
+    yield from add_reminder(async_call, db, conn.name, nick, chan, message, remind_time, current_time)
+    yield from load_cache(async_call, db)
 
     remind_text = format_time(seconds, count=2)
     output = "Alright, I'll remind you \"{}\" in $(b){}$(clear)!".format(message, remind_text)