meteoalarmapi 0.4.0__py3-none-any.whl

meteoalarmapi/__init__.py

@@ -0,0 +1,8 @@
+from .meteoalert import (
+    Meteoalert,
+    ServerError,
+    UnexpectedError,
+    WrongCountry,
+)
+
+__all__ = ["Meteoalert", "ServerError", "UnexpectedError", "WrongCountry"]

meteoalarmapi/meteoalert.py

@@ -0,0 +1,173 @@
+"""Weather alerts for a European region from MeteoAlarm.org.
+
+Reads the country's legacy Atom feed, keeps the entries whose area matches
+the region (by name or EMMA_ID code) and fetches each one's CAP document.
+"""
+
+import re
+from datetime import datetime, timezone
+
+import requests
+import xmltodict
+
+
+class WrongCountry(Exception):
+    pass
+
+
+class ServerError(Exception):
+    pass
+
+
+class UnexpectedError(Exception):
+    pass
+
+
+# CAP severities, least to most severe
+SEVERITIES = ["Unknown", "Minor", "Moderate", "Severe", "Extreme"]
+TIMEOUT = 10
+
+
+def _utcnow():
+    # A function so tests can patch the clock
+    return datetime.now(timezone.utc)
+
+
+class Meteoalert:
+
+    endpoint = "https://feeds.meteoalarm.org/feeds/meteoalarm-legacy-atom-{0}"
+
+    def __init__(self, country, province, language="en-GB"):
+        self.country = country.lower()
+        self.province = province
+        self.language = language
+
+    def get_alert(self):
+        """The most severe alert for the province, or {} when there is none.
+
+        See get_alerts() for the order.
+        """
+        alerts = self.get_alerts()
+        return alerts[0] if alerts else {}
+
+    def get_alerts(self, include_expired=True):
+        """Every alert for the province, most severe first.
+
+        Unexpired alerts come first, then the highest awareness level (or CAP
+        severity when there is none). Equally ranked alerts keep feed order.
+
+        With include_expired=False, expired alerts are left out. Future
+        alerts (not started yet) are kept, so upcoming warnings still show.
+        """
+        feed = xmltodict.parse(self._fetch(self.endpoint.format(self.country)))
+        entries = (feed.get("feed") or {}).get("entry", [])
+        if not isinstance(entries, list):
+            entries = [entries]
+
+        alerts = []
+        # The feed has an entry per language and area of an alert, all
+        # pointing at the same CAP document, so fetch each one once.
+        seen = set()
+        for entry in entries:
+            if not self.is_location_match(entry, self.province):
+                continue
+            links = entry.get("link", [])
+            if not isinstance(links, list):
+                links = [links]
+            cap_url = next((link.get("@href") for link in links
+                            if link.get("@type") == "application/cap+xml"), None)
+            if cap_url and cap_url not in seen:
+                seen.add(cap_url)
+                text = self._fetch(cap_url, missing_ok=True)
+                # A warning withdrawn between reading the feed and fetching its
+                # document is gone, not a sign of a wrong country, so skip it.
+                if text is not None:
+                    alerts.append(self._parse_cap(text))
+
+        if not include_expired:
+            # Some feeds keep warnings for a while after they end
+            alerts = [a for a in alerts if not self.is_expired(a.get("expires"))]
+
+        # sorted() is stable, so equally ranked alerts keep feed order
+        return sorted(alerts, key=self.alert_rank, reverse=True)
+
+    def _parse_cap(self, text):
+        """The CAP <info> in the requested language (or the first one) as a dict,
+        plus the message fields needed to track an alert across updates"""
+        alert = xmltodict.parse(text).get("alert", {})
+        infos = alert.get("info", [])
+        if not isinstance(infos, list):
+            infos = [infos]
+        if not infos:
+            return {}
+        info = next((i for i in infos if self.language in (i.get("language") or "")),
+                    infos[0])
+
+        data = {key: value for key, value in info.items() if isinstance(value, str)}
+        parameters = info.get("parameter", [])
+        if not isinstance(parameters, list):
+            parameters = [parameters]
+        for parameter in parameters:
+            data[parameter.get("valueName")] = parameter.get("value")
+
+        # Each CAP message has its own identifier; an Update or Cancel lists
+        # the messages it replaces in references
+        data["identifier"] = alert.get("identifier")
+        data["message_type"] = alert.get("msgType")
+        data["references"] = alert.get("references")
+        data["sent"] = alert.get("sent")
+        return data
+
+    def alert_rank(self, data):
+        """Sort key for an alert: (not expired, awareness level, severity)"""
+        level = re.match(r"\s*(\d+)", data.get("awareness_level") or "")
+        severity = data.get("severity")
+        return (
+            not self.is_expired(data.get("expires")),
+            int(level.group(1)) if level else 0,
+            SEVERITIES.index(severity) if severity in SEVERITIES else 0,
+        )
+
+    @staticmethod
+    def is_expired(expires):
+        """Whether a CAP time (2024-01-01T12:00:00+01:00) is in the past"""
+        try:
+            moment = datetime.fromisoformat(expires.replace("Z", "+00:00"))
+        except (AttributeError, ValueError):
+            return False
+        if moment.tzinfo is None:
+            moment = moment.replace(tzinfo=timezone.utc)
+        return moment <= _utcnow()
+
+    def is_location_match(self, entry, province):
+        # Attempt to match the province first by regex on name
+        if re.search(rf"{province}", entry.get("cap:areaDesc") or "", re.IGNORECASE):
+            return True
+
+        # then by areaCode
+        geocode = entry.get("cap:geocode")
+        return isinstance(geocode, dict) and geocode.get("value") == province
+
+    def _fetch(self, url, missing_ok=False):
+        """The response text, or None for a 404/410 when missing_ok"""
+        try:
+            response = requests.get(url, timeout=TIMEOUT)
+        except Exception as err:
+            raise UnexpectedError(str(err)) from err
+        if missing_ok and response.status_code in (404, 410):
+            return None
+        self.check_status_code(response.status_code)
+        return response.content.decode("utf-8")
+
+    def check_status_code(self, status_code):
+        if status_code == 404:
+            # MeteoAlarm sometimes briefly returns 404 for valid countries too
+            raise WrongCountry(
+                f"MeteoAlarm has no feed for country {self.country!r} (404). Check the "
+                "name matches feeds.meteoalarm.org; if it does, MeteoAlarm may be "
+                "temporarily unavailable"
+            )
+        elif status_code >= 500:
+            raise ServerError(f"Server error - status code: {status_code}")
+        elif status_code != 200:
+            raise UnexpectedError(f"Server returned unexpected status code: {status_code}")

