proper support of global and per-room display names

Author: Zil0

matrix_client/room.py

@@ -46,6 +46,9 @@ def __init__(self, client, room_id):
         self.guest_access = None
         self._prev_batch = None
         self._members = {}
+        self.members_displaynames = {
+            # user_id: displayname
+        }
         self.encrypted = False
 
     def set_user_profile(self,
@@ -83,7 +86,7 @@ def display_name(self):
             return self.canonical_alias
 
         # Member display names without me
-        members = [u.get_display_name() for u in self.get_joined_members() if
+        members = [u.get_display_name(self) for u in self.get_joined_members() if
                    self.client.user_id != u.user_id]
         members.sort()
 
@@ -478,10 +481,12 @@ def get_joined_members(self):
         response = self.client.api.get_room_members(self.room_id)
         for event in response["chunk"]:
             if event["content"]["membership"] == "join":
-                self._add_member(event["state_key"], event["content"].get("displayname"))
+                user_id = event["state_key"]
+                self._add_member(user_id, event["content"].get("displayname"))
         return list(self._members.values())
 
     def _add_member(self, user_id, displayname=None):
+        self.members_displaynames[user_id] = displayname
         if user_id in self._members:
             return
         if user_id in self.client.users:
@@ -655,8 +660,8 @@ def _process_state_event(self, state_event):
             elif etype == "m.room.member" and clevel == clevel.ALL:
                 # tracking room members can be large e.g. #matrix:matrix.org
                 if econtent["membership"] == "join":
-                    self._add_member(
-                        state_event["state_key"], econtent.get("displayname"))
+                    user_id = state_event["state_key"]
+                    self._add_member(user_id, econtent.get("displayname"))
                 elif econtent["membership"] in ("leave", "kick", "invite"):
                     self._members.pop(state_event["state_key"], None)
 

matrix_client/user.py

@@ -12,6 +12,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from warnings import warn
+
 from .checks import check_user_id
 
 
@@ -25,20 +27,30 @@ def __init__(self, api, user_id, displayname=None):
         self.displayname = displayname
         self.api = api
 
-    def get_display_name(self):
-        """ Get this users display name.
-            See also get_friendly_name()
+    def get_display_name(self, room=None):
+        """Get this user's display name.
+
+        Args:
+            room (Room): Optional. When specified, return the display name of the user
+                in this room.
 
         Returns:
-            str: Display Name
+            The display name. Defaults to the user ID if not set.
         """
+        if room:
+            try:
+                return room.members_displaynames[self.user_id]
+            except KeyError:
+                return self.user_id
         if not self.displayname:
             self.displayname = self.api.get_display_name(self.user_id)
-        return self.displayname
+        return self.displayname or self.user_id
 
     def get_friendly_name(self):
-        display_name = self.api.get_display_name(self.user_id)
-        return display_name if display_name is not None else self.user_id
+        """Deprecated. Use :meth:`get_display_name` instead."""
+        warn("get_friendly_name is deprecated. Use get_display_name instead.",
+             DeprecationWarning)
+        return self.get_display_name()
 
     def set_display_name(self, display_name):
         """ Set this users display name.

test/user_test.py

@@ -0,0 +1,52 @@
+import pytest
+import responses
+
+from matrix_client.api import MATRIX_V2_API_PATH
+from matrix_client.client import MatrixClient
+from matrix_client.user import User
+
+HOSTNAME = "http://localhost"
+
+
+class TestUser:
+    cli = MatrixClient(HOSTNAME)
+    user_id = "@test:localhost"
+    room_id = "!test:localhost"
+
+    @pytest.fixture()
+    def user(self):
+        return User(self.cli.api, self.user_id)
+
+    @pytest.fixture()
+    def room(self):
+        return self.cli._mkroom(self.room_id)
+
+    @responses.activate
+    def test_get_display_name(self, user, room):
+        displayname_url = HOSTNAME + MATRIX_V2_API_PATH + \
+            "/profile/{}/displayname".format(user.user_id)
+        displayname = 'test'
+        room_displayname = 'room_test'
+
+        # No displayname
+        assert user.get_display_name(room) == user.user_id
+        responses.add(responses.GET, displayname_url, json={})
+        assert user.get_display_name() == user.user_id
+        assert len(responses.calls) == 1
+
+        # Get global displayname
+        responses.replace(responses.GET, displayname_url,
+                          json={"displayname": displayname})
+        assert user.get_display_name() == displayname
+        assert len(responses.calls) == 2
+
+        # Global displayname already present
+        assert user.get_display_name() == displayname
+        # No new request
+        assert len(responses.calls) == 2
+
+        # Per-room displayname
+        room.members_displaynames[user.user_id] = room_displayname
+        assert user.get_display_name(room) == room_displayname
+        # No new request
+        assert len(responses.calls) == 2