simple-dwd-weatherforecast 2.0.33__py3-none-any.whl → 2.1.0__py3-none-any.whl

simple_dwd_weatherforecast/dwdforecast.py

@@ -298,13 +298,15 @@ class Weather:
         return (
             self.strip_to_day(
                 arrow.get(
-                    list(self.forecast_data.keys())[0], "YYYY-MM-DDTHH:mm:ss.SSSZ"  # type: ignore
+                    list(self.forecast_data.keys())[0],  # type: ignore
+                    "YYYY-MM-DDTHH:mm:ss.SSSZ",  # type: ignore
                 ).datetime
             )
             <= self.strip_to_day(timestamp)
             <= self.strip_to_day(
                 arrow.get(
-                    list(self.forecast_data.keys())[-1], "YYYY-MM-DDTHH:mm:ss.SSSZ"  # type: ignore
+                    list(self.forecast_data.keys())[-1],  # type: ignore
+                    "YYYY-MM-DDTHH:mm:ss.SSSZ",  # type: ignore
                 ).datetime
             )
         )
@@ -358,7 +360,7 @@ class Weather:
     def get_daily_condition(self, timestamp: datetime, shouldUpdate=True):
         if shouldUpdate:
             self.update()
-        if self.is_in_timerange(timestamp):
+        if self.is_in_timerange_day(timestamp):
             return self.get_condition(self.get_day_values(timestamp))
         return None
 
@@ -609,7 +611,8 @@ class Weather:
         "timestamp has to be checked prior to be in timerange"
         result = []
         first_entry_date = arrow.get(
-            next(iter(self.forecast_data)), "YYYY-MM-DDTHH:mm:ss.SSSZ"  # type: ignore
+            next(iter(self.forecast_data)),  # type: ignore
+            "YYYY-MM-DDTHH:mm:ss.SSSZ",  # type: ignore
         ).datetime  # type: ignore
         if timestamp.day != first_entry_date.day:
             time_step = self.strip_to_day(timestamp)

simple_dwd_weatherforecast/dwdmap.py

@@ -1,8 +1,11 @@
+from typing import Iterable
 import requests
 import math
 from io import BytesIO
-from PIL import Image
+from PIL import Image, ImageFile
 from enum import Enum
+from collections import deque
+from datetime import datetime, timedelta, timezone
 
 
 class WeatherMapType(Enum):
@@ -25,6 +28,13 @@ class WeatherBackgroundMapType(Enum):
     GEWAESSER = "dwd:Gewaesser"
 
 
