BigQuery: Make job.begin() method private. (#4242)

googleapis · Oct 24, 2017 · df016c2 · df016c2
1 parent 61bb7a0
commit df016c2
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 23 deletions.
diff --git a/bigquery/google/cloud/bigquery/client.py b/bigquery/google/cloud/bigquery/client.py
@@ -647,7 +647,7 @@ def load_table_from_uri(self, source_uris, destination,
         if isinstance(source_uris, six.string_types):
             source_uris = [source_uris]
         job = LoadJob(job_id, source_uris, destination, self, job_config)
-        job.begin(retry=retry)
+        job._begin(retry=retry)
         return job
 
     def load_table_from_file(self, file_obj, destination,
@@ -692,8 +692,7 @@ def load_table_from_file(self, file_obj, destination,
         :rtype: :class:`~google.cloud.bigquery.LoadJob`
 
         :returns: the job instance used to load the data (e.g., for
-                  querying status). Note that the job is already started:
-                  do not call ``job.begin()``.
+                  querying status).
         :raises: :class:`ValueError` if ``size`` is not passed in and can not
                  be determined, or if the ``file_obj`` can be detected to be
                  a file opened in text mode.
@@ -862,7 +861,7 @@ def copy_table(self, sources, destination, job_id=None, job_id_prefix=None,
             sources = [sources]
         job = CopyJob(job_id, sources, destination, client=self,
                       job_config=job_config)
-        job.begin(retry=retry)
+        job._begin(retry=retry)
         return job
 
     def extract_table(
@@ -911,7 +910,7 @@ def extract_table(
         job = ExtractJob(
             job_id, source, destination_uris, client=self,
             job_config=job_config)
-        job.begin(retry=retry)
+        job._begin(retry=retry)
         return job
 
     def query(self, query, job_config=None, job_id=None, job_id_prefix=None,
@@ -945,7 +944,7 @@ def query(self, query, job_config=None, job_id=None, job_id_prefix=None,
         """
         job_id = _make_job_id(job_id, job_id_prefix)
         job = QueryJob(job_id, query, client=self, job_config=job_config)
-        job.begin(retry=retry)
+        job._begin(retry=retry)
         return job
 
     def create_rows(self, table, rows, selected_fields=None, **kwargs):

diff --git a/bigquery/google/cloud/bigquery/job.py b/bigquery/google/cloud/bigquery/job.py
@@ -368,7 +368,7 @@ def _get_resource_config(cls, resource):
         config = resource['configuration'][cls._JOB_TYPE]
         return job_id, config
 
-    def begin(self, client=None, retry=DEFAULT_RETRY):
+    def _begin(self, client=None, retry=DEFAULT_RETRY):
         """API call:  begin the job via a POST request
 
         See
@@ -521,7 +521,7 @@ def result(self, timeout=None):
             given timeout.
         """
         if self.state is None:
-            self.begin()
+            self._begin()
         # TODO: modify PollingFuture so it can pass a retry argument to done().
         return super(_AsyncJob, self).result(timeout=timeout)
 

diff --git a/bigquery/tests/unit/test_job.py b/bigquery/tests/unit/test_job.py
@@ -553,7 +553,7 @@ def test_begin_w_already_running(self):
         job._properties['status'] = {'state': 'RUNNING'}
 
         with self.assertRaises(ValueError):
-            job.begin()
+            job._begin()
 
     def test_begin_w_bound_client(self):
         PATH = '/projects/%s/jobs' % (self.PROJECT,)
@@ -568,7 +568,7 @@ def test_begin_w_bound_client(self):
         job = self._make_one(self.JOB_ID, [self.SOURCE1], self.TABLE_REF,
                              client)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -608,7 +608,7 @@ def test_begin_w_autodetect(self):
         config.autodetect = True
         job = self._make_one(self.JOB_ID, [self.SOURCE1], self.TABLE_REF,
                              client, config)
-        job.begin()
+        job._begin()
 
         sent = {
             'jobReference': {
@@ -688,7 +688,7 @@ def test_begin_w_alternate_client(self):
         config.source_format = 'CSV'
         config.write_disposition = 'WRITE_TRUNCATE'
 
-        job.begin(client=client2)
+        job._begin(client=client2)
 
         self.assertEqual(len(conn1._requested), 0)
         self.assertEqual(len(conn2._requested), 1)
@@ -1019,7 +1019,7 @@ def test_begin_w_bound_client(self):
         destination = self._table_ref(self.DESTINATION_TABLE)
         job = self._make_one(self.JOB_ID, [source], destination, client)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -1077,7 +1077,7 @@ def test_begin_w_alternate_client(self):
         config.write_disposition = 'WRITE_TRUNCATE'
         job = self._make_one(self.JOB_ID, [source], destination, client1,
                              config)
-        job.begin(client=client2)
+        job._begin(client=client2)
 
         self.assertEqual(len(conn1._requested), 0)
         self.assertEqual(len(conn2._requested), 1)
@@ -1339,7 +1339,7 @@ def test_begin_w_bound_client(self):
         job = self._make_one(self.JOB_ID, source, [self.DESTINATION_URI],
                              client)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -1394,7 +1394,7 @@ def test_begin_w_alternate_client(self):
         job = self._make_one(self.JOB_ID, source, [self.DESTINATION_URI],
                              client1, job_config)
 
-        job.begin(client=client2)
+        job._begin(client=client2)
 
         self.assertEqual(len(conn1._requested), 0)
         self.assertEqual(len(conn2._requested), 1)
@@ -2243,7 +2243,7 @@ def test_begin_w_bound_client(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=config)
 
-        job.begin()
+        job._begin()
 
         self.assertIsNone(job.default_dataset)
         self.assertEqual(job.udf_resources, [])
@@ -2324,7 +2324,7 @@ def test_begin_w_alternate_client(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client1, job_config=config)
 
-        job.begin(client=client2)
+        job._begin(client=client2)
 
         self.assertEqual(len(conn1._requested), 0)
         self.assertEqual(len(conn2._requested), 1)
@@ -2373,7 +2373,7 @@ def test_begin_w_udf(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=config)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -2431,7 +2431,7 @@ def test_begin_w_named_query_parameter(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=jconfig)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -2486,7 +2486,7 @@ def test_begin_w_positional_query_parameter(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=jconfig)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -2572,7 +2572,7 @@ def test_begin_w_table_defs(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=config)
 
-        job.begin()
+        job._begin()
 
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]
@@ -2615,7 +2615,7 @@ def test_dry_run_query(self):
         job = self._make_one(
             self.JOB_ID, self.QUERY, client, job_config=config)
 
-        job.begin()
+        job._begin()
         self.assertEqual(job.udf_resources, [])
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]