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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-google-weather-api
-Version: 0.0.6
+Version: 0.0.8
 Summary: A python client library for Google Weather API
 Author-email: tronikos <tronikos@gmail.com>
 License-Expression: Apache-2.0
@@ -13,6 +13,8 @@ Requires-Dist: aiohttp>=3.8
 Requires-Dist: mashumaro
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
 Dynamic: license-file
 
 # python-google-weather-api

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

@@ -1,6 +1,6 @@
 [project]
 name = "python-google-weather-api"
-version = "0.0.6"
+version = "0.0.8"
 license = "Apache-2.0"
 authors = [
     { name="tronikos", email="tronikos@gmail.com" },
@@ -16,6 +16,8 @@ dependencies = [
 [project.optional-dependencies]
 test = [
     "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
 ]
 
 
@@ -27,6 +29,13 @@ test = [
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+addopts = "--cov=google_weather_api --cov-report=term-missing --cov-fail-under=90"
+
+[tool.coverage.run]
+branch = true
+
 [tool.ruff]
 target-version = "py311"
 line-length = 127
@@ -64,6 +73,7 @@ ignore = [
     "D203",  # 1 blank line required before class docstring
     "D213",  # Multi-line docstring summary should start at the second line
     "PLR0913",  # Too many arguments in function definition
+    "PLR0917",  # Too many positional arguments in function definition
     "PLR1714",  # Consider merging multiple comparisons
     "PLR2004",  # Magic value used in comparison
     "TRY003",  # Avoid specifying long messages outside the exception class

{python_google_weather_api-0.0.6 → python_google_weather_api-0.0.8}/src/google_weather_api/__init__.py

@@ -21,9 +21,11 @@ from .model import (
     IceThickness,
     Interval,
     LocalizedText,
+    MinuteForecastResponse,
     MoonEvents,
     Precipitation,
     PrecipitationProbability,
+    PrecipitationSegment,
     QuantitativePrecipitationForecast,
     SunEvents,
     Temperature,
@@ -54,9 +56,11 @@ __all__ = [
     "IceThickness",
     "Interval",
     "LocalizedText",
+    "MinuteForecastResponse",
     "MoonEvents",
     "Precipitation",
     "PrecipitationProbability",
+    "PrecipitationSegment",
     "QuantitativePrecipitationForecast",
     "SunEvents",
     "Temperature",

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

@@ -17,6 +17,7 @@ from .model import (
     CurrentConditionsResponse,
     DailyForecastResponse,
     HourlyForecastResponse,
+    MinuteForecastResponse,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -45,7 +46,7 @@ class GoogleWeatherApi:
         self.referrer = referrer
         self.timeout = aiohttp.ClientTimeout(total=timeout)
 
-    async def _async_get(self, endpoint: str, params: dict[str, Any]) -> dict[str, Any]:
+    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}
@@ -53,11 +54,13 @@ class GoogleWeatherApi:
             headers[aiohttp.hdrs.REFERER] = self.referrer
         params = {
             **params,
-            "key": self.api_key,
-            "language_code": self.language_code,
             "units_system": self.units_system,
         }
+        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,
@@ -87,6 +90,35 @@ class GoogleWeatherApi:
         except aiohttp.ClientError as err:
             raise GoogleWeatherApiConnectionError(err) from err
 
+    async def _async_get_all_pages(
+        self,
+        endpoint: str,
+        params: dict[str, Any],
+        records_key: str,
+        limit: int,
+        *,
+        include_language_code: bool = True,
+    ) -> dict[str, Any]:
+        """Perform a GET request, following pagination until `limit` records are collected.
+
+        Some endpoints cap the number of records they return per page regardless of the
+        requested page size, for example 24 for hourly forecasts, so a single request is
+        not always enough.
+        """
+        params = {**params, "page_size": limit}
+        data = await self._async_get(endpoint, params, include_language_code=include_language_code)
+        records: list[Any] = data.get(records_key, [])
+        while len(records) < limit and (page_token := data.get("nextPageToken")):
+            data = await self._async_get(
+                endpoint, {**params, "page_token": page_token}, include_language_code=include_language_code
+            )
+            page_records: list[Any] = data.get(records_key, [])
+            if not page_records:
+                break
+            records.extend(page_records)
+        data[records_key] = records[:limit]
+        return data
+
     async def async_get_current_conditions(self, latitude: float, longitude: float) -> CurrentConditionsResponse:
         """Fetch current weather conditions.
 
@@ -106,14 +138,15 @@ class GoogleWeatherApi:
 
         See https://developers.google.com/maps/documentation/weather/reference/rest/v1/forecast.hours/lookup
         """
-        data = await self._async_get(
+        data = await self._async_get_all_pages(
             "forecast/hours:lookup",
             {
                 "location.latitude": latitude,
                 "location.longitude": longitude,
                 "hours": hours,
-                "page_size": hours,
             },
+            "forecastHours",
+            hours,
         )
         return HourlyForecastResponse.from_dict(data)
 
@@ -122,13 +155,37 @@ class GoogleWeatherApi:
 
         See https://developers.google.com/maps/documentation/weather/reference/rest/v1/forecast.days/lookup
         """
-        data = await self._async_get(
+        data = await self._async_get_all_pages(
             "forecast/days:lookup",
             {
                 "location.latitude": latitude,
                 "location.longitude": longitude,
                 "days": days,
-                "page_size": days,
             },
+            "forecastDays",
+            days,
         )
         return DailyForecastResponse.from_dict(data)
+
+    async def async_get_minute_forecast(
+        self, latitude: float, longitude: float, page_size: int = 360
+    ) -> MinuteForecastResponse:
+        """Fetch the precipitation nowcast for up to 6 hours.
+
+        Segments cover 2- or 15-minute intervals depending on the location. The endpoint
+        does not accept language_code (a reserved field in google.maps.weather.v1), so it
+        is omitted from these requests.
+
+        See https://developers.google.com/maps/documentation/weather/minute-forecast
+        """
+        data = await self._async_get_all_pages(
+            "forecast/minutes:lookup",
+            {
+                "location.latitude": latitude,
+                "location.longitude": longitude,
+            },
+            "segments",
+            page_size,
+            include_language_code=False,
+        )
+        return MinuteForecastResponse.from_dict(data)

{python_google_weather_api-0.0.6 → python_google_weather_api-0.0.8}/src/google_weather_api/exceptions.py

@@ -1,17 +1,17 @@
-"""Exceptions for Google Weather API."""
-
-
-class GoogleWeatherApiError(Exception):
-    """Exception talking to the Google Weather API."""
-
-
-class GoogleWeatherApiConnectionError(GoogleWeatherApiError):
-    """Exception connecting to the Google Weather API."""
-
-
-class GoogleWeatherApiAuthError(GoogleWeatherApiError):
-    """Exception raised for authentication errors in the Google Weather API."""
-
-
-class GoogleWeatherApiResponseError(GoogleWeatherApiError):
-    """Exception raised for errors in the Google Weather API response."""
+"""Exceptions for Google Weather API."""
+
+
+class GoogleWeatherApiError(Exception):
+    """Exception talking to the Google Weather API."""
+
+
+class GoogleWeatherApiConnectionError(GoogleWeatherApiError):
+    """Exception connecting to the Google Weather API."""
+
+
+class GoogleWeatherApiAuthError(GoogleWeatherApiError):
+    """Exception raised for authentication errors in the Google Weather API."""
+
+
+class GoogleWeatherApiResponseError(GoogleWeatherApiError):
+    """Exception raised for errors in the Google Weather API response."""