Update to 1.5.0

Author: rysteboe

.gitignore

@@ -62,6 +62,3 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
-
-# Pycharm
-.idea

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 ====
 
+#### 1.5.0
+Release date: 10/19/18
+* Update API to work with new competitions submissions backend.  This change will force old API clients to update.  
+* Update error message when config file is not found.
+
 #### 1.4.7.1
 Release date: 8/28/18
 * Fix host

KaggleSwagger.yaml

@@ -118,7 +118,7 @@ paths:
           description: Error
           schema:
             $ref: '#/definitions/Error'
-  /competitions/submissions/url/{contentLength}/{lastModifiedDateUtc}:
+  /competitions/{id}/submissions/url/{contentLength}/{lastModifiedDateUtc}:
     post:
       tags:
         - kaggle
@@ -133,7 +133,12 @@ paths:
           name: fileName
           required: false
           type: string
-          description: Competition submission file name    
+          description: Competition submission file name
+        - in: path
+          name: id
+          required: true
+          type: string
+          description: Competition name, as it appears in the competition's URL
         - in: path
           name: contentLength
           required: true

README.md

@@ -4,6 +4,8 @@ Official API for https://www.kaggle.com, accessible using a command line tool im
 
 Beta release - Kaggle reserves the right to modify the API functionality currently offered.
 
+IMPORTANT: Competitions submissions using an API version prior to 1.5.0 may not work.  If you are encountering difficulties with submitting to competitions, please check your version with `kaggle --version`.  If it is below 1.5.0, please update with `pip install kaggle --upgrade`.
+
 ## Installation
 
 Ensure you have Python 3 and the package manager `pip` installed.

kaggle/api/kaggle_api.py

