-
Notifications
You must be signed in to change notification settings - Fork 315
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
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7de81df
docs: revise get table labels code sample, add TODO to clean up snipp…
Mattix23 3ce25cd
added a test with labels
Mattix23 b9962d2
Update samples/snippets/get_table_labels_test.py
tswast 8c3b264
Merge branch 'main' into issue790-get_table_label
tswast File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
Mattix23 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
assert table_id in out |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.