python-google-weather-api 0.0.7__py3-none-any.whl → 0.0.9__py3-none-any.whl

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",

google_weather_api/api.py

@@ -17,11 +17,14 @@ from .model import (
     CurrentConditionsResponse,
     DailyForecastResponse,
     HourlyForecastResponse,
+    MinuteForecastResponse,
 )
 
 _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"
 
 
@@ -45,20 +48,22 @@ 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}
+        # 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 = {
             **params,
-            "language_code": self.language_code,
             "units_system": self.units_system,
         }
-        # Log before adding the API key so it doesn't end up in debug logs.
+        if include_language_code:
+            params["language_code"] = self.language_code
         _LOGGER.debug("GET %s with params: %s", url, params)
-        params["key"] = self.api_key
         try:
             async with self.session.get(
                 url,
@@ -89,18 +94,27 @@ class GoogleWeatherApi:
             raise GoogleWeatherApiConnectionError(err) from err
 
     async def _async_get_all_pages(
-        self, endpoint: str, params: dict[str, Any], records_key: str, limit: int
+        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.
 
-        The API caps the number of records it returns per page (24 for hourly forecasts),
-        regardless of the requested page size, so a single request is not enough.
+        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)
+        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})
+            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
@@ -155,3 +169,26 @@ class GoogleWeatherApi:
             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)

google_weather_api/model.py

@@ -639,3 +639,64 @@ class HourlyForecastResponse(BaseModel):
 
     next_page_token: str | None = field(default=None, metadata={"alias": "nextPageToken"})
     """The token to retrieve the next page."""
+
+
+@dataclass
+class PrecipitationSegment(BaseModel):
+    """Represents a segment of precipitation forecast data."""
+
+    class DominantPrecipitationType(ApiStrEnum):
+        """Represents the type of precipitation of a segment."""
+
+        DOMINANT_PRECIPITATION_TYPE_UNSPECIFIED = "DOMINANT_PRECIPITATION_TYPE_UNSPECIFIED"
+        NONE = "NONE"
+        RAIN = "RAIN"
+        SNOW = "SNOW"
+        HAIL = "HAIL"
+
+    class PrecipitationIntensity(ApiStrEnum):
+        """Represents the precipitation intensity of a segment."""
+
+        PRECIPITATION_INTENSITY_UNSPECIFIED = "PRECIPITATION_INTENSITY_UNSPECIFIED"
+        NO_INTENSITY = "NO_INTENSITY"
+        LIGHT = "LIGHT"
+        MID_LIGHT = "MID_LIGHT"
+        MODERATE = "MODERATE"
+        MID_MODERATE = "MID_MODERATE"
+        HEAVY = "HEAVY"
+        MID_HEAVY = "MID_HEAVY"
+
+    time_frame: Interval = field(metadata={"alias": "timeFrame"})
+    """The timeframe relevant to the segment."""
+
+    type: DominantPrecipitationType = DominantPrecipitationType.DOMINANT_PRECIPITATION_TYPE_UNSPECIFIED
+    """A code that indicates the type of precipitation."""
+
+    probability: int = 0
+    """The chance of precipitation (values from 0 to 100)."""
+
+    qpf: QuantitativePrecipitationForecast | None = None
+    """The amount of precipitation, measured as liquid water equivalent."""
+
+    snowfall_amount: QuantitativePrecipitationForecast | None = field(default=None, metadata={"alias": "snowfallAmount"})
+    """The amount of snow accumulation, measured as liquid water equivalent."""
+
+    intensity: PrecipitationIntensity = PrecipitationIntensity.PRECIPITATION_INTENSITY_UNSPECIFIED
+    """A code that indicates the precipitation intensity of the segment."""
+
+
+@dataclass
+class MinuteForecastResponse(BaseModel):
+    """Response model for the forecast.minutes.lookup method."""
+
+    overall_prediction_timeframe: Interval = field(metadata={"alias": "overallPredictionTimeframe"})
+    """The overall timeframe for the predictions."""
+
+    time_zone: TimeZone = field(metadata={"alias": "timeZone"})
+    """The time zone at the requested location."""
+
+    segments: list[PrecipitationSegment] = field(default_factory=list)
+    """The minute-level prediction segments."""
+
+    next_page_token: str | None = field(default=None, metadata={"alias": "nextPageToken"})
+    """The token to retrieve the next page."""

{python_google_weather_api-0.0.7.dist-info → python_google_weather_api-0.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-google-weather-api
-Version: 0.0.7
+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.9.dist-info/RECORD

@@ -0,0 +1,10 @@
+google_weather_api/__init__.py,sha256=Su4PjNcbIJFYoFCEH4wwdtT-M2HSMtLNLvF-TWGHiNo,1601
+google_weather_api/api.py,sha256=4_Y8TN6Mtrf4JDGoBOVm6W0uedxe5sPxMVx-ktD2kCI,7478
+google_weather_api/exceptions.py,sha256=AHHzb-cbE0bgzp4PH2IC5s3jHAJHONbL9iw5b-_MvoU,534
+google_weather_api/model.py,sha256=2Dx6VGh5Uaotb3McZSNs0BT6iJTrr5spYEUUC-IlXiA,24858
+google_weather_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_google_weather_api-0.0.9.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+python_google_weather_api-0.0.9.dist-info/METADATA,sha256=SvCCnXAfToJfdwSvgBJ1D41y3lR3IsJGxgBwl_WJY5E,1412
+python_google_weather_api-0.0.9.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+python_google_weather_api-0.0.9.dist-info/top_level.txt,sha256=ZkFbtKDHz3vUJhH6DGEPVLj3PPeNpR9-Wg0f4HqGD78,19
+python_google_weather_api-0.0.9.dist-info/RECORD,,

{python_google_weather_api-0.0.7.dist-info → python_google_weather_api-0.0.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (84.0.0)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_google_weather_api-0.0.7.dist-info/RECORD

@@ -1,10 +0,0 @@
-google_weather_api/__init__.py,sha256=mIsd7IvUJhucWozTmTKqDHT2wtGEPMG34Ux2Ve9q8QM,1489
-google_weather_api/api.py,sha256=7RzupmA5E0ft-Yn_ygGCIDxIz1bcB1iXuo0cbcU0vsY,5997
-google_weather_api/exceptions.py,sha256=AHHzb-cbE0bgzp4PH2IC5s3jHAJHONbL9iw5b-_MvoU,534
-google_weather_api/model.py,sha256=9dwgYTRLi37XPNDL0X5OZrBut6qBjxqO8BL4kFl-iL0,22500
-google_weather_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_google_weather_api-0.0.7.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-python_google_weather_api-0.0.7.dist-info/METADATA,sha256=KJCoHyP64kq1mZdcH3r4_zUn955g3bbfwy3_b4MBwTw,1412
-python_google_weather_api-0.0.7.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_google_weather_api-0.0.7.dist-info/top_level.txt,sha256=ZkFbtKDHz3vUJhH6DGEPVLj3PPeNpR9-Wg0f4HqGD78,19
-python_google_weather_api-0.0.7.dist-info/RECORD,,