Types

types

Types used in the library.

Classes:

• Game –

  Hoyoverse game.

• Region –

  Region to get data from.

AppGeetestResult module-attribute

AppGeetestResult: TypeAlias = Union[
    "SessionMMTResult", "SessionMMTv4Result"
]

Solved geetest result.

AppGeetestSession module-attribute

AppGeetestSession: TypeAlias = Union[
    "SessionMMT", "SessionMMTv4"
]

Geetest session returned by the API.

AppGeetestSolver module-attribute

AppGeetestSolver: TypeAlias = Callable[
    [AppGeetestSession], Awaitable[AppGeetestResult]
]

Asynchronous geetest solver callable.

IDOr module-attribute

IDOr: TypeAlias = Union[int, UniqueT]

Allows partial objects.

Lang module-attribute

Lang: TypeAlias = Literal[
    "zh-cn",
    "zh-tw",
    "de-de",
    "en-us",
    "es-es",
    "fr-fr",
    "id-id",
    "it-it",
    "ja-jp",
    "ko-kr",
    "pt-pt",
    "ru-ru",
    "th-th",
    "vi-vn",
    "tr-tr",
]

UniqueT module-attribute

UniqueT = TypeVar('UniqueT', bound='Unique')

Game

Hoyoverse game.

Attributes:

• GENSHIN –

  Genshin Impact

• HONKAI –

  Honkai Impact 3rd

• STARRAIL –

  Honkai Star Rail

• TOT –

  Tears of Themis

• ZZZ –

  Zenless Zone Zero

GENSHIN class-attribute instance-attribute

GENSHIN = 'genshin'

Genshin Impact

HONKAI class-attribute instance-attribute

HONKAI = 'honkai3rd'

Honkai Impact 3rd

STARRAIL class-attribute instance-attribute

STARRAIL = 'hkrpg'

Honkai Star Rail

TOT class-attribute instance-attribute

TOT = 'tot'

Tears of Themis

ZZZ class-attribute instance-attribute

ZZZ = 'nap'

Zenless Zone Zero

Region

Region to get data from.

Attributes:

• CHINESE –

  Applies to all chinese mainland APIs.

• OVERSEAS –

  Applies to all overseas APIs.

CHINESE class-attribute instance-attribute

CHINESE = 'cn'

Applies to all chinese mainland APIs.

OVERSEAS class-attribute instance-attribute

OVERSEAS = 'os'

Applies to all overseas APIs.