Merge pull request #459 from TotallyNotRobots/add-3.10

Add 3.10 to testing

Author: linuxdaemon

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+// 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"
+		}
+	},
+
+	// 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 '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": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	"remoteUser": "root"
+}

.github/workflows/pythonapp.yml

@@ -18,7 +18,8 @@ jobs:
         - '3.7'
         - '3.8'
         - '3.9'
-    runs-on: ubuntu-latest
+        - '3.10'
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v3
       with:

.pre-commit-config.yaml

@@ -22,7 +22,9 @@ repos:
   - id: check-docstring-first
   - id: check-executables-have-shebangs
   - id: check-json
+    exclude: '.devcontainer/.*'
   - id: pretty-format-json
+    exclude: '.devcontainer/.*'
     args:
     - --indent
     - '4'
@@ -33,11 +35,11 @@ repos:
     args:
     - --remove
 - repo: https://github.com/psf/black
-  rev: 2ddea293a88919650266472186620a98a4a8bb37  # frozen: 22.12.0
+  rev: b0d1fba7ac3be53c71fb0d3211d911e629f8aecb  # frozen: 23.1.0
   hooks:
   - id: black
 - repo: https://github.com/pycqa/isort
-  rev: 4e97b170469b7c8ef29afe944ebfb057791457aa  # frozen: 5.11.4
+  rev: dbf82f2dd09ae41d9355bcd7ab69187a19e6bf2f  # frozen: 5.12.0
   hooks:
   - id: isort
 - repo: https://github.com/pre-commit/pygrep-hooks

cloudbot/__main__.py

@@ -1,3 +1,4 @@
+import asyncio
 import logging
 import os
 import signal
@@ -9,7 +10,7 @@
 from cloudbot.util import async_util
 
 
-def main():
+async def async_main():
     # store the original working directory, for use when restarting
     original_wd = Path().resolve()
 
@@ -55,7 +56,7 @@ def exit_gracefully(signum, frame):
     # start the bot
 
     # CloudBot.run() will return True if it should restart, False otherwise
-    restart = _bot.run()
+    restart = await _bot.run()
 
     # the bot has stopped, do we want to restart?
     if restart:
@@ -84,5 +85,9 @@ def exit_gracefully(signum, frame):
     logging.shutdown()
 
 
+def main():
+    asyncio.run(async_main())
+
+
 if __name__ == "__main__":
     main()

cloudbot/bot.py

@@ -1,6 +1,7 @@
 import asyncio
 import collections
 import gc
+import importlib
 import logging
 import re
 import time
@@ -10,13 +11,12 @@
 from pathlib import Path
 from typing import Any, Dict, Optional, Type
 
-from sqlalchemy import Table, create_engine, inspect
+from sqlalchemy import Table, create_engine
+from sqlalchemy import inspect as sa_inspect
 from sqlalchemy.engine import Engine
 from sqlalchemy.orm import Session, scoped_session, sessionmaker
-from venusian import Scanner
 from watchdog.observers import Observer
 
-from cloudbot import clients
 from cloudbot.client import Client
 from cloudbot.config import Config
 from cloudbot.event import CommandEvent, Event, EventType, RegexEvent
@@ -186,22 +186,21 @@ def data_dir(self) -> str:
         )
         return str(self.data_path)
 
-    def run(self):
+    async def run(self):
         """
         Starts CloudBot.
         This will load plugins, connect to IRC, and process input.
         :return: True if CloudBot should be restarted, False otherwise
         """
         self.loop.set_default_executor(self.executor)
         # Initializes the bot, plugins and connections
-        self.loop.run_until_complete(self._init_routine())
+        await self._init_routine()
         # Wait till the bot stops. The stopped_future will be set to True to restart, False otherwise
         logger.debug("Init done")
-        restart = self.loop.run_until_complete(self.stopped_future)
+        restart = await self.stopped_future
         logger.debug("Waiting for plugin unload")
-        self.loop.run_until_complete(self.plugin_manager.unload_all())
+        await self.plugin_manager.unload_all()
         logger.debug("Unload complete")
