From 80944f080bcc4fda870a6daf1d884de616d39ae7 Mon Sep 17 00:00:00 2001 From: Peter Lamut Date: Thu, 14 Jan 2021 16:59:26 +0100 Subject: [PATCH] fix: reading the labels attribute on Job instances (#471) --- google/cloud/bigquery/job/base.py | 7 +++---- tests/system.py | 17 +++++++++++++++++ tests/unit/job/test_base.py | 2 +- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/google/cloud/bigquery/job/base.py b/google/cloud/bigquery/job/base.py index 930b71e8a..5ba01aa67 100644 --- a/google/cloud/bigquery/job/base.py +++ b/google/cloud/bigquery/job/base.py @@ -233,7 +233,7 @@ def path(self): @property def labels(self): """Dict[str, str]: Labels for the job.""" - return self._properties.setdefault("labels", {}) + return self._properties.setdefault("configuration", {}).setdefault("labels", {}) @property def etag(self): @@ -671,9 +671,8 @@ def __setattr__(self, name, value): def labels(self): """Dict[str, str]: Labels for the job. - This method always returns a dict. To change a job's labels, - modify the dict, then call ``Client.update_job``. To delete a - label, set its value to :data:`None` before updating. + This method always returns a dict. Once a job has been created on the + server, its labels cannot be modified anymore. Raises: ValueError: If ``value`` type is invalid. diff --git a/tests/system.py b/tests/system.py index 447f66b1a..0fa5bc41e 100644 --- a/tests/system.py +++ b/tests/system.py @@ -1667,6 +1667,23 @@ def test_job_cancel(self): # raise an error, and that the job completed (in the `retry()` # above). + def test_job_labels(self): + DATASET_ID = _make_dataset_id("job_cancel") + JOB_ID_PREFIX = "fetch_" + DATASET_ID + QUERY = "SELECT 1 as one" + + self.temp_dataset(DATASET_ID) + + job_config = bigquery.QueryJobConfig( + labels={"custom_label": "label_value", "another_label": "foo123"} + ) + job = Config.CLIENT.query( + QUERY, job_id_prefix=JOB_ID_PREFIX, job_config=job_config + ) + + expected_labels = {"custom_label": "label_value", "another_label": "foo123"} + self.assertEqual(job.labels, expected_labels) + def test_get_failed_job(self): # issue 4246 from google.api_core.exceptions import BadRequest diff --git a/tests/unit/job/test_base.py b/tests/unit/job/test_base.py index 610ad2875..44bbc2c77 100644 --- a/tests/unit/job/test_base.py +++ b/tests/unit/job/test_base.py @@ -251,7 +251,7 @@ def test_labels_hit(self): labels = {"foo": "bar"} client = _make_client(project=self.PROJECT) job = self._make_one(self.JOB_ID, client) - job._properties["labels"] = labels + job._properties.setdefault("configuration", {})["labels"] = labels self.assertEqual(job.labels, labels) def test_etag(self):