+class germany_boundaries:
+    minx = 4.4
+    miny = 46.4
+    maxx = 16.1
+    maxy = 55.6
+
+
 def get_from_location(
     longitude,
     latitude,
@@ -60,7 +70,14 @@ def get_germany(
     image_height=580,
 ):
     return get_map(
-        4.4, 46.4, 16.1, 55.6, map_type, background_type, image_width, image_height
+        germany_boundaries.minx,
+        germany_boundaries.miny,
+        germany_boundaries.maxx,
+        germany_boundaries.maxy,
+        map_type,
+        background_type,
+        image_width,
+        image_height,
     )
 
 
@@ -83,3 +100,83 @@ def get_map(
     if request.status_code == 200:
         image = Image.open(BytesIO(request.content))
         return image
+
+
+class ImageLoop:
+    _last_update: datetime
+    _images: deque[ImageFile.ImageFile]
+
+    _minx: float
+    _miny: float
+    _maxx: float
+    _maxy: float
+    _map_type: WeatherMapType
+    _background_type: WeatherBackgroundMapType
+    _image_width: int
+    _image_height: int
+
+    def __init__(
+        self,
+        minx: float,
+        miny: float,
+        maxx: float,
+        maxy: float,
+        map_type: WeatherMapType,
+        background_type: WeatherBackgroundMapType,
+        steps: int = 6,
+        image_width: int = 520,
+        image_height: int = 580,
+    ):
+        if image_width > 1200 or image_height > 1400:
+            raise ValueError(
+                "Width and height must not exceed 1200 and 1400 respectively. Please be kind to the DWD servers."
+            )
+        self._minx = minx
+        self._miny = miny
+        self._maxx = maxx
+        self._maxy = maxy
+        self._map_type = map_type
+        self._background_type = background_type
+        self._steps = steps
+        self._image_width = image_width
+        self._image_height = image_height
+
+        self._images = deque([], steps)
+
+        self._full_reload()
+
+    def get_images(self) -> Iterable[ImageFile.ImageFile]:
+        return self._images
+
+    def _full_reload(self):
+        self._images.clear()
+        now = get_time_last_5_min(datetime.now(timezone.utc))
+        self._last_update = now - timedelta(minutes=5) * self._steps
+
+        while now > self._last_update:
+            self._last_update += timedelta(minutes=5)
+            self._images.append(self._get_image(self._last_update))
+
+    def update(self):
+        now = get_time_last_5_min(datetime.now(timezone.utc))
+
+        # If last update is older than the buffer can hold, reload the whole buffer
+        if now - self._last_update > self._steps * timedelta(minutes=5):
+            self._full_reload()
+        # Update the buffer and fetch only the new images
+        else:
+            while now > self._last_update:
+                self._last_update += timedelta(minutes=5)
+                self._images.append(self._get_image(self._last_update))
+
+    def _get_image(self, date: datetime) -> ImageFile.ImageFile:
+        url = f"https://maps.dwd.de/geoserver/dwd/wms?service=WMS&version=1.1.0&request=GetMap&layers={self._map_type.value},{self._background_type.value}&bbox={self._minx},{self._miny},{self._maxx},{self._maxy}&width={self._image_width}&height={self._image_height}&srs=EPSG:4326&styles=&format=image/png&TIME={date.strftime("%Y-%m-%dT%H:%M:00.0Z")}"
+        request = requests.get(url, stream=True)
+        if request.status_code != 200:
+            raise ConnectionError("Error during image request from DWD servers")
+        return Image.open(BytesIO(request.content))
+
+
+def get_time_last_5_min(date: datetime) -> datetime:
+    minute = math.floor(date.minute / 5) * 5
+    return date.replace(minute=minute, second=0, microsecond=0)

{simple_dwd_weatherforecast-2.0.33.dist-info → simple_dwd_weatherforecast-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simple_dwd_weatherforecast
-Version: 2.0.33
+Version: 2.1.0
 Summary: A simple tool to retrieve a weather forecast from DWD OpenData
 Home-page: https://github.com/FL550/simple_dwd_weatherforecast.git
 Author: Max Fermor
@@ -198,13 +198,50 @@ class WeatherBackgroundMapType(Enum):
     GEMEINDEN = "dwd:Warngebiete_Gemeinden"
     SATELLIT = "dwd:bluemarble"
 
-def get_from_location(longitude, latitude, radius_km, map_type: WeatherMapType, background_type: WeatherBackgroundMapType, optional integer image_width, optional integer image_height) #Returns map as pillow image with given radius from coordinates
+get_from_location(longitude, latitude, radius_km, map_type: WeatherMapType, background_type: WeatherBackgroundMapType, optional integer image_width, optional integer image_height) #Returns map as pillow image with given radius from coordinates
 
 get_germany(map_type: WeatherMapType, optional WeatherBackgroundMapType background_type, optional integer image_width, optional integer image_height, optional string save_to_filename) #Returns map as pillow image of whole germany
 
 get_map(minx,miny,maxx,maxy, map_type: WeatherMapType, background_type: WeatherBackgroundMapType, optional integer image_width, optional integer image_height, optional string save_to_filename) #Returns map as pillow image
 ```
 
+
+### Image loop
+
+There is also the possibility to retrieve multiple images as a loop. This can be done by the class ImageLoop.
+
+
+#### Usage example
+```python
+from simple_dwd_weatherforecast import dwdmap
+
+maploop = dwdmap.ImageLoop(
+    dwdmap.germany_boundaries.minx,
+    dwdmap.germany_boundaries.miny,
+    dwdmap.germany_boundaries.maxx,
+    dwdmap.germany_boundaries.maxy,
+    dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+    dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+    steps=5,
+)
+
+for image in enumerate(maploop._images):
+    image[1].save(f"image{image[0]}.png")
+
+```
+
+#### Available methods
+
+```python
+ImageLoop(minx: float, miny: float, maxx: float, maxy: float, map_type: WeatherMapType, background_type: WeatherBackgroundMapType,
+        steps: int = 6, image_width: int = 520,image_height: int = 580) -> ImageLoop
+
+get_images() -> Iterable[ImageFile.ImageFile] # Returns the image loop
+
+update() # Updates the loop to the most recent files
+
+```
+
 ## Help and Contribution
 
 Feel free to open an issue if you find one and I will do my best to help you. If you want to contribute, your help is appreciated! If you want to add a new feature, add a pull request first so we can chat about the details.

{simple_dwd_weatherforecast-2.0.33.dist-info → simple_dwd_weatherforecast-2.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 simple_dwd_weatherforecast/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-simple_dwd_weatherforecast/dwdforecast.py,sha256=4ZqQweWyXCMJ8NajdKV_Ca0WkbxrsJXKX7RD0lQayXU,36587
-simple_dwd_weatherforecast/dwdmap.py,sha256=fZMi3nk4MwzZm0dJ8TUwCgOuTw6t8kZmnOkoHGKpXx4,2695
+simple_dwd_weatherforecast/dwdforecast.py,sha256=ctnQAFJS8UID9KZCXK7O5FyBTlgkqvoNLVJG5E3TkCY,36694
+simple_dwd_weatherforecast/dwdmap.py,sha256=OpFbBgALHUcvuH95dzOxMPwb7eFGNX7OJJkNPRr0AB4,5954
 simple_dwd_weatherforecast/stations.json,sha256=1u8qc2CT_rVy49SAlOicGixzHln6Y0FXevuFAz2maBw,838948
 simple_dwd_weatherforecast/uv_stations.json,sha256=ADenYo-aR6qbf0UFkfYr72kkFzL9HyUKe4VQ23POGF8,2292
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -8,7 +8,7 @@ tests/dummy_data.py,sha256=sF8pXxq8innSpRc4lW0XxGcr34dESSAoBdAf2F2D4AI,63395
 tests/dummy_data_full.py,sha256=IwYoeqVX8cpfn_gE-7arXaWV9btRm_HHqka_LfKqW-E,64053
 tests/dummy_uv.py,sha256=TM1TwvNq_ea4WgIJyYsNAEXZJTx1dXH1ZVrW_LfLBLg,4548
 tests/test_get_daily_avg.py,sha256=MNd7u9Y7_E6SIyxg59EKfdKx4QJ7R_WT5wvRgm7Gzks,2315
-tests/test_get_daily_condition.py,sha256=foRgUO0W4ctWuer04RvUi2JqcFpiDBhFoLg9OdQSFj8,2004
+tests/test_get_daily_condition.py,sha256=9Qrhv14-vLnLz0N0FWG7Mv6_iEbNPqrHDDWWNQNydU0,2298
 tests/test_get_daily_max.py,sha256=schjGJDflg1YEQSdfRndw2NT4AvrVheSDveyVZrFySM,2220
 tests/test_get_daily_min.py,sha256=GzqlOfLdwLqGLYVeAJ0fbK1JRq-_fT7z6Gea74lSY7E,2224
 tests/test_get_daily_sum.py,sha256=UEntbPwGSleHocu0587WnuC5ijptQtzVNreR1d6yoM0,2221
@@ -25,7 +25,7 @@ tests/test_get_timeframe_values.py,sha256=z8ozpWlyilw8-zjbk2gDExhTobNbgmcVTbZ6ZH
 tests/test_is_in_timerange.py,sha256=3y88L3N73NxSTJ-_edx6OCnxHWKJWWFma98gjZvJDGg,1338
 tests/test_is_valid_timeframe.py,sha256=mXjeu3lUyixiBUEljirTf6qDM_FZFQGWa-Rk0NBMUDU,891
 tests/test_location_tools.py,sha256=wto_XzVnARJQ-Qc83YAn0ahfMBSaOHpfzqAeKRDsNm8,1208
-tests/test_map.py,sha256=Bnf7XSap7xAfozE5U9aB0GjjMiHmXrpyJPE79VmEvFg,830
+tests/test_map.py,sha256=uKxNjMXLFT3pczZKLqkfPK5xaVfmql-r5L9VPgCbS3Q,5671
 tests/test_parsekml.py,sha256=Y0EHJi5e8lqFUS8N9yfA5ByQkKV4-iyrwUaIipQpM7w,1065
 tests/test_region.py,sha256=ReUB9Cy9roBemkpEkTjZZav-Mu3Ha7ADOAfa9J-gi80,877
 tests/test_reported_weather.py,sha256=ULg4ogZRxus01p2rdxiSFL75AisqtcvnLDOc7uJMBH0,767
@@ -35,8 +35,8 @@ tests/test_update.py,sha256=r763R-MfqFqQQy43PcmE9yWAiQU6T2rQ1u55ujlwMt8,7216
 tests/test_update_hourly.py,sha256=mUc66JHndgIMdZ0DD_KXQTbPPg1g86F6CPUwJYjBV5U,1619
 tests/test_uv_index.py,sha256=tr6wnOyHlXT1S3yp1oeHc4-Brmc-EMEdM4mtyrdpcHg,579
 tests/test_weather.py,sha256=ZyX4ldUoJpJp7YpiNQwU6Od-nYRay-3qcaDJdNq8fhY,780
-simple_dwd_weatherforecast-2.0.33.dist-info/LICENCE,sha256=27UG7gteqvSWuZlsbIq2_OAbh7VyifGGl-1zpuUoBcw,1072
-simple_dwd_weatherforecast-2.0.33.dist-info/METADATA,sha256=OoVmEQpJwfD2ThO8I7DcKwD2Xcv0sm5izDTWFaJkOTs,10937
-simple_dwd_weatherforecast-2.0.33.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
-simple_dwd_weatherforecast-2.0.33.dist-info/top_level.txt,sha256=iyEobUh14Tzitx39Oi8qm0NhBrnZovl_dNKtvLUkLEM,33
-simple_dwd_weatherforecast-2.0.33.dist-info/RECORD,,
+simple_dwd_weatherforecast-2.1.0.dist-info/LICENCE,sha256=27UG7gteqvSWuZlsbIq2_OAbh7VyifGGl-1zpuUoBcw,1072
+simple_dwd_weatherforecast-2.1.0.dist-info/METADATA,sha256=Czz5cBb-mPwEPqRITu4_umcHf-Krkb0kGjlBJwlqQDw,11893
+simple_dwd_weatherforecast-2.1.0.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
+simple_dwd_weatherforecast-2.1.0.dist-info/top_level.txt,sha256=iyEobUh14Tzitx39Oi8qm0NhBrnZovl_dNKtvLUkLEM,33
+simple_dwd_weatherforecast-2.1.0.dist-info/RECORD,,

{simple_dwd_weatherforecast-2.0.33.dist-info → simple_dwd_weatherforecast-2.1.0.dist-info}/WHEEL

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

tests/test_get_daily_condition.py

@@ -49,3 +49,11 @@ class Weather_get_daily_condition(unittest.TestCase):
             self.dwd_weather.get_daily_condition(test_time),
             "cloudy",
         )
+
+    @patch("simple_dwd_weatherforecast.dwdforecast.Weather.update", return_value=None)
+    def test_same_day(self, _):
+        test_time = datetime(2020, 11, 6, 0, 0)
+        self.assertEqual(
+            self.dwd_weather.get_daily_condition(test_time),
+            "sunny",
+        )

tests/test_map.py

@@ -1,16 +1,171 @@
 import unittest
+from unittest.mock import patch
 from simple_dwd_weatherforecast import dwdmap
+from datetime import datetime, timedelta, timezone
 
 
 class MapTestCase(unittest.TestCase):
     def test_prevent_too_large_height(self):
         with self.assertRaises(ValueError):
-            dwdmap.get_map(4.4, 46.4, 16.1, 55.6, dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR, dwdmap.WeatherBackgroundMapType.BUNDESLAENDER, 1300, 700)
+            dwdmap.get_map(
+                4.4,
+                46.4,
+                16.1,
+                55.6,
+                dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+                dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+                1300,
+                700,
+            )
 
     def test_prevent_too_large_width(self):
         with self.assertRaises(ValueError):
-            dwdmap.get_map(4.4, 46.4, 16.1, 55.6, dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR, dwdmap.WeatherBackgroundMapType.BUNDESLAENDER, 300, 1700)
+            dwdmap.get_map(
+                4.4,
+                46.4,
+                16.1,
+                55.6,
+                dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+                dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+                300,
+                1700,
+            )
 
     def test_prevent_too_large(self):
         with self.assertRaises(ValueError):
-            dwdmap.get_map(4.4, 46.4, 16.1, 55.6, dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR, dwdmap.WeatherBackgroundMapType.BUNDESLAENDER, 1300, 1700)
+            dwdmap.get_map(
+                4.4,
+                46.4,
+                16.1,
+                55.6,
+                dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+                dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+                1300,
+                1700,
+            )
+
+
+class ImageLoopTestCase(unittest.TestCase):
+    @patch("simple_dwd_weatherforecast.dwdmap.ImageLoop._get_image", return_value=None)
+    def test_init(self, mock_function):
+        maploop = dwdmap.ImageLoop(
+            0.1,
+            0.2,
+            0.3,
+            0.4,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+            1,
+        )
+        self.assertEqual(
+            maploop._minx,
+            0.1,
+        )
+        self.assertEqual(
+            maploop._miny,
+            0.2,
+        )
+        self.assertEqual(
+            maploop._maxx,
+            0.3,
+        )
+        self.assertEqual(
+            maploop._maxy,
+            0.4,
+        )
+        self.assertEqual(
+            maploop._map_type,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+        )
+        self.assertEqual(
+            maploop._background_type,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+        )
+        mock_function.assert_called_once()
+
+    @patch("simple_dwd_weatherforecast.dwdmap.ImageLoop._get_image", return_value=None)
+    def test_steps1(self, mock_function):
+        _ = dwdmap.ImageLoop(
+            0.1,
+            0.2,
+            0.3,
+            0.4,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+            5,
+        )
+        self.assertEqual(mock_function.call_count, 5)
+
+    @patch("simple_dwd_weatherforecast.dwdmap.ImageLoop._get_image", return_value=None)
+    def test_steps2(self, mock_function):
+        _ = dwdmap.ImageLoop(
+            0.1,
+            0.2,
+            0.3,
+            0.4,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+            10,
+        )
+        self.assertEqual(mock_function.call_count, 10)
+
+    @patch("simple_dwd_weatherforecast.dwdmap.ImageLoop._get_image", return_value=None)
+    def test_update_full(self, mock_function):
+        maploop = dwdmap.ImageLoop(
+            0.1,
+            0.2,
+            0.3,
+            0.4,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+            5,
+        )
+        maploop._last_update = datetime(year=2024, month=9, day=4, hour=5, minute=50)
+        self.assertEqual(mock_function.call_count, 5)
+
+    @patch("simple_dwd_weatherforecast.dwdmap.ImageLoop._get_image", return_value=None)
+    def test_update_part(self, mock_function):
+        maploop = dwdmap.ImageLoop(
+            0.1,
+            0.2,
+            0.3,
+            0.4,
+            dwdmap.WeatherMapType.NIEDERSCHLAGSRADAR,
+            dwdmap.WeatherBackgroundMapType.BUNDESLAENDER,
+            5,
+        )
+        now = dwdmap.get_time_last_5_min(datetime.now(timezone.utc))
+        maploop._last_update = now - timedelta(minutes=15)
+        mock_function.reset_mock()
+        maploop.update()
+        self.assertEqual(mock_function.call_count, 3)
+
+
+class GeneralTestCase(unittest.TestCase):
+    def test_get_time_last_5_min_strip(self):
+        time = datetime(year=2024, month=9, day=4, hour=9, minute=50, second=52)
+        self.assertEqual(
+            dwdmap.get_time_last_5_min(time),
+            datetime(year=2024, month=9, day=4, hour=9, minute=50),
+        )
+
+    def test_get_time_last_5_min_exact(self):
+        time = datetime(year=2024, month=9, day=4, hour=9, minute=50, second=00)
+        self.assertEqual(
+            dwdmap.get_time_last_5_min(time),
+            datetime(year=2024, month=9, day=4, hour=9, minute=50),
+        )
+
+    def test_get_time_last_5_min_between1(self):
+        time = datetime(year=2024, month=9, day=4, hour=9, minute=52, second=00)
+        self.assertEqual(
+            dwdmap.get_time_last_5_min(time),
+            datetime(year=2024, month=9, day=4, hour=9, minute=50),
+        )
+
+    def test_get_time_last_5_min_between2(self):
+        time = datetime(year=2024, month=9, day=4, hour=9, minute=3, second=00)
+        self.assertEqual(
+            dwdmap.get_time_last_5_min(time),
+            datetime(year=2024, month=9, day=4, hour=9, minute=0),
+        )