​
WeatherToolkit

class WeatherToolkit(BaseToolkit):

A class representing a toolkit for interacting with weather data.

This class provides methods for fetching weather data for a given city using the OpenWeatherMap API.

​
init

def __init__(self, timeout: Optional[float] = None):

Initializes a new instance of the WeatherToolkit class.

Parameters:

  • timeout (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:None)

​
get_openweathermap_api_key

def get_openweathermap_api_key(self):

Returns:

str: The OpenWeatherMap API key.

​
get_weather_data

def get_weather_data(
    self,
    city: str,
    temp_units: Literal['kelvin', 'celsius', 'fahrenheit'] = 'kelvin',
    wind_units: Literal['meters_sec', 'miles_hour', 'knots', 'beaufort'] = 'meters_sec',
    visibility_units: Literal['meters', 'miles'] = 'meters',
    time_units: Literal['unix', 'iso', 'date'] = 'unix'
):

Fetch and return a comprehensive weather report for a given city as a string. The report includes current weather conditions, temperature, wind details, visibility, and sunrise/sunset times, all formatted as a readable string.

The function interacts with the OpenWeatherMap API to retrieve the data.

Parameters:

  • city (str): The name of the city for which the weather information is desired. Format “City, CountryCode” (e.g., “Paris, FR” for Paris, France). If the country code is not provided, the API will search for the city in all countries, which may yield incorrect results if multiple cities with the same name exist.
  • temp_units (Literal['kelvin', 'celsius', 'fahrenheit']): Units for temperature. (default: :obj:kelvin) wind_units (Literal[‘meters_sec’, ‘miles_hour’, ‘knots’, ‘beaufort’]): Units for wind speed. (default: :obj:meters_sec)
  • visibility_units (Literal['meters', 'miles']): Units for visibility distance. (default: :obj:meters)
  • time_units (Literal['unix', 'iso', 'date']): Format for sunrise and sunset times. (default: :obj:unix)

Returns:

str: A string containing the fetched weather data, formatted in a readable manner. If an error occurs, a message indicating the error will be returned instead.

Example of return string: “Weather in Paris, FR: 15°C, feels like 13°C. Max temp: 17°C, Min temp : 12°C. Wind: 5 m/s at 270 degrees. Visibility: 10 kilometers. Sunrise at 05:46:05 (UTC), Sunset at 18:42:20 (UTC).”

Note: Please ensure that the API key is valid and has permissions to access the weather data.

​
get_tools

def get_tools(self):

Returns:

List[FunctionTool]: A list of FunctionTool objects representing the functions in the toolkit.