Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check if water level is valid #115

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Check if water level is valid #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4ddc69
Check if water level is valid
bieniu Oct 8, 2024
9ca5ef0
Fix tests
bieniu Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions imgw_pib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -11,6 +11,7 @@
API_HYDROLOGICAL_DETAILS_ENDPOINT,
API_HYDROLOGICAL_ENDPOINT,
API_WEATHER_ENDPOINT,
DATA_VALIDITY_PERIOD,
HEADERS,
TIMEOUT,
)
Expand Down Expand Up @@ -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"
Expand All @@ -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,
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions imgw_pib/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
"""IMDB-PIB constants."""

from datetime import timedelta

from aiohttp import ClientTimeout

API_BASE_ENDPOINT = "https://danepubliczne.imgw.pl/api/data"
Expand All @@ -11,3 +13,5 @@

HEADERS = {"Content-Type": "application/json"}
TIMEOUT = ClientTimeout(total=20)

DATA_VALIDITY_PERIOD = timedelta(hours=6)
14 changes: 8 additions & 6 deletions tests/test_init.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]],
Expand All @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand Down Expand Up @@ -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(
Expand Down