Skip to content

Commit df016c2

Browse files
authored
BigQuery: Make job.begin() method private. (#4242)
1 parent 61bb7a0 commit df016c2

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

bigquery/google/cloud/bigquery/client.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ def load_table_from_uri(self, source_uris, destination,
647647
if isinstance(source_uris, six.string_types):
648648
source_uris = [source_uris]
649649
job = LoadJob(job_id, source_uris, destination, self, job_config)
650-
job.begin(retry=retry)
650+
job._begin(retry=retry)
651651
return job
652652

653653
def load_table_from_file(self, file_obj, destination,
@@ -692,8 +692,7 @@ def load_table_from_file(self, file_obj, destination,
692692
:rtype: :class:`~google.cloud.bigquery.LoadJob`
693693
694694
:returns: the job instance used to load the data (e.g., for
695-
querying status). Note that the job is already started:
696-
do not call ``job.begin()``.
695+
querying status).
697696
:raises: :class:`ValueError` if ``size`` is not passed in and can not
698697
be determined, or if the ``file_obj`` can be detected to be
699698
a file opened in text mode.
@@ -862,7 +861,7 @@ def copy_table(self, sources, destination, job_id=None, job_id_prefix=None,
862861
sources = [sources]
863862
job = CopyJob(job_id, sources, destination, client=self,
864863
job_config=job_config)
865-
job.begin(retry=retry)
864+
job._begin(retry=retry)
866865
return job
867866

868867
def extract_table(
@@ -911,7 +910,7 @@ def extract_table(
911910
job = ExtractJob(
912911
job_id, source, destination_uris, client=self,
913912
job_config=job_config)
914-
job.begin(retry=retry)
913+
job._begin(retry=retry)
915914
return job
916915

917916
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,
945944
"""
946945
job_id = _make_job_id(job_id, job_id_prefix)
947946
job = QueryJob(job_id, query, client=self, job_config=job_config)
948-
job.begin(retry=retry)
947+
job._begin(retry=retry)
949948
return job
950949

951950
def create_rows(self, table, rows, selected_fields=None, **kwargs):

bigquery/google/cloud/bigquery/job.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ def _get_resource_config(cls, resource):
368368
config = resource['configuration'][cls._JOB_TYPE]
369369
return job_id, config
370370

371-
def begin(self, client=None, retry=DEFAULT_RETRY):
371+
def _begin(self, client=None, retry=DEFAULT_RETRY):
372372
"""API call: begin the job via a POST request
373373
374374
See
@@ -521,7 +521,7 @@ def result(self, timeout=None):
521521
given timeout.
522522
"""
523523
if self.state is None:
524-
self.begin()
524+
self._begin()
525525
# TODO: modify PollingFuture so it can pass a retry argument to done().
526526
return super(_AsyncJob, self).result(timeout=timeout)
527527

bigquery/tests/unit/test_job.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ def test_begin_w_already_running(self):
553553
job._properties['status'] = {'state': 'RUNNING'}
554554

555555
with self.assertRaises(ValueError):
556-
job.begin()
556+
job._begin()
557557

558558
def test_begin_w_bound_client(self):
559559
PATH = '/projects/%s/jobs' % (self.PROJECT,)
@@ -568,7 +568,7 @@ def test_begin_w_bound_client(self):
568568
job = self._make_one(self.JOB_ID, [self.SOURCE1], self.TABLE_REF,
569569
client)
570570

571-
job.begin()
571+
job._begin()
572572

573573
self.assertEqual(len(conn._requested), 1)
574574
req = conn._requested[0]
@@ -608,7 +608,7 @@ def test_begin_w_autodetect(self):
608608
config.autodetect = True
609609
job = self._make_one(self.JOB_ID, [self.SOURCE1], self.TABLE_REF,
610610
client, config)
611-
job.begin()
611+
job._begin()
612612

613613
sent = {
614614
'jobReference': {
@@ -688,7 +688,7 @@ def test_begin_w_alternate_client(self):
688688
config.source_format = 'CSV'
689689
config.write_disposition = 'WRITE_TRUNCATE'
690690

691-
job.begin(client=client2)
691+
job._begin(client=client2)
692692

693693
self.assertEqual(len(conn1._requested), 0)
694694
self.assertEqual(len(conn2._requested), 1)
@@ -1019,7 +1019,7 @@ def test_begin_w_bound_client(self):
10191019
destination = self._table_ref(self.DESTINATION_TABLE)
10201020
job = self._make_one(self.JOB_ID, [source], destination, client)
10211021

1022-
job.begin()
1022+
job._begin()
10231023

10241024
self.assertEqual(len(conn._requested), 1)
10251025
req = conn._requested[0]
@@ -1077,7 +1077,7 @@ def test_begin_w_alternate_client(self):
10771077
config.write_disposition = 'WRITE_TRUNCATE'
10781078
job = self._make_one(self.JOB_ID, [source], destination, client1,
10791079
config)
1080-
job.begin(client=client2)
1080+
job._begin(client=client2)
10811081

10821082
self.assertEqual(len(conn1._requested), 0)
10831083
self.assertEqual(len(conn2._requested), 1)
@@ -1339,7 +1339,7 @@ def test_begin_w_bound_client(self):
13391339
job = self._make_one(self.JOB_ID, source, [self.DESTINATION_URI],
13401340
client)
13411341

1342-
job.begin()
1342+
job._begin()
13431343

13441344
self.assertEqual(len(conn._requested), 1)
13451345
req = conn._requested[0]
@@ -1394,7 +1394,7 @@ def test_begin_w_alternate_client(self):
13941394
job = self._make_one(self.JOB_ID, source, [self.DESTINATION_URI],
13951395
client1, job_config)
13961396

1397-
job.begin(client=client2)
1397+
job._begin(client=client2)
13981398

13991399
self.assertEqual(len(conn1._requested), 0)
14001400
self.assertEqual(len(conn2._requested), 1)
@@ -2243,7 +2243,7 @@ def test_begin_w_bound_client(self):
22432243
job = self._make_one(
22442244
self.JOB_ID, self.QUERY, client, job_config=config)
22452245

2246-
job.begin()
2246+
job._begin()
22472247

22482248
self.assertIsNone(job.default_dataset)
22492249
self.assertEqual(job.udf_resources, [])
@@ -2324,7 +2324,7 @@ def test_begin_w_alternate_client(self):
23242324
job = self._make_one(
23252325
self.JOB_ID, self.QUERY, client1, job_config=config)
23262326

2327-
job.begin(client=client2)
2327+
job._begin(client=client2)
23282328

23292329
self.assertEqual(len(conn1._requested), 0)
23302330
self.assertEqual(len(conn2._requested), 1)
@@ -2373,7 +2373,7 @@ def test_begin_w_udf(self):
23732373
job = self._make_one(
23742374
self.JOB_ID, self.QUERY, client, job_config=config)
23752375

2376-
job.begin()
2376+
job._begin()
23772377

23782378
self.assertEqual(len(conn._requested), 1)
23792379
req = conn._requested[0]
@@ -2431,7 +2431,7 @@ def test_begin_w_named_query_parameter(self):
24312431
job = self._make_one(
24322432
self.JOB_ID, self.QUERY, client, job_config=jconfig)
24332433

2434-
job.begin()
2434+
job._begin()
24352435

24362436
self.assertEqual(len(conn._requested), 1)
24372437
req = conn._requested[0]
@@ -2486,7 +2486,7 @@ def test_begin_w_positional_query_parameter(self):
24862486
job = self._make_one(
24872487
self.JOB_ID, self.QUERY, client, job_config=jconfig)
24882488

2489-
job.begin()
2489+
job._begin()
24902490

24912491
self.assertEqual(len(conn._requested), 1)
24922492
req = conn._requested[0]
@@ -2572,7 +2572,7 @@ def test_begin_w_table_defs(self):
25722572
job = self._make_one(
25732573
self.JOB_ID, self.QUERY, client, job_config=config)
25742574

2575-
job.begin()
2575+
job._begin()
25762576

25772577
self.assertEqual(len(conn._requested), 1)
25782578
req = conn._requested[0]
@@ -2615,7 +2615,7 @@ def test_dry_run_query(self):
26152615
job = self._make_one(
26162616
self.JOB_ID, self.QUERY, client, job_config=config)
26172617

2618-
job.begin()
2618+
job._begin()
26192619
self.assertEqual(job.udf_resources, [])
26202620
self.assertEqual(len(conn._requested), 1)
26212621
req = conn._requested[0]

0 commit comments

Comments
 (0)