Skip to content

Enum

bmkg.enums

Module to store common enum classes used by bmkg.

Cardinal

Bases: StrEnum

A str enum class that define valid cardinal direction.

Attributes:

Name Type Description
NORTH str

"N"

NORTH_NORTHEAST str

"NNE"

NORTHEAST str

"NE"

EAST_NORTHEAST str

"ENE"

EAST str

"E"

EAST_SOUTHEAST str

"ESE"

SOUTHEAST str

"SE"

SOUTH_SOUTHEAST str

"SSE"

SOUTH str

"S"

SOUTH_SOUTHWEST str

"SSW"

SOUTHWEST str

"SW"

WEST_SOUTHWEST str

"WSW"

WEST str

"W"

WEST_NORTHWEST str

"WNW"

NORTHWEST str

"NW"

NORTH_NORTHWEST str

"NNW"

VARIABLE str

"VARIABLE"

Examples:

>>> Cardinal("N")
<Cardinal.NORTH: 'N'>
>>> Cardinal["NORTH"]
<Cardinal.NORTH: 'N'>
>>> Cardinal.NORTH
<Cardinal.NORTH: 'N'>
>>> Cardinal.NORTH == "N"
True
>>> print(Cardinal.NORTH)
N
Note

VARIABLE direction mean as its name suggest, the direction can't be determined.

Weather

Bases: IntEnum

An int enum class that define valid weather.

Attributes:

Name Type Description
CLEAR_SKIES int

0

SUNNY int

1

PARTLY_CLOUDY int

2

MOSTLY_CLOUDY int

3

OVERCAST int

4

HAZE int

5

SMOKE int

10

THUNDER int

17

FOG int

45

LIGHT_RAIN int

61

MODERATE_RAIN int

63

ISOLATED_SHOWER int

80

THUNDERSTORM int

95

SEVERE_THUNDERSTORM int

97

Examples:

>>> Weather(0)
<Weather.CLEAR_SKIES: 0>
>>> Weather["CLEAR_SKIES"]
<Weather.CLEAR_SKIES: 0>
>>> Weather.CLEAR_SKIES
<Weather.CLEAR_SKIES: 0>
>>> Weather.CLEAR_SKIES == 0
True
>>> print(Weather.CLEAR_SKIES)
0