onload > on_start

Author: dmptrluke

cloudbot/hook.py

@@ -277,21 +277,24 @@ def _sieve_hook(func):
         return lambda func: _sieve_hook(func)
 
 
-def onload(param=None, **kwargs):
-    """External onload decorator. Can be used directly as a decorator, or with args to return a decorator
+def on_start(param=None, **kwargs):
+    """External on_start decorator. Can be used directly as a decorator, or with args to return a decorator
     :type param: function | None
     """
 
-    def _onload_hook(func):
-        hook = _get_hook(func, "onload")
+    def _on_start_hook(func):
+        hook = _get_hook(func, "on_start")
         if hook is None:
-            hook = _Hook(func, "onload")
+            hook = _Hook(func, "on_start")
             _add_hook(func, hook)
 
         hook._add_hook(kwargs)
         return func
 
     if callable(param):
-        return _onload_hook(param)
+        return _on_start_hook(param)
     else:
-        return lambda func: _onload_hook(func)
+        return lambda func: _on_start_hook(func)
+
+
+onload = on_start

cloudbot/plugin.py

@@ -18,7 +18,7 @@ def find_hooks(parent, module):
     """
     :type parent: Plugin
     :type module: object
-    :rtype: (list[CommandHook], list[RegexHook], list[RawHook], list[SieveHook], List[EventHook], list[OnloadHook])
+    :rtype: (list[CommandHook], list[RegexHook], list[RawHook], list[SieveHook], List[EventHook], list[OnStartHook])
     """
     # set the loaded flag
     module._cloudbot_loaded = True
@@ -27,8 +27,8 @@ def find_hooks(parent, module):
     raw = []
     sieve = []
     event = []
-    onload = []
-    type_lists = {"command": command, "regex": regex, "irc_raw": raw, "sieve": sieve, "event": event, "onload": onload}
+    on_start = []
+    type_lists = {"command": command, "regex": regex, "irc_raw": raw, "sieve": sieve, "event": event, "on_start": on_start}
     for name, func in module.__dict__.items():
         if hasattr(func, "_cloudbot_hook"):
             # if it has cloudbot hook
@@ -40,7 +40,7 @@ def find_hooks(parent, module):
             # delete the hook to free memory
             del func._cloudbot_hook
 
-    return command, regex, raw, sieve, event, onload
+    return command, regex, raw, sieve, event, on_start
 
 
 def find_tables(code):
@@ -158,11 +158,11 @@ def load_plugin(self, path):
         # create database tables
         yield from plugin.create_tables(self.bot)
 
-        # run onload hooks
-        for onload_hook in plugin.run_on_load:
-            success = yield from self.launch(onload_hook, Event(bot=self.bot, hook=onload_hook))
+        # run on_start hooks
+        for on_start_hook in plugin.run_on_start:
+            success = yield from self.launch(on_start_hook, Event(bot=self.bot, hook=on_start_hook))
             if not success:
-                logger.warning("Not registering hooks from plugin {}: onload hook errored".format(plugin.title))
+                logger.warning("Not registering hooks from plugin {}: on_start hook errored".format(plugin.title))
 
                 # unregister databases
                 plugin.unregister_tables(self.bot)
@@ -214,7 +214,7 @@ def load_plugin(self, path):
             self._log_hook(sieve_hook)
 
         # we don't need this anymore
-        del plugin.run_on_load
+        del plugin.run_on_start
 
     @asyncio.coroutine
     def unload_plugin(self, path):
@@ -408,7 +408,7 @@ def launch(self, hook, event):
         :type hook: cloudbot.plugin.Hook | cloudbot.plugin.CommandHook
         :rtype: bool
         """
-        if hook.type != "onload":  # we don't need sieves on onload hooks.
+        if hook.type != "on_start":  # we don't need sieves on on_start hooks.
             for sieve in self.bot.plugin_manager.sieves:
                 event = yield from self._sieve(sieve, event, hook)
                 if event is None:
