Merge pull request #15 from wmo-raf/dev

Refactoring

Author: erick-otenyo

forecastmanager/blocks.py

@@ -1,5 +1,4 @@
 from wagtail import blocks
-from django.utils.translation import gettext_lazy as _
 
 
 class ExtremeMeasurementBlock(blocks.StructBlock):
@@ -13,7 +12,7 @@ class Meta:
 class ExtremeBlock(blocks.StructBlock):
     title = blocks.CharBlock(required=True)
     measurements = blocks.StreamBlock([
-        ('measurements',ExtremeMeasurementBlock() )
+        ('measurements', ExtremeMeasurementBlock())
     ])
 
     class Meta:

forecastmanager/constants.py

@@ -0,0 +1,185 @@
+from django.utils.translation import gettext_lazy as _
+
+# extracted from https://nrkno.github.io/yr-weather-symbols/
+WEATHER_CONDITIONS = [
+    {'id': 'clearsky_day', 'name': 'Clear sky Day'},
+    {'id': 'clearsky_night', 'name': 'Clear sky Night'},
+    {'id': 'clearsky_polartwilight', 'name': 'Clear sky Polar Twilight'},
+
+    {'id': 'fair_day', 'name': 'Fair Day'},
+    {'id': 'fair_night', 'name': 'Fair Night'},
+    {'id': 'fair_polartwilight', 'name': 'Fair Polar Twilight'},
+
+    {'id': 'partlycloudy_day', 'name': 'Partly Cloudy Day'},
+    {'id': 'partlycloudy_night', 'name': 'Partly Cloudy Night'},
+    {'id': 'partlycloudy_polartwilight', 'name': 'Partly Cloudy Polar Twilight'},
+
+    {'id': 'cloudy', 'name': 'Cloudy'},
+
+    {'id': 'rainshowers_day', 'name': 'Rain Showers Day'},
+    {'id': 'rainshowers_night', 'name': 'Rain Showers Night'},
+    {'id': 'rainshowers_polartwilight', 'name': 'Rain Showers Polar Twilight'},
+
+    {'id': 'rainshowersandthunder_day', 'name': 'Rain Showers and Thunder Day'},
+    {'id': 'rainshowersandthunder_night', 'name': 'Rain Showers and Thunder Night'},
+    {'id': 'rainshowersandthunder_polartwilight', 'name': 'Rain Showers and Thunder Polar Twilight'},
+
+    {'id': 'sleetshowers_day', 'name': 'Sleet Showers Day'},
+    {'id': 'sleetshowers_night', 'name': 'Sleet Showers Night'},
+    {'id': 'sleetshowers_polartwilight', 'name': 'Sleet Showers Polar Twilight'},
+
+    {'id': 'snowshowers_day', 'name': 'Snow Showers Day'},
+    {'id': 'snowshowers_night', 'name': 'Snow Showers Night'},
+    {'id': 'snowshowers_polartwilight', 'name': 'Snow Showers Polar Twilight'},
+
+    {'id': 'rain', 'name': 'Rain'}, {'id': 'heavyrain', 'name': 'Heavy Rain'},
+
+    {'id': 'heavyrainandthunder', 'name': 'Heavy Rain and Thunder'}, {'id': 'sleet', 'name': 'Sleet'},
+
+    {'id': 'snow', 'name': 'Snow'}, {'id': 'snowandthunder', 'name': 'Snow and Thunder'},
+
+    {'id': 'fog', 'name': 'Fog'},
+
+    {'id': 'sleetshowersandthunder_day', 'name': 'Sleet Showers and Thunder Day'},
+    {'id': 'sleetshowersandthunder_night', 'name': 'Sleet Showers and Thunder Night'},
+    {'id': 'sleetshowersandthunder_polartwilight', 'name': 'Sleet Showers and Thunder Polar Twilight'},
+
+    {'id': 'snowshowersandthunder_day', 'name': 'Snow Showers and Thunder Day'},
+    {'id': 'snowshowersandthunder_night', 'name': 'Snow Showers and Thunder Night'},
+    {'id': 'snowshowersandthunder_polartwilight', 'name': 'Snow Showers and Thunder Polar Twilight'},
+
+    {'id': 'rainandthunder', 'name': 'Rain and Thunder'},
+
+    {'id': 'sleetandthunder', 'name': 'Sleet and Thunder'},
+
+    {'id': 'lightrainshowersandthunder_day', 'name': 'Light Rain Showers and Thunder Day'},
+    {'id': 'lightrainshowersandthunder_night', 'name': 'Light Rain Showers and Thunder Night'},
+    {'id': 'lightrainshowersandthunder_polartwilight', 'name': 'Light Rain Showers and Thunder Polar Twilight'},
+
+    {'id': 'heavyrainshowersandthunder_day', 'name': 'Heavy Rain Showers and Thunder Day'},
+    {'id': 'heavyrainshowersandthunder_night', 'name': 'Heavy Rain Showers and Thunder Night'},
+    {'id': 'heavyrainshowersandthunder_polartwilight', 'name': 'Heavy Rain Showers and Thunder Polar Twilight'},
+
+    {'id': 'lightsleetshowersandthunder_day', 'name': 'Light Sleet Showers and Thunder Day'},
+    {'id': 'lightsleetshowersandthunder_night', 'name': 'Light Sleet Showers and Thunder Night'},
+    {'id': 'lightsleetshowersandthunder_polartwilight', 'name': 'Light Sleet Showers and Thunder Polar Twilight'},
+
+    {'id': 'heavysleetshowersandthunder_day', 'name': 'Heavy Sleet Showers and Thunder Day'},
+    {'id': 'heavysleetshowersandthunder_night', 'name': 'Heavy Sleet Showers and Thunder Night'},
+    {'id': 'heavysleetshowersandthunder_polartwilight', 'name': 'Heavy Sleet Showers and Thunder Polar Twilight'},
+
+    {'id': 'lightsnowshowersandthunder_day', 'name': 'Light Snow Showers and Thunder Day'},
+    {'id': 'lightsnowshowersandthunder_night', 'name': 'Light Snow Showers and Thunder Night'},
+    {'id': 'lightsnowshowersandthunder_polartwilight', 'name': 'Light Snow Showers and Thunder Polar Twilight'},
+
+    {'id': 'heavysnowshowersandthunder_day', 'name': 'Heavy Snow Showers and Thunder Day'},
+    {'id': 'heavysnowshowersandthunder_night', 'name': 'Heavy Snow Showers and Thunder Night'},
+    {'id': 'heavysnowshowersandthunder_polartwilight', 'name': 'Heavy Snow Showers and Thunder Polar Twilight'},
+
+    {'id': 'lightrainandthunder', 'name': 'Light Rain and Thunder'},
+    {'id': 'lightsleetandthunder', 'name': 'Light Sleet and Thunder'},
+    {'id': 'heavysleetandthunder', 'name': 'Heavy Sleet and Thunder'},
+    {'id': 'lightsnowandthunder', 'name': 'Light Snow and Thunder'},
+    {'id': 'heavysnowandthunder', 'name': 'Heavy Snow and Thunder'},
+    {'id': 'lightrainshowers_day', 'name': 'Light Rain Showers Day'},
+    {'id': 'lightrainshowers_night', 'name': 'Light Rain Showers Night'},
+    {'id': 'lightrainshowers_polartwilight', 'name': 'Light Rain Showers Polar Twilight'},
+    {'id': 'heavyrainshowers_day', 'name': 'Heavy Rain Showers Day'},
+    {'id': 'heavyrainshowers_night', 'name': 'Heavy Rain Showers Night'},
+    {'id': 'heavyrainshowers_polartwilight', 'name': 'Heavy Rain Showers Polar Twilight'},
+    {'id': 'lightsleetshowers_day', 'name': 'Light Sleet Showers Day'},
+    {'id': 'lightsleetshowers_night', 'name': 'Light Sleet Showers Night'},
+    {'id': 'lightsleetshowers_polartwilight', 'name': 'Light Sleet Showers Polar Twilight'},
+    {'id': 'heavysleetshowers_day', 'name': 'Heavy Sleet Showers Day'},
+    {'id': 'heavysleetshowers_night', 'name': 'Heavy Sleet Showers Night'},
+    {'id': 'heavysleetshowers_polartwilight', 'name': 'Heavy Sleet Showers Polar Twilight'},
+    {'id': 'lightsnowshowers_day', 'name': 'Light Snow Showers Day'},
+    {'id': 'lightsnowshowers_night', 'name': 'Light Snow Showers Night'},
+    {'id': 'lightsnowshowers_polartwilight', 'name': 'Light Snow Showers Polar Twilight'},
+    {'id': 'heavysnowshowers_day', 'name': 'Heavy Snow Showers Day'},
+    {'id': 'heavysnowshowers_night', 'name': 'Heavy Snow Showers Night'},
+    {'id': 'heavysnowshowers_polartwilight', 'name': 'Heavy Snow Showers Polar Twilight'},
+    {'id': 'lightrain', 'name': 'Light Rain'}, {'id': 'lightsleet', 'name': 'Light Sleet'},
+    {'id': 'heavysleet', 'name': 'Heavy Sleet'}, {'id': 'lightsnow', 'name': 'Light Snow'},
+    {'id': 'heavysnow', 'name': 'Heavy Snow'}]
+
+WEATHER_PARAMETERS = [
+    {
+        "name": "air_temperature_max",
+        "label": "Maximum Air Temperature",
+        "unit": "°C",
+        "data_type": "int"
+    },
+    {
+        "name": "air_temperature_min",
+        "label": "Minimum Air Temperature",
+        "unit": "°C",
+        "data_type": "int"
+    },
+    {
+        "name": "air_temperature",
+        "label": "Air Temperature",
+        "unit": "°C",
+        "data_type": "int"
+    },
+    {
+        "name": "dew_point_temperature",
+        "label": "Dew Point Temperature",
+        "unit": "°C",
+        "data_type": "int"
+    },
+    {
+        "name": "precipitation_amount",
+        "label": "Precipitation Amount",
+        "unit": "mm",
+        "data_type": "float"
+    },
+    {
+        "name": "air_pressure_at_sea_level",
+        "label": "Air Pressure (Sea level)",
+        "unit": "hPa",
+        "data_type": "int"
+    },
+    {
+        "name": "wind_speed",
+        "label": "Wind Speed",
+        "unit": "m/s",
+        "data_type": "int"
+    },
+    {
+        "name": "wind_from_direction",
+        "label": "Wind Direction",
+        "unit": "°",
+        "data_type": "int"
+    },
+    {
+        "name": "relative_humidity",
+        "label": "Relative Humidity",
+        "unit": "%",
+        "data_type": "int"
+    },
+    {
+        "name": "sunrise",
+        "label": "Sunrise",
+    },
+    {
+        "name": "sunset",
+        "label": "Sunset",
+    },
+    {
+        "name": "moonrise",
+        "label": "Moonrise",
+    },
+    {
+        "name": "moonset",
+        "label": "Moonset",
+    },
+]
+
+WEATHER_PARAMETER_CHOICES = [(param['name'], _(param['label'])) for param in WEATHER_PARAMETERS]
+
+WEATHER_PARAMETERS_AS_DICT = {param['name']: param for param in WEATHER_PARAMETERS}
+
+WEATHER_CONDITION_CHOICES = [(condition['id'], _(condition['name'])) for condition in WEATHER_CONDITIONS]
+
+WEATHER_CONDITIONS_AS_DICT = {condition['id']: condition for condition in WEATHER_CONDITIONS}

