env-canada 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

env_canada/__init__.py

@@ -1,5 +1,5 @@
-from .ec_aqhi import *
-from .ec_historical import *
-from .ec_hydro import *
-from .ec_radar import *
-from .ec_weather import *
+from .ec_aqhi import ECAirQuality
+from .ec_historical import ECHistorical, ECHistoricalRange
+from .ec_hydro import ECHydro
+from .ec_radar import ECRadar
+from .ec_weather import ECWeather

env_canada/constants.py

@@ -1 +1 @@
-USER_AGENT = "env_canada/0.6.1"
+USER_AGENT = "env_canada/0.7.0"

env_canada/ec_radar.py

@@ -1,17 +1,18 @@
-from aiohttp.client_exceptions import ClientConnectorError
 import asyncio
 import datetime
-from io import BytesIO
 import logging
 import math
 import os
-from PIL import Image, ImageDraw, ImageFont
+from io import BytesIO
 
-from .ec_cache import CacheClientSession as ClientSession
 import dateutil.parser
 import defusedxml.ElementTree as et
 import imageio.v2 as imageio
 import voluptuous as vol
+from aiohttp.client_exceptions import ClientConnectorError
+from PIL import Image, ImageDraw, ImageFont
+
+from .ec_cache import CacheClientSession as ClientSession
 
 ATTRIBUTION = {
     "english": "Data provided by Environment Canada",
@@ -156,16 +157,12 @@ class ECRadar(object):
         # Get overlay parameters
 
         self.show_legend = kwargs["legend"]
-        if self.show_legend:
-            self.legend_layer = None
-            self.legend_image = None
-            self.legend_position = None
+        self.legend_layer = None
+        self.legend_image = None
+        self.legend_position = None
 
         self.show_timestamp = kwargs["timestamp"]
-        if self.show_timestamp:
-            self.font = ImageFont.load(
-                os.path.join(os.path.dirname(__file__), "10x20.pil")
-            )
+        self.font = None
 
     @property
     def precip_type(self):
@@ -197,22 +194,20 @@ class ECRadar(object):
             async with ClientSession(raise_for_status=True) as session:
                 response = await session.get(url=basemap_url, params=basemap_params)
                 base_bytes = await response.read()
-                self.map_image = Image.open(BytesIO(base_bytes)).convert("RGBA")
 
         except ClientConnectorError as e:
             logging.warning("NRCan base map could not be retrieved: %s" % e)
-
             try:
                 async with ClientSession(raise_for_status=True) as session:
                     response = await session.get(
                         url=backup_map_url, params=basemap_params
                     )
                     base_bytes = await response.read()
-                    self.map_image = Image.open(BytesIO(base_bytes)).convert("RGBA")
             except ClientConnectorError:
                 logging.warning("Mapbox base map could not be retrieved")
+                return None
 
-        return
+        return base_bytes
 
     async def _get_legend(self):
         """Fetch legend image."""
@@ -221,13 +216,13 @@ class ECRadar(object):
                 layer=precip_layers[self.layer_key], style=legend_style[self.layer_key]
             )
         )
-        async with ClientSession(raise_for_status=True) as session:
-            response = await session.get(url=geomet_url, params=legend_params)
-            legend_bytes = await response.read()
-        self.legend_image = Image.open(BytesIO(legend_bytes)).convert("RGB")
-        legend_width = self.legend_image.size[0]
-        self.legend_position = (self.width - legend_width, 0)
-        self.legend_layer = self.layer_key
+        try:
+            async with ClientSession(raise_for_status=True) as session:
+                response = await session.get(url=geomet_url, params=legend_params)
+                return await response.read()
+        except ClientConnectorError:
+            logging.warning("Legend could not be retrieved")
+            return None
 
     async def _get_dimensions(self):
         """Get time range of available data."""
@@ -255,54 +250,73 @@ class ECRadar(object):
     async def _combine_layers(self, radar_bytes, frame_time):
         """Add radar overlay to base layer and add timestamp."""
 
-        radar = Image.open(BytesIO(radar_bytes)).convert("RGBA")
-
-        # Add transparency to radar
-
-        if self.radar_opacity < 100:
-            alpha = round((self.radar_opacity / 100) * 255)
-            radar_copy = radar.copy()
-            radar_copy.putalpha(alpha)
-            radar.paste(radar_copy, radar)
-
-        # Overlay radar on basemap
-
+        base_bytes = None
         if not self.map_image:
-            await self._get_basemap()
-        if self.map_image:
-            frame = Image.alpha_composite(self.map_image, radar)
-        else:
-            frame = radar
-
-        # Add legend
+            base_bytes = await self._get_basemap()
 
