Source code for pyowm.alertapi30.condition

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from pyowm.commons import exceptions




class Condition:
    """
    Object representing a condition to be checked on a specific weather parameter. A condition is given when comparing
    the weather parameter against a numerical value with respect to an operator.
    Allowed weather params and operators are specified by the `pyowm.utils.alertapi30.WeatherParametersEnum` and
    `pyowm.utils.alertapi30.OperatorsEnum` enumerator classes.
    :param weather_param: the weather variable to be checked (eg. TEMPERATURE, CLOUDS, ...)
    :type weather_param: str
    :param operator: the comparison operator to be applied to the weather variable (eg. GREATER_THAN, EQUAL, ...)
    :type operator: str
    :param amount: comparison value
    :type amount: int or float
    :param id: optional unique ID for this Condition instance
    :type id: str
    :returns:  a *Condition* instance
    :raises: *AssertionError* when either the weather param has wrong type or the operator has wrong type or the
    amount has wrong type

    """
    def __init__(self, weather_param, operator, amount, id=None):
        assert weather_param is not None
        assert isinstance(weather_param, str), "Value must be a string"
        self.weather_param = weather_param

        assert operator is not None
        assert isinstance(operator, str), "Value must be a string"
        self.operator = operator

        assert amount is not None
        assert isinstance(amount, (int, float))
        self.amount = amount
        self.id = id



    @classmethod
    def from_dict(cls, the_dict):
        if the_dict is None:
            raise exceptions.ParseAPIResponseError('Data is None')
        try:
            weather_param = the_dict['name']
            operator = the_dict['expression']
            amount = the_dict['amount']
            the_id = the_dict.get('_id', None)
            return Condition(weather_param, operator, amount, id=the_id)
        except KeyError as e:
            raise exceptions.ParseAPIResponseError('Impossible to parse data: %s' % e)




    def to_dict(self):
        return {
            'id': self.id,
            'weather_param': self.weather_param,
            'operator': self.operator,
            'amount': self.amount}


    def __repr__(self):
        return '<%s.%s - when %s %s %s>' % (__name__, self.__class__.__name__, self.weather_param,
                                            self.operator, str(self.amount))