kaggle 1.7.3b1__tar.gz → 1.7.4__tar.gz

{kaggle-1.7.3b1 → kaggle-1.7.4}/CHANGELOG.md

@@ -1,5 +1,30 @@
 Changelog
 ====
+
+### 1.7.4
+
+Version 1.7.3 was never released. There were errors in versioning on
+test.pypi.org. For consistency, we decided to jump several version numbers.
+This is the first release since 1.6.17.
+
+The actual changes are described in 1.7.3.
+
+### 1.7.3
+
+There was an error in versioning. We went from 1.6.17 to 1.7.3.
+
+* Added the ability to submit to a code competition. Some required arguments have been made optional.
+* Added a `--timeout` option to `kaggle kernels push` to limit the run-time to the specified number of seconds.
+* Removed Swagger. Projects that use `kaggle/api/kaggle_api.py` may be affected. That file is deprecated and will be
+  removed. Most of its functions still work, but those that involve uploading files no longer work.
+  The command-line tool uses a higher-level abstraction for uploading, and client code needs
+  to be converted to use that.
+
+### 1.7.3b2
+
+* Added the ability to submit to a code competition. Some required arguments have been made optional.
+* Added a `--timeout` option to `kaggle kernels push` to limit the run-time to the specified number of seconds.
+
 ### 1.7.3b1
 
 * Fix escaped-quote issue in HTTP requests.