@@ -483,7 +483,7 @@ def __init__(self, filepath, filename, title, code):
         self.file_path = filepath
         self.file_name = filename
         self.title = title
-        self.commands, self.regexes, self.raw_hooks, self.sieves, self.events, self.run_on_load = find_hooks(self, code)
+        self.commands, self.regexes, self.raw_hooks, self.sieves, self.events, self.run_on_start = find_hooks(self, code)
         # we need to find tables for each plugin so that they can be unloaded from the global metadata when the
         # plugin is reloaded
         self.tables = find_tables(code)
@@ -686,19 +686,19 @@ def __str__(self):
                                               self.plugin.file_name)
 
 
-class OnloadHook(Hook):
-    def __init__(self, plugin, on_load_hook):
+class OnStartHook(Hook):
+    def __init__(self, plugin, on_start_hook):
         """
         :type plugin: Plugin
-        :type on_load_hook: cloudbot.util.hook._OnLoadHook
+        :type on_start_hook: cloudbot.util.hook._On_startHook
         """
-        super().__init__("onload", plugin, on_load_hook)
+        super().__init__("on_start", plugin, on_start_hook)
 
     def __repr__(self):
-        return "Onload[{}]".format(Hook.__repr__(self))
+        return "On_start[{}]".format(Hook.__repr__(self))
 
     def __str__(self):
-        return "onload {} from {}".format(self.function_name, self.plugin.file_name)
+        return "on_start {} from {}".format(self.function_name, self.plugin.file_name)
 
 
 _hook_name_to_plugin = {
@@ -707,5 +707,5 @@ def __str__(self):
     "irc_raw": RawHook,
     "sieve": SieveHook,
     "event": EventHook,
-    "onload": OnloadHook
+    "on_start": OnStartHook
 }

plugins/attacks.py

@@ -9,7 +9,7 @@
 from cloudbot.util import textgen
 
 
-@hook.onload()
+@hook.on_start()
 def load_attacks(bot):
     """
     :type bot: cloudbot.bot.CloudBot

plugins/eightball.py

@@ -7,7 +7,7 @@
 from cloudbot.util import colors
 
 
-@hook.onload()
+@hook.on_start()
 def load_responses(bot):
     path = os.path.join(bot.data_dir, "8ball_responses.txt")
     global responses

plugins/encrypt.py

@@ -44,7 +44,7 @@ def decode_aes(c, s):
         return "Invalid password for the given message (couldn't encode result as utf-8)"
 
 
-@hook.onload
+@hook.on_start
 def create_db(db):
     """check to see that our db has the the encryption table.
     :type db: sqlalchemy.orm.session.Session

plugins/factoids.py

@@ -28,7 +28,7 @@ def _load_cache_db(db):
 
 
 @asyncio.coroutine
-@hook.onload()
+@hook.on_start()
 def load_cache(async, db):
     """
     :type db: sqlalchemy.orm.Session

plugins/fortune.py

@@ -6,7 +6,7 @@
 from cloudbot import hook
 
 
-@hook.onload()
+@hook.on_start()
 def load_fortunes(bot):
     path = os.path.join(bot.data_dir, "fortunes.txt")
     global fortunes

plugins/geoip.py

@@ -72,7 +72,7 @@ def check_db(loop):
 
 
 @asyncio.coroutine
-@hook.onload
+@hook.on_start
 def load_geoip(loop):
     asyncio.async(check_db(loop), loop=loop)
 

plugins/horoscope.py

@@ -7,7 +7,7 @@
 from cloudbot.util import formatting
 
 
-@hook.onload()
+@hook.on_start()
 def init(db):
     db.execute("create table if not exists horoscope(nick primary key, sign)")
     db.commit()

plugins/ignore.py

@@ -19,7 +19,7 @@
 )
 
 
-@hook.onload
+@hook.on_start
 def load_cache(db):
     """
     :type db: sqlalchemy.orm.Session