-        self.loop.close()
         return restart
 
     def get_client(self, name: str) -> Type[Client]:
@@ -316,8 +315,21 @@ def load_clients(self):
         """
         Load all clients from the "clients" directory
         """
-        scanner = Scanner(bot=self)
-        scanner.scan(clients, categories=["cloudbot.client"])
+        for file in (Path(__file__).parent / "clients").rglob("*.py"):
+            if file.name.startswith("_"):
+                continue
+
+            mod = importlib.import_module("cloudbot.clients." + file.stem)
+            for _, obj in vars(mod).items():
+                if not isinstance(obj, type):
+                    continue
+
+                try:
+                    _type = obj._cloudbot_client  # type: ignore
+                except AttributeError:
+                    continue
+
+                self.register_client(_type, obj)
 
     async def process(self, event):
         run_before_tasks = []
@@ -467,7 +479,7 @@ def migrate_db(self) -> None:
         old_session: Session = scoped_session(sessionmaker(bind=engine))()
         new_session: Session = database.Session()
         table: Table
-        inspector = inspect(engine)
+        inspector = sa_inspect(engine)
         for table in database.metadata.tables.values():
             logger.info("Migrating table %s", table.name)
             if not inspector.has_table(table.name):

cloudbot/client.py

@@ -4,8 +4,6 @@
 import random
 from typing import Any, Dict
 
-import venusian
-
 from cloudbot.permissions import PermissionManager
 from cloudbot.util import async_util
 
@@ -14,10 +12,7 @@
 
 def client(_type):
     def _decorate(cls):
-        def callback_cb(context, name, obj):
-            context.bot.register_client(_type, cls)
-
-        venusian.attach(cls, callback_cb, category="cloudbot.client")
+        cls._cloudbot_client = _type
         return cls
 
     return _decorate

cloudbot/util/async_util.py

