-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Core: Add client options. #8265
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
8fc5a12
Add ClientOptions class to api_core.
busunkim96 e56133a
Modify IoT to respect api_endpoint in client options.
busunkim96 6e74647
Blacken.
busunkim96 17caa54
Fix incorrect type in docstring.
busunkim96 be73bba
Fix lint, raise coverage to 100.
busunkim96 fc8e1a5
Use named arguments, add method to construct client_options from dict.
busunkim96 2f448b6
Fix typo in device_manager_client.
busunkim96 4447da0
Update test_client_options.py
busunkim96 8c6af56
Revert iot changes.
busunkim96 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 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,48 @@ | ||
# Copyright 2019 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. | ||
|
||
"""Client options class. | ||
|
||
Client options provide a consistent interface for user options to be defined | ||
across clients. | ||
""" | ||
|
||
|
||
class ClientOptions(object): | ||
"""Client Options used to set options on clients. | ||
|
||
Args: | ||
api_endpoint (str): The desired API endpoint, e.g., compute.googleapis.com | ||
""" | ||
|
||
def __init__(self, api_endpoint=None): | ||
self.api_endpoint = api_endpoint | ||
|
||
|
||
def from_dict(options): | ||
"""Construct a client options object from a dictionary. | ||
|
||
Args: | ||
options (dict): A dictionary with client options. | ||
""" | ||
|
||
client_options = ClientOptions() | ||
|
||
for key, value in options.items(): | ||
if hasattr(client_options, key): | ||
setattr(client_options, key, value) | ||
else: | ||
raise ValueError("ClientOptions does not accept an option '" + key + "'") | ||
|
||
return client_options |
This file contains 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,36 @@ | ||
# Copyright 2019 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 pytest | ||
|
||
from google.api_core import client_options | ||
|
||
|
||
def test_constructor(): | ||
options = client_options.ClientOptions(api_endpoint="foo.googleapis.com") | ||
|
||
assert options.api_endpoint == "foo.googleapis.com" | ||
|
||
|
||
def test_from_dict(): | ||
options = client_options.from_dict({"api_endpoint": "foo.googleapis.com"}) | ||
|
||
assert options.api_endpoint == "foo.googleapis.com" | ||
|
||
|
||
def test_from_dict_bad_argument(): | ||
with pytest.raises(ValueError): | ||
client_options.from_dict( | ||
{"api_endpoint": "foo.googleapis.com", "bad_arg": "1234"} | ||
) |
This file contains 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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
# Generated by synthtool. DO NOT EDIT! | ||
[run] | ||
branch = True | ||
|
||
|
This file contains 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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
# Generated by synthtool. DO NOT EDIT! | ||
[flake8] | ||
ignore = E203, E266, E501, W503 | ||
exclude = | ||
|
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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 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 |
---|---|---|
@@ -1,2 +1,3 @@ | ||
# Generated by synthtool. DO NOT EDIT! | ||
[bdist_wheel] | ||
universal = 1 |
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would allow users to do something like:
client = pubsub_v1.PublisherClient(client_options={"api_endpoint": "...", "user_project": "..."})