From 90e78bb7f58f2ec64b2d1bd35ac4015b110b21d6 Mon Sep 17 00:00:00 2001 From: Noelle Wang <73260931+No767@users.noreply.github.com> Date: Thu, 25 Jan 2024 16:44:21 -0800 Subject: [PATCH] Implement better extension/library watchdog (#58) --- bot/libs/utils/logger.py | 1 + bot/libs/utils/reloader.py | 88 ++++++++++++++++++++++++++++++++++++++ bot/rodhaj.py | 25 +++-------- poetry.lock | 44 ++++++------------- pyproject.toml | 2 +- requirements.txt | 3 +- 6 files changed, 109 insertions(+), 54 deletions(-) create mode 100644 bot/libs/utils/reloader.py diff --git a/bot/libs/utils/logger.py b/bot/libs/utils/logger.py index 310e6ca..294706b 100644 --- a/bot/libs/utils/logger.py +++ b/bot/libs/utils/logger.py @@ -17,6 +17,7 @@ def __enter__(self) -> None: max_bytes = 32 * 1024 * 1024 # 32 MiB self.log.setLevel(logging.INFO) logging.getLogger("discord").setLevel(logging.INFO) + logging.getLogger("watchfiles").setLevel(logging.WARNING) handler = RotatingFileHandler( filename="rodhaj.log", encoding="utf-8", diff --git a/bot/libs/utils/reloader.py b/bot/libs/utils/reloader.py new file mode 100644 index 0000000..3f7fd12 --- /dev/null +++ b/bot/libs/utils/reloader.py @@ -0,0 +1,88 @@ +from __future__ import annotations + +import asyncio +import importlib +import os +import sys +from pathlib import Path +from typing import TYPE_CHECKING, Optional + +from discord.ext import commands +from watchfiles import Change, awatch + +if TYPE_CHECKING: + from rodhaj import Rodhaj + + +class Reloader: + """An watchdog for reloading extensions and library files + + This reloads/unloads extensions, and also reloads library modules. + This does not implement a deep reload, as there is no way to do so + that way. + """ + + def __init__(self, bot: Rodhaj, path: Path): + self.bot = bot + self.path = path + + self.loop = asyncio.get_running_loop() + self.logger = bot.logger + self._cogs_path = self.path / "cogs" + self._libs_path = self.path / "libs" + + ### Finding modules from the path directly + + def find_modules_from_path(self, path: str) -> Optional[str]: + root, ext = os.path.splitext(path) + sys_path_index = len(sys.path[0].split("/")) + if ext != ".py": + return + + local_path = root.split("/")[sys_path_index:] + return ".".join(item for item in local_path) + + ### Loading/reloading extensions and library modules + + async def reload_or_load_extension(self, module: str) -> None: + try: + await self.bot.reload_extension(module) + self.logger.info("Reloaded extension: %s", module) + except commands.ExtensionNotLoaded: + await self.bot.load_extension(module) + self.logger.info("Loaded extension: %s", module) + + async def reload_library(self, module: str) -> None: + try: + actual_module = sys.modules[module] + importlib.reload(actual_module) + self.logger.info("Reloaded lib module: %s", module) + except KeyError: + self.logger.warning("Failed to reload module %s. Does it exist?", module) + + async def reload_extension_or_library(self, module: str) -> None: + if module.startswith("libs"): + await self.reload_library(module) + elif module.startswith("cogs"): + await self.reload_or_load_extension(module) + + ### Internal coroutine to start the watch + + async def _start(self) -> None: + async for changes in awatch(self._cogs_path, self._libs_path): + for ctype, cpath in changes: + module = self.find_modules_from_path(cpath) + if module is None: + continue + + if ctype == Change.modified or ctype == Change.added: + await self.reload_extension_or_library(module) + elif ctype == Change.deleted: + await self.bot.unload_extension(module) + + ### Public method to start the reloader + + def start(self) -> None: + """Starts the deep reloader""" + self.loop.create_task(self._start()) + self.bot.dispatch("deepreloader_ready") diff --git a/bot/rodhaj.py b/bot/rodhaj.py index 8bea9f5..ae10c48 100644 --- a/bot/rodhaj.py +++ b/bot/rodhaj.py @@ -19,16 +19,11 @@ RodhajHelp, send_error_embed, ) +from libs.utils.reloader import Reloader if TYPE_CHECKING: from cogs.tickets import Tickets -_fsw = True -try: - from watchfiles import awatch -except ImportError: - _fsw = False - TRANSPROGRAMMER_GUILD_ID = 1183302385020436480 @@ -65,6 +60,7 @@ def __init__( self.transprogrammer_guild_id = TRANSPROGRAMMER_GUILD_ID self.version = str(VERSION) self._dev_mode = dev_mode + self._reloader = Reloader(self, Path(__file__).parent) ### Ticket related utils async def fetch_partial_config(self) -> Optional[PartialConfig]: @@ -196,17 +192,6 @@ async def on_message(self, message: discord.Message) -> None: return await self.process_commands(message, ctx) - ### Dev related utils - - async def fs_watcher(self) -> None: - cogs_path = Path(__file__).parent.joinpath("cogs") - async for changes in awatch(cogs_path): - changes_list = list(changes)[0] - if changes_list[0].modified == 2: - reload_file = Path(changes_list[1]) - self.logger.info(f"Reloading extension: {reload_file.name[:-3]}") - await self.reload_extension(f"cogs.{reload_file.name[:-3]}") - ### Internal core overrides async def setup_hook(self) -> None: @@ -219,9 +204,9 @@ async def setup_hook(self) -> None: self.partial_config = await self.fetch_partial_config() - if self._dev_mode is True and _fsw is True: - self.logger.info("Dev mode is enabled. Loading FSWatcher") - self.loop.create_task(self.fs_watcher()) + if self._dev_mode: + self.logger.info("Dev mode is enabled. Loading Reloader") + self._reloader.start() async def on_ready(self): if not hasattr(self, "uptime"): diff --git a/poetry.lock b/poetry.lock index 0b12785..0e6e83d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. [[package]] name = "aiodns" @@ -137,24 +137,25 @@ files = [ [[package]] name = "anyio" -version = "4.0.0" +version = "4.2.0" description = "High level compatibility layer for multiple asynchronous event loop implementations" optional = false python-versions = ">=3.8" files = [ - {file = "anyio-4.0.0-py3-none-any.whl", hash = "sha256:cfdb2b588b9fc25ede96d8db56ed50848b0b649dca3dd1df0b11f683bb9e0b5f"}, - {file = "anyio-4.0.0.tar.gz", hash = "sha256:f7ed51751b2c2add651e5747c891b47e26d2a21be5d32d9311dfe9692f3e5d7a"}, + {file = "anyio-4.2.0-py3-none-any.whl", hash = "sha256:745843b39e829e108e518c489b31dc757de7d2131d53fac32bd8df268227bfee"}, + {file = "anyio-4.2.0.tar.gz", hash = "sha256:e1875bb4b4e2de1669f4bc7869b6d3f54231cdced71605e6e64c9be77e3be50f"}, ] [package.dependencies] exceptiongroup = {version = ">=1.0.2", markers = "python_version < \"3.11\""} idna = ">=2.8" sniffio = ">=1.1" +typing-extensions = {version = ">=4.1", markers = "python_version < \"3.11\""} [package.extras] -doc = ["Sphinx (>=7)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)"] -test = ["anyio[trio]", "coverage[toml] (>=7)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (>=0.17)"] -trio = ["trio (>=0.22)"] +doc = ["Sphinx (>=7)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"] +test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (>=0.17)"] +trio = ["trio (>=0.23)"] [[package]] name = "astunparse" @@ -811,13 +812,13 @@ tests = ["environs[django]", "pytest"] [[package]] name = "exceptiongroup" -version = "1.1.3" +version = "1.2.0" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" files = [ - {file = "exceptiongroup-1.1.3-py3-none-any.whl", hash = "sha256:343280667a4585d195ca1cf9cef84a4e178c4b6cf2274caef9859782b567d5e3"}, - {file = "exceptiongroup-1.1.3.tar.gz", hash = "sha256:097acd85d473d75af5bb98e41b61ff7fe35efe6675e4f9370ec6ec5126d160e9"}, + {file = "exceptiongroup-1.2.0-py3-none-any.whl", hash = "sha256:4bfd3996ac73b41e9b9628b04e079f193850720ea5945fc96a08633c66912f14"}, + {file = "exceptiongroup-1.2.0.tar.gz", hash = "sha256:91f5c769735f051a4290d52edd0858999b57e5876e9f85937691bd4c9fa3ed68"}, ] [package.extras] @@ -1084,16 +1085,6 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -1615,7 +1606,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1623,16 +1613,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1649,7 +1631,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1657,7 +1638,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2297,4 +2277,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = ">=3.9,<4" -content-hash = "feaf97f502139324dc51844a16cc97f122aaa83a4075f0d5fe048e8ac6cea45a" +content-hash = "b3dc901a7b78f8d6a9c55365a57cdd885f24fd885169ab2602856362c9add17b" diff --git a/pyproject.toml b/pyproject.toml index 2c2116d..d5ad886 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,6 +22,7 @@ environs = "^10.3.0" async-lru = "^2.0.4" msgspec = "^0.18.6" jishaku = "^2.5.2" +watchfiles = "^0.21.0" [tool.poetry.group.dev.dependencies] # These are pinned by major version @@ -30,7 +31,6 @@ jishaku = "^2.5.2" pre-commit = "^3" pyright = "^1.1" ruff = "^0.1" -watchfiles = "^0" [tool.poetry.group.docs.dependencies] sphinx = "^7.2.6" diff --git a/requirements.txt b/requirements.txt index 0ed6ce4..dc9f872 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,4 +11,5 @@ typing-extensions==4.9.0 environs==10.3.0 async-lru==2.0.4 msgspec==0.18.6 -jishaku==2.5.2 \ No newline at end of file +jishaku==2.5.2 +watchfiles>=0.21.0,<1 \ No newline at end of file