+        legend_bytes = None
         if self.show_legend:
             if not self.legend_image or self.legend_layer != self.layer_key:
-                await self._get_legend()
-            frame.paste(self.legend_image, self.legend_position)
+                legend_bytes = await self._get_legend()
 
-        # Add timestamp
+        # All the synchronous PIL stuff here
+        def _create_image():
+            radar = Image.open(BytesIO(radar_bytes)).convert("RGBA")
 
-        if self.show_timestamp:
-            timestamp = (
-                timestamp_label[self.layer_key][self.language]
-                + " @ "
-                + frame_time.astimezone().strftime("%H:%M")
-            )
-            text_box = Image.new("RGBA", self.font.getbbox(timestamp)[2:], "white")
-            box_draw = ImageDraw.Draw(text_box)
-            box_draw.text(xy=(0, 0), text=timestamp, fill=(0, 0, 0), font=self.font)
-            double_box = text_box.resize((text_box.width * 2, text_box.height * 2))
-            frame.paste(double_box)
-            frame = frame.quantize()
-
-        # Return frame as PNG bytes
-
-        img_byte_arr = BytesIO()
-        frame.save(img_byte_arr, format="PNG")
-        frame_bytes = img_byte_arr.getvalue()
+            if base_bytes:
+                self.map_image = Image.open(BytesIO(base_bytes)).convert("RGBA")
 
-        return frame_bytes
+            if legend_bytes:
+                self.legend_image = Image.open(BytesIO(legend_bytes)).convert("RGB")
+                legend_width = self.legend_image.size[0]
+                self.legend_position = (self.width - legend_width, 0)
+                self.legend_layer = self.layer_key
+
+            # Add transparency to radar
+            if self.radar_opacity < 100:
+                alpha = round((self.radar_opacity / 100) * 255)
+                radar_copy = radar.copy()
+                radar_copy.putalpha(alpha)
+                radar.paste(radar_copy, radar)
+
+            if self.show_timestamp and not self.font:
+                self.font = ImageFont.load(
+                    os.path.join(os.path.dirname(__file__), "10x20.pil")
+                )
+
+            # Overlay radar on basemap
+            if self.map_image:
+                frame = Image.alpha_composite(self.map_image, radar)
+            else:
+                frame = radar
+
+            # Add legend
+            if self.show_legend and self.legend_image:
+                frame.paste(self.legend_image, self.legend_position)
+
+            # Add timestamp
+            if self.show_timestamp and self.font:
+                timestamp = (
+                    timestamp_label[self.layer_key][self.language]
+                    + " @ "
+                    + frame_time.astimezone().strftime("%H:%M")
+                )
+                text_box = Image.new("RGBA", self.font.getbbox(timestamp)[2:], "white")
+                box_draw = ImageDraw.Draw(text_box)
+                box_draw.text(xy=(0, 0), text=timestamp, fill=(0, 0, 0), font=self.font)
+                double_box = text_box.resize((text_box.width * 2, text_box.height * 2))
+                frame.paste(double_box)
+                frame = frame.quantize()
+
+            # Return frame as PNG bytes
+            img_byte_arr = BytesIO()
+            frame.save(img_byte_arr, format="PNG")
+            frame_bytes = img_byte_arr.getvalue()
+
+            return frame_bytes
+
+        # Since PIL is synchronous, run it all in another thread
+        return await asyncio.get_event_loop().run_in_executor(None, _create_image)
 
     async def _get_radar_image(self, session, frame_time):
         params = dict(
@@ -331,6 +345,17 @@ class ECRadar(object):
     async def get_loop(self, fps=5):
         """Build an animated GIF of recent radar images."""
 
+        def build_image():
+            gif_frames = [imageio.imread(f, mode="RGBA") for f in frames]
+            gif_bytes = imageio.mimwrite(
+                imageio.RETURN_BYTES,
+                gif_frames,
+                format="GIF",
+                duration=duration,
+                subrectangles=True,
+            )
+            return gif_bytes
+
         """Build list of frame timestamps."""
         start, end = await self._get_dimensions()
         frame_times = [start]
@@ -361,12 +386,6 @@ class ECRadar(object):
         """Assemble animated GIF."""
         duration = 1000 / fps
 
-        gif_frames = [imageio.imread(f, mode="RGBA") for f in frames]
-        gif_bytes = imageio.mimwrite(
-            imageio.RETURN_BYTES,
-            gif_frames,
-            format="GIF",
-            duration=duration,
-            subrectangles=True,
-        )
+        loop = asyncio.get_running_loop()
+        gif_bytes = await loop.run_in_executor(None, build_image)
         return gif_bytes

env_canada/ec_weather.py

@@ -137,24 +137,6 @@ conditions_meta = {
         "english": "Icon Code",
         "french": "Code icône",
     },
-    "high_temp_yesterday": {
-        "xpath": './yesterdayConditions/temperature[@class="high"]',
-        "type": "float",
-        "english": "High Temperature Yesterday",
-        "french": "Haute température d'hier",
-    },
-    "low_temp_yesterday": {
-        "xpath": './yesterdayConditions/temperature[@class="low"]',
-        "type": "float",
-        "english": "Low Temperature Yesterday",
-        "french": "Basse température d'hier",
-    },
-    "precip_yesterday": {
-        "xpath": "./yesterdayConditions/precip",
-        "type": "float",
-        "english": "Precipitation Yesterday",
-        "french": "Précipitation d'hier",
-    },
     "normal_high": {
         "xpath": './forecastGroup/regionalNormals/temperature[@class="high"]',
         "type": "int",
@@ -183,7 +165,7 @@ conditions_meta = {
         "xpath": "./currentConditions/dateTime/timeStamp",
         "type": "timestamp",
         "english": "Observation Time",
-        "french": "Temps d'observation"
+        "french": "Temps d'observation",
     },
 }
 
@@ -278,7 +260,6 @@ def closest_site(site_list, lat, lon):
 
 
 class ECWeather(object):
-
     """Get weather data from Environment Canada."""
 
     def __init__(self, **kwargs):
@@ -432,7 +413,9 @@ class ECWeather(object):
                 self.conditions[c].update(get_condition(meta))
 
             # Update station metadata
-            self.metadata["station"] = weather_tree.find("./currentConditions/station").text
+            self.metadata["station"] = weather_tree.find(
+                "./currentConditions/station"
+            ).text
 
             # Update text summary
             period = get_condition(summary_meta["forecast_period"])["value"]
@@ -494,7 +477,9 @@ class ECWeather(object):
                     "temperature": int(f.findtext("./temperature") or 0),
                     "icon_code": f.findtext("./iconCode"),
                     "precip_probability": int(f.findtext("./lop") or "0"),
-                    "wind_speed": int(wind_speed_text if wind_speed_text.isnumeric() else 0),
+                    "wind_speed": int(
+                        wind_speed_text if wind_speed_text.isnumeric() else 0
+                    ),
                     "wind_direction": f.findtext("./wind/direction"),
                 }
             )

