Adapt test to listitems

Author: qcastel

dataikuapi/dss/admin.py

@@ -1,5 +1,7 @@
 import datetime
 
+from dataikuapi.dss.utils import DSSTaggableObjectListItem
+
 from .future import DSSFuture
 import json, warnings
 
@@ -1169,6 +1171,38 @@ def delete(self):
         return self.client._perform_empty(
             "DELETE", "/personal-api-keys/%s" % self.id_)
 
+class DSSPersonalApiKeyListItem(DSSTaggableObjectListItem):
+    """An item in a list of datasets. Do not instantiate this class, :meth:`dataikuapi.DSSClient.list_personal_api_keys` or :meth:`dataikuapi.DSSClient.list_all_personal_api_keys`"""
+    def __init__(self, client, data):
+        super(DSSPersonalApiKeyListItem, self).__init__(data)
+        self.client = client
+
+    def to_personal_api_key(self):
+        """Gets the :class:`DSSPersonalApiKey` corresponding to this item"""
+        return DSSPersonalApiKey(self.client, self._data["id"])
+
+    @property
+    def id(self):
+        return self._data["id"]
+    @property
+    def user(self):
+        return self._data["user"]
+    @property
+    def key(self):
+        return self._data["key"]
+    @property
+    def label(self):
+        return self._data["label"]
+    @property
+    def description(self):
+        return self._data["description"]
+    @property
+    def created_on(self):
+        return self._data["createdOn"]
+    @property
+    def created_by(self):
+        return self._data["createdBy"]
+        
 class DSSCluster(object):
     """
     A handle to interact with a cluster on the DSS instance

dataikuapi/dssclient.py

@@ -10,7 +10,7 @@
 from .dss.project import DSSProject
 from .dss.app import DSSApp
 from .dss.plugin import DSSPlugin
-from .dss.admin import DSSUser, DSSUserActivity, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSGlobalUsageSummary, DSSInstanceVariables, DSSPersonalApiKey
+from .dss.admin import DSSPersonalApiKeyListItem, DSSUser, DSSUserActivity, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSGlobalUsageSummary, DSSInstanceVariables, DSSPersonalApiKey
 
 from .dss.meaning import DSSMeaning
 from .dss.sqlquery import DSSSQLQuery
@@ -674,21 +674,24 @@ def create_global_api_key(self, label=None, description=None, admin=False):
     # Personal API Keys
     ########################################################
 
-    def list_personal_api_keys(self, as_type='objects'):
+    def list_personal_api_keys(self, as_type='listitems'):
         """
         List all your personal API keys.
 
         :param str as_type: How to return the personal API keys. Possible values are "dict" and "objects"
         
-        :return: if as_type=dict, each personal API keys is returned as a dict.
+        :return: if as_type=listitems, each one as a :class:`dataikuapi.dss.admin.DSSPersonalApiKeyListItem`.
                  if as_type=objects, each key is returned as a :class:`dataikuapi.dss.admin.DSSPersonalApiKey`.
         """
         resp = self._perform_json(
             "GET", "/personal-api-keys/")
-        if as_type == 'objects':
+
+        if as_type == "listitems":
+            return [DSSPersonalApiKeyListItem(self, item) for item in resp]
+        elif as_type == 'objects':
             return [DSSPersonalApiKey(self, item['id']) for item in resp]
         else:
-            return resp
+            raise ValueError("Unknown as_type")
 
     def get_personal_api_key(self, id):
         """
@@ -723,22 +726,24 @@ def create_personal_api_key(self, label="", description="", as_type='dict'):
         else:
             return resp
 
-    def list_all_personal_api_keys(self, as_type='objects'):
+    def list_all_personal_api_keys(self, as_type='listitems'):
         """
         List all personal API keys.
         Only admin can list all the keys.
         
         :param str as_type: How to return the personal API keys. Possible values are "dict" and "objects"
         
-        :return: if as_type=dict, each personal API keys is returned as a dict.
+        :return: if as_type=listitems, each one as a :class:`dataikuapi.dss.admin.DSSPersonalApiKeyListItem`.
                  if as_type=objects, each key is returned as a :class:`dataikuapi.dss.admin.DSSPersonalApiKey`.        
         """
         resp = self._perform_json(
             "GET", "/admin/personal-api-keys/")
-        if as_type == 'objects':
+        if as_type == "listitems":
+            return [DSSPersonalApiKeyListItem(self, item) for item in resp]
+        elif as_type == 'objects':
             return [DSSPersonalApiKey(self, item['id']) for item in resp]
         else:
-            return resp
+            raise ValueError("Unknown as_type")
 
     def create_personal_api_key_for_user(self, user, label="", description="", as_type='object'):
         """