forecastmanager/forecast_settings.py

@@ -0,0 +1,151 @@
+from django.db import models
+from django.templatetags.static import static
+from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy as _
+from modelcluster.fields import ParentalKey
+from modelcluster.models import ClusterableModel
+from wagtail.admin.panels import (
+    FieldPanel,
+    TabbedInterface,
+    ObjectList, InlinePanel,
+)
+from wagtail.contrib.settings.models import BaseSiteSetting
+from wagtail.contrib.settings.registry import register_setting
+from wagtail.models import Orderable
+
+from forecastmanager.constants import WEATHER_PARAMETER_CHOICES, WEATHER_PARAMETERS_AS_DICT
+from forecastmanager.widgets import WeatherSymbolChooserWidget
+
+
+@register_setting
+class ForecastSetting(ClusterableModel, BaseSiteSetting):
+    enable_auto_forecast = models.BooleanField(default=False, verbose_name=_('Enable automated forecasts'))
+    default_city = models.ForeignKey("City", blank=True, null=True, on_delete=models.CASCADE,
+                                     verbose_name=_("Default City"))
+    weather_detail_page = models.ForeignKey("wagtailcore.Page", blank=True, null=True, on_delete=models.SET_NULL, )
+
+    edit_handler = TabbedInterface([
+        ObjectList([
+            InlinePanel('periods', heading=_("Forecast Periods"), label=_("Forecast Period")),
+        ], heading=_("Forecast Periods")),
+        ObjectList([
+            InlinePanel('data_parameters', heading=_("Data Parameters"), label=_("Data Parameter")),
+        ], heading=_("Forecast Data Parameters")),
+        ObjectList([
+            InlinePanel('weather_conditions', heading=_("Weather Conditions"), label=_("Weather Condition")),
+        ], heading=_("Forecast Weather Conditions")),
+        ObjectList([
+            FieldPanel('enable_auto_forecast'),
+        ], heading=_("Forecast Source")),
+        ObjectList([
+            FieldPanel('default_city'),
+            FieldPanel('weather_detail_page'),
+        ], heading=_("City")),
+    ])
+
+    @cached_property
+    def data_parameter_values(self):
+        data_parameters = self.data_parameters.all()
+        params = []
+        for param in data_parameters:
+            params.append({"parameter": param.parameter, "name": param.name, "parameter_type": param.parameter_type,
+                           "parameter_unit": param.parameter_unit if param.parameter_unit else " "})
+        return params
+
+    @property
+    def periods_as_choices(self):
+        return [(period.id, period.label) for period in self.periods.all()]
+
+    @property
+    def weather_conditions_list(self):
+        weather_conditions = self.weather_conditions.all()
+        return [c.alias if c.alias else c.label for c in weather_conditions]
+
+
+class ForecastPeriod(Orderable):
+    parent = ParentalKey(ForecastSetting, on_delete=models.CASCADE, related_name="periods")
+    default = models.BooleanField(default=False, verbose_name=_("Is default"))
+    forecast_effective_time = models.TimeField(verbose_name=_("Forecast Effective Time"))
+    label = models.CharField(max_length=100, verbose_name=_("Label"))
+
+    class Meta:
+        unique_together = ("default", "forecast_effective_time")
+
+    panels = [
+        FieldPanel('forecast_effective_time'),
+        FieldPanel('label'),
+        FieldPanel('default'),
+    ]
+
+    def __str__(self):
+        return self.label
+
+    def save(self, *args, **kwargs):
+        if self.default:
+            ForecastPeriod.objects.filter(default=True).update(default=False)
+        super().save(*args, **kwargs)
+
+
+class ForecastDataParameters(Orderable):
+    PARAMETER_TYPE_CHOICES = (
+        ("numeric", _("Number")),
+        ("time", _("Time")),
+        ("text", _("Text")),
+    )
+    parent = ParentalKey(ForecastSetting, on_delete=models.CASCADE, related_name="data_parameters")
+    parameter = models.CharField(max_length=100, choices=WEATHER_PARAMETER_CHOICES, unique=True,
+                                 verbose_name=_("Parameter"))
+    name = models.CharField(max_length=100, verbose_name=_("Parameter Label"),
+                            help_text=_("Parameter name as locally labelled"))
+    parameter_type = models.CharField(max_length=100, choices=PARAMETER_TYPE_CHOICES, verbose_name=_("Parameter Type"),
+                                      default="numeric")
+    parameter_unit = models.CharField(_("Unit of measurement"), max_length=100, null=True, blank=True,
+                                      help_text="e.g °C, %, mm, hPa, etc ")
+
+    panels = [
+        FieldPanel('parameter'),
+        FieldPanel('name'),
+    ]
+
+    def __str__(self):
+        return self.name
+
+    @property
+    def parameter_info(self):
+        return WEATHER_PARAMETERS_AS_DICT.get(self.parameter)
+
+    def parse_value(self, value):
+        info = self.parameter_info
+
+        if not info.get("data_type"):
+            return value
+
+        try:
+            if info.get("data_type") == "int":
+                return int(float(value))
+            elif info.get("data_type") == "float":
+                return float(value)
+        except ValueError:
+            pass
+
+        return value
+
+
+class WeatherCondition(Orderable):
+    parent = ParentalKey(ForecastSetting, on_delete=models.CASCADE, related_name="weather_conditions")
+    symbol = models.CharField(max_length=100, verbose_name=_("Weather Symbol"))
+    label = models.CharField(max_length=100, unique=True, verbose_name=_("Label"))
+    alias = models.CharField(max_length=100, blank=True, null=True, unique=True, verbose_name=_("Alias"))
+
+    panels = [
+        FieldPanel('symbol', widget=WeatherSymbolChooserWidget),
+        FieldPanel('label'),
+        FieldPanel('alias'),
+    ]
+
+    def __str__(self):
+        return self.label
+
+    @property
+    def icon_url(self):
+        return static('forecastmanager/weathericons/{}.png'.format(self.symbol))