From d4ddc6974384372b3434d7b398b7aa644532d86f Mon Sep 17 00:00:00 2001 From: Maciej Bieniek Date: Tue, 8 Oct 2024 11:55:34 +0200 Subject: [PATCH 1/2] Check if water level is valid --- imgw_pib/__init__.py | 29 ++++++++++++++++++++--------- imgw_pib/const.py | 4 ++++ 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/imgw_pib/__init__.py b/imgw_pib/__init__.py index d86326c..3a37c80 100644 --- a/imgw_pib/__init__.py +++ b/imgw_pib/__init__.py @@ -1,7 +1,7 @@ """Python wrapper for IMGW-PIB API.""" import logging -from datetime import UTC, datetime, timedelta +from datetime import UTC, datetime from http import HTTPStatus from typing import Any, Self @@ -11,6 +11,7 @@ API_HYDROLOGICAL_DETAILS_ENDPOINT, API_HYDROLOGICAL_ENDPOINT, API_WEATHER_ENDPOINT, + DATA_VALIDITY_PERIOD, HEADERS, TIMEOUT, ) @@ -235,7 +236,19 @@ def _parse_weather_data(data: dict[str, Any]) -> WeatherData: def _parse_hydrological_data(self: Self, data: dict[str, Any]) -> HydrologicalData: """Parse hydrological data.""" - water_level = data[ApiNames.WATER_LEVEL] + water_level_measurement_date = get_datetime( + data[ApiNames.WATER_LEVEL_MEASUREMENT_DATE], + "%Y-%m-%d %H:%M:%S", + ) + if ( + water_level_measurement_date is not None + and datetime.now(tz=UTC) - water_level_measurement_date + < DATA_VALIDITY_PERIOD + ): + water_level = data[ApiNames.WATER_LEVEL] + else: + water_level_measurement_date = None + water_level = None if water_level is None: msg = "Invalid water level value" @@ -246,10 +259,6 @@ def _parse_hydrological_data(self: Self, data: dict[str, Any]) -> HydrologicalDa value=float(water_level) if water_level is not None else None, unit=Units.CENTIMETERS.value if water_level is not None else None, ) - water_level_measurement_date = get_datetime( - data[ApiNames.WATER_LEVEL_MEASUREMENT_DATE], - "%Y-%m-%d %H:%M:%S", - ) flood_warning_level_sensor = SensorData( name="Flood Warning Level", value=self._warning_water_level, @@ -269,9 +278,11 @@ def _parse_hydrological_data(self: Self, data: dict[str, Any]) -> HydrologicalDa data[ApiNames.WATER_TEMPERATURE_MEASUREMENT_DATE], "%Y-%m-%d %H:%M:%S", ) - if water_temperature_measurement_date is not None and datetime.now( - tz=UTC - ) - water_temperature_measurement_date < timedelta(hours=6): + if ( + water_temperature_measurement_date is not None + and datetime.now(tz=UTC) - water_temperature_measurement_date + < DATA_VALIDITY_PERIOD + ): water_temperature = data[ApiNames.WATER_TEMPERATURE] else: water_temperature_measurement_date = None diff --git a/imgw_pib/const.py b/imgw_pib/const.py index c966699..ecae877 100644 --- a/imgw_pib/const.py +++ b/imgw_pib/const.py @@ -1,5 +1,7 @@ """IMDB-PIB constants.""" +from datetime import timedelta + from aiohttp import ClientTimeout API_BASE_ENDPOINT = "https://danepubliczne.imgw.pl/api/data" @@ -11,3 +13,5 @@ HEADERS = {"Content-Type": "application/json"} TIMEOUT = ClientTimeout(total=20) + +DATA_VALIDITY_PERIOD = timedelta(hours=6) From 9ca5ef071d9c2f6a8109d03b4ce4386e21e3987b Mon Sep 17 00:00:00 2001 From: Maciej Bieniek Date: Tue, 8 Oct 2024 12:26:06 +0200 Subject: [PATCH 2/2] Fix tests --- tests/test_init.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/tests/test_init.py b/tests/test_init.py index 7f5e36e..71c4278 100644 --- a/tests/test_init.py +++ b/tests/test_init.py @@ -228,7 +228,7 @@ async def test_invalid_water_level_value( assert str(exc.value) == "Invalid water level value" -@pytest.mark.parametrize("date_time", [None, "lorem ipsum"]) +@pytest.mark.parametrize("date_time", [None, "lorem ipsum", "2024-01-22 09:10:00"]) @pytest.mark.asyncio async def test_invalid_date( hydrological_stations: list[dict[str, Any]], @@ -240,7 +240,7 @@ async def test_invalid_date( hydrological_stations[5][ApiNames.WATER_LEVEL_MEASUREMENT_DATE] = date_time - with aioresponses() as session_mock: + with aioresponses() as session_mock, freeze_time(TEST_TIME): session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get( @@ -251,11 +251,13 @@ async def test_invalid_date( ) imgwpib = await ImgwPib.create(session, hydrological_station_id="154190050") - hydrological_data = await imgwpib.get_hydrological_data() + + with pytest.raises(ApiError) as exc_info: + await imgwpib.get_hydrological_data() await session.close() - assert hydrological_data.water_level_measurement_date is None + assert str(exc_info.value) == "Invalid water level value" @pytest.mark.parametrize( @@ -276,7 +278,7 @@ async def test_flood_warning( hydrological_stations[5][ApiNames.WATER_LEVEL] = water_level hydrological_details["status"]["warningValue"] = flood_warning_level - with aioresponses() as session_mock: + with aioresponses() as session_mock, freeze_time(TEST_TIME): session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get( @@ -312,7 +314,7 @@ async def test_flood_alarm( hydrological_stations[5][ApiNames.WATER_LEVEL] = water_level hydrological_details["status"]["alarmValue"] = flood_alarm_level - with aioresponses() as session_mock: + with aioresponses() as session_mock, freeze_time(TEST_TIME): session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get(API_HYDROLOGICAL_ENDPOINT, payload=hydrological_stations) session_mock.get(