Skip to content

docs: revise get table labels code sample, add TODO to clean up snipp… #1464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ def test_manage_table_labels(client, to_delete):
table.labels = labels
table = client.create_table(table)

# TODO(Mattix23): After code sample is updated from cloud.google.com delete this

# [START bigquery_get_table_labels]
# from google.cloud import bigquery
# client = bigquery.Client()
Expand Down
39 changes: 39 additions & 0 deletions samples/snippets/get_table_labels.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 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.


def get_table_labels(table_id: str) -> None:
orig_table_id = table_id
# [START bigquery_get_table_labels]
from google.cloud import bigquery

client = bigquery.Client()

# TODO(dev): Change table_id to the full name of the table you want to create.
table_id = "your-project.your_dataset.your_table_name"

# [END bigquery_get_table_labels]
table_id = orig_table_id

# [START bigquery_get_table_labels]
table = client.get_table(table_id) # API Request

# View table labels
print(f"Table ID: {table_id}.")
if table.labels:
for label, value in table.labels.items():
print(f"\t{label}: {value}")
else:
print("\tTable has no labels defined.")
# [END bigquery_get_table_labels]
50 changes: 50 additions & 0 deletions samples/snippets/get_table_labels_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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

from google.cloud import bigquery

import get_table_labels

if typing.TYPE_CHECKING:
import pytest


def test_get_table_labels(
capsys: "pytest.CaptureFixture[str]",
table_id: str,
bigquery_client: bigquery.Client,
) -> None:
table = bigquery_client.get_table(table_id)
table.labels = {"color": "green"}
bigquery_client.update_table(table, ["labels"])

get_table_labels.get_table_labels(table_id)

out, _ = capsys.readouterr()
assert table_id in out
assert "color" in out


def test_get_table_labels_no_label(
capsys: "pytest.CaptureFixture[str]",
table_id: str,
) -> None:

get_table_labels.get_table_labels(table_id)

out, _ = capsys.readouterr()
assert "no labels defined" in out
assert table_id in out