python-pirateweather 1.0.0__tar.gz → 1.0.2__tar.gz

{python_pirateweather-1.0.0/python_pirateweather.egg-info → python_pirateweather-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-pirateweather
-Version: 1.0.0
+Version: 1.0.2
 Summary: A thin Python Wrapper for the Pirate Weather API
 Home-page: https://github.com/cloneofghosts/python-pirate-weather
 Author: cloneofghosts

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2}/pirateweather/api.py

@@ -8,7 +8,16 @@ from pirateweather.models import Forecast
 
 
 def load_forecast(
-    key, lat, lng, time=None, units="us", lang="en", lazy=False, callback=None
+    key,
+    lat,
+    lng,
+    time=None,
+    units="us",
+    lang="en",
+    lazy=False,
+    callback=None,
+    extend=None,
+    version=1,
 ):
     """Build the request url and loads some or all of the needed json depending on lazy is True.
 
@@ -17,18 +26,21 @@ def load_forecast(
     time:   A datetime.datetime object representing the desired time of
            the forecast. If no timezone is present, the API assumes local
            time at the provided latitude and longitude.
-    units:  A string of the preferred units of measurement, "us" id
+    units:  A string of the preferred units of measurement, "us" is
             default. also ca,uk,si is available
     lang:   Return summary properties in the desired language
     lazy:   Defaults to false.  The function will only request the json
             data as it is needed. Results in more requests, but
             probably a faster response time (I haven't checked)
+    extend: If set to true the API will hourly data for 168 hours instead
+            of the standard 48 hours.
+    version: If set to 2 the API will return fields that were not part of the Dark Sky API.
     """
 
     if time is None:
         url = (
             f"https://api.pirateweather.net/forecast/{key}/{lat},{lng}"
-            f"?units={units}&lang={lang}"
+            f"?units={units}&lang={lang}&extend={extend}&version={version}"
         )
     else:
         url_time = time.replace(

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2}/pirateweather/models.py

@@ -4,7 +4,7 @@ import datetime
 
 import requests
 
-from pirateweather.utils import PropertyUnavailable, UnicodeMixin
+from pirateweather.utils import UnicodeMixin
 
 
 class Forecast(UnicodeMixin):
@@ -88,14 +88,7 @@ class PirateWeatherDataBlock(UnicodeMixin):
 
     def __unicode__(self):
         """Return a string representation of the data block."""
-        return (
-            "<PirateWeatherDataBlock instance: "
-            "%s with %d PirateWeatherDataPoints>"
-            % (
-                self.summary,
-                len(self.data),
-            )
-        )
+        return f"<PirateWeatherDataBlock instance: {self.summary} with {len(self.data)} PirateWeatherDataPoints>"
 
 
 class PirateWeatherDataPoint(UnicodeMixin):
@@ -124,14 +117,11 @@ class PirateWeatherDataPoint(UnicodeMixin):
             self.sunsetTime = None
 
     def __getattr__(self, name):
-        """Return the weather property dynamically or raise PropertyUnavailable if missing."""
+        """Return the weather property dynamically or return None if missing."""
         try:
             return self.d[name]
-        except KeyError as err:
-            raise PropertyUnavailable(
-                f"Property '{name}' is not valid"
-                " or is not available for this forecast"
-            ) from err
+        except KeyError:
+            return None
 
     def __unicode__(self):
         """Return a string representation of the data point."""
@@ -146,13 +136,11 @@ class Alert(UnicodeMixin):
         self.json = json
 
     def __getattr__(self, name):
-        """Return the alert property dynamically or raise PropertyUnavailable if missing."""
+        """Return the alert property dynamically or return None if missing."""
         try:
             return self.json[name]
-        except KeyError as err:
-            raise PropertyUnavailable(
-                f"Property '{name}' is not valid" " or is not available for this alert"
-            ) from err
+        except KeyError:
+            return None
 
     def __unicode__(self):
         """Return a string representation of the alert."""

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2}/pirateweather/utils.py

@@ -7,7 +7,3 @@ class UnicodeMixin:
     def __str__(self):
         """Return the unicode representation of the object for Python 3 compatibility."""
         return self.__unicode__()
-
-
-class PropertyUnavailable(AttributeError):
-    """Raise when a requested property is unavailable in the forecast data."""

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2/python_pirateweather.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-pirateweather
-Version: 1.0.0
+Version: 1.0.2
 Summary: A thin Python Wrapper for the Pirate Weather API
 Home-page: https://github.com/cloneofghosts/python-pirate-weather
 Author: cloneofghosts

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2}/setup.py

