Skip to content
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

add example of creating AutoML Tables client with non-default endpoint ('new' sdk) #3929

Merged
merged 8 commits into from
Jun 5, 2020
Merged
30 changes: 30 additions & 0 deletions tables/automl/automl_tables_set_endpoint.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Copyright 2020 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
#
# http://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 create_client_with_endpoint(gcp_project_id):
"""Create a Tables client with a non-default endpoint."""
# [START automl_set_endpoint]
from google.cloud import automl_v1beta1 as automl
from google.api_core.client_options import ClientOptions

# Set the endpoint you want to use via the ClientOptions.
# gcp_project_id = 'YOUR_PROJECT_ID'
client_options = ClientOptions(api_endpoint="eu-automl.googleapis.com:443")
client = automl.TablesClient(
project=gcp_project_id, region="eu", client_options=client_options
)
# [END automl_set_endpoint]

return client
27 changes: 27 additions & 0 deletions tables/automl/endpoint_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/usr/bin/env python

# Copyright 2020 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
#
# http://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 os

import automl_tables_set_endpoint

PROJECT = os.environ["GCLOUD_PROJECT"]


def test_client_creation(capsys):
client = automl_tables_set_endpoint.create_client_with_endpoint(PROJECT)
print(client.list_datasets())
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to have the create_client_with_endpoint method print something, and then assert on your print? Then, you would be testing your sample, rather than the actual AutoML underlying function.

Also, if testing is something you're not 100% comfortable with, do feel free to put some time on my calendar and we can take 20-30 min to have a faster back and forth about what you think is most appropriate for this sample :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to @leahecole 's suggestion.

For the set endpoint kind of samples, we typically use a really simple API call to verify that the client was created and operates correctly.

See example here.

I suggest copying the output of the regular Tables list_datasets sample.

Copy link
Contributor Author

@amygdala amygdala Jun 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, no need to check anything re: the 'list_datasets' output specifics. There may or may not be any defined, but the details aren't relevant here. (I picked that call arbitrarily as a simple connectivity check, so I don't think that sample is particularly relevant).

In fact, I think we can remove an assertion on the output altogether-- if the call fails, it will throw an exception, which will fail the test. Would you prefer the test explicitly catch the exception + then raise an error, or just let it be thrown?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to just executing list_datasets since the goal is to check that the client was constructed correctly.

out, _ = capsys.readouterr()
assert "GRPCIterator" in out
dinagraves marked this conversation as resolved.
Show resolved Hide resolved