@@ -853,15 +853,16 @@ def competitions_submissions_upload_with_http_info(self, file, guid, content_len
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def competitions_submissions_url(self, content_length, last_modified_date_utc, **kwargs):  # noqa: E501
+    def competitions_submissions_url(self, id, content_length, last_modified_date_utc, **kwargs):  # noqa: E501
         """Generate competition submission URL  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.competitions_submissions_url(content_length, last_modified_date_utc, async_req=True)
+        >>> thread = api.competitions_submissions_url(id, content_length, last_modified_date_utc, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
+        :param str id: Competition name, as it appears in the competition's URL (required)
         :param int content_length: Content length of file in bytes (required)
         :param int last_modified_date_utc: Last modified date of file in milliseconds since epoch in UTC (required)
         :param str file_name: Competition submission file name
@@ -871,20 +872,21 @@ def competitions_submissions_url(self, content_length, last_modified_date_utc, *
         """
         kwargs['_return_http_data_only'] = True
         if kwargs.get('async_req'):
-            return self.competitions_submissions_url_with_http_info(content_length, last_modified_date_utc, **kwargs)  # noqa: E501
+            return self.competitions_submissions_url_with_http_info(id, content_length, last_modified_date_utc, **kwargs)  # noqa: E501
         else:
-            (data) = self.competitions_submissions_url_with_http_info(content_length, last_modified_date_utc, **kwargs)  # noqa: E501
+            (data) = self.competitions_submissions_url_with_http_info(id, content_length, last_modified_date_utc, **kwargs)  # noqa: E501
             return data
 
-    def competitions_submissions_url_with_http_info(self, content_length, last_modified_date_utc, **kwargs):  # noqa: E501
+    def competitions_submissions_url_with_http_info(self, id, content_length, last_modified_date_utc, **kwargs):  # noqa: E501
         """Generate competition submission URL  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.competitions_submissions_url_with_http_info(content_length, last_modified_date_utc, async_req=True)
+        >>> thread = api.competitions_submissions_url_with_http_info(id, content_length, last_modified_date_utc, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
+        :param str id: Competition name, as it appears in the competition's URL (required)
         :param int content_length: Content length of file in bytes (required)
         :param int last_modified_date_utc: Last modified date of file in milliseconds since epoch in UTC (required)
         :param str file_name: Competition submission file name
@@ -893,7 +895,7 @@ def competitions_submissions_url_with_http_info(self, content_length, last_modif
                  returns the request thread.
         """
 
-        all_params = ['content_length', 'last_modified_date_utc', 'file_name']  # noqa: E501
+        all_params = ['id', 'content_length', 'last_modified_date_utc', 'file_name']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -908,6 +910,10 @@ def competitions_submissions_url_with_http_info(self, content_length, last_modif
                 )
             params[key] = val
         del params['kwargs']
+        # verify the required parameter 'id' is set
+        if ('id' not in params or
+                params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `competitions_submissions_url`")  # noqa: E501
         # verify the required parameter 'content_length' is set
         if ('content_length' not in params or
                 params['content_length'] is None):
@@ -920,6 +926,8 @@ def competitions_submissions_url_with_http_info(self, content_length, last_modif
         collection_formats = {}
 
         path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
         if 'content_length' in params:
             path_params['contentLength'] = params['content_length']  # noqa: E501
         if 'last_modified_date_utc' in params:
@@ -947,7 +955,7 @@ def competitions_submissions_url_with_http_info(self, content_length, last_modif
         auth_settings = ['basicAuth']  # noqa: E501
 
         return self.api_client.call_api(
-            '/competitions/submissions/url/{contentLength}/{lastModifiedDateUtc}', 'POST',
+            '/competitions/{id}/submissions/url/{contentLength}/{lastModifiedDateUtc}', 'POST',
             path_params,
             query_params,
             header_params,

kaggle/api/kaggle_api_extended.py

@@ -60,7 +60,7 @@
 
 
 class KaggleApi(KaggleApi):
-    __version__ = '1.4.7.1'
+    __version__ = '1.5.0'
 
     CONFIG_NAME_PROXY = 'proxy'
     CONFIG_NAME_COMPETITION = 'competition'
@@ -109,13 +109,13 @@ def authenticate(self):
                 config_data = self.read_config_file(config_data)
             else:
                 raise IOError('Could not find {}. Make sure it\'s located in'
-                              ' {}. Or use the environment method.'
-                              .format(self.config_file, self.config_dir))
+                              ' {}. Or use the environment method.'.format(
+                                  self.config_file, self.config_dir))
 
         # Step 3: load into configuration!
         self._load_config(config_data)
 
-    def read_config_environment(self, config_data={}, quiet=False):
+    def read_config_environment(self, config_data=None, quiet=False):
         """read_config_environment is the second effort to get a username
            and key to authenticate to the Kaggle API. The environment keys
            are equivalent to the kaggle.json file, but with "KAGGLE_" prefix
@@ -129,6 +129,8 @@ def read_config_environment(self, config_data={}, quiet=False):
 
         # Add all variables that start with KAGGLE_ to config data
 
+        if config_data is None:
+            config_data = {}
         for key, val in os.environ.items():
             if key.startswith('KAGGLE_'):
                 config_key = key.replace('KAGGLE_', '', 1).lower()
@@ -187,7 +189,7 @@ def _load_config(self, config_data):
                     'https://github.com/Kaggle/kaggle-api#api-credentials ' +
                     'for instructions.')
 
-    def read_config_file(self, config_data={}, quiet=False):
+    def read_config_file(self, config_data=None, quiet=False):
         """read_config_file is the first effort to get a username
            and key to authenticate to the Kaggle API. Since we can get the
            username and password from the environment, it's not required.
@@ -198,7 +200,8 @@ def read_config_file(self, config_data={}, quiet=False):
                         password, if defined
            quiet: suppress verbose print of output (default is False)
         """
-        config_data = {}
+        if config_data is None:
+            config_data = {}
 
         if os.path.exists(self.config):
 
@@ -211,7 +214,7 @@ def read_config_file(self, config_data={}, quiet=False):
                             'users on this system! To fix this, you can run' +
                             '\'chmod 600 {}\''.format(self.config))
 
-                with open(self.config, 'r') as f:
+                with open(self.config) as f:
                     config_data = json.load(f)
             except:
                 pass
@@ -458,18 +461,35 @@ def competition_submit(self, file_name, message, competition, quiet=False):
         else:
             url_result = self.process_response(
                 self.competitions_submissions_url_with_http_info(
+                    id=competition,
                     file_name=os.path.basename(file_name),
                     content_length=os.path.getsize(file_name),
-                    last_modified_date_utc=int(
-                        os.path.getmtime(file_name) * 1000)))
-            url_result_list = url_result['createUrl'].split('/')
-            upload_result = self.process_response(
-                self.competitions_submissions_upload_with_http_info(
-                    file=file_name,
-                    guid=url_result_list[-3],
-                    content_length=url_result_list[-2],
-                    last_modified_date_utc=url_result_list[-1]))
-            upload_result_token = upload_result['token']
+                    last_modified_date_utc=int(os.path.getmtime(file_name))))
+
+            # Temporary while new worker is gradually turned on.  'isComplete'
+            # exists on the old DTO but not the new, so this is an hacky but
+            # easy solution to figure out which submission logic to use
+            if 'isComplete' in url_result:
+                # Old submissions path
+                url_result_list = url_result['createUrl'].split('/')
+                upload_result = self.process_response(
+                    self.competitions_submissions_upload_with_http_info(
+                        file=file_name,
+                        guid=url_result_list[-3],
+                        content_length=url_result_list[-2],
+                        last_modified_date_utc=url_result_list[-1]))
+                upload_result_token = upload_result['token']
+            else:
+                # New submissions path!
+                success = self.upload_complete(file_name,
+                                               url_result['createUrl'], quiet)
+                if not success:
+                    # Actual error is printed during upload_complete.  Not
+                    # ideal but changing would not be backwards compatible
+                    return "Could not submit to competition"
+
+                upload_result_token = url_result['token']
+
             submit_result = self.process_response(
                 self.competitions_submissions_submit_with_http_info(
                     id=competition,

setup.py

@@ -19,7 +19,7 @@
 
 setup(
     name='kaggle',
-    version='1.4.7.1',
+    version='1.5.0',
     description='Kaggle API',
     long_description=
     ('Official API for https://www.kaggle.com, accessible using a command line '