@@ -20,7 +20,7 @@ def read(fname):
 
 setup(
     name="python-pirateweather",
-    version="1.0.0",
+    version="1.0.2",
     author="cloneofghosts",
     description=("A thin Python Wrapper for the Pirate Weather API"),
     license="BSD 2-clause",

{python_pirateweather-1.0.0 → python_pirateweather-1.0.2}/tests/test_pirateweather.py

@@ -7,7 +7,6 @@ from datetime import datetime
 import pytest
 import requests
 import responses
-from nose.tools import raises
 
 import pirateweather
 
@@ -19,11 +18,11 @@ class EndToEnd(unittest.TestCase):
         """Set up the API key, location and time for the tests."""
 
         self.api_key = os.environ.get("PIRATEWEATHER_API_KEY")
-
         self.lat = 52.370235
         self.lng = 4.903549
-
         self.time = datetime(2015, 2, 27, 6, 0, 0)
+        self.extend = "hourly"
+        self.version = 2
 
     def test_with_time(self):
         """Test querying the TimeMachine API endpoint."""
@@ -50,6 +49,38 @@ class EndToEnd(unittest.TestCase):
         forecast = pirateweather.load_forecast(self.api_key, self.lat, self.lng)
         assert forecast.response.status_code == 200
 
+    def test_extend(self):
+        """Test querying the API endpoint."""
+
+        forecast = pirateweather.load_forecast(
+            self.api_key, self.lat, self.lng, None, "us", "en", False, None, self.extend
+        )
+        hourl_data = forecast.hourly()
+
+        assert forecast.response.status_code == 200
+        assert len(hourl_data.data) == 169
+
+    def test_version(self):
+        """Test querying the API endpoint."""
+
+        forecast = pirateweather.load_forecast(
+            self.api_key, self.lat, self.lng, None, "us", "en", False, None, None, 2
+        )
+
+        assert forecast.response.status_code == 200
+        assert forecast.response.url.find("version=2") >= 0
+
+    def test_version_data_point(self):
+        """Test querying the API endpoint."""
+
+        forecast = pirateweather.load_forecast(
+            self.api_key, self.lat, self.lng, None, "us", "en", False, None, None, 2
+        )
+        fc_cur = forecast.currently()
+
+        assert forecast.response.status_code == 200
+        assert fc_cur.fireIndex
+
     def test_invalid_key(self):
         """Test querying the API endpoint with a invalid API key."""
 
@@ -86,7 +117,7 @@ class BasicFunctionality(unittest.TestCase):
     def setUp(self):
         """Set up the data to use in the next tests."""
 
-        URL = "https://api.pirateweather.net/forecast/foo/50.0,10.0?units=us&lang=en"
+        URL = "https://api.pirateweather.net/forecast/foo/50.0,10.0?units=us&lang=en&extend=None&version=1"
         responses.add(
             responses.GET,
             URL,
@@ -159,12 +190,11 @@ class BasicFunctionality(unittest.TestCase):
             == "<PirateWeatherDataBlock instance: Drizzle until this evening. with 49 PirateWeatherDataPoints>"
         )
 
-    @raises(pirateweather.utils.PropertyUnavailable)
     def test_datapoint_attribute_not_available(self):
         """Test fetching an invalid property on the daily block."""
 
         daily = self.fc.daily()
-        daily.data[0].notavailable  # noqa: B018
+        assert daily.data[0].notavailable is None
 
     def test_apparentTemperature(self):
         """Test the first hour data block apparent temperature."""
@@ -188,7 +218,7 @@ class ForecastsWithAlerts(unittest.TestCase):
     def setUp(self):
         """Set up the test data with alerts to use in the next tests."""
 
-        URL = "https://api.pirateweather.net/forecast/foo/50.0,10.0?units=us&lang=en"
+        URL = "https://api.pirateweather.net/forecast/foo/50.0,10.0?units=us&lang=en&extend=None&version=1"
         responses.add(
             responses.GET,
             URL,
@@ -236,14 +266,13 @@ class ForecastsWithAlerts(unittest.TestCase):
 
         assert first_alert.time == 1402133400
 
-    @raises(pirateweather.utils.PropertyUnavailable)
     def test_alert_property_does_not_exist(self):
         """Test fetching an invalid property on the alerts."""
 
         alerts = self.fc.alerts()
         first_alert = alerts[0]
 
-        first_alert.notarealproperty  # noqa: B018
+        assert first_alert.notarealproperty is None
 
     def test_alert_string_repr(self):
         """Test the string representation of the currently data."""