feat(hotreload): release 1.0.0

hotreload/hotreload.py

@@ -1,3 +1,4 @@
+from asyncio import run_coroutine_threadsafe
 from pathlib import Path
 
 from red_commons.logging import RedTraceLogger, getLogger
@@ -5,7 +6,7 @@ from redbot.core import commands
 from redbot.core.bot import Red
 from redbot.core.core_commands import CoreLogic
 from redbot.core.utils.chat_formatting import bold, humanize_list
-from watchdog.events import FileSystemEvent, FileSystemEventHandler
+from watchdog.events import FileSystemEvent, RegexMatchingEventHandler
 from watchdog.observers import Observer
 
 
@@ -14,13 +15,28 @@ class HotReload(commands.Cog):
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.0.0-rc1"
+    __version__ = "1.0.0"
     __documentation__ = "https://seacogs.coastalcommits.com/hotreload/"
 
     def __init__(self, bot: Red) -> None:
         super().__init__()
         self.bot: Red = bot
         self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.HotReload")
+        self.observer = None
+        watchdog_loggers = [getLogger(name="watchdog.observers.inotify_buffer")]
+        for watchdog_logger in watchdog_loggers:
+            watchdog_logger.setLevel("INFO")  # SHUT UP!!!!
+
+    def cog_load(self) -> None:
+        """Start the observer when the cog is loaded."""
+        self.bot.loop.create_task(self.start_observer())
+
+    def cog_unload(self) -> None:
+        """Stop the observer when the cog is unloaded."""
+        if self.observer:
+            self.observer.stop()
+            self.observer.join()
+            self.logger.info("Stopped observer. No longer watching for file changes.")
 
     def format_help_for_context(self, ctx: commands.Context) -> str:
         pre_processed = super().format_help_for_context(ctx) or ""
@@ -41,30 +57,35 @@ class HotReload(commands.Cog):
 
     async def start_observer(self) -> None:
         """Start the observer to watch for file changes."""
-        observer = Observer()
+        self.observer = Observer()
-        for path in await self.get_paths():
+        paths = await self.get_paths()
-            observer.schedule(HotReloadHandler(self.bot, path), path, recursive=True)
+        for path in paths:
-        observer.start()
+            self.observer.schedule(event_handler=HotReloadHandler(bot=self.bot, path=path), path=path, recursive=True)
-        self.logger.info("Started observer.")
+        self.observer.start()
+        self.logger.info("Started observer. Watching for file changes.")
 
 
-class HotReloadHandler(FileSystemEventHandler):
+class HotReloadHandler(RegexMatchingEventHandler):
     """Handler for file changes."""
 
     def __init__(self, bot: Red, path: Path) -> None:
+        super().__init__(regexes=[r".*\.py$"])
         self.bot: Red = bot
         self.path: Path = path
-        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.HotReloadHandler")
+        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.HotReload.Observer")
 
     def on_modified(self, event: FileSystemEvent) -> None:
         """Handle file modification events."""
         if event.is_directory:
             return
-        self.logger.info(f"File {event.src_path} has been modified.")
+        relative_path = Path(event.src_path).relative_to(self.path)
-        # self.bot.loop.create_task(self.reload_cog())
+        package_name = relative_path.parts[0]
+        self.logger.info(f"File {'/'.join(relative_path.parts[1:])} in the cog {package_name} has been modified.")
+        run_coroutine_threadsafe(self.reload_cog(package_name), loop=self.bot.loop)
 
     async def reload_cog(self, cog_name: str) -> None:
         """Reload modified cog."""
         core_logic = CoreLogic(bot=self.bot)
-        core_logic._reload(pkg_names=(cog_name,))
+        self.logger.info(f"Reloading {cog_name} cog.")
+        await core_logic._reload(pkg_names=(cog_name,))
         self.logger.info(f"Reloaded {cog_name} cog.")