Справочник API¶
Клиент¶
pygismeteo.Gismeteo ¶
Gismeteo(
*,
token: str,
base_url: AnyHttpUrl = build(
scheme="https", host="api.gismeteo.net", path="v2"
),
lang: Lang = RU,
session: Client | None = None,
)
Клиент Gismeteo API.
Используйте как контекстный менеджер: на выходе закрывается HTTP-клиент.
Examples:
with pygismeteo.Gismeteo(token="56b30cb255.3443075") as gismeteo:
city = gismeteo.search.by_query("Москва")[0]
current = gismeteo.current.by_id(city.id)
print(current.temperature.air.c)
Parameters:
-
token(str) –X-Gismeteo-Token. Выдают по запросу на b2b@gismeteo.ru.
-
base_url(AnyHttpUrl, default:build(scheme='https', host='api.gismeteo.net', path='v2')) –Адрес API. По умолчанию
https://api.gismeteo.net/v2. -
lang(Lang, default:RU) –Язык названий и описаний в ответах.
-
session(Client | None, default:None) –Свой HTTP-клиент, например с другими таймаутами. Без него клиент создаётся при первом запросе.
closeзакрывает и переданный клиент.
Эндпоинты¶
pygismeteo.types.Search ¶
Search(session: THttpClient)
Bases: SearchBase[HttpxClient]
Поиск географических объектов.
by_coordinates ¶
by_coordinates(
latitude: Latitude,
longitude: Longitude,
*,
limit: SearchLimit,
) -> Model
Найти ближайшие к точке объекты.
Parameters:
-
latitude(Latitude) –Широта.
-
longitude(Longitude) –Долгота.
-
limit(SearchLimit) –Сколько объектов вернуть, от 1 до 36.
Examples:
search_results = gismeteo.search.by_coordinates(55.75222, 37.61556, limit=36)
print(search_results)
by_ip ¶
by_ip(ip: IPv4Address) -> Model
Определить объект по IPv4-адресу.
Parameters:
-
ip(IPv4Address) –IPv4-адрес.
Examples:
from ipaddress import IPv4Address
place = gismeteo.search.by_ip(IPv4Address("8.8.8.8"))
print(place)
pygismeteo.types.Current ¶
Current(session: THttpClient)
Bases: CurrentBase[HttpxClient]
Текущая погода.
by_coordinates ¶
by_id ¶
by_id(id_: LocalityID) -> Model
Текущая погода по ID географического объекта.
Parameters:
-
id_(LocalityID) –ID географического объекта из поиска.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
current = gismeteo.current.by_id(city_id)
print(current)
pygismeteo.types.Step3 ¶
Step3(session: THttpClient)
Bases: Step3Base[HttpxClient]
Прогноз с шагом 3 часа.
by_coordinates ¶
by_id ¶
by_id(id_: LocalityID, /, *, days: Step3Days) -> Model
Прогноз по ID географического объекта.
Parameters:
-
id_(LocalityID) –ID географического объекта из поиска.
-
days(Step3Days) –Количество дней, от 1 до 10.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step3 = gismeteo.step3.by_id(city_id, days=10)
print(step3)
pygismeteo.types.Step6 ¶
Step6(session: THttpClient)
Bases: Step6Base[HttpxClient]
Прогноз с шагом 6 часов.
by_coordinates ¶
by_id ¶
by_id(id_: LocalityID, /, *, days: Step6Days) -> Model
Прогноз по ID географического объекта.
Parameters:
-
id_(LocalityID) –ID географического объекта из поиска.
-
days(Step6Days) –Количество дней, от 3 до 10.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step6 = gismeteo.step6.by_id(city_id, days=10)
print(step6)
pygismeteo.types.Step24 ¶
Step24(session: THttpClient)
Bases: Step24Base[HttpxClient]
Прогноз с шагом 24 часа.
by_coordinates ¶
by_coordinates(
latitude: Latitude,
longitude: Longitude,
*,
days: Step24Days,
) -> Model
Прогноз по координатам.
Parameters:
-
latitude(Latitude) –Широта.
-
longitude(Longitude) –Долгота.
-
days(Step24Days) –Количество дней, от 3 до 10.
Examples:
step24 = gismeteo.step24.by_coordinates(55.75222, 37.61556, days=10)
print(step24)
by_id ¶
by_id(id_: LocalityID, /, *, days: Step24Days) -> Model
Прогноз по ID географического объекта.
Parameters:
-
id_(LocalityID) –ID географического объекта из поиска.
-
days(Step24Days) –Количество дней, от 3 до 10.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step24 = gismeteo.step24.by_id(city_id, days=10)
print(step24)
Модели ответов¶
pygismeteo.models.search_by_query ¶
pygismeteo.models.search_by_coordinates ¶
pygismeteo.models.search_by_ip ¶
pygismeteo.models.current ¶
Текущая погода. Запрос возвращает Model.
Precipitation ¶
Pressure ¶
Humidity ¶
Direction ¶
Bases: FrozenModel
Направление ветра.
Speed ¶
Wind ¶
Cloudiness ¶
Bases: FrozenModel
Облачность.
Date ¶
Radiation ¶
Comfort ¶
Water ¶
Air ¶
Temperature ¶
Model ¶
Bases: FrozenModel
Текущая погода.
phenomenon class-attribute instance-attribute ¶
phenomenon: int | None = None
Код погодного явления.
kind instance-attribute ¶
kind: WeatherDataType
Наблюдение или прогноз. Прогноз приходит, если нет данных наблюдений.
pygismeteo.models.step3 ¶
Прогноз с шагом 3 часа. Запрос возвращает Model.
Model module-attribute ¶
Прогноз: по элементу на каждые 3 часа.
Precipitation ¶
Pressure ¶
Humidity ¶
Direction ¶
Bases: FrozenModel
Направление ветра.
Speed ¶
Wind ¶
Cloudiness ¶
Bases: FrozenModel
Облачность.
Date ¶
Radiation ¶
Comfort ¶
Water ¶
Air ¶
Temperature ¶
ModelItem ¶
Bases: FrozenModel
Прогноз на один 3-часовой интервал.
phenomenon class-attribute instance-attribute ¶
phenomenon: int | None = None
Код погодного явления.
kind instance-attribute ¶
kind: WeatherDataType
Наблюдение или прогноз. Прогноз приходит, если нет данных наблюдений.
pygismeteo.models.step6 ¶
Прогноз с шагом 6 часов. Запрос возвращает Model.
Model module-attribute ¶
Прогноз: по элементу на каждые 6 часов.
Precipitation ¶
Pressure ¶
Humidity ¶
Direction ¶
Bases: FrozenModel
Направление ветра.
Speed ¶
Wind ¶
Cloudiness ¶
Bases: FrozenModel
Облачность.
Date ¶
Radiation ¶
Comfort ¶
Water ¶
Air ¶
Temperature ¶
ModelItem ¶
Bases: FrozenModel
Прогноз на один 6-часовой интервал.
phenomenon class-attribute instance-attribute ¶
phenomenon: int | None = None
Код погодного явления.
kind instance-attribute ¶
kind: WeatherDataType
Наблюдение или прогноз. Прогноз приходит, если нет данных наблюдений.
pygismeteo.models.step24 ¶
Прогноз с шагом 24 часа. Запрос возвращает Model.
Precipitation ¶
Bases: FrozenModel
Осадки.
HPa ¶
MmHgAtm ¶
InHg ¶
Pressure ¶
Percent ¶
Humidity ¶
Cloudiness ¶
Bases: FrozenModel
Облачность.
Date ¶
Radiation ¶
Max ¶
Min ¶
Comfort ¶
Max1 ¶
Water ¶
Max2 ¶
Avg ¶
Air ¶
Temperature ¶
Max3 ¶
Min3 ¶
Avg1 ¶
Speed ¶
Max4 ¶
Bases: FrozenModel
Максимум.
Min4 ¶
Bases: FrozenModel
Минимум.
Avg2 ¶
Bases: FrozenModel
Среднее.
Direction ¶
Wind ¶
ModelItem ¶
Bases: FrozenModel
Прогноз на одни сутки.
phenomenon class-attribute instance-attribute ¶
phenomenon: int | None = None
Код погодного явления.
kind class-attribute instance-attribute ¶
kind: WeatherDataType | None = None
Больше не используется, всегда None.
pygismeteo.models.enums ¶
Перечисления с описанием значений на русском и английском.
Члены записаны как (значение, описание на английском, описание на русском). Например, PrecipitationType.RAIN равен 1, а его description.ru равно "Дождь".
Description dataclass ¶
Description
IntEnumWithDescription ¶
IntEnumWithDescription
Bases: _DescriptionMixin, IntEnum
Целочисленное перечисление с описанием значений.
StrEnumWithDescription ¶
StrEnumWithDescription
Bases: _DescriptionMixin, StrEnum
Строковое перечисление с описанием значений.
CloudinessType ¶
CloudinessType
Bases: IntEnumWithDescription
Облачность.
PARTLY_CLOUDY class-attribute instance-attribute ¶
PARTLY_CLOUDY = (
101,
"Partly cloudy",
"Переменная облачность",
)
PrecipitationType ¶
PrecipitationType
Bases: IntEnumWithDescription
Тип осадков.
PrecipitationIntensity ¶
PrecipitationIntensity
Bases: IntEnumWithDescription
Интенсивность осадков.
GeomagneticField ¶
GeomagneticField
Bases: IntEnumWithDescription
Геомагнитная обстановка, от 1 до 8 баллов.
NO_SIGNIFICANT_DISTURBANCES class-attribute instance-attribute ¶
NO_SIGNIFICANT_DISTURBANCES = (
1,
"No significant disturbances",
"Нет заметных возмущений",
)
SMALL_DISTURBANCES class-attribute instance-attribute ¶
SMALL_DISTURBANCES = (
2,
"Small disturbances",
"Небольшие возмущения",
)
WEAK_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
WEAK_GEOMAGNETIC_STORM = (
3,
"Weak geomagnetic storm",
"Слабая геомагнитная буря",
)
MINOR_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
MINOR_GEOMAGNETIC_STORM = (
4,
"Minor geomagnetic storm",
"Малая геомагнитная буря",
)
MODERATE_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
MODERATE_GEOMAGNETIC_STORM = (
5,
"Moderate geomagnetic storm",
"Умеренная геомагнитная буря",
)
STRONG_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
STRONG_GEOMAGNETIC_STORM = (
6,
"Strong geomagnetic storm",
"Сильная геомагнитная буря",
)
SEVERE_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
SEVERE_GEOMAGNETIC_STORM = (
7,
"Severe geomagnetic storm",
"Жесткий геомагнитный шторм",
)
EXTREME_GEOMAGNETIC_STORM class-attribute instance-attribute ¶
EXTREME_GEOMAGNETIC_STORM = (
8,
"Extreme geomagnetic storm",
"Экстремальный шторм",
)
WindScale8 ¶
WindScale8
Bases: IntEnumWithDescription
Направление ветра по 8 румбам, 0 означает штиль.
NORTHEASTERLY class-attribute instance-attribute ¶
NORTHEASTERLY = (2, 'Northeasterly', 'Северо-восточный')
SOUTHEASTERLY class-attribute instance-attribute ¶
SOUTHEASTERLY = (4, 'Southeasterly', 'Юго-восточный')
SOUTHWESTERLY class-attribute instance-attribute ¶
SOUTHWESTERLY = (6, 'Southwesterly', 'Юго-западный')
NORTHWESTERLY class-attribute instance-attribute ¶
NORTHWESTERLY = (8, 'Northwesterly', 'Северо-западный')
GeographicObjectType ¶
GeographicObjectType
Bases: StrEnumWithDescription
Тип географического объекта.
WEATHER_STATION class-attribute instance-attribute ¶
WEATHER_STATION = ('M', 'Weather station', 'Метеостанция')
Типы¶
pygismeteo.types.Lang ¶
Bases: StrEnum
Язык названий и описаний в ответах.
pygismeteo.types.LocalityID module-attribute ¶
ID географического объекта из поиска.
pygismeteo.types.Latitude module-attribute ¶
Широта, от -90 до 90.
pygismeteo.types.Longitude module-attribute ¶
Долгота, от -180 до 180.
pygismeteo.types.SearchLimit module-attribute ¶
Сколько объектов вернуть при поиске по координатам, от 1 до 36.
pygismeteo.types.Step3Days module-attribute ¶
Количество дней прогноза с шагом 3 часа, от 1 до 10.
pygismeteo.types.Step6Days module-attribute ¶
Количество дней прогноза с шагом 6 часов, от 3 до 10.