google-genai 1.56.0__py3-none-any.whl → 1.58.0__py3-none-any.whl

google/genai/tests/client/test_client_requests.py

@@ -0,0 +1,221 @@
+# Copyright 2025 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.
+#
+
+
+"""Tests for client behavior when issuing requests."""
+
+from ... import _api_client as api_client
+from ... import Client
+from ... import types
+
+
+def build_test_client(monkeypatch):
+  monkeypatch.setenv('GOOGLE_API_KEY', 'google_api_key')
+  return Client()
+
+
+def test_join_url_path_base_url_with_trailing_slash_and_path_with_leading_slash():
+  base_url = 'https://fake-url.com/some_path/'
+  path = '/v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/some_path/v1beta/models'
+  )
+
+
+def test_join_url_path_with_base_url_with_trailing_slash_and_path_without_leading_slash():
+  base_url = 'https://fake-url.com/some_path/'
+  path = 'v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/some_path/v1beta/models'
+  )
+
+
+def test_join_url_path_with_base_url_without_trailing_slash_and_path_with_leading_slash():
+  base_url = 'https://fake-url.com/some_path'
+  path = '/v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/some_path/v1beta/models'
+  )
+
+
+def test_join_url_path_with_base_url_without_trailing_slash_and_path_without_leading_slash():
+  base_url = 'https://fake-url.com/some_path'
+  path = 'v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/some_path/v1beta/models'
+  )
+
+
+def test_join_url_path_base_url_without_path_with_trailing_slash():
+  base_url = 'https://fake-url.com/'
+  path = 'v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/v1beta/models'
+  )
+
+
+def test_join_url_path_base_url_without_path_without_trailing_slash():
+  base_url = 'https://fake-url.com'
+  path = 'v1beta/models'
+  assert (
+      api_client.join_url_path(base_url, path)
+      == 'https://fake-url.com/v1beta/models'
+  )
+
+
+def test_build_request_sets_library_version_headers(monkeypatch):
+  request_client = build_test_client(monkeypatch).models._api_client
+  request = request_client._build_request('GET', 'test/path', {'key': 'value'})
+  assert 'google-genai-sdk/' in request.headers['user-agent']
+  assert 'gl-python/' in request.headers['user-agent']
+  assert 'google-genai-sdk/' in request.headers['x-goog-api-client']
+  assert 'gl-python/' in request.headers['x-goog-api-client']
+
+
+def test_build_request_appends_to_user_agent_headers(monkeypatch):
+  request_client = build_test_client(monkeypatch).models._api_client
+  request = request_client._build_request(
+      'GET',
+      'test/path',
+      {'key': 'value'},
+      types.HttpOptionsDict(
+          base_url='test/url',
+          api_version='1',
+          headers={'user-agent': 'test-user-agent'},
+      ),
+  )
+  assert 'test-user-agent' in request.headers['user-agent']
+  assert 'google-genai-sdk/' in request.headers['user-agent']
+  assert 'gl-python/' in request.headers['user-agent']
+  assert 'google-genai-sdk/' in request.headers['x-goog-api-client']
+
+
+def test_build_request_appends_to_goog_api_client_headers(monkeypatch):
+  request_client = build_test_client(monkeypatch).models._api_client
+  request = request_client._build_request(
+      'GET',
+      'test/path',
+      {'key': 'value'},
+      types.HttpOptionsDict(
+          base_url='test/url',
+          api_version='1',
+          headers={'x-goog-api-client': 'test-goog-api-client'},
+      ),
+  )
+  assert 'google-genai-sdk/' in request.headers['user-agent']
+  assert 'test-goog-api-client' in request.headers['x-goog-api-client']
+  assert 'google-genai-sdk/' in request.headers['x-goog-api-client']
+  assert 'gl-python/' in request.headers['x-goog-api-client']
+
+
+def test_build_request_keeps_sdk_version_headers(monkeypatch):
+  headers_to_inject = {}
+  api_client.append_library_version_headers(headers_to_inject)
+  assert 'google-genai-sdk/' in headers_to_inject['user-agent']
+  request_client = build_test_client(monkeypatch).models._api_client
+  request = request_client._build_request(
+      'GET',
+      'test/path',
+      {'key': 'value'},
+      types.HttpOptionsDict(
+          base_url='test/url',
+          api_version='1',
+          headers=headers_to_inject,
+      ),
+  )
+  assert 'google-genai-sdk/' in request.headers['user-agent']
+  assert 'gl-python/' in request.headers['x-goog-api-client']
+  assert 'google-genai-sdk/' in request.headers['x-goog-api-client']
+  assert 'gl-python/' in request.headers['x-goog-api-client']
+
+
+def test_build_request_with_resource_scope(monkeypatch):
+  monkeypatch.delenv('GOOGLE_API_KEY', raising=False)
+  monkeypatch.delenv('GEMINI_API_KEY', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_PROJECT', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_LOCATION', raising=False)
+
+  client = Client(
+      vertexai=True,
+      http_options=types.HttpOptionsDict(
+          base_url='https://custom-base-url.com',
+          base_url_resource_scope=types.ResourceScope.COLLECTION,
+      ),
+  )
+
+  request = client.models._api_client._build_request(
+      'post',
+      'publishers/google/models/gemini-3-pro-preview',
+      {'key': 'value'},
+  )
+  assert request.url == 'https://custom-base-url.com/publishers/google/models/gemini-3-pro-preview'
+
+
+def test_build_request_with_resource_scope_with_project_and_location(
+    monkeypatch,
+):
+  monkeypatch.delenv('GOOGLE_API_KEY', raising=False)
+  monkeypatch.delenv('GEMINI_API_KEY', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_PROJECT', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_LOCATION', raising=False)
+
+  client = Client(
+      vertexai=True,
+      project='test-project',
+      location='test-location',
+      http_options=types.HttpOptionsDict(
+          base_url='https://custom-base-url.com',
+          base_url_resource_scope=types.ResourceScope.COLLECTION,
+      ),
+  )
+
+  request = client.models._api_client._build_request(
+      'post',
+      'publishers/google/models/gemini-3-pro-preview',
+      {'key': 'value'},
+  )
+  assert request.url == 'https://custom-base-url.com/publishers/google/models/gemini-3-pro-preview'
+
+
+
+def build_test_client_no_env_vars(monkeypatch):
+  monkeypatch.delenv('GOOGLE_API_KEY', raising=False)
+  monkeypatch.delenv('GEMINI_API_KEY', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_PROJECT', raising=False)
+  monkeypatch.delenv('GOOGLE_CLOUD_LOCATION', raising=False)
+  return Client(
+      vertexai=True,
+      http_options=types.HttpOptionsDict(
+          base_url='https://custom-base-url.com',
+          headers={'Authorization': 'Bearer fake_access_token'},
+      ),
+    )
+
+
+def test_build_request_with_custom_base_url_no_env_vars(monkeypatch):
+  request_client = (
+      build_test_client_no_env_vars(monkeypatch).models._api_client
+  )
+  request = request_client._build_request(
+      'GET',
+      'test/path',
+      {'key': 'value'},
+  )
+  assert request.url == 'https://custom-base-url.com'

google/genai/tests/client/test_custom_client.py

@@ -0,0 +1,104 @@
+# Copyright 2025 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.
+#
+
+"""Tests for custom clients."""
+import asyncio
+from unittest import mock
+
+from google.oauth2 import credentials
+import httpx
+import pytest
+
+from ... import _api_client as api_client
+from ... import Client
+
+
+try:
+  import aiohttp
+
+  AIOHTTP_NOT_INSTALLED = False
+except ImportError:
+  AIOHTTP_NOT_INSTALLED = True
+  aiohttp = mock.MagicMock()
+
+requires_aiohttp = pytest.mark.skipif(
+    AIOHTTP_NOT_INSTALLED, reason='aiohttp is not installed, skipping test.'
+)
+
+
+# Httpx
+def test_constructor_with_httpx_clients():
+  mldev_http_options = {
+      'httpx_client': httpx.Client(trust_env=False),
+      'httpx_async_client': httpx.AsyncClient(trust_env=False),
+  }
+  vertexai_http_options = {
+      'httpx_client': httpx.Client(trust_env=False),
+      'httpx_async_client': httpx.AsyncClient(trust_env=False),
+  }
+
+  # Even if aiohttp is installed, expect it to be disabled when httpx clients
+  # are provided.
+  api_client.has_aiohttp = True
+
+  mldev_client = Client(
+      api_key='google_api_key', http_options=mldev_http_options
+  )
+  assert not mldev_client.models._api_client._httpx_client.trust_env
+  assert not mldev_client.models._api_client._async_httpx_client.trust_env
+  # Expect aiohttp to be disabled when httpx clients are provided, regardless of
+  # whether aiohttp is installed.
+  assert not mldev_client.models._api_client._use_aiohttp()
+
+  vertexai_client = Client(
+      vertexai=True,
+      project='fake_project_id',
+      location='fake-location',
+      http_options=vertexai_http_options,
+  )
+  assert not vertexai_client.models._api_client._httpx_client.trust_env
+  assert not vertexai_client.models._api_client._async_httpx_client.trust_env
+  # Expect aiohttp to be disabled when httpx clients are provided, regardless of
+  # whether aiohttp is installed.
+  assert not mldev_client.models._api_client._use_aiohttp()
+
+
+# Aiohttp
+@requires_aiohttp
+@pytest.mark.asyncio
+@pytest.mark.skipif(
+    AIOHTTP_NOT_INSTALLED, reason='aiohttp is not installed, skipping test.'
+)
+async def test_constructor_with_aiohttp_clients():
+  api_client.has_aiohttp = True
+  mldev_http_options = {
+      'aiohttp_client': aiohttp.ClientSession(trust_env=False),
+  }
+  vertexai_http_options = {
+      'aiohttp_client': aiohttp.ClientSession(trust_env=False),
+  }
+  mldev_client = Client(
+      api_key='google_api_key', http_options=mldev_http_options
+  )
+  assert not mldev_client.models._api_client._aiohttp_session.trust_env
+
+  vertexai_client = Client(
+      vertexai=True,
+      project='fake_project_id',
+      location='fake-location',
+      http_options=vertexai_http_options,
+  )
+  assert not vertexai_client.models._api_client._aiohttp_session.trust_env
+

google/genai/tests/client/test_http_options.py

@@ -0,0 +1,178 @@
+# Copyright 2025 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.
+#
+
+
+"""Tests for client behavior when issuing requests."""
+
+import pytest
+
+from ... import _api_client
+from ... import types
+
+
+def test_patch_http_options_with_copies_all_fields():
+  patch_options = types.HttpOptions(
+      base_url='https://fake-url.com/',
+      api_version='v1',
+      headers={'X-Custom-Header': 'custom_value'},
+      timeout=10000,
+      client_args={'http2': True},
+      async_client_args={'http1': True},
+      extra_body={'key': 'value'},
+      retry_options=types.HttpRetryOptions(attempts=10),
+      base_url_resource_scope=types.ResourceScope.COLLECTION,
+  )
+  options = types.HttpOptions()
+  patched = _api_client.patch_http_options(options, patch_options)
+  http_options_keys = types.HttpOptions.model_fields.keys()
+
+  for key in http_options_keys:
+    assert hasattr(patched, key)
+    if key not in ['httpx_client', 'httpx_async_client', 'aiohttp_client']:
+      assert getattr(patched, key) is not None
+  assert patched.base_url == 'https://fake-url.com/'
+  assert patched.api_version == 'v1'
+  assert patched.headers['X-Custom-Header'] == 'custom_value'
+  assert patched.timeout == 10000
+  assert patched.retry_options.attempts == 10
+  assert patched.client_args['http2']
+  assert patched.async_client_args['http1']
+
+
+def test_patch_http_options_merges_headers():
+  original_options = types.HttpOptions(
+      headers={
+          'X-Custom-Header': 'different_value',
+          'X-different-header': 'different_value',
+      }
+  )
+  patch_options = types.HttpOptions(
+      base_url='https://fake-url.com/',
+      api_version='v1',
+      headers={'X-Custom-Header': 'custom_value'},
+      timeout=10000,
+  )
+  patched = _api_client.patch_http_options(original_options, patch_options)
+  # If the header is present in both the original and patch options, the patch
+  # options value should be used
+  assert patched.headers['X-Custom-Header'] == 'custom_value'
+  assert patched.headers['X-different-header'] == 'different_value'
+  assert patched.base_url == 'https://fake-url.com/'
+  assert patched.api_version == 'v1'
+  assert patched.timeout == 10000
+
+
+def test_patch_http_options_appends_version_headers():
+  original_options = types.HttpOptions(
+      headers={
+          'X-Custom-Header': 'different_value',
+          'X-different-header': 'different_value',
+      }
+  )
+  patch_options = types.HttpOptions(
+      base_url='https://fake-url.com/',
+      api_version='v1',
+      headers={'X-Custom-Header': 'custom_value'},
+      timeout=10000,
+  )
+  patched = _api_client.patch_http_options(original_options, patch_options)
+  assert 'user-agent' in patched.headers
+  assert 'x-goog-api-client' in patched.headers
+
+
+def test_setting_timeout_populates_server_timeout_header():
+  api_client = _api_client.BaseApiClient(
+      vertexai=False,
+      api_key='test_api_key',
+      http_options=types.HttpOptions(timeout=10000),
+  )
+  request = api_client._build_request(
+      http_method='POST',
+      path='sample/path',
+      request_dict={},
+  )
+  assert 'X-Server-Timeout' in request.headers
+  assert request.headers['X-Server-Timeout'] == '10'
+
+
+def test_timeout_rounded_to_nearest_second():
+  api_client = _api_client.BaseApiClient(
+      vertexai=False,
+      api_key='test_api_key',
+  )
+  http_options = types.HttpOptions(timeout=7300)
+  request = api_client._build_request(
+      http_method='POST',
+      path='sample/path',
+      request_dict={},
+      http_options=http_options,
+  )
+  assert request.headers['X-Server-Timeout'] == '8'
+
+
+def test_server_timeout_not_overwritten():
+  api_client = _api_client.BaseApiClient(
+      vertexai=False,
+      api_key='test_api_key',
+  )
+  http_options = types.HttpOptions(
+      headers={'X-Server-Timeout': '3'},
+      timeout=11000)
+  request = api_client._build_request(
+      http_method='POST',
+      path='sample/path',
+      request_dict={},
+      http_options=http_options,
+  )
+  assert request.headers['X-Server-Timeout'] == '3'
+
+
+def test_server_timeout_not_set_by_default():
+  api_client = _api_client.BaseApiClient(
+      vertexai=False,
+      api_key='test_api_key',
+  )
+  request = api_client._build_request(
+      http_method='POST',
+      path='sample/path',
+      request_dict={},
+  )
+  assert not 'X-Server-Timeout' in request.headers
+
+
+def test_resource_scope_without_base_url_raises_error():
+  with pytest.raises(ValueError):
+    _api_client.BaseApiClient(
+        vertexai=True,
+        http_options=types.HttpOptions(
+            base_url_resource_scope=types.ResourceScope.COLLECTION,
+        ),
+    )
+
+
+def test_base_url_resource_scope_not_set_by_default():
+  api_client = _api_client.BaseApiClient(
+      vertexai=True,
+      http_options=types.HttpOptions(
+          base_url='https://fake-url.com/',
+      ),
+  )
+
+  assert api_client._http_options.base_url_resource_scope is None
+
+
+def test_retry_options_not_set_by_default():
+  options = types.HttpOptions()
+  assert options.retry_options is None

google/genai/tests/client/test_replay_client_equality.py

@@ -0,0 +1,168 @@
+# Copyright 2025 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.
+#
+
+
+"""Tests replay client correctly compares requests ignoring key casing."""
+
+from ... import _replay_api_client
+from ... import types
+
+
+def test_equal_objects_with_same_casing_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 2.0, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 2.0, 'maxOutputTokens': 3},
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+
+def test_equal_objects_with_different_casing_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 2.0, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {'topK': 2.0, 'max_output_tokens': 3},
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+
+def test_equal_objects_with_different_nested_casing_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 2.0, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'top_k': 2.0, 'maxOutputTokens': 3},
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+def test_equal_int_float_values_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 2.0, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {'topK': 2, 'max_output_tokens': 3},
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+
+def test_equal_enum_string_values_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {
+          'topK': 2.0,
+          'maxOutputTokens': 3,
+          'type': types.Type.STRING,
+      },
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {
+          'topK': 2,
+          'max_output_tokens': 3,
+          'type': 'STRING',
+      },
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+
+def test_equal_enum_values_returns_true():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {
+          'topK': 2.0,
+          'maxOutputTokens': 3,
+          'type': types.Type.STRING,
+      },
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {
+          'topK': 2,
+          'max_output_tokens': 3,
+          'type': types.Type.STRING,
+      },
+  }]
+
+  assert _replay_api_client._equals_ignore_key_case(obj1, obj2)
+
+
+def test_different_number_value_returns_false():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 3, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {'topK': 2.0, 'max_output_tokens': 3},
+  }]
+
+  assert not _replay_api_client._equals_ignore_key_case(
+      obj1, obj2
+  )
+
+
+def test_different_string_value_returns_false():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {'topK': 3, 'maxOutputTokens': 3},
+  }]
+  obj2 = [{
+      'contents': [
+          {'parts': [{'text': 'What is your name?'}], 'role': 'model'}
+      ],
+      'generation_config': {'topK': 3, 'max_output_tokens': 3},
+  }]
+
+  assert not _replay_api_client._equals_ignore_key_case(
+      obj1, obj2
+  )
+
+
+def test_different_enum_values_returns_false():
+  obj1 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generationConfig': {
+          'topK': 2.0,
+          'maxOutputTokens': 3,
+          'type': types.Type.STRING,
+      },
+  }]
+  obj2 = [{
+      'contents': [{'parts': [{'text': 'What is your name?'}], 'role': 'user'}],
+      'generation_config': {
+          'topK': 2,
+          'max_output_tokens': 3,
+          'type': types.Type.OBJECT,
+      },
+  }]
+
+  assert not _replay_api_client._equals_ignore_key_case(
+      obj1, obj2
+  )