From d2cf17dfbadd8c756e81c3507e9e1b158fe0313f Mon Sep 17 00:00:00 2001 From: Mario Torres Jr Date: Tue, 17 Jan 2023 13:47:31 -0600 Subject: [PATCH 1/2] docs: revise delete label table code sample, add TODO to clean up snippets.py --- docs/snippets.py | 2 + samples/snippets/delete_label_table.py | 43 +++++++++++++++++++++ samples/snippets/delete_label_table_test.py | 34 ++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 samples/snippets/delete_label_table.py create mode 100644 samples/snippets/delete_label_table_test.py diff --git a/docs/snippets.py b/docs/snippets.py index 85856eb3e..eca2b1353 100644 --- a/docs/snippets.py +++ b/docs/snippets.py @@ -203,6 +203,8 @@ def test_manage_table_labels(client, to_delete): # [END bigquery_get_table_labels] assert table.labels == labels + # TODO(Mattix23): After code sample is updated from cloud.google.com delete this + # [START bigquery_delete_label_table] # from google.cloud import bigquery # client = bigquery.Client() diff --git a/samples/snippets/delete_label_table.py b/samples/snippets/delete_label_table.py new file mode 100644 index 000000000..0e9eaaf8f --- /dev/null +++ b/samples/snippets/delete_label_table.py @@ -0,0 +1,43 @@ +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from google.cloud import bigquery + + +def delete_label_table(table_id: str, label_key: str) -> bigquery.Table: + orig_table_id = table_id + orig_label_key = label_key + # [START bigquery_delete_label_table] + from google.cloud import bigquery + + client = bigquery.Client() + + # TODO(dev): Change table_id to the full name of the table you wish to delete from. + table_id = "your-project.your_dataset.your_table_name" + # TODO(dev): Change label_key to the name of the label you want to remove. + label_key = "color" + # [END bigquery_delete_label_table] + table_id = orig_table_id + label_key = orig_label_key + # [START bigquery_delete_label_table] + table = client.get_table(table_id) # API request + + # To delete a label from a table, set its value to None + table.labels[label_key] = None + + table = client.update_table(table, ["labels"]) # API request + + print(f"Deleted label '{label_key}' from {table_id}.") + # [END bigquery_delete_label_table] + return table diff --git a/samples/snippets/delete_label_table_test.py b/samples/snippets/delete_label_table_test.py new file mode 100644 index 000000000..ef8bdbacc --- /dev/null +++ b/samples/snippets/delete_label_table_test.py @@ -0,0 +1,34 @@ +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import typing + +import delete_label_table + +if typing.TYPE_CHECKING: + import pytest + + +def test_label_table( + capsys: "pytest.CaptureFixture[str]", + table_id: str, +) -> None: + + table = delete_label_table.delete_label_table(table_id, "color") + + out, _ = capsys.readouterr() + assert "Deleted" in out + assert "color" in out + assert table_id in out + assert table.labels is None or "color" not in table.labels From 3354812b31d515651336dd438e7a4df6e75fbe7b Mon Sep 17 00:00:00 2001 From: Mario Torres Jr Date: Tue, 17 Jan 2023 13:52:31 -0600 Subject: [PATCH 2/2] changed name of test function to align with file name --- samples/snippets/delete_label_table_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/delete_label_table_test.py b/samples/snippets/delete_label_table_test.py index ef8bdbacc..54acae77f 100644 --- a/samples/snippets/delete_label_table_test.py +++ b/samples/snippets/delete_label_table_test.py @@ -20,7 +20,7 @@ import pytest -def test_label_table( +def test_delete_label_table( capsys: "pytest.CaptureFixture[str]", table_id: str, ) -> None: