aiopywttr¶
Welcome to the documentation of aiopywttr, the asynchronous wrapper for the wttr.in weather API!
Synchronous version here.
Installation¶
The latest version can be installed with the following command:
pip install -U aiopywttr pywttr-models
API Reference¶
Asynchronous wrapper for wttr.in weather API.
Examples:
Choose language. First option is preferred because of type safety.
language = aiopywttr.Language.ZH_CN
language = aiopywttr.Language["ZH_CN"]
language = aiopywttr.Language("zh-cn")
Print the average temperature in Paris today:
async with aiopywttr.Wttr() as wttr:
weather = await wttr.weather("Paris", language=language)
print(weather.weather[0].avgtemp_c)
Custom base url:
async with aiopywttr.Wttr(
base_url=pydantic.AnyHttpUrl("https://example.com")
) as wttr:
...
Custom aiohttp.ClientSession:
async with aiohttp.ClientSession(
timeout=aiohttp.ClientTimeout(total=60, connect=5)
) as session:
wttr = aiopywttr.Wttr(session=session)
...
__version__ module-attribute ¶
__version__ = '3.0.2'
Language ¶
Bases: StrEnum
StrEnum of languages supported by wttr.in.
Examples:
First option is preferred because of type safety.
language = Language.ZH_CN
language = Language["ZH_CN"]
language = Language("zh-cn")
Wttr ¶
Wttr(
*,
base_url: AnyHttpUrl = build(
scheme="https", host="wttr.in"
),
session: ClientSession | None = None,
)
Asynchronous wrapper for wttr.in weather API.
Examples:
Choose language. First option is preferred because of type safety.
language = aiopywttr.Language.ZH_CN
language = aiopywttr.Language["ZH_CN"]
language = aiopywttr.Language("zh-cn")
Print the average temperature in Paris today:
async with aiopywttr.Wttr() as wttr:
weather = await wttr.weather("Paris", language=language)
print(weather.weather[0].avgtemp_c)
Custom base url:
async with aiopywttr.Wttr(
base_url=pydantic.AnyHttpUrl("https://example.com")
) as wttr:
...
Custom aiohttp.ClientSession:
async with aiohttp.ClientSession(
timeout=aiohttp.ClientTimeout(total=60, connect=5)
) as session:
wttr = aiopywttr.Wttr(session=session)
...
base_url property ¶
base_url: AnyHttpUrl
session property ¶
session: ClientSession | None
weather async ¶
Asynchronous wrapper for wttr.in weather API.
Examples:
Choose language. First option is preferred because of type safety.
language = aiopywttr.Language.ZH_CN
language = aiopywttr.Language["ZH_CN"]
language = aiopywttr.Language("zh-cn")
Print the average temperature in Paris today:
async with aiopywttr.Wttr() as wttr:
weather = await wttr.weather("Paris", language=language)
print(weather.weather[0].avgtemp_c)
Custom base url:
async with aiopywttr.Wttr(
base_url=pydantic.AnyHttpUrl("https://example.com")
) as wttr:
...
Custom aiohttp.ClientSession:
async with aiohttp.ClientSession(
timeout=aiohttp.ClientTimeout(total=60, connect=5)
) as session:
wttr = aiopywttr.Wttr(session=session)
...
models ¶
Internal library for pywttr and aiopywttr.
AnyModel module-attribute ¶
AnyModel: TypeAlias = (
Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
| Model
)
__version__ module-attribute ¶
__version__ = '2.0.7'
af ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_af instance-attribute ¶
lang_af: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_af instance-attribute ¶
lang_af: tuple[WeatherDescItem, ...]
am ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_am instance-attribute ¶
lang_am: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_am instance-attribute ¶
lang_am: tuple[WeatherDescItem, ...]
ar ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ar instance-attribute ¶
lang_ar: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ar instance-attribute ¶
lang_ar: tuple[WeatherDescItem, ...]
base ¶
LangItem module-attribute ¶
LangItem = WeatherDescItem
CurrentConditionItem ¶
Bases: FrozenModel
precip_inches class-attribute instance-attribute ¶
pressure_inches class-attribute instance-attribute ¶
visibility_miles class-attribute instance-attribute ¶
weather_desc class-attribute instance-attribute ¶
weather_desc: tuple[WeatherDescItem, ...] = Field(
alias="weatherDesc"
)
weather_icon_url class-attribute instance-attribute ¶
weather_icon_url: tuple[WeatherIconUrlItem, ...] = Field(
alias="weatherIconUrl"
)
winddir16_point class-attribute instance-attribute ¶
winddir_degree class-attribute instance-attribute ¶
windspeed_kmph class-attribute instance-attribute ¶
NearestAreaItem ¶
Bases: FrozenModel
area_name class-attribute instance-attribute ¶
area_name: tuple[AreaNameItem, ...] = Field(
alias="areaName"
)
country instance-attribute ¶
country: tuple[CountryItem, ...]
region instance-attribute ¶
region: tuple[RegionItem, ...]
weather_url class-attribute instance-attribute ¶
weather_url: tuple[WeatherUrlItem, ...] = Field(
alias="weatherUrl"
)
RequestItem ¶
AstronomyItem ¶
HourlyItem ¶
Bases: FrozenModel
wind_gust_kmph class-attribute instance-attribute ¶
wind_gust_miles class-attribute instance-attribute ¶
precip_inches class-attribute instance-attribute ¶
pressure_inches class-attribute instance-attribute ¶
visibility_miles class-attribute instance-attribute ¶
weather_desc class-attribute instance-attribute ¶
weather_desc: tuple[WeatherDescItem, ...] = Field(
alias="weatherDesc"
)
weather_icon_url class-attribute instance-attribute ¶
weather_icon_url: tuple[WeatherIconUrlItem, ...] = Field(
alias="weatherIconUrl"
)
winddir16_point class-attribute instance-attribute ¶
winddir_degree class-attribute instance-attribute ¶
windspeed_kmph class-attribute instance-attribute ¶
WeatherItem ¶
Bases: FrozenModel, Generic[_THourlyItem]
astronomy instance-attribute ¶
astronomy: tuple[AstronomyItem, ...]
total_snow_cm class-attribute instance-attribute ¶
Model ¶
Bases: FrozenModel, Generic[_TCurrentConditionItem, _THourlyItem]
nearest_area instance-attribute ¶
nearest_area: tuple[NearestAreaItem, ...]
request instance-attribute ¶
request: tuple[RequestItem, ...]
weather instance-attribute ¶
weather: tuple[WeatherItem[_THourlyItem], ...]
be ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_be instance-attribute ¶
lang_be: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_be instance-attribute ¶
lang_be: tuple[WeatherDescItem, ...]
bn ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_bn instance-attribute ¶
lang_bn: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_bn instance-attribute ¶
lang_bn: tuple[WeatherDescItem, ...]
ca ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ca instance-attribute ¶
lang_ca: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ca instance-attribute ¶
lang_ca: tuple[WeatherDescItem, ...]
da ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_da instance-attribute ¶
lang_da: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_da instance-attribute ¶
lang_da: tuple[WeatherDescItem, ...]
de ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_de instance-attribute ¶
lang_de: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_de instance-attribute ¶
lang_de: tuple[WeatherDescItem, ...]
el ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_el instance-attribute ¶
lang_el: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_el instance-attribute ¶
lang_el: tuple[WeatherDescItem, ...]
en ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_xx property ¶
lang_xx: tuple[WeatherDescItem, ...]
lang_en property ¶
lang_en: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_xx property ¶
lang_xx: tuple[WeatherDescItem, ...]
lang_en property ¶
lang_en: tuple[WeatherDescItem, ...]
et ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_et instance-attribute ¶
lang_et: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_et instance-attribute ¶
lang_et: tuple[WeatherDescItem, ...]
fa ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_fa instance-attribute ¶
lang_fa: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_fa instance-attribute ¶
lang_fa: tuple[WeatherDescItem, ...]
fr ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_fr instance-attribute ¶
lang_fr: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_fr instance-attribute ¶
lang_fr: tuple[WeatherDescItem, ...]
gl ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_gl instance-attribute ¶
lang_gl: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_gl instance-attribute ¶
lang_gl: tuple[WeatherDescItem, ...]
hi ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_hi instance-attribute ¶
lang_hi: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_hi instance-attribute ¶
lang_hi: tuple[WeatherDescItem, ...]
hu ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_hu instance-attribute ¶
lang_hu: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_hu instance-attribute ¶
lang_hu: tuple[WeatherDescItem, ...]
ia ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ia instance-attribute ¶
lang_ia: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ia instance-attribute ¶
lang_ia: tuple[WeatherDescItem, ...]
id ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_id instance-attribute ¶
lang_id: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_id instance-attribute ¶
lang_id: tuple[WeatherDescItem, ...]
it ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_it instance-attribute ¶
lang_it: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_it instance-attribute ¶
lang_it: tuple[WeatherDescItem, ...]
lt ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_lt instance-attribute ¶
lang_lt: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_lt instance-attribute ¶
lang_lt: tuple[WeatherDescItem, ...]
mg ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_mg instance-attribute ¶
lang_mg: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_mg instance-attribute ¶
lang_mg: tuple[WeatherDescItem, ...]
nb ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_nb instance-attribute ¶
lang_nb: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_nb instance-attribute ¶
lang_nb: tuple[WeatherDescItem, ...]
nl ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_nl instance-attribute ¶
lang_nl: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_nl instance-attribute ¶
lang_nl: tuple[WeatherDescItem, ...]
oc ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_oc instance-attribute ¶
lang_oc: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_oc instance-attribute ¶
lang_oc: tuple[WeatherDescItem, ...]
pl ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_pl instance-attribute ¶
lang_pl: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_pl instance-attribute ¶
lang_pl: tuple[WeatherDescItem, ...]
pt_br ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_pt_br class-attribute instance-attribute ¶
lang_pt_br: tuple[WeatherDescItem, ...] = Field(
alias="lang_pt-br"
)
HourlyItem ¶
Bases: HourlyItem
lang_pt_br class-attribute instance-attribute ¶
lang_pt_br: tuple[WeatherDescItem, ...] = Field(
alias="lang_pt-br"
)
ro ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ro instance-attribute ¶
lang_ro: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ro instance-attribute ¶
lang_ro: tuple[WeatherDescItem, ...]
ru ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ru instance-attribute ¶
lang_ru: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ru instance-attribute ¶
lang_ru: tuple[WeatherDescItem, ...]
ta ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_ta instance-attribute ¶
lang_ta: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_ta instance-attribute ¶
lang_ta: tuple[WeatherDescItem, ...]
th ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_th instance-attribute ¶
lang_th: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_th instance-attribute ¶
lang_th: tuple[WeatherDescItem, ...]
tr ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_tr instance-attribute ¶
lang_tr: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_tr instance-attribute ¶
lang_tr: tuple[WeatherDescItem, ...]
uk ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_uk instance-attribute ¶
lang_uk: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_uk instance-attribute ¶
lang_uk: tuple[WeatherDescItem, ...]
vi ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_vi instance-attribute ¶
lang_vi: tuple[WeatherDescItem, ...]
HourlyItem ¶
Bases: HourlyItem
lang_vi instance-attribute ¶
lang_vi: tuple[WeatherDescItem, ...]
zh_cn ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_zh_cn class-attribute instance-attribute ¶
lang_zh_cn: tuple[WeatherDescItem, ...] = Field(
alias="lang_zh-cn"
)
HourlyItem ¶
Bases: HourlyItem
lang_zh_cn class-attribute instance-attribute ¶
lang_zh_cn: tuple[WeatherDescItem, ...] = Field(
alias="lang_zh-cn"
)
zh_tw ¶
Model module-attribute ¶
Model = Model[CurrentConditionItem, HourlyItem]
CurrentConditionItem ¶
Bases: CurrentConditionItem
lang_zh_tw class-attribute instance-attribute ¶
lang_zh_tw: tuple[WeatherDescItem, ...] = Field(
alias="lang_zh-tw"
)
HourlyItem ¶
Bases: HourlyItem
lang_zh_tw class-attribute instance-attribute ¶
lang_zh_tw: tuple[WeatherDescItem, ...] = Field(
alias="lang_zh-tw"
)