lories.components.weather.forecast#

Classes#

WeatherForecast

Helper class that provides a standard way to create an ABC using

Module Contents#

class lories.components.weather.forecast.WeatherForecast(context: lories._core._registrator.RegistratorContext, configs: lories._core._configurations.Configurations | None = None, **kwargs)[source]#

Bases: lories.components.weather.Weather

Inheritance diagram of lories.components.weather.forecast.WeatherForecast

Helper class that provides a standard way to create an ABC using inheritance.

get(start: pandas.Timestamp | datetime.datetime | str | None = None, end: pandas.Timestamp | datetime.datetime | str | None = None, timezone: pytz.BaseTzInfo | str | int | float | None = None, **kwargs) → pandas.DataFrame[source]#

Retrieves the forecasted data for a specified time interval

Parameters:

  • start (pandas.Timestamp, datetime or str) – the start timestamp for which forecasted data will be looked up for. For many applications, passing datetime.datetime.now() will suffice.

  • end (pandas.Timestamp, datetime or str) – the end timestamp for which forecasted data will be looked up for.

  • timezone (pytz.BaseTzInfo, str or number) – the timezone for the timestamps data will be looked up for.

Returns:

the forecasted data, indexed in a specific time interval.

Return type:

pandas.DataFrame