Update kagglesdk (#683)

This includes the new endpoint for GetSubmission, but also has some
changes added to models recently.

All this was generated by `kapigen` -- don't spend too much time
reviewing!

Author: stevemessick

kagglesdk/competitions/services/competition_api_service.py

@@ -1,6 +1,6 @@
 from kagglesdk.common.types.file_download import FileDownload
 from kagglesdk.common.types.http_redirect import HttpRedirect
-from kagglesdk.competitions.types.competition_api_service import ApiCreateSubmissionRequest, ApiCreateSubmissionResponse, ApiDownloadDataFileRequest, ApiDownloadDataFilesRequest, ApiDownloadLeaderboardRequest, ApiGetLeaderboardRequest, ApiGetLeaderboardResponse, ApiListCompetitionsRequest, ApiListCompetitionsResponse, ApiListDataFilesRequest, ApiListDataFilesResponse, ApiListSubmissionsRequest, ApiListSubmissionsResponse, ApiStartSubmissionUploadRequest, ApiStartSubmissionUploadResponse
+from kagglesdk.competitions.types.competition_api_service import ApiCreateSubmissionRequest, ApiCreateSubmissionResponse, ApiDownloadDataFileRequest, ApiDownloadDataFilesRequest, ApiDownloadLeaderboardRequest, ApiGetLeaderboardRequest, ApiGetLeaderboardResponse, ApiGetSubmissionRequest, ApiListCompetitionsRequest, ApiListCompetitionsResponse, ApiListDataFilesRequest, ApiListDataFilesResponse, ApiListSubmissionsRequest, ApiListSubmissionsResponse, ApiStartSubmissionUploadRequest, ApiStartSubmissionUploadResponse, ApiSubmission
 from kagglesdk.kaggle_http_client import KaggleHttpClient
 
 class CompetitionApiClient(object):
@@ -80,6 +80,18 @@ def create_submission(self, request: ApiCreateSubmissionRequest = None) -> ApiCr
 
     return self._client.call("competitions.CompetitionApiService", "ApiCreateSubmission", request, ApiCreateSubmissionResponse)
 
+  def get_submission(self, request: ApiGetSubmissionRequest = None) -> ApiSubmission:
+    r"""
+    Args:
+      request (ApiGetSubmissionRequest):
+        The request object; initialized to empty instance if not specified.
+    """
+
+    if request is None:
+      request = ApiGetSubmissionRequest()
+
+    return self._client.call("competitions.CompetitionApiService", "ApiGetSubmission", request, ApiSubmission)
+
   def start_submission_upload(self, request: ApiStartSubmissionUploadRequest = None) -> ApiStartSubmissionUploadResponse:
     r"""
     Args:

kagglesdk/competitions/types/competition_api_service.py

@@ -77,14 +77,22 @@ class ApiCreateSubmissionResponse(KaggleObject):
   r"""
   Attributes:
     message (str)
+      TODO: Remove when we feel okay with the breaking change, this adds no
+      value.
+    ref (int)
   """
 
   def __init__(self):
     self._message = ""
+    self._ref = 0
     self._freeze()
 
   @property
   def message(self) -> str:
+    r"""
+    TODO: Remove when we feel okay with the breaking change, this adds no
+    value.
+    """
     return self._message
 
   @message.setter
@@ -96,6 +104,19 @@ def message(self, message: str):
       raise TypeError('message must be of type str')
     self._message = message
 
+  @property
+  def ref(self) -> int:
+    return self._ref
+
+  @ref.setter
+  def ref(self, ref: int):
+    if ref is None:
+      del self.ref
+      return
+    if not isinstance(ref, int):
+      raise TypeError('ref must be of type int')
+    self._ref = ref
+
 
 class ApiDownloadDataFileRequest(KaggleObject):
   r"""
@@ -219,10 +240,15 @@ class ApiGetLeaderboardRequest(KaggleObject):
   Attributes:
     competition_name (str)
       Competition name. Example: 'titanic'.
+    override_public (bool)
+      By default we return the private leaderboard if it's available, otherwise
+      the public LB. This flag lets you override to get public even if private
+      is available.
   """
 
   def __init__(self):
     self._competition_name = ""
+    self._override_public = None
     self._freeze()
 
   @property
@@ -239,6 +265,24 @@ def competition_name(self, competition_name: str):
       raise TypeError('competition_name must be of type str')
     self._competition_name = competition_name
 
+  @property
+  def override_public(self) -> bool:
+    r"""
+    By default we return the private leaderboard if it's available, otherwise
+    the public LB. This flag lets you override to get public even if private
+    is available.
+    """
+    return self._override_public or False
+
+  @override_public.setter
+  def override_public(self, override_public: bool):
+    if override_public is None:
+      del self.override_public
+      return
+    if not isinstance(override_public, bool):
+      raise TypeError('override_public must be of type bool')
+    self._override_public = override_public
+
 
   def endpoint(self):
     path = '/api/v1/competitions/{competition_name}/leaderboard/view'
@@ -274,6 +318,41 @@ def submissions(self, submissions: Optional[List[Optional['ApiLeaderboardSubmiss
     self._submissions = submissions
 
 
+class ApiGetSubmissionRequest(KaggleObject):
+  r"""
+  Attributes:
+    ref (int)
+      SubmissionId.
+  """
+
+  def __init__(self):
+    self._ref = 0
+    self._freeze()
+
+  @property
+  def ref(self) -> int:
+    """SubmissionId."""
+    return self._ref
+
+  @ref.setter
+  def ref(self, ref: int):
+    if ref is None:
+      del self.ref
+      return
+    if not isinstance(ref, int):
+      raise TypeError('ref must be of type int')
+    self._ref = ref
+
+
+  def endpoint(self):
+    path = '/api/v1/competitions/submissions/get/{ref}'
+    return path.format_map(self.to_field_map(self))
+
+
+  @staticmethod
+  def method():
+    return 'POST'
+
 class ApiLeaderboardSubmission(KaggleObject):
   r"""
   Attributes:
@@ -837,6 +916,8 @@ class ApiSubmission(KaggleObject):
     submitted_by_ref (str)
     team_name (str)
     url (str)
+      Minor note: ListSubmissions and GetSubmission may differ in setting this
+      field.
   """
 
   def __init__(self):
@@ -1013,6 +1094,10 @@ def team_name(self, team_name: str):
 
   @property
   def url(self) -> str:
+    r"""
+    Minor note: ListSubmissions and GetSubmission may differ in setting this
+    field.
+    """
     return self._url or ""
 
   @url.setter
@@ -1634,6 +1719,7 @@ def total_count(self, total_count: int):
 
 ApiCreateSubmissionResponse._fields = [
   FieldMetadata("message", "message", "_message", str, "", PredefinedSerializer()),
+  FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
 ]
 
 ApiDownloadDataFileRequest._fields = [
@@ -1651,12 +1737,17 @@ def total_count(self, total_count: int):
 
 ApiGetLeaderboardRequest._fields = [
   FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
+  FieldMetadata("overridePublic", "override_public", "_override_public", bool, None, PredefinedSerializer(), optional=True),
 ]
 
 ApiGetLeaderboardResponse._fields = [
   FieldMetadata("submissions", "submissions", "_submissions", ApiLeaderboardSubmission, [], ListSerializer(KaggleObjectSerializer())),
 ]
 
+ApiGetSubmissionRequest._fields = [
+  FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
+]
+
 ApiLeaderboardSubmission._fields = [
   FieldMetadata("teamId", "team_id", "_team_id", int, 0, PredefinedSerializer()),
   FieldMetadata("teamName", "team_name", "_team_name", str, None, PredefinedSerializer(), optional=True),

kagglesdk/kaggle_http_client.py

@@ -122,7 +122,7 @@ def _prepare_request(self, service_name: str, request_name: str,
       self._session.headers.update({
         'Accept': 'application/json',
         'Content-Type': 'text/plain',
-      })
+        })
     elif method == 'POST':
       data = request.to_field_map(request, ignore_defaults=True)
       if isinstance(data, dict):
@@ -176,7 +176,7 @@ def _print_request(self, request):
     self._print('---------------------Request----------------------')
     self._print(
       f'{request.method} {request.url}\n{_headers_to_str(request.headers)}\n\n{request.body}'
-    )
+      )
     self._print('--------------------------------------------------')
 
   def _print_response(self, response, body=True):
@@ -208,14 +208,14 @@ def _init_session(self):
     self._session.headers.update({
       'User-Agent': 'kaggle-api/v1.7.0',  # Was: V2
       'Content-Type': 'application/x-www-form-urlencoded',  # Was: /json
-    })
+      })
 
     iap_token = self._get_iap_token_if_required()
     if iap_token is not None:
       self._session.headers.update({
         # https://cloud.google.com/iap/docs/authentication-howto#authenticating_from_proxy-authorization_header
         'Proxy-Authorization': f'Bearer {iap_token}',
-      })
+        })
 
     self._try_fill_auth()
     # self._fill_xsrf_token(iap_token)  # TODO Make this align with original handler.

kagglesdk/models/services/model_api_service.py

@@ -1,6 +1,6 @@
 from kagglesdk.common.types.http_redirect import HttpRedirect
 from kagglesdk.kaggle_http_client import KaggleHttpClient
-from kagglesdk.models.types.model_api_service import ApiCreateModelInstanceRequest, ApiCreateModelInstanceVersionRequest, ApiCreateModelRequest, ApiCreateModelResponse, ApiDeleteModelInstanceRequest, ApiDeleteModelInstanceVersionRequest, ApiDeleteModelRequest, ApiDeleteModelResponse, ApiDownloadModelInstanceVersionRequest, ApiGetModelInstanceRequest, ApiGetModelRequest, ApiListModelInstanceVersionFilesRequest, ApiListModelInstanceVersionFilesResponse, ApiListModelsRequest, ApiListModelsResponse, ApiModel, ApiModelInstance, ApiUpdateModelInstanceRequest, ApiUpdateModelRequest, ApiUpdateModelResponse, ApiUploadModelFileRequest, ApiUploadModelFileResponse, CreateModelSigningTokenRequest, CreateModelSigningTokenResponse, KeysRequest, KeysResponse, WellKnowEndpointRequest, WellKnowEndpointResponse
+from kagglesdk.models.types.model_api_service import ApiCreateModelInstanceRequest, ApiCreateModelInstanceVersionRequest, ApiCreateModelRequest, ApiCreateModelResponse, ApiDeleteModelInstanceRequest, ApiDeleteModelInstanceVersionRequest, ApiDeleteModelRequest, ApiDeleteModelResponse, ApiDownloadModelInstanceVersionRequest, ApiGetModelInstanceRequest, ApiGetModelRequest, ApiListModelGatingUserConsentsRequest, ApiListModelGatingUserConsentsResponse, ApiListModelInstanceVersionFilesRequest, ApiListModelInstanceVersionFilesResponse, ApiListModelsRequest, ApiListModelsResponse, ApiModel, ApiModelInstance, ApiUpdateModelInstanceRequest, ApiUpdateModelRequest, ApiUpdateModelResponse, ApiUploadModelFileRequest, ApiUploadModelFileResponse, CreateModelSigningTokenRequest, CreateModelSigningTokenResponse, KeysRequest, KeysResponse, WellKnowEndpointRequest, WellKnowEndpointResponse
 
 class ModelApiClient(object):
 
@@ -223,3 +223,19 @@ def keys(self, request: KeysRequest = None) -> KeysResponse:
       request = KeysRequest()
 
     return self._client.call("models.ModelApiService", "Keys", request, KeysResponse)
+
+  def list_model_gating_user_consents(self, request: ApiListModelGatingUserConsentsRequest = None) -> ApiListModelGatingUserConsentsResponse:
+    r"""
+    Model gating
+    List the user consents for a gated model, under the model's current active
+    agreement.
+
+    Args:
+      request (ApiListModelGatingUserConsentsRequest):
+        The request object; initialized to empty instance if not specified.
+    """
+
+    if request is None:
+      request = ApiListModelGatingUserConsentsRequest()
+
+    return self._client.call("models.ModelApiService", "ApiListModelGatingUserConsents", request, ApiListModelGatingUserConsentsResponse)