Improve error handling and README. Update Ubuntu. (#67)

* Tweak error handling

* Update README

* Update ubuntu version

* Update version

Author: saaste

.github/workflows/pythonpackage.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]

README.md

@@ -25,10 +25,11 @@ Working example can be found in [example.py](example.py).
 $ pip install fmi-weather-client 
 ```
 
-### Get weather and forecasts
+### Get weather, forecasts, and observations
 You can get the weather using the following functions:
 - `weather_by_place_name(place_name)`
 - `weather_by_coordinates(latitude, longitude)`
+- `observation_by_station_id(fmi_station_id)`
 
 Example:
 ```python
@@ -65,9 +66,11 @@ except ServerError as err:
 
 ```
 
-You can get the observation data from a station ID [shown here](https://www.ilmatieteenlaitos.fi/havaintoasemat) using the following functions:
+You can get the observation data from a station using the following functions:
 - `observation_by_station_id(fmi_sid)`
 
+To get a weather observation from a station, you must provide a station ID. IDs can be found on [FMI's station list](https://www.ilmatieteenlaitos.fi/havaintoasemat). Note that weather observations are available only from **weather stations**. These are the ones with `sää` in the `Ryhmä` column.
+
 Example:
 ```python
 import fmi_weather_client as fmi

example.py

@@ -5,12 +5,12 @@
     # Get current weather in Kilpisjärvi using coordinates
     kilpisjarvi_weather = fmi.weather_by_coordinates(69.0478, 20.7982)
 
-    # Get forecast for Helsinki
-    helsinki_forecast = fmi.forecast_by_place_name("Helsinki")
-
     # Get observation data
     oulu_observation = fmi.observation_by_station_id(101794)
 
+    # Get forecast for Helsinki
+    helsinki_forecast = fmi.forecast_by_place_name("Helsinki")
+
     # Print current temperature
     print()
     print(f"Temperature @ {kilpisjarvi_weather.place}: {kilpisjarvi_weather.data.temperature}")

fmi_weather_client/http.py

@@ -155,6 +155,7 @@ def _send_request(params: Dict[str, Any]) -> str:
     response = requests.get(url, params=params, timeout=10)
 
     if response.status_code == 200:
+        _validate_response(response)
         _LOGGER.debug("GET response from %s in %d ms. Status: %d.",
                       url,
                       response.elapsed.microseconds / 1000,
@@ -165,6 +166,16 @@ def _send_request(params: Dict[str, Any]) -> str:
     return response.text
 
 
+def _validate_response(response: requests.Response):
+    """Validate response body"""
+    data = xmltodict.parse(response.text)
+
+    if ('wfs:FeatureCollection' in data and
+            '@numberMatched' in data['wfs:FeatureCollection'] and
+            data['wfs:FeatureCollection']['@numberMatched'] == '0'):
+        raise ClientError(200, "Valid data source not found with given parameters")
+
+
 def _handle_errors(response: requests.Response):
     """Handle error responses from FMI service"""
     if 400 <= response.status_code < 500:

fmi_weather_client/parsers/errors.py

@@ -8,7 +8,6 @@
 import xmltodict
 
 from fmi_weather_client.models import FMIPlace, Forecast, Value, WeatherData, RequestType
-from fmi_weather_client.parsers.errors import StationTypeError
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -23,8 +22,6 @@ def parse_fmi_response(body: str, request_type: RequestType):
     data = xmltodict.parse(body)
 
     try:
-        _check_valid(data)
-
         station = _get_place(data, request_type)
         _LOGGER.debug("Received place: %s (%d, %d)", station.name, station.lat, station.lon)
 
@@ -61,12 +58,6 @@ def parse_fmi_response(body: str, request_type: RequestType):
     return Forecast(station.name, station.lat, station.lon, forecasts)
 
 
-def _check_valid(data: Dict[str, Any]):
-    if data['wfs:FeatureCollection']['@numberMatched'] == '0':
-        raise StationTypeError("no matched places/observation stations")
-    return True
-
-
 def _get_place(data: Dict[str, Any], request_type: RequestType) -> FMIPlace:
     place_data = (data['wfs:FeatureCollection']['wfs:member']['omso:GridSeriesObservation']
                       ['om:featureOfInterest']['sams:SF_SpatialSamplingFeature']['sams:shape']

fmi_weather_client/parsers/forecast.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="fmi-weather-client",
-    version="0.5.1",
+    version="0.6.0",
     author="Mika Hiltunen",
     author_email="saaste@gmail.com",
     description="Library for fetching weather information from Finnish Meteorological Institute (FMI)",

setup.py

@@ -6,7 +6,6 @@
 import fmi_weather_client
 import test.test_data as test_data
 from fmi_weather_client.errors import ClientError, ServerError
-from fmi_weather_client.parsers.errors import StationTypeError
 
 
 class FMIWeatherTest(unittest.TestCase):
@@ -84,11 +83,6 @@ def test_nil_forecast_response(self, mock_get):
         self.assertEqual(forecast_coord.forecasts, [])
         self.assertEqual(forecast_name.forecasts, [])
 
-    @mock.patch('requests.get', side_effect=test_data.mock_invalid_station_id_response)
-    def test_invalid_observation_id(self, mock_get):
-        with self.assertRaises(StationTypeError):
-            fmi_weather_client.observation_by_station_id(103124)
-
     # ERROR CASES
     @mock.patch('requests.get', side_effect=test_data.mock_no_location_exception_response)
     def test_no_location_exception_response(self, mock_get):
@@ -110,6 +104,11 @@ def test_server_error_response(self, mock_get):
         with self.assertRaises(ServerError):
             fmi_weather_client.weather_by_coordinates(27.31317, 63.14343)
 
+    @mock.patch('requests.get', side_effect=test_data.mock_invalid_station_id_response)
+    def test_invalid_observation_id(self, mock_get):
+        with self.assertRaises(ClientError):
+            fmi_weather_client.observation_by_station_id(103124)
+
     def assert_name_weather(self, weather):
         self.assertEqual(weather.place, 'Iisalmi')
         self.assertEqual(weather.data.time.timestamp(), 1663585800.0)
@@ -175,5 +174,6 @@ def assert_observation_id(self, weather):
         self.assertEqual(weather.data.temperature.value, -7.2)
         self.assertEqual(weather.data.wind_speed.value, 2.6)
 
+
 if __name__ == '__main__':
     unittest.main()