@@ -3,7 +3,6 @@
 """
 
 import asyncio
-import sys
 from asyncio import AbstractEventLoop
 from asyncio.tasks import Task
 from functools import partial
@@ -56,19 +55,10 @@ def run_coroutine_threadsafe(coro, loop):
     if not asyncio.iscoroutine(coro):
         raise TypeError("A coroutine object is required")
 
-    if sys.version_info < (3, 5, 1):
-        loop.call_soon_threadsafe(partial(wrap_future, coro, loop=loop))
-    else:
-        asyncio.run_coroutine_threadsafe(coro, loop)
-
-
-def create_future(loop=None) -> asyncio.Future:
-    if loop is None:
-        loop = asyncio.get_event_loop()
+    asyncio.run_coroutine_threadsafe(coro, loop)
 
-    if sys.version_info < (3, 5, 2):
-        return asyncio.Future(loop=loop)
 
+def create_future(loop) -> asyncio.Future:
     return loop.create_future()
 
 

cloudbot/util/mapping.py

@@ -1,6 +1,6 @@
 import weakref
 from collections import defaultdict
-from typing import Generic, Mapping, MutableMapping, Type, TypeVar, cast
+from typing import TYPE_CHECKING, Generic, Optional, TypeVar, Union, cast
 
 __all__ = (
     "KeyFoldDict",
@@ -10,57 +10,74 @@
 )
 
 
-K = TypeVar("K", bound=str)
+K_contra = TypeVar("K_contra", bound=str, contravariant=True)
 V = TypeVar("V")
+T = TypeVar("T")
 
 
-class KeyFoldMixin(Generic[K, V]):
+if TYPE_CHECKING:
+    from typing import Protocol
+
+    class MapBase(Protocol[K_contra, V]):
+        def __getitem__(self, item: K_contra) -> V:
+            ...
+
+        def __delitem__(self, item: K_contra) -> None:
+            ...
+
+        def __setitem__(self, item: K_contra, value: V) -> None:
+            ...
+
+        def get(self, item: K_contra, default: V = None) -> Optional[V]:
+            ...
+
+        def setdefault(
+            self, key: K_contra, default: Union[V, T] = None
+        ) -> Union[V, T]:
+            ...
+
+        def pop(
+            self, key: K_contra, default: Union[V, T] = None
+        ) -> Union[V, T]:
+            ...
+
+else:
+
+    class MapBase(Generic[K_contra, V]):
+        ...
+
+
+class KeyFoldMixin(MapBase[K_contra, V]):
     """
     A mixin for Mapping to allow for case-insensitive keys
     """
 
-    @classmethod
-    def get_class(cls) -> Type[MutableMapping[K, V]]:
-        raise NotImplementedError
-
-    def __getitem__(self, item: K) -> V:
-        return self.get_class().__getitem__(
-            cast(Mapping[K, V], self), cast(K, item.casefold())
-        )
+    def __getitem__(self, item: K_contra) -> V:
+        return super().__getitem__(cast(K_contra, item.casefold()))
 
-    def __setitem__(self, key: K, value: V) -> None:
-        return self.get_class().__setitem__(
-            cast(MutableMapping[K, V], self), cast(K, key.casefold()), value
-        )
+    def __setitem__(self, key: K_contra, value: V) -> None:
+        return super().__setitem__(cast(K_contra, key.casefold()), value)
 
-    def __delitem__(self, key: K) -> None:
-        return self.get_class().__delitem__(
-            cast(MutableMapping[K, V], self), cast(K, key.casefold())
-        )
+    def __delitem__(self, key: K_contra) -> None:
+        return super().__delitem__(cast(K_contra, key.casefold()))
 
-    def pop(self, key: K, *args) -> V:
+    def pop(self, key: K_contra, *args) -> V:
         """
         Wraps `dict.pop`
         """
-        return self.get_class().pop(
-            cast(MutableMapping[K, V], self), cast(K, key.casefold()), *args
-        )
+        return super().pop(cast(K_contra, key.casefold()), *args)
 
-    def get(self, key: K, default=None):
+    def get(self, key: K_contra, default=None):
         """
         Wrap `dict.get`
         """
-        return self.get_class().get(
-            cast(Mapping[K, V], self), cast(K, key.casefold()), default
-        )
+        return super().get(cast(K_contra, key.casefold()), default)
 
-    def setdefault(self, key: K, default=None):
+    def setdefault(self, key: K_contra, default=None):
         """
         Wrap `dict.setdefault`
         """
-        return self.get_class().setdefault(
-            cast(MutableMapping[K, V], self), cast(K, key.casefold()), default
-        )
+        return super().setdefault(cast(K_contra, key.casefold()), default)
 
     def update(self, *args, **kwargs):
         """
@@ -84,26 +101,14 @@ class KeyFoldDict(KeyFoldMixin, dict):
     KeyFolded dict type
     """
 
-    @classmethod
-    def get_class(cls) -> Type[MutableMapping[K, V]]:
-        return dict
-
 
 class DefaultKeyFoldDict(KeyFoldMixin, defaultdict):
     """
     KeyFolded defaultdict
     """
 
-    @classmethod
-    def get_class(cls) -> Type[MutableMapping[K, V]]:
-        return defaultdict
-
 
 class KeyFoldWeakValueDict(KeyFoldMixin, weakref.WeakValueDictionary):
     """
     KeyFolded WeakValueDictionary
     """
-
-    @classmethod
-    def get_class(cls) -> Type[MutableMapping[K, V]]:
-        return weakref.WeakValueDictionary

requirements-dev.txt

@@ -4,7 +4,7 @@ mypy == 0.910
 pre-commit == 2.17.0
 pylint == 2.11.1
 pytest == 6.2.5
-pytest-asyncio == 0.16.0
+pytest-asyncio == 0.20.3
 pytest-cov == 3.0.0
 pytest-random-order == 1.0.4
 responses == 0.16.0

requirements.txt

@@ -17,6 +17,5 @@ py-irclib == 0.3.0
 requests == 2.27.1
 tweepy == 3.10.0
 urllib3 == 1.26.7
-venusian == 3.0.0
 watchdog == 2.1.6
 yarl == 1.7.2