Merge pull request #169 from EJEP/forecast_step_aware

Make forecast know if it is daily or 3 hourly

Author: Emlyn Price

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 + Remove deprecated `new_old` and `future_old` functions.
 + Add `__str__` functions to `Timestep`, `Element`, `Day`, `Site`
++ Add element to `Forecast` to track if forecast is daily or 3 hourly
 
 ## [0.9.8] - 2020-07-03
 

datapoint/Forecast.py

@@ -1,10 +1,12 @@
 import datetime
 from datapoint.exceptions import APIException
 
+
 class Forecast():
-    def __init__(self, api_key=""):
+    def __init__(self, api_key="", frequency=""):
         self.api_key = api_key
 
+        self.frequency = frequency
         self.data_date = None
         self.continent = None
         self.country = None

datapoint/Manager.py

@@ -304,7 +304,7 @@ def get_nearest_forecast_site(self, latitude,  longitude):
                     float(longitude),
                     float(latitude))
 
-            if ((distance == None) or (new_distance < distance)):
+            if ((distance is None) or (new_distance < distance)):
                 distance = new_distance
                 nearest = site
 
@@ -325,15 +325,15 @@ def get_forecast_for_site(self, site_id, frequency="daily"):
         A frequency of "3hourly" will return 8 timesteps:
         0, 180, 360 ... 1260 (minutes since midnight UTC)
         """
-        data = self.__call_api(site_id, {"res":frequency})
+        data = self.__call_api(site_id, {"res": frequency})
         params = data['SiteRep']['Wx']['Param']
-        forecast = Forecast()
+        forecast = Forecast(frequency=frequency)
 
         # If the 'Location' key is missing, there is no data for the site,
         # raise an error.
         if 'Location' not in data['SiteRep']['DV']:
             err_string = ('DataPoint has not returned any data for the'
-                          'requested site.' )
+                          'requested site.')
             raise APIException(err_string)
 
         # Check if the other keys we need are in the data returned from the
@@ -456,7 +456,6 @@ def get_forecast_for_site(self, site_id, frequency="daily"):
 
         return forecast
 
-
     def get_observation_sites(self):
         """
         This function returns a list of Site objects for which observations are available.
@@ -528,7 +527,7 @@ def get_observations_for_site(self, site_id, frequency='hourly'):
             Returns hourly observations for the previous 24 hours
             """
 
-            data = self.__call_api(site_id,{"res":frequency}, OBSERVATION_URL)
+            data = self.__call_api(site_id,{"res": frequency}, OBSERVATION_URL)
 
             params = data['SiteRep']['Wx']['Param']
             observation = Observation()

tests/unit/test_forecast.py

@@ -6,7 +6,7 @@
 class TestForecast(unittest.TestCase):
 
     def setUp(self):
-        self.forecast_3hrly = datapoint.Forecast.Forecast()
+        self.forecast_3hrly = datapoint.Forecast.Forecast(frequency='3hourly')
 
         test_day_0 = datapoint.Day.Day()
         test_day_0.date = datetime.datetime(2020, 3, 3, tzinfo=datetime.timezone.utc)
@@ -47,7 +47,7 @@ def setUp(self):
             ts.date = datetime.datetime(2020, 3, 4, 2*i, tzinfo=datetime.timezone.utc)
             test_day_1.timesteps.append(ts)
 
-        self.forecast_daily = datapoint.Forecast.Forecast()
+        self.forecast_daily = datapoint.Forecast.Forecast(frequency='daily')
 
         self.forecast_daily.days.append(test_day_0)
         self.forecast_daily.days.append(test_day_1)