Feat: Add api_key argument to Client constructor (#1441)

Author: andrewsg

google/cloud/storage/client.py

@@ -108,6 +108,12 @@ class Client(ClientWithProject):
  :param extra_headers:
  (Optional) Custom headers to be sent with the requests attached to the client.
  For example, you can add custom audit logging headers.
+
+ :type api_key: string
+ :param api_key:
+ (Optional) An API key. Mutually exclusive with any other credentials.
+ This parameter is an alias for setting `client_options.api_key` and
+ will supercede any api key set in the `client_options` parameter.
  """
 
  SCOPE = (
@@ -126,6 +132,8 @@ def __init__(
  client_options=None,
  use_auth_w_custom_endpoint=True,
  extra_headers={},
+ *,
+ api_key=None,
  ):
  self._base_connection = None
 
@@ -146,6 +154,17 @@ def __init__(
 
  connection_kw_args = {"client_info": client_info}
 
+ # api_key should set client_options.api_key. Set it here whether
+ # client_options was specified as a dict, as a ClientOptions object, or
+ # None.
+ if api_key:
+ if client_options and not isinstance(client_options, dict):
+ client_options.api_key = api_key
+ else:
+ if not client_options:
+ client_options = {}
+ client_options["api_key"] = api_key
+
  if client_options:
  if isinstance(client_options, dict):
  client_options = google.api_core.client_options.from_dict(

setup.py

@@ -30,7 +30,7 @@
 dependencies = [
  "google-auth >= 2.26.1, < 3.0dev",
  "google-api-core >= 2.15.0, <3.0.0dev",
- "google-cloud-core >= 2.3.0, < 3.0dev",
+ "google-cloud-core >= 2.4.2, < 3.0dev",
  # The dependency "google-resumable-media" is no longer used. However, the
  # dependency is still included here to accommodate users who may be
  # importing exception classes from the google-resumable-media without

tests/unit/test_client.py

@@ -191,6 +191,53 @@ def test_ctor_w_client_options_object(self):
  self.assertEqual(client._connection.API_BASE_URL, api_endpoint)
  self.assertEqual(client.api_endpoint, api_endpoint)
 
+ def test_ctor_w_api_key(self):
+ from google.auth.api_key import Credentials
+
+ PROJECT = "PROJECT"
+ api_key = "my_api_key"
+
+ client = self._make_one(project=PROJECT, api_key=api_key)
+
+ self.assertEqual(
+ client._connection.API_BASE_URL, client._connection.DEFAULT_API_ENDPOINT
+ )
+ self.assertIsInstance(client._credentials, Credentials)
+ self.assertEqual(client._credentials.token, api_key)
+
+ def test_ctor_w_api_key_and_client_options(self):
+ from google.auth.api_key import Credentials
+ from google.api_core.client_options import ClientOptions
+
+ PROJECT = "PROJECT"
+ api_key = "my_api_key"
+ api_endpoint = "https://www.foo-googleapis.com"
+ client_options = ClientOptions(api_endpoint=api_endpoint)
+
+ client = self._make_one(
+ project=PROJECT, client_options=client_options, api_key=api_key
+ )
+
+ self.assertEqual(client._connection.API_BASE_URL, api_endpoint)
+ self.assertIsInstance(client._credentials, Credentials)
+ self.assertEqual(client._credentials.token, api_key)
+
+ def test_ctor_w_api_key_and_client_dict(self):
+ from google.auth.api_key import Credentials
+
+ PROJECT = "PROJECT"
+ api_key = "my_api_key"
+ api_endpoint = "https://www.foo-googleapis.com"
+ client_options = {"api_endpoint": api_endpoint}
+
+ client = self._make_one(
+ project=PROJECT, client_options=client_options, api_key=api_key
+ )
+
+ self.assertEqual(client._connection.API_BASE_URL, api_endpoint)
+ self.assertIsInstance(client._credentials, Credentials)
+ self.assertEqual(client._credentials.token, api_key)
+
  def test_ctor_w_universe_domain_and_matched_credentials(self):
  PROJECT = "PROJECT"
  universe_domain = "example.com"