{kaggle-1.7.3b1 → kaggle-1.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaggle
-Version: 1.7.3b1
+Version: 1.7.4
 Summary: Access Kaggle resources anywhere
 Project-URL: Homepage, https://github.com/Kaggle/kaggle-api
 Project-URL: Issues, https://github.com/Kaggle/kaggle-api/issues
@@ -259,6 +259,16 @@ rm -rf /tmp/autogen && mkdir -p /tmp/autogen && unzip -qo /tmp/autogen.zip -d /t
 mv /tmp/autogen/autogen-*/* /tmp/autogen && rm -rf /tmp/autogen/autogen-* &&
 sudo chmod a+rx /tmp/autogen/autogen.sh
 ```
+The internal documentation needs to be updated. To install a release from test.pypi.org
+you need to do:
+```bash
+pip install \
+     --index-url https://test.pypi.org/simple \
+     --force \
+     --extra-index-url https://pypi.org/simple \
+     --break-system-packages \
+     kaggle
+```
 
 ### Prerequisites
 

{kaggle-1.7.3b1 → kaggle-1.7.4}/README.md

@@ -29,6 +29,16 @@ rm -rf /tmp/autogen && mkdir -p /tmp/autogen && unzip -qo /tmp/autogen.zip -d /t
 mv /tmp/autogen/autogen-*/* /tmp/autogen && rm -rf /tmp/autogen/autogen-* &&
 sudo chmod a+rx /tmp/autogen/autogen.sh
 ```
+The internal documentation needs to be updated. To install a release from test.pypi.org
+you need to do:
+```bash
+pip install \
+     --index-url https://test.pypi.org/simple \
+     --force \
+     --extra-index-url https://pypi.org/simple \
+     --break-system-packages \
+     kaggle
+```
 
 ### Prerequisites
 

{kaggle-1.7.3b1 → kaggle-1.7.4}/kaggle/api/kaggle_api_extended.py

@@ -34,7 +34,8 @@ import requests
 import urllib3.exceptions as urllib3_exceptions
 from requests import RequestException
 
-from kaggle.models.kaggle_models_extended import ResumableUploadResult, File
+from kaggle.models.kaggle_models_extended import ResumableUploadResult, File, \
+  Kernel
 
 from requests.adapters import HTTPAdapter
 from slugify import slugify
@@ -61,7 +62,8 @@ from kagglesdk.datasets.types.dataset_types import DatasetSettings, \
   SettingsLicense, DatasetCollaborator
 from kagglesdk.kernels.types.kernels_api_service import ApiListKernelsRequest, \
   ApiListKernelFilesRequest, ApiSaveKernelRequest, ApiGetKernelRequest, \
-  ApiListKernelSessionOutputRequest, ApiGetKernelSessionStatusRequest
+  ApiListKernelSessionOutputRequest, ApiGetKernelSessionStatusRequest, \
+  ApiSaveKernelResponse
 from kagglesdk.kernels.types.kernels_enums import KernelsListSortType, \
   KernelsListViewType
 from kagglesdk.models.types.model_api_service import ApiListModelsRequest, \
@@ -251,7 +253,7 @@ class ResumableFileUpload(object):
 
 
 class KaggleApi:
-  __version__ = '1.7.3b1'
+  __version__ = '1.7.4'
 
   CONFIG_NAME_PROXY = 'proxy'
   CONFIG_NAME_COMPETITION = 'competition'
@@ -290,7 +292,7 @@ class KaggleApi:
 
   args = {}  # DEBUG Add --local to use localhost
   if os.environ.get('KAGGLE_API_ENVIRONMENT') == 'LOCALHOST':
-    args = {'--local'}
+    args = {'--verbose','--local'}
 
   # Kernels valid types
   valid_push_kernel_types = ['script', 'notebook']
@@ -700,7 +702,16 @@ class KaggleApi:
       return enum_class[item]
     except KeyError:
       prefix = self.camel_to_snake(enum_class.__name__).upper()
-      return enum_class[f'{prefix}_{self.camel_to_snake(item_name).upper()}']
+      full_name = f'{prefix}_{self.camel_to_snake(item_name).upper()}'
+    try:
+      return enum_class[full_name]
+    except KeyError:
+      # Handle PY_TORCH vs PYTORCH, etc.
+      full_name = full_name.replace('_', '')
+      for item in vars(enum_class):
+        if item.replace('_', '') == full_name:
+          return enum_class[item]
+      raise
 
   def short_enum_name(self, value):
     full_name = str(value)
@@ -792,8 +803,47 @@ class KaggleApi:
     else:
       print('No competitions found')
 
+  def competition_submit_code(self, file_name, message, competition, kernel=None, kernel_version=None, quiet=False):
+    """ Submit to a code competition.
+
+            Parameters
+            ==========
+            file_name: the name of  the output file created by the kernel (not used for packages)
+            message: the submission description
+            competition: the competition name; if not given use the 'competition' config value
+            kernel: the <owner>/<notebook> of the notebook to use for a code competition
+            kernel_version: the version number, returned by 'kaggle kernels push ...'
+            quiet: suppress verbose output (default is False)
+        """
+    if competition is None:
+      competition = self.get_config_value(self.CONFIG_NAME_COMPETITION)
+      if competition is not None and not quiet:
+        print('Using competition: ' + competition)
+    if competition is None:
+      raise ValueError('No competition specified')
+
+    if kernel is None:
+      raise ValueError('No kernel specified')
+    else:
+      with self.build_kaggle_client() as kaggle:
+        items = kernel.split('/')
+        if len(items) != 2:
+          raise ValueError('The kernel must be specified as <owner>/<notebook>')
+        submit_request = ApiCreateCodeSubmissionRequest()
+        submit_request.file_name = file_name
+        submit_request.competition_name = competition
+        submit_request._kernel_owner = items[0]
+        submit_request.kernel_slug = items[1]
+        if kernel_version:
+          submit_request.kernel_version = int(kernel_version)
+        if message:
+          submit_request.submission_description = message
+        submit_response = kaggle.competitions.competition_api_client.create_code_submission(
+            submit_request)
+        return submit_response
+
   def competition_submit(self, file_name, message, competition, quiet=False):
-    """ Submit a competition.
+    """ Submit to a competition.
 
             Parameters
             ==========
@@ -810,6 +860,8 @@ class KaggleApi:
     if competition is None:
       raise ValueError('No competition specified')
     else:
+      if file_name is None:
+        raise ValueError('No file specified')
       with self.build_kaggle_client() as kaggle:
         request = ApiStartSubmissionUploadRequest()
         request.competition_name = competition
@@ -828,15 +880,18 @@ class KaggleApi:
         submit_request = ApiCreateSubmissionRequest()
         submit_request.competition_name = competition
         submit_request.blob_file_tokens = response.token
-        submit_request.submission_description = message
+        if message:
+          submit_request.submission_description = message
         submit_response = kaggle.competitions.competition_api_client.create_submission(
             submit_request)
         return submit_response
 
   def competition_submit_cli(self,
-                             file_name,
-                             message,
-                             competition,
+                             file_name=None,
+                             message=None,
+                             competition=None,
+                             kernel=None,
+                             version=None,
                              competition_opt=None,
                              quiet=False):
     """ Submit a competition using the client. Arguments are same as for
@@ -847,12 +902,20 @@ class KaggleApi:
             file_name: the competition metadata file
             message: the submission description
             competition: the competition name; if not given use the 'competition' config value
+            kernel: the name of the kernel to submit to a code competition
+            version: the version of the kernel to submit to a code competition, e.g. '1'
             quiet: suppress verbose output (default is False)
             competition_opt: an alternative competition option provided by cli
         """
+    if kernel and not version or version and not kernel:
+      raise ValueError('Code competition submissions require both the output file name and the version label')
     competition = competition or competition_opt
     try:
-      submit_result = self.competition_submit(file_name, message, competition,
+      if kernel:
+        submit_result = self.competition_submit_code(file_name, message, competition,
+                                                     kernel, version, quiet)
+      else:
+        submit_result = self.competition_submit(file_name, message, competition,
                                               quiet)
     except RequestException as e:
       if e.response and e.response.status_code == 404:
@@ -1665,8 +1728,14 @@ class KaggleApi:
     dataset = dataset or dataset_opt
 
     owner_slug, dataset_slug, _ = self.split_dataset_string(dataset)
-    metadata = self.process_response(
-        self.metadata_get_with_http_info(owner_slug, dataset_slug))
+    request = ApiGetDatasetMetadataRequest()
+    request.owner_slug = owner_slug
+    request.dataset_slug = dataset_slug
+    with self.build_kaggle_client() as kaggle:
+      response = kaggle.datasets.dataset_api_client.get_dataset_metadata(request)
+      if response.error_message:
+        raise Exception(response.error_message)
+      metadata = response.info
 
     if 'info' in metadata and 'licenses' in metadata['info']:
       # license_objs format is like: [{ 'name': 'CC0-1.0' }]
@@ -2297,10 +2366,6 @@ class KaggleApi:
       print('No files found')
       return
 
-    if result.error_message:
-      print(result.error_message)
-      return
-
     next_page_token = result.nextPageToken
     if next_page_token:
       print('Next Page Token = {}'.format(next_page_token))
@@ -2369,7 +2434,7 @@ class KaggleApi:
     meta_file = self.kernels_initialize(folder)
     print('Kernel metadata template written to: ' + meta_file)
 
-  def kernels_push(self, folder, timeout):
+  def kernels_push(self, folder, timeout=None) -> ApiSaveKernelResponse:
     """ Read the metadata file and kernel files from a notebook, validate
             both, and use the Kernel API to push to Kaggle if all is valid.
             Parameters
@@ -2465,7 +2530,7 @@ class KaggleApi:
           # but the server expects just one
           if 'source' in cell and isinstance(cell['source'], list):
             cell['source'] = ''.join(cell['source'])
-      script_body = json.dumps(json_body).replace("'", "\\'")
+      script_body = json.dumps(json_body)
 
     with self.build_kaggle_client() as kaggle:
       request = ApiSaveKernelRequest()
@@ -2829,9 +2894,9 @@ class KaggleApi:
       data['slug'] = model_ref_split[1]
       data['title'] = model.title
       data['subtitle'] = model.subtitle
-      data['isPrivate'] = model.isPrivate  # TODO Test to ensure True default
+      data['isPrivate'] = model.is_private  # TODO Test to ensure True default
       data['description'] = model.description
-      data['publishTime'] = model.publishTime
+      data['publishTime'] = model.publish_time
 
       with open(meta_file, 'w') as f:
         json.dump(data, f, indent=2)
@@ -3010,7 +3075,7 @@ class KaggleApi:
     folder = folder or os.getcwd()
     result = self.model_create_new(folder)
 
-    if result.hasId:
+    if result.id:
       print('Your model was created. Id={}. Url={}'.format(
           result.id, result.url))
     else:
@@ -3134,7 +3199,7 @@ class KaggleApi:
     folder = folder or os.getcwd()
     result = self.model_update(folder)
 
-    if result.hasId:
+    if result.id:
       print('Your model was updated. Id={}. Url={}'.format(
           result.id, result.url))
     else:
@@ -3357,7 +3422,7 @@ class KaggleApi:
     folder = folder or os.getcwd()
     result = self.model_instance_create(folder, quiet, dir_mode)
 
-    if result.hasId:
+    if result.id:
       print('Your model instance was created. Id={}. Url={}'.format(
           result.id, result.url))
     else:
@@ -3442,10 +3507,10 @@ class KaggleApi:
         next_page_token = response.next_page_token
         if next_page_token:
           print('Next Page Token = {}'.format(next_page_token))
-        return response
+        return FileList.from_response(response)
       else:
         print('No files found')
-        return FileList({})
+        return FileList({'files': [], 'nextPageToken': ''})
 
   def model_instance_files_cli(self,
                                model_instance,
@@ -4635,6 +4700,20 @@ class FileList(object):
     else:
       self.nextPageToken = ""
 
+  @staticmethod
+  def from_response(response):
+    inst = FileList({'files': [], 'nextPageToken': ''})
+    inst.error_message = ''
+    files = response.files
+    if files:
+      inst.files = [File(f) for f in files]
+    else:
+      inst.files = []
+    token = response.next_page_token
+    if token:
+      inst.nextPageToken = token
+    else:
+      inst.nextPageToken = ""
   def __repr__(self):
     return ''
 

{kaggle-1.7.3b1/src → kaggle-1.7.4}/kaggle/cli.py

@@ -136,6 +136,7 @@ def parse_competitions(subparsers):
       '--page',
       dest='page',
       default=1,
+      type=int,
       required=False,
       help=Help.param_page)
   parser_competitions_list_optional.add_argument(
@@ -183,6 +184,7 @@ def parse_competitions(subparsers):
       dest='page_size',
       required=False,
       default=20,
+      type=int,
       help=Help.param_page_size)
   parser_competitions_files._action_groups.append(
       parser_competitions_files_optional)
@@ -234,8 +236,6 @@ def parse_competitions(subparsers):
       help=Help.command_competitions_submit)
   parser_competitions_submit_optional = parser_competitions_submit._action_groups.pop(
   )
-  parser_competitions_submit_required = parser_competitions_submit.add_argument_group(
-      'required arguments')
   parser_competitions_submit_optional.add_argument(
       'competition', nargs='?', default=None, help=Help.param_competition)
   parser_competitions_submit_optional.add_argument(
@@ -244,14 +244,18 @@ def parse_competitions(subparsers):
       dest='competition_opt',
       required=False,
       help=argparse.SUPPRESS)
-  parser_competitions_submit_required.add_argument(
-      '-f', '--file', dest='file_name', required=True, help=Help.param_upfile)
-  parser_competitions_submit_required.add_argument(
+  parser_competitions_submit_optional.add_argument(
+      '-f', '--file', dest='file_name', help=Help.param_upfile)
+  parser_competitions_submit_optional.add_argument(
+      '-k', '--kernel', dest='kernel', help=Help.param_code_kernel)
+  parser_competitions_submit_optional.add_argument(
       '-m',
       '--message',
       dest='message',
       required=True,
       help=Help.param_competition_message)
+  parser_competitions_submit_optional.add_argument(
+      '-v', '--version', dest='version', help=Help.param_code_version)
   parser_competitions_submit_optional.add_argument(
       '-q', '--quiet', dest='quiet', action='store_true', help=Help.param_quiet)
   parser_competitions_submit._action_groups.append(
@@ -358,7 +362,7 @@ def parse_datasets(subparsers):
       required=False,
       help=Help.param_dataset_sort_by)
   parser_datasets_list.add_argument(
-      '--size', dest='size', required=False, help=Help.param_dataset_size)
+      '--size', dest='size', type=int, required=False, help=Help.param_dataset_size)
   parser_datasets_list.add_argument(
       '--file-type',
       dest='file_type',
@@ -382,6 +386,7 @@ def parse_datasets(subparsers):
       '--page',
       dest='page',
       default=1,
+      type=int,
       required=False,
       help=Help.param_page)
   parser_datasets_list.add_argument(
@@ -394,11 +399,13 @@ def parse_datasets(subparsers):
       '--max-size',
       dest='max_size',
       required=False,
+      type=int,
       help=Help.param_dataset_maxsize)
   parser_datasets_list.add_argument(
       '--min-size',
       dest='min_size',
       required=False,
+      type=int,
       help=Help.param_dataset_minsize)
   parser_datasets_list._action_groups.append(parser_datasets_list_optional)
   parser_datasets_list.set_defaults(func=api.dataset_list_cli)
@@ -433,6 +440,7 @@ def parse_datasets(subparsers):
       dest='page_size',
       required=False,
       default=20,
+      type=int,
       help=Help.param_page_size)
   parser_datasets_files._action_groups.append(parser_datasets_files_optional)
   parser_datasets_files.set_defaults(func=api.dataset_list_files_cli)
@@ -645,9 +653,9 @@ def parse_kernels(subparsers):
   parser_kernels_list_optional.add_argument(
       '-m', '--mine', dest='mine', action='store_true', help=Help.param_mine)
   parser_kernels_list_optional.add_argument(
-      '-p', '--page', dest='page', default=1, help=Help.param_page)
+      '-p', '--page', dest='page', default=1, type=int, help=Help.param_page)
   parser_kernels_list_optional.add_argument(
-      '--page-size', dest='page_size', default=20, help=Help.param_page_size)
+      '--page-size', dest='page_size', default=20, type=int, help=Help.param_page_size)
   parser_kernels_list_optional.add_argument(
       '-s', '--search', dest='search', help=Help.param_search)
   parser_kernels_list_optional.add_argument(
@@ -716,7 +724,7 @@ def parse_kernels(subparsers):
   parser_kernels_files_optional.add_argument(
       '--page-token', dest='page_token', help=Help.param_page_token)
   parser_kernels_files_optional.add_argument(
-      '--page-size', dest='page_size', default=20, help=Help.param_page_size)
+      '--page-size', dest='page_size', default=20, type=int, help=Help.param_page_size)
   parser_kernels_files._action_groups.append(parser_kernels_files_optional)
   parser_kernels_files.set_defaults(func=api.kernels_list_files_cli)
 
@@ -750,6 +758,7 @@ def parse_kernels(subparsers):
   parser_kernels_push_optional.add_argument(
       '-t',
       '--timeout',
+      type=int,
       dest='timeout')
   parser_kernels_push._action_groups.append(parser_kernels_push_optional)
   parser_kernels_push.set_defaults(func=api.kernels_push_cli)
@@ -889,7 +898,7 @@ def parse_models(subparsers):
   parser_models_list.add_argument(
       '--owner', dest='owner', required=False, help=Help.param_model_owner)
   parser_models_list.add_argument(
-      '--page-size', dest='page_size', default=20, help=Help.param_page_size)
+      '--page-size', dest='page_size', default=20, type=int, help=Help.param_page_size)
   parser_models_list.add_argument(
       '--page-token',
       dest='page_token',
@@ -1056,7 +1065,7 @@ def parse_model_instances(subparsers):
       action='store_true',
       help=Help.param_csv)
   parser_model_instances_files_optional.add_argument(
-      '--page-size', dest='page_size', default=20, help=Help.param_page_size)
+      '--page-size', dest='page_size', default=20, type=int, help=Help.param_page_size)
   parser_model_instances_files_optional.add_argument(
       '--page-token',
       dest='page_token',
@@ -1184,7 +1193,7 @@ def parse_model_instance_versions(subparsers):
       action='store_true',
       help=Help.param_csv)
   parser_model_instance_versions_files_optional.add_argument(
-      '--page-size', dest='page_size', default=20, help=Help.param_page_size)
+      '--page-size', dest='page_size', default=20, type=int, help=Help.param_page_size)
   parser_model_instance_versions_files_optional.add_argument(
       '--page-token',
       dest='page_token',
@@ -1420,7 +1429,9 @@ class Help(object):
   param_delete_old_version = 'Delete old versions of this dataset'
   param_force = ('Skip check whether local version of file is up to date, force'
                  ' file download')
-  param_upfile = 'File for upload (full path)'
+  param_upfile = 'File for upload (full path), or the name of the output file produced by a kernel (for code competitions)'
+  param_code_kernel = 'Name of kernel (notebook) to submit to a code competition'
+  param_code_version = 'Version of kernel to submit to a code competition, e.g. "Version 1"'
   param_csv = 'Print results in CSV format (if not set print in table format)'
   param_page = 'Page number for results paging. Page size is 20 by default'
   # NOTE: Default and max page size are set by the mid-tier code.

{kaggle-1.7.3b1/src → kaggle-1.7.4}/kaggle/models/kaggle_models_extended.py

@@ -120,7 +120,10 @@ class File(object):
     except AttributeError:
       self.name = init_dict.name
       self.creation_date = init_dict.creation_date
-      self.size = File.get_size(init_dict.total_bytes)
+      try:
+        self.size = File.get_size(init_dict.total_bytes)
+      except Exception: # AttributeError would be preferred but doesn't work.
+        self.size = File.get_size(init_dict.size)
 
   def __repr__(self):
     return self.name

{kaggle-1.7.3b1/src → kaggle-1.7.4}/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, ApiGetSubmissionRequest, ApiListCompetitionsRequest, ApiListCompetitionsResponse, ApiListDataFilesRequest, ApiListDataFilesResponse, ApiListSubmissionsRequest, ApiListSubmissionsResponse, ApiStartSubmissionUploadRequest, ApiStartSubmissionUploadResponse, ApiSubmission
+from kagglesdk.competitions.types.competition_api_service import ApiCreateCodeSubmissionRequest, ApiCreateCodeSubmissionResponse, 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 @@ class CompetitionApiClient(object):
 
     return self._client.call("competitions.CompetitionApiService", "ApiCreateSubmission", request, ApiCreateSubmissionResponse)
 
+  def create_code_submission(self, request: ApiCreateCodeSubmissionRequest = None) -> ApiCreateCodeSubmissionResponse:
+    r"""
+    Args:
+      request (ApiCreateCodeSubmissionRequest):
+        The request object; initialized to empty instance if not specified.
+    """
+
+    if request is None:
+      request = ApiCreateCodeSubmissionRequest()
+
+    return self._client.call("competitions.CompetitionApiService", "ApiCreateCodeSubmission", request, ApiCreateCodeSubmissionResponse)
+
   def get_submission(self, request: ApiGetSubmissionRequest = None) -> ApiSubmission:
     r"""
     Args: