Skip to content

Destination Weather API

Module for the HERE Destination Weather API.

DestinationWeatherApi

Bases: HEREApi

A python interface into the HERE Destination Weather API.

Source code in src/herepy/destination_weather_api.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class DestinationWeatherApi(HEREApi):
    """A python interface into the HERE Destination Weather API."""

    def __init__(self, api_key: str = None, timeout: int = None):
        """
        Initialize a DestinationWeatherApi instance.

        Args:
          api_key (str):
            API key taken from HERE Developer Portal.
          timeout (int):
            Timeout limit for requests.

        """
        super().__init__(api_key, timeout)
        self._base_url = "https://weather.cc.api.here.com/weather/1.0/report.json"

    def _get(self, data, product):
        url = Utils.build_url(self._base_url, extra_params=data)
        response = requests.get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get(self._product_node(product)) is not None:
            return DestinationWeatherResponse.new_from_jsondict(json_data, param_defaults={self._product_node(product): None})
        else:
            error = self._get_error_from_response(json_data)
            raise error

    def _get_error_from_response(self, json_data):
        if "error" in json_data:
            if json_data["error"] == "Unauthorized":
                return UnauthorizedError(json_data["error_description"])
        error_type = json_data.get("Type")
        error_message = json_data.get("Message", "Error occurred on " + sys._getframe(1).f_code.co_name)
        if error_type == "Invalid Request":
            return InvalidRequestError(error_message)
        else:
            return HEREError(error_message)

    def _product_node(self, product):
        if product == WeatherProductType.observation:
            return "observations"
        elif product == WeatherProductType.forecast_7days:
            return "forecasts"
        elif product == WeatherProductType.forecast_7days_simple:
            return "dailyForecasts"
        elif product == WeatherProductType.forecast_hourly:
            return "hourlyForecasts"
        elif product == WeatherProductType.forecast_astronomy:
            return "astronomy"
        elif product == WeatherProductType.alerts:
            return "alerts"
        else:
            return "nwsAlerts"

    def weather_for_location_name(
        self,
        location_name: str,
        product: WeatherProductType,
        one_observation: bool = True,
        metric: bool = True,
    ) -> DestinationWeatherResponse | None:
        """
        Request the product for given location name.

        Args:
          location_name (str):
            Location name.
          product (WeatherProductType):
            A WeatherProductType identifying the type of report to obtain.
          one_observation (bool):
            Limit the result to the best mapped weather station.
          metric (bool):
            Use the metric system.

        Returns:
          DestinationWeatherResponse
        Raises:
          HEREError

        """
        data = {
            "apiKey": self._api_key,
            "product": product.__str__(),
            "oneobservation": "true" if one_observation else "false",
            "metric": "true" if metric else "false",
            "name": location_name,
        }
        return self._get(data, product)

    def weather_for_zip_code(
        self,
        zip_code: int,
        product: WeatherProductType,
        one_observation: bool = True,
        metric: bool = True,
    ) -> DestinationWeatherResponse | None:
        """
        Request the product for given zip code.

        Args:
          zip_code (int):
            U.S. zip code.
          product (WeatherProductType):
            A WeatherProductType identifying the type of report to obtain.
          one_observation (bool):
            Limit the result to the best mapped weather station.
          metric (bool):
            Use the metric system.

        Returns:
          DestinationWeatherResponse
        Raises:
          HEREError

        """
        data = {
            "apiKey": self._api_key,
            "product": product.__str__(),
            "oneobservation": "true" if one_observation else "false",
            "metric": "true" if metric else "false",
            "zipcode": zip_code,
        }
        return self._get(data, product)

    def weather_for_coordinates(
        self,
        latitude: float,
        longitude: float,
        product: WeatherProductType,
        one_observation: bool = True,
        metric: bool = True,
    ) -> DestinationWeatherResponse | None:
        """
        Request the product for given coordinates.

        Args:
          latitude (float):
            Latitude.
          longitude (float):
            Longitude.
          product (WeatherProductType):
            A WeatherProductType identifying the type of report to obtain.
          one_observation (bool):
            Limit the result to the best mapped weather station.
          metric (bool):
            Use the metric system.

        Returns:
          DestinationWeatherResponse
        Raises:
          HEREError

        """
        data = {
            "apiKey": self._api_key,
            "product": product.__str__(),
            "oneobservation": "true" if one_observation else "false",
            "metric": "true" if metric else "false",
            "latitude": latitude,
            "longitude": longitude,
        }
        return self._get(data, product)

__init__(api_key=None, timeout=None)

Initialize a DestinationWeatherApi instance.

Parameters:

Name Type Description Default
api_key str

API key taken from HERE Developer Portal.

 None
timeout int

Timeout limit for requests.

 None
Source code in src/herepy/destination_weather_api.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
def __init__(self, api_key: str = None, timeout: int = None):
    """
    Initialize a DestinationWeatherApi instance.

    Args:
      api_key (str):
        API key taken from HERE Developer Portal.
      timeout (int):
        Timeout limit for requests.

    """
    super().__init__(api_key, timeout)
    self._base_url = "https://weather.cc.api.here.com/weather/1.0/report.json"

weather_for_coordinates(latitude, longitude, product, one_observation=True, metric=True)

Request the product for given coordinates.

Parameters:

Name Type Description Default
latitude float

Latitude.

 required
longitude float

Longitude.

 required
product WeatherProductType

A WeatherProductType identifying the type of report to obtain.

 required
one_observation bool

Limit the result to the best mapped weather station.

 True
metric bool

Use the metric system.

 True

Returns:

Type Description
DestinationWeatherResponse | None

DestinationWeatherResponse

Raises: HEREError

Source code in src/herepy/destination_weather_api.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def weather_for_coordinates(
    self,
    latitude: float,
    longitude: float,
    product: WeatherProductType,
    one_observation: bool = True,
    metric: bool = True,
) -> DestinationWeatherResponse | None:
    """
    Request the product for given coordinates.

    Args:
      latitude (float):
        Latitude.
      longitude (float):
        Longitude.
      product (WeatherProductType):
        A WeatherProductType identifying the type of report to obtain.
      one_observation (bool):
        Limit the result to the best mapped weather station.
      metric (bool):
        Use the metric system.

    Returns:
      DestinationWeatherResponse
    Raises:
      HEREError

    """
    data = {
        "apiKey": self._api_key,
        "product": product.__str__(),
        "oneobservation": "true" if one_observation else "false",
        "metric": "true" if metric else "false",
        "latitude": latitude,
        "longitude": longitude,
    }
    return self._get(data, product)

weather_for_location_name(location_name, product, one_observation=True, metric=True)

Request the product for given location name.

Parameters:

Name Type Description Default
location_name str

Location name.

 required
product WeatherProductType

A WeatherProductType identifying the type of report to obtain.

 required
one_observation bool

Limit the result to the best mapped weather station.

 True
metric bool

Use the metric system.

 True

Returns:

Type Description
DestinationWeatherResponse | None

DestinationWeatherResponse

Raises: HEREError

Source code in src/herepy/destination_weather_api.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def weather_for_location_name(
    self,
    location_name: str,
    product: WeatherProductType,
    one_observation: bool = True,
    metric: bool = True,
) -> DestinationWeatherResponse | None:
    """
    Request the product for given location name.

    Args:
      location_name (str):
        Location name.
      product (WeatherProductType):
        A WeatherProductType identifying the type of report to obtain.
      one_observation (bool):
        Limit the result to the best mapped weather station.
      metric (bool):
        Use the metric system.

    Returns:
      DestinationWeatherResponse
    Raises:
      HEREError

    """
    data = {
        "apiKey": self._api_key,
        "product": product.__str__(),
        "oneobservation": "true" if one_observation else "false",
        "metric": "true" if metric else "false",
        "name": location_name,
    }
    return self._get(data, product)

weather_for_zip_code(zip_code, product, one_observation=True, metric=True)

Request the product for given zip code.

Parameters:

Name Type Description Default
zip_code int

U.S. zip code.

 required
product WeatherProductType

A WeatherProductType identifying the type of report to obtain.

 required
one_observation bool

Limit the result to the best mapped weather station.

 True
metric bool

Use the metric system.

 True

Returns:

Type Description
DestinationWeatherResponse | None

DestinationWeatherResponse

Raises: HEREError

Source code in src/herepy/destination_weather_api.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def weather_for_zip_code(
    self,
    zip_code: int,
    product: WeatherProductType,
    one_observation: bool = True,
    metric: bool = True,
) -> DestinationWeatherResponse | None:
    """
    Request the product for given zip code.

    Args:
      zip_code (int):
        U.S. zip code.
      product (WeatherProductType):
        A WeatherProductType identifying the type of report to obtain.
      one_observation (bool):
        Limit the result to the best mapped weather station.
      metric (bool):
        Use the metric system.

    Returns:
      DestinationWeatherResponse
    Raises:
      HEREError

    """
    data = {
        "apiKey": self._api_key,
        "product": product.__str__(),
        "oneobservation": "true" if one_observation else "false",
        "metric": "true" if metric else "false",
        "zipcode": zip_code,
    }
    return self._get(data, product)