Rename UserRole to DatasetCollaborator in kagglesdk (#651)

Author: erdalsivri

kaggle/api/kaggle_api_extended.py

@@ -67,7 +67,7 @@
 from kagglesdk.datasets.types.dataset_enums import DatasetSelectionGroup, \
   DatasetSortBy, DatasetFileTypeGroup, DatasetLicenseGroup
 from kagglesdk.datasets.types.dataset_types import DatasetSettings, \
-  SettingsLicense, UserRole, DatasetSettingsFile
+  SettingsLicense, DatasetCollaborator, DatasetSettingsFile
 from kagglesdk.kernels.types.kernels_api_service import ApiListKernelsRequest, \
   ApiListKernelFilesRequest, ApiSaveKernelRequest, ApiGetKernelRequest, \
   ApiListKernelSessionOutputRequest, ApiGetKernelSessionStatusRequest

kagglesdk/datasets/types/dataset_types.py

@@ -20,7 +20,7 @@ class DatasetInfo(KaggleObject):
     is_private (bool)
     keywords (str)
     licenses (SettingsLicense)
-    collaborators (UserRole)
+    collaborators (DatasetCollaborator)
     data (DatasetSettingsFile)
   """
 
@@ -220,18 +220,18 @@ def licenses(self, licenses: Optional[List[Optional['SettingsLicense']]]):
     self._licenses = licenses
 
   @property
-  def collaborators(self) -> Optional[List[Optional['UserRole']]]:
+  def collaborators(self) -> Optional[List[Optional['DatasetCollaborator']]]:
     return self._collaborators
 
   @collaborators.setter
-  def collaborators(self, collaborators: Optional[List[Optional['UserRole']]]):
+  def collaborators(self, collaborators: Optional[List[Optional['DatasetCollaborator']]]):
     if collaborators is None:
       del self.collaborators
       return
     if not isinstance(collaborators, list):
       raise TypeError('collaborators must be of type list')
-    if not all([isinstance(t, UserRole) for t in collaborators]):
-      raise TypeError('collaborators must contain only items of type UserRole')
+    if not all([isinstance(t, DatasetCollaborator) for t in collaborators]):
+      raise TypeError('collaborators must contain only items of type DatasetCollaborator')
     self._collaborators = collaborators
 
   @property
@@ -259,7 +259,7 @@ class DatasetSettings(KaggleObject):
     is_private (bool)
     keywords (str)
     licenses (SettingsLicense)
-    collaborators (UserRole)
+    collaborators (DatasetCollaborator)
     data (DatasetSettingsFile)
   """
 
@@ -357,18 +357,18 @@ def licenses(self, licenses: Optional[List[Optional['SettingsLicense']]]):
     self._licenses = licenses
 
   @property
-  def collaborators(self) -> Optional[List[Optional['UserRole']]]:
+  def collaborators(self) -> Optional[List[Optional['DatasetCollaborator']]]:
     return self._collaborators
 
   @collaborators.setter
-  def collaborators(self, collaborators: Optional[List[Optional['UserRole']]]):
+  def collaborators(self, collaborators: Optional[List[Optional['DatasetCollaborator']]]):
     if collaborators is None:
       del self.collaborators
       return
     if not isinstance(collaborators, list):
       raise TypeError('collaborators must be of type list')
-    if not all([isinstance(t, UserRole) for t in collaborators]):
-      raise TypeError('collaborators must contain only items of type UserRole')
+    if not all([isinstance(t, DatasetCollaborator) for t in collaborators]):
+      raise TypeError('collaborators must contain only items of type DatasetCollaborator')
     self._collaborators = collaborators
 
   @property
@@ -536,7 +536,7 @@ def name(self, name: str):
     self._name = name
 
 
-class UserRole(KaggleObject):
+class DatasetCollaborator(KaggleObject):
   r"""
   Attributes:
     username (str)
@@ -589,7 +589,7 @@ def role(self, role: 'CollaboratorType'):
   FieldMetadata("isPrivate", "is_private", "_is_private", bool, False, PredefinedSerializer()),
   FieldMetadata("keywords", "keywords", "_keywords", str, [], ListSerializer(PredefinedSerializer())),
   FieldMetadata("licenses", "licenses", "_licenses", SettingsLicense, [], ListSerializer(KaggleObjectSerializer())),
-  FieldMetadata("collaborators", "collaborators", "_collaborators", UserRole, [], ListSerializer(KaggleObjectSerializer())),
+  FieldMetadata("collaborators", "collaborators", "_collaborators", DatasetCollaborator, [], ListSerializer(KaggleObjectSerializer())),
   FieldMetadata("data", "data", "_data", DatasetSettingsFile, [], ListSerializer(KaggleObjectSerializer())),
 ]
 
@@ -600,7 +600,7 @@ def role(self, role: 'CollaboratorType'):
   FieldMetadata("isPrivate", "is_private", "_is_private", bool, False, PredefinedSerializer()),
   FieldMetadata("keywords", "keywords", "_keywords", str, [], ListSerializer(PredefinedSerializer())),
   FieldMetadata("licenses", "licenses", "_licenses", SettingsLicense, [], ListSerializer(KaggleObjectSerializer())),
-  FieldMetadata("collaborators", "collaborators", "_collaborators", UserRole, [], ListSerializer(KaggleObjectSerializer())),
+  FieldMetadata("collaborators", "collaborators", "_collaborators", DatasetCollaborator, [], ListSerializer(KaggleObjectSerializer())),
   FieldMetadata("data", "data", "_data", DatasetSettingsFile, [], ListSerializer(KaggleObjectSerializer())),
 ]
 
@@ -621,7 +621,7 @@ def role(self, role: 'CollaboratorType'):
   FieldMetadata("name", "name", "_name", str, None, PredefinedSerializer(), optional=True),
 ]
 
-UserRole._fields = [
+DatasetCollaborator._fields = [
   FieldMetadata("username", "username", "_username", str, "", PredefinedSerializer()),
   FieldMetadata("role", "role", "_role", CollaboratorType, CollaboratorType.COLLABORATOR_TYPE_UNSPECIFIED, EnumSerializer()),
 ]

src/kaggle/api/kaggle_api_extended.py

@@ -51,7 +51,7 @@
 from kagglesdk.datasets.types.dataset_enums import DatasetSelectionGroup, \
   DatasetSortBy, DatasetFileTypeGroup, DatasetLicenseGroup
 from kagglesdk.datasets.types.dataset_types import DatasetSettings, \
-  SettingsLicense, UserRole, DatasetSettingsFile
+  SettingsLicense, DatasetCollaborator, DatasetSettingsFile
 from kagglesdk.kernels.types.kernels_api_service import ApiListKernelsRequest, \
   ApiListKernelFilesRequest, ApiSaveKernelRequest, ApiGetKernelRequest, \
   ApiListKernelSessionOutputRequest, ApiGetKernelSessionStatusRequest