Update to latest protos (#25)

Author: stevemessick

.gitignore

@@ -1 +1,2 @@
 dist/
+.idea

kagglesdk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.13"
+__version__ = "0.1.14"
 
 from kagglesdk.kaggle_client import KaggleClient
 from kagglesdk.kaggle_creds import KaggleCredentials

kagglesdk/community/types/content_enums.py

@@ -15,21 +15,37 @@ class ContentState(enum.Enum):
   """
   TEMPORARILY_QUARANTINED = 3
   r"""
-  Quarantined by an admin or by the system. This means that the content is
-  only visible to the user and admins, however users are able to toggle their
-  content out of this state.
+  DEPRECATED, use SYSTEM_DELETED: Quarantined by an admin or by the system.
+  This means that the content is only visible to the user and admins, however
+  users are able to toggle their content out of this state.
   """
   PERMANENTLY_QUARANTINED = 4
   r"""
-  Quarantined by an admin or by the system, the user cannot toggle their
-  content's state back to public.
+  DEPRECATED, use SYSTEM_DELETED: Quarantined by an admin or by the system,
+  the user cannot toggle their content's state back to public.
   """
   USER_DELETED = 5
-  """Deleted by the user."""
+  r"""
+  Deleted by the user. This data needs to be wiped out according to the
+  table's data retention policy.
+  """
   SYSTEM_DELETED = 6
-  """Deleted by an admin or by a system account."""
+  r"""
+  Deleted by an admin or by a system account for moderation purposes. This
+  data may need to be restored in the event of a successfull user appeal, and
+  should not be wiped out.
+  """
   PENDING_PERMANENT_DELETE = 7
-  """Awaiting hard deletion."""
+  """Awaiting permanent deletion."""
+  PERMANENTLY_DELETED = 10
+  r"""
+  All the data has been deleted, and thus satisfies wipeout. The data is in a
+  state where it should not be restored. This state immediately follows
+  PENDING_PERMANENT_DELETE, if the row is kept in the DB. This row could also
+  be removed from the DB ('hard deleted'), as no data is associated with it.
+  Whether a row is kept as PERMANENTLY_DELETED or removed from the DB is up
+  to each team. For more details, see: http://shortn/_Z23aOje4MH
+  """
   DRAFT = 8
   r"""
   Initial state of entity that has never been previously published.

kagglesdk/kaggle_client.py

@@ -69,8 +69,8 @@ def __init__(self, http_client: KaggleHttpClient):
       self.account_client = AccountClient(http_client)
       self.group_api_client = GroupApiClient(http_client)
 
-  def __init__(self, env: KaggleEnv = None, verbose: bool = False, username: str = None, password: str = None, api_token: str = None, user_agent: str = None):
-    self._http_client = http_client = KaggleHttpClient(env, verbose, username=username, password=password, api_token=api_token, user_agent=user_agent)
+  def __init__(self, env: KaggleEnv = None, verbose: bool = False, username: str = None, password: str = None, api_token: str = None, user_agent: str = '', response_processor=None):
+    self._http_client = http_client = KaggleHttpClient(env, verbose, username=username, password=password, api_token=api_token, user_agent=user_agent, response_processor=response_processor)
     self.admin = KaggleClient.Admin(http_client)
     self.benchmarks = KaggleClient.Benchmarks(http_client)
     self.blobs = KaggleClient.Blobs(http_client)

kagglesdk/kaggle_http_client.py

@@ -16,6 +16,8 @@
     KaggleEnv,
 )
 from kagglesdk.kaggle_object import KaggleObject
+from kagglesdk.common.types.file_download import FileDownload
+from kagglesdk.common.types.http_redirect import HttpRedirect
 from typing import Type
 
 # TODO (http://b/354237483) Generate the client from the existing one.
@@ -59,7 +61,8 @@ def __init__(
         username: str = None,
         password: str = None,
         api_token: str = None,
-        user_agent: str = "kaggle-api/v1.7.0", # Was: V2
+        user_agent: str = "kaggle-api/v1.7.0",  # Was: V2
+        response_processor=None,
     ):
         self._env = env or get_env()
         self._signed_in = None
