[sc-80908] DSSClient.list_users() can now return a list of DSSUser for convenience

Author: NawreCode

dataikuapi/dss/admin.py

@@ -172,10 +172,13 @@ def get_settings(self):
     def get_last_activity(self):
         """
         Gets the last activity of a user:
-        - his last successful login attempt
-        - his last failed login attempt
-        - his last load of DSS
-        :return: a dict
+
+            * last successful login attempt
+            * last failed login attempt
+            * last loading of DSS (new tab or tab refresh)
+
+        :return: the user's activity, as a dict
+        :rtype: dict
         """
         return self.client._perform_json("GET", "/admin/users/%s/activity" % self.login)
 
@@ -260,8 +263,7 @@ def __init__(self, settings):
 
     def get_raw(self):
         """
-        :return: the raw settings of the user, as a dict. Modifications made to the returned object 
-        are reflected when saving
+        :return: the raw settings of the user, as a dict. Modifications made to the returned object are reflected when saving
         :rtype: dict
         """
         return self.settings
@@ -341,15 +343,15 @@ def admin_properties(self):
         """
         The user properties (not editable by the user) for this user. Do not set this property, modify the dict in place
 
-        :rtype dict
+        :rtype: dict
         """
         return self.settings["adminProperties"]
 
     @property
     def enabled(self):
         """
         Whether this user is enabled
-        :rtype boolean
+        :rtype: boolean
         """
         return self.settings["enabled"]
 

dataikuapi/dssclient.py

@@ -329,17 +329,21 @@ def sql_query(self, query, connection=None, database=None, dataset_full_name=Non
     # Users
     ########################################################
 
-    def list_users(self):
+    def list_users(self, as_objects=False):
         """
         List all users setup on the DSS instance
 
         Note: this call requires an API key with admin rights
 
-        :return: A list of users, as a list of dicts
-        :rtype: list of dicts
+        :return: A list of users, as a list of :class:`dataikuapi.dss.admin.DSSUser` if as_objects is True, else as a list of dicts
+        :rtype: list of :class:`dataikuapi.dss.admin.DSSUser` or list of dicts
         """
-        return self._perform_json(
-            "GET", "/admin/users/")
+        users = self._perform_json("GET", "/admin/users/")
+
+        if as_objects:
+            return [DSSUser(self, user["login"]) for user in users]
+        else:
+            return users
 
     def get_user(self, login):
         """