Merge pull request #674 from TotallyNotRobots/hook-dict

Move plugin hooks to typed dict

.devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+FROM mcr.microsoft.com/devcontainers/python:3.11
+
+RUN \
+    pipx uninstall pydocstyle \
+    && pipx uninstall pycodestyle \
+    && pipx uninstall mypy \
+    && pipx uninstall pylint \
+    && pipx uninstall pytest \
+    && pipx uninstall flake8 \
+    && pipx uninstall black
+
+ENV SHELL /bin/bash

.devcontainer/devcontainer.json

@@ -1,38 +1,50 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-	"name": "Python 3",
-	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/python:0-3.9",
-	"features": {
-		"ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
-			"plugins": "ssh-agent",
-			"omzPlugins": "https://github.com/zsh-users/zsh-autosuggestions"
-		}
-	},
+    "name": "Python 3",
+    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+    "dockerFile": "./Dockerfile",
+    "context": "..",
+    "features": {
+        "ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
+            "plugins": "ssh-agent",
+            "omzPlugins": "https://github.com/zsh-users/zsh-autosuggestions"
+        }
+    },
 
-	// Features to add to the dev container. More info: https://containers.dev/features.
-	// "features": {},
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
 
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
 
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "pip3 install -Ur requirements-dev.txt",
-	"postStartCommand": "pip3 install -Ur requirements-dev.txt",
-	// Configure tool-specific properties.
-	// "customizations": {},
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "pip3 install -Ur requirements-dev.txt",
+    "postCreateCommand": "pip3 install -Ur requirements-dev.txt",
+    // Configure tool-specific properties.
+    // "customizations": {},
 
-	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-	"remoteUser": "root",
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"tamasfe.even-better-toml",
-				"ms-python.python",
-				"ms-python.vscode-pylance",
-				"EditorConfig.EditorConfig"
-			]
-		}
-	}
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "tamasfe.even-better-toml",
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "EditorConfig.EditorConfig",
+                "GitHub.vscode-pull-request-github"
+            ],
+            "settings": {
+                "python.pythonPath": "/usr/local/bin/python",
+                "python.testing.pytestArgs": ["--no-cov"],
+                "terminal.integrated.profiles.linux": {
+                    "zsh": {
+                        "path": "/usr/bin/zsh"
+                    }
+                },
+                "terminal.integrated.defaultProfile.linux": "zsh"
+            }
+        }
+    }
 }

.vscode/extensions.json

@@ -1,6 +1,5 @@
 {
     "recommendations": [
-        "github.vscode-github-actions",
         "github.vscode-pull-request-github"
     ]
 }

cloudbot/plugin.py

@@ -7,7 +7,16 @@
 from functools import partial
 from operator import attrgetter
 from pathlib import Path
-from typing import Dict, List, MutableMapping, Optional, Tuple, Type, cast
+from typing import (
+    Dict,
+    List,
+    MutableMapping,
+    Optional,
+    Tuple,
+    Type,
+    TypedDict,
+    cast,
+)
 from weakref import WeakValueDictionary
 
 import sqlalchemy
@@ -19,8 +28,18 @@
     CommandHook,
     ConfigHook,
     EventHook,
+    IrcOutHook,
+    OnCapAckHook,
+    OnCapAvaliableHook,
+    OnConnectHook,
+    OnStartHook,
+    OnStopHook,
+    PeriodicHook,
+    PermHook,
+    PostHookHook,
     RawHook,
     RegexHook,
+    SieveHook,
     hook_name_to_plugin,
 )
 from cloudbot.util import HOOK_ATTR, LOADED_ATTR, async_util, database
@@ -29,7 +48,25 @@
 logger = logging.getLogger("cloudbot")
 
 
