Make clientManager easier to use

- Backend.clientManager renamed to Backend.clients
- clientManager is now a Mapping subclass

Before/After from Python:
backend.clientManager.clients[thing] → backend.clients[thing]

From QML:
Backend.clientManager.clients[thing] → Backend.clients.get(thing)

harmonyqml/backend/backend.py

@@ -32,7 +32,7 @@ class Backend(QObject):
         from .signal_manager import SignalManager
         self._signal_manager: SignalManager = SignalManager(self)
 
-        self.clientManager.configLoad()
+        self.clients.configLoad()
 
 
     @pyqtProperty("QVariant", constant=True)
@@ -40,7 +40,7 @@ class Backend(QObject):
         return self._html_filter
 
     @pyqtProperty("QVariant", constant=True)
-    def clientManager(self):
+    def clients(self):
         return self._client_manager
 
     @pyqtProperty("QVariant", constant=True)
@@ -59,7 +59,7 @@ class Backend(QObject):
         if user_id in self._queried_displaynames:
             return self._queried_displaynames[user_id]
 
-        for client in self.clientManager.clients.values():
+        for client in self.clients.values():
             for room in client.nio.rooms.values():
                 displayname = room.user_name(user_id)
 
@@ -70,7 +70,7 @@ class Backend(QObject):
 
 
     def _query_user_displayname(self, user_id: str) -> str:
-        client      = next(iter(self.clientManager.clients.values()))
+        client      = next(iter(self.clients.values()))
         response    = client.net.talk(client.nio.get_displayname, user_id)
         displayname = getattr(response, "displayname", "") or user_id
 
@@ -93,7 +93,7 @@ class Backend(QObject):
         if room_id in self.fully_loaded_rooms:
             return
 
