python-google-weather-api 0.0.8__tar.gz → 0.0.9__tar.gz

{python_google_weather_api-0.0.8/src/python_google_weather_api.egg-info → python_google_weather_api-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-google-weather-api
-Version: 0.0.8
+Version: 0.0.9
 Summary: A python client library for Google Weather API
 Author-email: tronikos <tronikos@gmail.com>
 License-Expression: Apache-2.0

{python_google_weather_api-0.0.8 → python_google_weather_api-0.0.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-google-weather-api"
-version = "0.0.8"
+version = "0.0.9"
 license = "Apache-2.0"
 authors = [
     { name="tronikos", email="tronikos@gmail.com" },

{python_google_weather_api-0.0.8 → python_google_weather_api-0.0.9}/src/google_weather_api/api.py

@@ -23,6 +23,8 @@ from .model import (
 _LOGGER = logging.getLogger(__name__)
 
 _BASE_URL = "https://weather.googleapis.com/v1"
+# See https://docs.cloud.google.com/docs/authentication/api-keys-use
+_API_KEY_HEADER = "X-Goog-Api-Key"
 _USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36"
 
 
@@ -49,7 +51,10 @@ class GoogleWeatherApi:
     async def _async_get(self, endpoint: str, params: dict[str, Any], *, include_language_code: bool = True) -> dict[str, Any]:
         """Perform a GET request."""
         url = f"{_BASE_URL}/{endpoint}"
-        headers = {aiohttp.hdrs.USER_AGENT: _USER_AGENT}
+        # Send the API key in a header rather than the "key" query parameter so it
+        # never ends up in a URL, which aiohttp includes in exceptions such as
+        # ContentTypeError and which callers commonly log.
+        headers = {aiohttp.hdrs.USER_AGENT: _USER_AGENT, _API_KEY_HEADER: self.api_key}
         if self.referrer:
             headers[aiohttp.hdrs.REFERER] = self.referrer
         params = {
@@ -58,9 +63,7 @@ class GoogleWeatherApi:
         }
         if include_language_code:
             params["language_code"] = self.language_code
-        # Log before adding the API key so it doesn't end up in debug logs.
         _LOGGER.debug("GET %s with params: %s", url, params)
-        params["key"] = self.api_key
         try:
             async with self.session.get(
                 url,

{python_google_weather_api-0.0.8 → python_google_weather_api-0.0.9/src/python_google_weather_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-google-weather-api
-Version: 0.0.8
+Version: 0.0.9
 Summary: A python client library for Google Weather API
 Author-email: tronikos <tronikos@gmail.com>
 License-Expression: Apache-2.0

{python_google_weather_api-0.0.8 → python_google_weather_api-0.0.9}/tests/test_api.py

@@ -41,7 +41,8 @@ async def test_request_params_and_headers(api: GoogleWeatherApi, mock_server: Mo
     await api.async_get_current_conditions(LATITUDE, LONGITUDE)
 
     request = mock_server.requests[0]
-    assert request.query["key"] == API_KEY
+    assert request.headers["X-Goog-Api-Key"] == API_KEY
+    assert "key" not in request.query
     assert request.query["location.latitude"] == str(LATITUDE)
     assert request.query["location.longitude"] == str(LONGITUDE)
     assert request.query["language_code"] == "en"
@@ -126,7 +127,7 @@ async def test_get_hourly_forecast_follows_pagination(api: GoogleWeatherApi, moc
     assert first.query["hours"] == "4"
     assert second.query["page_token"] == page1["nextPageToken"]
     assert second.query["hours"] == "4"
-    assert second.query["key"] == API_KEY
+    assert second.headers["X-Goog-Api-Key"] == API_KEY
 
 
 async def test_hourly_forecast_stops_once_enough_records(api: GoogleWeatherApi, mock_server: MockServer) -> None:
@@ -238,6 +239,23 @@ async def test_non_json_response(api: GoogleWeatherApi, mock_server: MockServer)
         await api.async_get_current_conditions(LATITUDE, LONGITUDE)
 
 
+async def test_api_key_not_in_error_message(api: GoogleWeatherApi, mock_server: MockServer) -> None:
+    """Test the API key does not leak into errors that include the request URL.
+
+    aiohttp includes the full request URL in ContentTypeError, which callers
+    commonly log, e.g. for a 502 HTML page from a proxy in front of the API.
+    """
+    mock_server.add_response("<html>502 Bad Gateway</html>", status=HTTPStatus.BAD_GATEWAY)
+
+    with pytest.raises(GoogleWeatherApiConnectionError) as exc_info:
+        await api.async_get_current_conditions(LATITUDE, LONGITUDE)
+
+    assert "currentConditions:lookup" in str(exc_info.value)
+    assert API_KEY not in str(exc_info.value)
+    # Tracebacks render chained exceptions with str(), so the cause must be clean too.
+    assert API_KEY not in str(exc_info.value.__cause__)
+
+
 @pytest.mark.parametrize(
     ("raised", "expected_message"),
     [