-def find_hooks(parent, module):
+class HookDict(TypedDict):
+    command: List[CommandHook]
+    on_connect: List[OnConnectHook]
+    on_start: List[OnStartHook]
+    on_stop: List[OnStopHook]
+    on_cap_available: List[OnCapAvaliableHook]
+    on_cap_ack: List[OnCapAckHook]
+    sieve: List[SieveHook]
+    event: List[EventHook]
+    regex: List[RegexHook]
+    periodic: List[PeriodicHook]
+    irc_raw: List[RawHook]
+    irc_out: List[IrcOutHook]
+    post_hook: List[PostHookHook]
+    config: List[ConfigHook]
+    perm_check: List[PermHook]
+
+
+def find_hooks(parent, module) -> HookDict:
     hooks = defaultdict(list)
     for func in module.__dict__.values():
         if hasattr(func, HOOK_ATTR) and not hasattr(func, "_not_" + HOOK_ATTR):
@@ -44,7 +81,7 @@ def find_hooks(parent, module):
             # delete the hook to free memory
             delattr(func, HOOK_ATTR)
 
-    return hooks
+    return cast(HookDict, hooks)
 
 
 def find_tables(code):
@@ -351,7 +388,7 @@ async def load_plugin(self, path):
         self._sort_hooks()
 
         # we don't need this anymore
-        del plugin.hooks["on_start"]
+        plugin.hooks["on_start"].clear()
 
     def _sort_hooks(self) -> None:
         def _sort_list(hooks):

cloudbot/util/web.py

@@ -20,8 +20,13 @@
 from typing import Dict, Optional, Union
 
 import requests
-from requests import HTTPError, PreparedRequest, RequestException, Response
-from requests import Request
+from requests import (
+    HTTPError,
+    PreparedRequest,
+    Request,
+    RequestException,
+    Response,
+)
 
 # Constants
 DEFAULT_SHORTENER = "is.gd"
@@ -163,7 +168,9 @@ def paste(data, ext="txt", service=DEFAULT_PASTEBIN, raise_on_no_paste=False):
 
 
 class ServiceError(Exception):
-    def __init__(self, request: Union[Request, PreparedRequest], message: str) -> None:
+    def __init__(
+        self, request: Union[Request, PreparedRequest], message: str
+    ) -> None:
         super().__init__(message)
         self.request = request
 

tests/conftest.py

@@ -1,4 +1,5 @@
 import datetime
+import importlib
 import logging
 from typing import List
 from unittest.mock import MagicMock, patch
@@ -30,13 +31,13 @@ def caplog_bot(caplog):
 
 @pytest.fixture()
 def patch_import_module():
-    with patch("importlib.import_module") as mocked:
+    with patch.object(importlib, "import_module") as mocked:
         yield mocked
 
 
 @pytest.fixture()
 def patch_import_reload():
-    with patch("importlib.reload") as mocked:
+    with patch.object(importlib, "reload") as mocked:
         yield mocked
 
 

tests/core_tests/test_plugin_manager.py

@@ -14,7 +14,6 @@
 from cloudbot.util import database
 from tests.util.mock_module import MockModule
 
-
 @pytest.fixture()
 def mock_bot(mock_bot_factory, event_loop, tmp_path):
     tmp_base = tmp_path / "tmp"
@@ -221,6 +220,8 @@ def test_plugin_with_objs_full_dict_attr(mock_manager, patch_import_module):
 def test_plugin_load_disabled(
     mock_manager, patch_import_module, patch_import_reload
 ):
+    patch_import_module.reset_mock()
+    patch_import_reload.reset_mock()
     patch_import_module.return_value = MockModule()
     mock_manager.bot.config.update(
         {

tests/plugin_tests/test_chan_log.py

@@ -6,6 +6,9 @@
 def test_format_exception_chain():
     def _get_data(exc):
         yield repr(exc)
+        if hasattr(exc, 'add_note'):
+            yield f"  add_note = {exc.add_note!r}"
+
         yield f"  args = {exc.args!r}"
         yield f"  with_traceback = {exc.with_traceback!r}"
         yield ""