-        for client in self.clientManager.clients.values():
+        for client in self.clients.values():
             if room_id in client.nio.rooms:
                 client.loadPastEvents(
                     room_id, self.past_tokens[room_id], limit
@@ -105,12 +105,11 @@ class Backend(QObject):
     @pyqtSlot(list)
     def pdb(self, additional_data: Sequence = ()) -> None:
         # pylint: disable=all
-        ad = additional_data
-        cm = self.clientManager
-        cl = self.clientManager.clients
-        m  = self.models
+        a = additional_data
+        c = self.clients
+        m = self.models
 
-        tcl = lambda user: cl[f"@test_{user}:matrix.org"]
+        tcl = lambda user: c[f"@test_{user}:matrix.org"]
 
         import pdb
         from PyQt5.QtCore import pyqtRemoveInputHook

harmonyqml/backend/client_manager.py

@@ -5,7 +5,8 @@ import json
 import os
 import platform
 import threading
-from typing import Dict, Optional
+from collections.abc import Mapping
+from typing import Dict, Iterable, Optional
 
 from atomicfile import AtomicFile
 from PyQt5.QtCore import (
@@ -22,7 +23,11 @@ AccountConfig = Dict[str, Dict[str, str]]
 _CONFIG_LOCK = threading.Lock()
 
 
-class ClientManager(QObject):
+class _ClientManagerMeta(type(QObject), type(Mapping)):  # type: ignore
+    pass
+
+
+class ClientManager(QObject, Mapping, metaclass=_ClientManagerMeta):
     clientAdded        = pyqtSignal(Client)
     clientDeleted      = pyqtSignal(str)
     clientCountChanged = pyqtSignal(int)
@@ -33,23 +38,35 @@ class ClientManager(QObject):
         self.backend = backend
         self._clients: Dict[str, Client] = {}
 
-        func = lambda: self.clientCountChanged.emit(len(self.clients))
+        func = lambda: self.clientCountChanged.emit(len(self))
         self.clientAdded.connect(func)
         self.clientDeleted.connect(func)
 
 
     def __repr__(self) -> str:
-        return f"{type(self).__name__}(clients={self.clients!r})"
+        return f"{type(self).__name__}(clients={self._clients!r})"
 
 
-    @pyqtProperty("QVariantMap", notify=clientCountChanged)
-    def clients(self):
-        return self._clients
+    def __getitem__(self, user_id: str) -> Client:
+        return self.get(user_id)
+
+
+    def __len__(self) -> int:
+        return self.count
+
+
+    def __iter__(self):
+        return iter(self._clients)
+
+
+    @pyqtSlot(str, result="QVariant")
+    def get(self, key: str) -> Client:
+        return self._clients[key]
 
 
     @pyqtProperty(int, notify=clientCountChanged)
-    def clientCount(self):
-        return len(self.clients)
+    def count(self):
+        return len(self._clients)
 
 
     @pyqtSlot()
@@ -72,23 +89,23 @@ class ClientManager(QObject):
 
 
     def _on_connected(self, client: Client) -> None:
-        self.clients[client.userId] = client
+        self._clients[client.userId] = client
         self.clientAdded.emit(client)
         client.startSyncing()
 
 
     @pyqtSlot(str)
-    def delete(self, user_id: str) -> None:
-        client = self.clients.pop(user_id, None)
+    def remove(self, user_id: str) -> None:
+        client = self._clients.pop(user_id, None)
         if client:
             self.clientDeleted.emit(user_id)
             client.logout()
 
 
     @pyqtSlot()
-    def deleteAll(self) -> None:
-        for user_id in self.clients.copy():
-            self.delete(user_id)
+    def removeAll(self) -> None:
+        for user_id in self._clients.copy():
+            self.remove(user_id)
 
 
     @pyqtProperty(str, constant=True)

harmonyqml/backend/signal_manager.py

@@ -27,9 +27,8 @@ class SignalManager(QObject):
         self.last_room_events:    Deque[str] = Deque(maxlen=1000)
         self._events_in_transfer: int        = 0
 
-        cm = self.backend.clientManager
-        cm.clientAdded.connect(self.onClientAdded)
-        cm.clientDeleted.connect(self.onClientDeleted)
+        self.backend.clients.clientAdded.connect(self.onClientAdded)
+        self.backend.clients.clientDeleted.connect(self.onClientDeleted)
 
 
     def onClientAdded(self, client: Client) -> None:
@@ -161,7 +160,7 @@ class SignalManager(QObject):
 
             event_is_our_profile_changed = (
                 etype == "RoomMemberEvent" and
-                edict.get("sender") in self.backend.clientManager.clients and
+                edict.get("sender") in self.backend.clients and
                 ((edict.get("content") or {}).get("membership") ==
                  (edict.get("prev_content") or {}).get("membership"))
             )

harmonyqml/components/Chat/Banners/InviteBanner.qml

@@ -30,16 +30,12 @@ Banner {
     buttonCallbacks: {
         "accept": function(button) {
             button.loading = true
-            Backend.clientManager.clients[chatPage.userId].joinRoom(
-                chatPage.roomId
-            )
+            Backend.clients.get(chatPage.userId).joinRoom(chatPage.roomId)
         },
 
         "decline": function(button) {
             button.loading = true
-            Backend.clientManager.clients[chatPage.userId].leaveRoom(
-                chatPage.roomId
-            )
+            Backend.clients.get(chatPage.userId).leaveRoom(chatPage.roomId)
         }
     }
 }

harmonyqml/components/Chat/Banners/LeftBanner.qml

@@ -22,9 +22,7 @@ Banner {
         "forget": function(button) {
             button.loading = true
             chatPage.canLoadPastEvents = false
-            Backend.clientManager.clients[chatPage.userId].forgetRoom(
-                chatPage.roomId
-            )
+            Backend.clients.get(chatPage.userId).forgetRoom(chatPage.roomId)
             pageStack.clear()
         },
     }

harmonyqml/components/Chat/SendBox.qml

@@ -32,7 +32,7 @@ HGlassRectangle {
             area.focus: true
 
             function setTyping(typing) {
-                Backend.clientManager.clients[chatPage.userId]
+                Backend.clients.get(chatPage.userId)
                        .setTypingState(chatPage.roomId, typing)
             }
 
@@ -50,7 +50,7 @@ HGlassRectangle {
                 }
 
                 if (textArea.text === "") { return }
-                Backend.clientManager.clients[chatPage.userId]
+                Backend.clients.get(chatPage.userId)
                        .sendMarkdown(chatPage.roomId, textArea.text)
                 textArea.clear()
             }

harmonyqml/components/Pages/RememberAccount.qml

@@ -20,7 +20,7 @@ Item {
 
         buttonCallbacks: {
             "yes": function(button) {
-                Backend.clientManager.remember(client)
+                Backend.clients.remember(client)
                 pageStack.showPage("Default")
             },
             "no": function(button) { pageStack.showPage("Default") },

harmonyqml/components/Pages/SignIn.qml

@@ -23,7 +23,7 @@ Item {
             "register": function(button) {},
 
             "login": function(button) {
-                var future = Backend.clientManager.new(
+                var future = Backend.clients.new(
                     "matrix.org", identifierField.text, passwordField.text
                 )
                 button.loadingUntilFutureDone(future)

harmonyqml/components/UI.qml

@@ -17,7 +17,7 @@ Item {
         anchors.fill: parent
     }
 
-    property bool accountsLoggedIn: Backend.clientManager.clientCount > 0
+    property bool accountsLoggedIn: Backend.clients.count > 0
 
     HSplitView {
         anchors.fill: parent

harmonyqml/components/Window.qml

@@ -8,7 +8,7 @@ ApplicationWindow {
     width: Math.min(Screen.width, 1152)
     height: Math.min(Screen.height, 768)
 
-    onClosing: Backend.clientManager.deleteAll()
+    onClosing: Backend.clients.removeAll()
 
     Loader {
         anchors.fill: parent