meteoalarmapi-0.4.0.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.5
+Name: meteoalarmapi
+Version: 0.4.0
+Summary: Weather alerts for European regions from MeteoAlarm.org. A maintained fork of meteoalertapi.
+Project-URL: Source, https://github.com/mastermc0/meteoalarmapi
+Project-URL: Issues, https://github.com/mastermc0/meteoalarmapi/issues
+Project-URL: Original, https://github.com/rolfberkenbosch/meteoalert-api
+Author: Rolf Berkenbosch
+Maintainer: mastermc0
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: requests
+Requires-Dist: xmltodict
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: requests-mock; extra == 'test'
+Description-Content-Type: text/markdown
+
+# meteoalarmapi
+
+![PyPI](https://img.shields.io/pypi/v/meteoalarmapi.svg?style=for-the-badge)
+
+An unofficial Python wrapper for [MeteoAlarm.org](https://meteoalarm.org) (European weather alerts), which can be used to check whether a given province in your country currently has a weather alert.
+
+This is a maintained fork of [meteoalertapi](https://github.com/rolfberkenbosch/meteoalert-api) by Rolf Berkenbosch, which has had no releases since February 2024. It keeps the same `Meteoalert` class and alert fields. See [What changed from meteoalertapi](#what-changed-from-meteoalertapi).
+
+## Installation
+
+```console
+pip install meteoalarmapi
+```
+
+## Code example
+
+```python
+from meteoalarmapi import Meteoalert
+
+# Find your country and province on https://meteoalarm.org/ or https://feeds.meteoalarm.org/
+# The province can be its name (matched as a regular expression) or its EMMA_ID code.
+meteo = Meteoalert('united-kingdom', 'Highlands & Eilean Siar')
+
+# The most severe current alert, or {} when there is none
+print(meteo.get_alert())
+
+# Every alert for the province, most severe first
+for alert in meteo.get_alerts():
+    print(alert['event'], alert['severity'], alert['onset'], alert['expires'])
+```
+
+Each alert also has the CAP message fields `identifier`, `message_type` (`Alert`, `Update` or `Cancel`), `references` and `sent`, so you can follow a warning across updates and tell when one is cancelled.
+
+Some feeds keep warnings for a while after they end. Pass `include_expired=False` to leave expired alerts out. Future alerts, which haven't started yet, are kept:
+
+```python
+for alert in meteo.get_alerts(include_expired=False):
+    print(alert['event'], alert['onset'], alert['expires'])
+```
+
+Alerts are ranked with current ones first, then by awareness level (`awareness_level`, e.g. `3; Orange; Severe`), then by CAP severity. Alerts that rank equally keep their order in the feed.
+
+## What changed from meteoalertapi
+
+- The package is now imported as `meteoalarmapi` instead of `meteoalertapi`.
+- `get_alert()` returns the most severe current alert. Before, it returned the first match in the feed, so a yellow warning could hide an amber one.
+- New `get_alerts()` returns every matching alert, most severe first.
+- `get_alerts(include_expired=False)` leaves out expired alerts, which some feeds keep for a while. Future alerts are kept.
+- `awareness_level`, `awareness_type` and the other CAP parameters are now included for feeds with a single language, such as the UK's. Before, they were silently dropped.
+- An alert listed several times in the feed (once per language or area) is returned and fetched only once.
+- Each alert includes the CAP `identifier`, `message_type`, `references` and `sent`.
+- Python 3.10 or newer is required.
+
+## Changelog
+
+See the [CHANGELOG](./CHANGELOG.md) file.
+
+## License
+
+MIT. Original work copyright (c) 2018 Rolf Berkenbosch.

meteoalarmapi-0.4.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+meteoalarmapi/__init__.py,sha256=m5QxF1M2bJ7_e_ODEdq4etSSHFdpsyfb5gbrGhtgRBY,176
+meteoalarmapi/meteoalert.py,sha256=GrmVryeIcZJa5lxae6B3bdSaWyKFmKus4Igs_3dcuqA,6573
+meteoalarmapi-0.4.0.dist-info/METADATA,sha256=Hh1Ezn_v5uki2kZ0zDfy3J2W9LjyIG6Bo3HUccm1Vco,3656
+meteoalarmapi-0.4.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+meteoalarmapi-0.4.0.dist-info/licenses/LICENSE,sha256=HBaBGf6hr0cOIaBAABNb1Tw8EWYSIYofOInJLKikqV0,1072
+meteoalarmapi-0.4.0.dist-info/RECORD,,

meteoalarmapi-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

meteoalarmapi-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rolf Berkenbosch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.