Improve "Team preferences"

Also use new methods `{get,update}_preferences` to avoid confusion.

Author: amotl

grafana_client/elements/team.py

@@ -1,4 +1,5 @@
 import typing as t
+import warnings
 
 from ..model import PersonalPreferences
 from .base import Base
@@ -135,7 +136,27 @@ def remove_team_member(self, team_id, user_id):
         r = self.client.DELETE(remove_team_member_path)
         return r
 
-    def get_team_preferences(self, team_id):
+    def get_team_preferences(self, team_id: int):
+        """
+
+        :param team_id:
+        :return:
+        """
+        warnings.warn("This method is deprecated, please use `get_preferences`", DeprecationWarning)
+        return self.get_preferences(team_id=team_id)
+
+    def update_team_preferences(self, team_id: int, preferences: t.Dict):
+        """
+
+        :param team_id:
+        :param preferences:
+        :return:
+        """
+        warnings.warn("This method is deprecated, please use `update_preferences`", DeprecationWarning)
+        preferences = PersonalPreferences(**preferences)
+        return self.update_preferences(team_id=team_id, preferences=preferences)
+
+    def get_preferences(self, team_id: int):
         """
 
         :param team_id:
@@ -145,22 +166,20 @@ def get_team_preferences(self, team_id):
         r = self.client.GET(get_team_preferences_path)
         return r
 
-    def update_team_preferences(self, team_id, preferences: t.Union[PersonalPreferences, t.Dict]):
+    def update_preferences(self, team_id: int, preferences: PersonalPreferences):
         """
 
         :param team_id:
         :param preferences:
         :return:
         """
         update_team_preferences_path = "/teams/%s/preferences" % team_id
-        if isinstance(preferences, dict):
-            data = preferences
-        elif isinstance(preferences, PersonalPreferences):
+        if isinstance(preferences, PersonalPreferences):
             data = preferences.asdict(filter_none=True)
         else:
             raise TypeError(
                 f"Unable to use data type '{type(preferences)}' for updating preferences. "
-                f"Use `PersonalPreferences` or `dict`."
+                f"Please use `PersonalPreferences` instead."
             )
         r = self.client.PUT(update_team_preferences_path, json=data)
         return r

test/elements/test_team.py

@@ -244,6 +244,9 @@ def test_remove_team_member(self, m):
 
     @requests_mock.Mocker()
     def test_get_team_preferences(self, m):
+        """
+        Legacy method.
+        """
         m.get(
             "http://localhost/api/teams/1/preferences",
             json={"theme": "", "homeDashboardId": 0, "timezone": ""},
@@ -252,7 +255,10 @@ def test_get_team_preferences(self, m):
         self.assertEqual(prefs["homeDashboardId"], 0)
 
     @requests_mock.Mocker()
-    def test_update_team_preferences_dict(self, m):
+    def test_update_team_preferences(self, m):
+        """
+        Legacy method, using a dictionary.
+        """
         m.put(
             "http://localhost/api/teams/1/preferences",
             json={"message": "Preferences updated"},
@@ -266,14 +272,29 @@ def test_update_team_preferences_dict(self, m):
         self.assertEqual(updates["message"], "Preferences updated")
 
     @requests_mock.Mocker()
-    def test_update_team_preferences_model(self, m):
+    def test_get_preferences(self, m):
+        """
+        Modern method.
+        """
+        m.get(
+            "http://localhost/api/teams/1/preferences",
+            json={"theme": "", "homeDashboardId": 0, "timezone": ""},
+        )
+        prefs = self.grafana.teams.get_preferences("1")
+        self.assertEqual(prefs["homeDashboardId"], 0)
+
+    @requests_mock.Mocker()
+    def test_update_preferences(self, m):
+        """
+        Modern method, using a `PersonalPreferences` instance.
+        """
         m.put(
             "http://localhost/api/teams/1/preferences",
             json={"message": "Preferences updated"},
         )
         prefs = PersonalPreferences(theme="light", homeDashboardId=0, timezone="utc")
 
-        updates = self.grafana.teams.update_team_preferences("1", prefs)
+        updates = self.grafana.teams.update_preferences("1", prefs)
         history = m.request_history
         json_payload = history[0].json()
         self.assertEqual(json_payload["theme"], "light")