@@ -70,6 +73,7 @@ def __init__(
         self._password = password
         self._api_token = api_token
         self._user_agent = user_agent
+        self._response_processor = response_processor
 
     def call(
         self,
@@ -83,6 +87,12 @@ def call(
 
         # Merge environment settings into session
         settings = self._session.merge_environment_settings(http_request.url, {}, None, None, None)
+
+        # Use stream=True for file downloads to avoid loading entire file into memory
+        # See: https://github.com/Kaggle/kaggle-api/issues/754
+        if response_type is not None and (response_type == FileDownload or response_type == HttpRedirect):
+            settings["stream"] = True
+
         http_response = self._session.send(http_request, **settings)
 
         response = self._prepare_response(response_type, http_response)
@@ -112,6 +122,9 @@ def _prepare_response(self, response_type, http_response):
         except KeyError:
             pass
         http_response.raise_for_status()
+        # Allow client to check header content.
+        if self._response_processor:
+            self._response_processor(http_response)
         if response_type is None:  # Method doesn't have a return type
             return None
         return response_type.prepare_from(http_response)

kagglesdk/search/types/search_service.py

@@ -167,6 +167,8 @@ class WriteUpItemInfo(KaggleObject):
       Name of the team that owns the WriteUp
     id (int)
       Id of the WriteUp
+    hackathon_track_ids (int)
+      The track ids of the Hackathon
   """
 
   def __init__(self):
@@ -177,6 +179,7 @@ def __init__(self):
     self._content_state = ContentState.CONTENT_STATE_UNSPECIFIED
     self._team_name = None
     self._id = 0
+    self._hackathon_track_ids = []
     self._freeze()
 
   @property
@@ -279,6 +282,22 @@ def id(self, id: int):
       raise TypeError('id must be of type int')
     self._id = id
 
+  @property
+  def hackathon_track_ids(self) -> Optional[List[int]]:
+    """The track ids of the Hackathon"""
+    return self._hackathon_track_ids
+
+  @hackathon_track_ids.setter
+  def hackathon_track_ids(self, hackathon_track_ids: Optional[List[int]]):
+    if hackathon_track_ids is None:
+      del self.hackathon_track_ids
+      return
+    if not isinstance(hackathon_track_ids, list):
+      raise TypeError('hackathon_track_ids must be of type list')
+    if not all([isinstance(t, int) for t in hackathon_track_ids]):
+      raise TypeError('hackathon_track_ids must contain only items of type int')
+    self._hackathon_track_ids = hackathon_track_ids
+
 
 WriteUpCompetitionInfo._fields = [
   FieldMetadata("competitionTitle", "competition_title", "_competition_title", str, "", PredefinedSerializer()),
@@ -299,5 +318,6 @@ def id(self, id: int):
   FieldMetadata("contentState", "content_state", "_content_state", ContentState, ContentState.CONTENT_STATE_UNSPECIFIED, EnumSerializer()),
   FieldMetadata("teamName", "team_name", "_team_name", str, None, PredefinedSerializer(), optional=True),
   FieldMetadata("id", "id", "_id", int, 0, PredefinedSerializer()),
+  FieldMetadata("hackathonTrackIds", "hackathon_track_ids", "_hackathon_track_ids", int, [], ListSerializer(PredefinedSerializer())),
 ]
 

kagglesdk/security/types/security_types.py

@@ -88,6 +88,7 @@ class KaggleResourceType(enum.Enum):
   KAGGLE_RESOURCE_TYPE_MODEL_VERSIONS = 612
   KAGGLE_RESOURCE_TYPE_GATING_AGREEMENTS = 614
   KAGGLE_RESOURCE_TYPE_GATING_AGREEMENTS_USER_CONSENTS = 616
+  KAGGLE_RESOURCE_TYPE_MODEL_PROXY = 620
   KAGGLE_RESOURCE_TYPE_BENCHMARKS = 700
   """---------- Benchmarks ----------"""
   KAGGLE_RESOURCE_TYPE_BENCHMARK_VERSIONS = 704
@@ -96,6 +97,10 @@ class KaggleResourceType(enum.Enum):
   KAGGLE_RESOURCE_TYPE_BENCHMARK_TASKS = 710
   KAGGLE_RESOURCE_TYPE_BENCHMARK_TASK_VERSIONS = 712
   KAGGLE_RESOURCE_TYPE_BENCHMARK_TASK_RUNS = 714
+  KAGGLE_RESOURCE_TYPE_COURSE_TRACKS = 800
+  """---------- Courses ----------"""
+  KAGGLE_RESOURCE_TYPE_COURSE_LESSONS = 802
+  KAGGLE_RESOURCE_TYPE_COURSE_TUTORIALS = 804
 
 class KaggleResourceId(KaggleObject):
   r"""

kagglesdk/users/types/user_avatar.py

@@ -4,6 +4,9 @@
 
 class UserAvatar(KaggleObject):
   r"""
+  A more lightweight version of the User object, with just what's required to
+  render a user's avatar.
+
   Attributes:
     display_name (str)
       Display name for the given user
@@ -28,8 +31,6 @@ class UserAvatar(KaggleObject):
       TODO(http://b/402224065) remove once clients have migrated from this.
     progression_opt_out (bool)
       True if the user is opted out of the progression system.
-    is_phone_verified (bool)
-      True if the user is phone verified
   """
 
   def __init__(self):
@@ -43,7 +44,6 @@ def __init__(self):
     self._performance_tier = None
     self._user_id = None
     self._progression_opt_out = None
-    self._is_phone_verified = None
     self._freeze()
 
   @property
@@ -195,20 +195,6 @@ def progression_opt_out(self, progression_opt_out: Optional[bool]):
       raise TypeError('progression_opt_out must be of type bool')
     self._progression_opt_out = progression_opt_out
 
-  @property
-  def is_phone_verified(self) -> bool:
-    """True if the user is phone verified"""
-    return self._is_phone_verified or False
-
-  @is_phone_verified.setter
-  def is_phone_verified(self, is_phone_verified: Optional[bool]):
-    if is_phone_verified is None:
-      del self.is_phone_verified
-      return
-    if not isinstance(is_phone_verified, bool):
-      raise TypeError('is_phone_verified must be of type bool')
-    self._is_phone_verified = is_phone_verified
-
 
 UserAvatar._fields = [
   FieldMetadata("displayName", "display_name", "_display_name", str, None, PredefinedSerializer(), optional=True),
@@ -221,6 +207,5 @@ def is_phone_verified(self, is_phone_verified: Optional[bool]):
   FieldMetadata("performanceTier", "performance_tier", "_performance_tier", UserAchievementTier, None, EnumSerializer(), optional=True),
   FieldMetadata("userId", "user_id", "_user_id", int, None, PredefinedSerializer(), optional=True),
   FieldMetadata("progressionOptOut", "progression_opt_out", "_progression_opt_out", bool, None, PredefinedSerializer(), optional=True),
-  FieldMetadata("isPhoneVerified", "is_phone_verified", "_is_phone_verified", bool, None, PredefinedSerializer(), optional=True),
 ]