{env_canada-0.6.1.dist-info → env_canada-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: env-canada
-Version: 0.6.1
+Name: env_canada
+Version: 0.7.0
 Summary: A package to access meteorological data from Environment Canada
 Home-page: https://github.com/michaeldavie/env_canada
 Author: Michael Davie
@@ -25,7 +25,7 @@ Requires-Dist: voluptuous
 # Environment Canada (env_canada)
 
 [![PyPI version](https://badge.fury.io/py/env-canada.svg)](https://badge.fury.io/py/env-canada)
-[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.6.1?utm_source=badge)
+[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.7.0?utm_source=badge)
 
 This package provides access to various data sources published by [Environment and Climate Change Canada](https://www.canada.ca/en/environment-climate-change.html).
 
@@ -116,7 +116,8 @@ Once updated asynchronously, historical weather data is contained with the `stat
 ```python
 import asyncio
 
-from env_canada import ECHistorical, get_historical_stations
+from env_canada import ECHistorical
+from env_canada.ec_historical import get_historical_stations
 
 # search for stations, response contains station_ids
 coordinates = [53.916944, -122.749444] # [lat, long]
@@ -165,7 +166,8 @@ For example :
 ```python
 import pandas as pd
 import asyncio
-from env_canada import ECHistoricalRange, get_historical_stations
+from env_canada import ECHistoricalRange
+from env_canada.ec_historical import get_historical_stations
 from datetime import datetime
 
 coordinates = ['48.508333', '-68.467667']
@@ -205,4 +207,4 @@ of `datetime(2022, 7, 1, 12, 12)`
 
 # License
 
-The code is available under terms of [MIT License](LICENSE.md)
+The code is available under terms of [MIT License](https://github.com/michaeldavie/env_canada/tree/master/LICENSE.md)

env_canada-0.7.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+env_canada/10x20.pbm,sha256=ClKTs2WUmhUhTHAQzPuGwPTICGVBzCvos5l-vHRBE5M,2463
+env_canada/10x20.pil,sha256=Oki6-TD7b0xFtfm6vxCKsmpEpsZ5Jaia_0v_aDz8bfE,5143
+env_canada/__init__.py,sha256=wEx1BCwVUH__GoosSlhNMHuUKCKNZAvv5uuSa5ZWq_g,187
+env_canada/constants.py,sha256=xUcfT4fpHqhAnvC1GZ_gpYYrJYozfitwFiOBKN65xXg,32
+env_canada/ec_aqhi.py,sha256=kJQ8xEgFnujGMYdxRXpoEK17B5e-ya-Y7rK0vLo_-w0,7768
+env_canada/ec_cache.py,sha256=qoFxmO-kOBT8jhgPeNWtVBRmguXcARIIOI54OaDh-20,1171
+env_canada/ec_exc.py,sha256=SBJwzmLf94lTx7KYVLfQYrMXYNYUoIxeVXc-BLkuXoE,67
+env_canada/ec_historical.py,sha256=slHaFwsoyW16uCVtE3_-IF3_BFhFD4IuWl7rpIRsCm4,15901
+env_canada/ec_hydro.py,sha256=LBsWreTlaTKec6ObjI0ih8-zOKBNjD02oiXKTyUa1EQ,4898
+env_canada/ec_radar.py,sha256=gcLa2z5T_CkrY-NLEJRqaLDHODJRcO5unW5MGxjKxF8,13115
+env_canada/ec_weather.py,sha256=M7nPeZIKLirRIcCENB8z2B8aBDZHrjltzMYPgRz9lz0,16789
+env_canada-0.7.0.dist-info/LICENSE,sha256=c037dTHQWAgRgDqZNN-5d-CZvcteSYN37u39SNklO0I,1072
+env_canada-0.7.0.dist-info/METADATA,sha256=IueyWyN-i8vtUD8G4p8kMumCncfOUyPUrUS_TMEfw7w,10707
+env_canada-0.7.0.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
+env_canada-0.7.0.dist-info/top_level.txt,sha256=fw7Pcl9ULBXYvqnAdyBdmwPXW8GSRFmhO0sLZWVfOCc,11
+env_canada-0.7.0.dist-info/RECORD,,

{env_canada-0.6.1.dist-info → env_canada-0.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (70.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

env_canada-0.6.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-env_canada/10x20.pbm,sha256=ClKTs2WUmhUhTHAQzPuGwPTICGVBzCvos5l-vHRBE5M,2463
-env_canada/10x20.pil,sha256=Oki6-TD7b0xFtfm6vxCKsmpEpsZ5Jaia_0v_aDz8bfE,5143
-env_canada/__init__.py,sha256=wQpbGVmwROrIR06RWinatD-qX7fbJvxBFOd6U0xoek4,126
-env_canada/constants.py,sha256=IsaGrjrg-YGadCHWyT0ZkBjbTDaF14W1gBPGQylncUY,32
-env_canada/ec_aqhi.py,sha256=kJQ8xEgFnujGMYdxRXpoEK17B5e-ya-Y7rK0vLo_-w0,7768
-env_canada/ec_cache.py,sha256=qoFxmO-kOBT8jhgPeNWtVBRmguXcARIIOI54OaDh-20,1171
-env_canada/ec_exc.py,sha256=SBJwzmLf94lTx7KYVLfQYrMXYNYUoIxeVXc-BLkuXoE,67
-env_canada/ec_historical.py,sha256=slHaFwsoyW16uCVtE3_-IF3_BFhFD4IuWl7rpIRsCm4,15901
-env_canada/ec_hydro.py,sha256=LBsWreTlaTKec6ObjI0ih8-zOKBNjD02oiXKTyUa1EQ,4898
-env_canada/ec_radar.py,sha256=WaJHtNnuQa3XoidvymOjJxNHqRLORTcy6_mczjIwd_A,12217
-env_canada/ec_weather.py,sha256=uBY6qd0-hVyZDhqPcpipfMDImXpJGiNIzMOjIzqNBfo,17358
-env_canada-0.6.1.dist-info/LICENSE,sha256=c037dTHQWAgRgDqZNN-5d-CZvcteSYN37u39SNklO0I,1072
-env_canada-0.6.1.dist-info/METADATA,sha256=yy2_dg0TKwYxaIwyc1UfBHiuIQpt3hyETSkzvnRPGU0,10580
-env_canada-0.6.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-env_canada-0.6.1.dist-info/top_level.txt,sha256=fw7Pcl9ULBXYvqnAdyBdmwPXW8GSRFmhO0sLZWVfOCc,11
-env_canada-0.6.1.dist-info/RECORD,,