Genshin Gacha Models

gacha

Genshin wish models.

Classes:

• BannerDetailItem –

  Item that may be gotten from a banner.

• BannerDetails –

  Details of a banner.

• BannerDetailsUpItem –

  Item that has a rate-up on a banner.

• GachaItem –

  Item that can be gotten from the gacha.

• GenshinBannerType –

  Banner types in wish histories.

• MWBannerType –

  Banner types in Genshin Miliastra Wonderland.

• MWWish –

  Wish made on Genshin Miliastra Wonderland banner.

• SignalSearch –

  Signal Search made on any banner.

• StarRailBannerType –

  Banner types in wish histories.

• Warp –

  Warp made on any banner.

• Wish –

  Wish made on any banner.

• ZZZBannerType –

  Banner types in wish histories.

__all__ module-attribute

__all__ = ['BannerDetailItem', 'BannerDetails', 'BannerDetailsUpItem', 'GachaItem', 'GenshinBannerType', 'MWBannerType', 'MWWish', 'SignalSearch', 'StarRailBannerType', 'Warp', 'Wish', 'ZZZBannerType']

BannerDetailItem pydantic-model

Item that may be gotten from a banner.

Fields:

• name (str)
• type (str)
• rarity (int)
• up (bool)
• order (int)

name pydantic-field

name: str

order pydantic-field

order: int

rarity pydantic-field

rarity: int

type pydantic-field

type: str

up pydantic-field

up: bool

BannerDetails pydantic-model

Details of a banner.

Fields:

• banner_id (str)
• banner_type (int)
• title (str)
• content (str)
• date_range (str)
• r5_up_prob (Optional[float])
• r4_up_prob (Optional[float])
• r5_prob (Optional[float])
• r4_prob (Optional[float])
• r3_prob (Optional[float])
• r5_guarantee_prob (Optional[float])
• r4_guarantee_prob (Optional[float])
• r3_guarantee_prob (Optional[float])
• r5_up_items (Sequence[BannerDetailsUpItem])
• r4_up_items (Sequence[BannerDetailsUpItem])
• r5_items (list[BannerDetailItem])
• r4_items (list[BannerDetailItem])
• r3_items (list[BannerDetailItem])

Validators:

• __replace_none → r5_up_items, r4_up_items
• __parse_percentage → r5_up_prob, r4_up_prob, r5_prob, r4_prob, r3_prob, r5_guarantee_prob, r4_guarantee_prob, r3_guarantee_prob

banner_id pydantic-field

banner_id: str

banner_type pydantic-field

banner_type: int

banner_type_name property

banner_type_name: str

content pydantic-field

content: str

date_range pydantic-field

date_range: str

items property

items: Sequence[BannerDetailItem]

name property

name: str

r3_guarantee_prob pydantic-field

r3_guarantee_prob: Optional[float]

r3_items pydantic-field

r3_items: list[BannerDetailItem]

r3_prob pydantic-field

r3_prob: Optional[float]

r4_guarantee_prob pydantic-field

r4_guarantee_prob: Optional[float]

r4_items pydantic-field

r4_items: list[BannerDetailItem]

r4_prob pydantic-field

r4_prob: Optional[float]

r4_up_items pydantic-field

r4_up_items: Sequence[BannerDetailsUpItem]

r4_up_prob pydantic-field

r4_up_prob: Optional[float]

r5_guarantee_prob pydantic-field

r5_guarantee_prob: Optional[float]

r5_items pydantic-field

r5_items: list[BannerDetailItem]

r5_prob pydantic-field

r5_prob: Optional[float]

r5_up_items pydantic-field

r5_up_items: Sequence[BannerDetailsUpItem]

r5_up_prob pydantic-field

r5_up_prob: Optional[float]

title pydantic-field

title: str

__parse_percentage pydantic-validator

__parse_percentage(v: Optional[str]) -> Optional[float]

__replace_none pydantic-validator

__replace_none(v: Optional[Sequence[Any]]) -> Sequence[Any]

BannerDetailsUpItem pydantic-model

Item that has a rate-up on a banner.

Fields:

• name (str)
• type (str)
• element (str)
• icon (str)

Validators:

• __parse_element → element

element pydantic-field

element: str

icon pydantic-field

icon: str

name pydantic-field

name: str

type pydantic-field

type: str

__parse_element pydantic-validator

__parse_element(v: str) -> str

BaseWish pydantic-model

Base wish model.

Fields:

• uid (int)
• id (int)
• name (str)
• rarity (int)
• tz_offset (int)
• time (datetime)

Validators:

• __cast_rarity → rarity
• __parse_time → time

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: int

time pydantic-field

time: datetime

Timezone-aware time of when the wish was made

tz_offset pydantic-field

tz_offset: int

Number of hours from UTC+8.

uid pydantic-field

uid: int

__cast_rarity pydantic-validator

__cast_rarity(v: Any) -> int

__parse_time pydantic-validator

__parse_time(v: str, info: ValidationInfo) -> datetime

GachaItem pydantic-model

Item that can be gotten from the gacha.

Fields:

• name (str)
• type (str)
• rarity (int)
• id (int)

Validators:

• __format_id → id

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: int

type pydantic-field

type: str

__format_id pydantic-validator

__format_id(v: int) -> int

is_character

is_character() -> bool

Whether this item is a character.

GenshinBannerType

Banner types in wish histories.

Attributes:

• CHARACTER –

  Rotating character banner.

• CHARACTER1 –

  Character banner #1.

• CHARACTER2 –

  Character banner #2.

• CHRONICLED –

  Chronicled banner.

• NOVICE –

  Temporary novice banner.

• PERMANENT –

  Permanent standard banner.

• STANDARD –

  Permanent standard banner.

• WEAPON –

  Rotating weapon banner.

CHARACTER class-attribute instance-attribute

CHARACTER = 301

Rotating character banner.

CHARACTER1 class-attribute instance-attribute

CHARACTER1 = 301

Character banner #1.

CHARACTER2 class-attribute instance-attribute

CHARACTER2 = 400

Character banner #2.

CHRONICLED class-attribute instance-attribute

CHRONICLED = 500

Chronicled banner.

NOVICE class-attribute instance-attribute

NOVICE = 100

Temporary novice banner.

PERMANENT class-attribute instance-attribute

PERMANENT = 200

Permanent standard banner.

STANDARD class-attribute instance-attribute

STANDARD = 200

Permanent standard banner.

WEAPON class-attribute instance-attribute

WEAPON = 302

Rotating weapon banner.

MWBannerType

Banner types in Genshin Miliastra Wonderland.

Attributes:

• EVENT –

  Event banner.

• EVENT_FEMALE_OUTFIT1 –

  Female Manekin outfit banner #1.

• EVENT_FEMALE_OUTFIT2 –

  Female Manekin outfit banner #2.

• EVENT_MALE_OUTFIT1 –

  Male Manekin outfit banner #1.

• EVENT_MALE_OUTFIT2 –

  Male Manekin outfit banner #2.

• PERMANENT –

  Permanent standard banner.

• STANDARD –

  Permanent standard banner.

EVENT class-attribute instance-attribute

EVENT = 2000

Event banner.

EVENT_FEMALE_OUTFIT1 class-attribute instance-attribute

EVENT_FEMALE_OUTFIT1 = 20021

Female Manekin outfit banner #1.

EVENT_FEMALE_OUTFIT2 class-attribute instance-attribute

EVENT_FEMALE_OUTFIT2 = 20022

Female Manekin outfit banner #2.

EVENT_MALE_OUTFIT1 class-attribute instance-attribute

EVENT_MALE_OUTFIT1 = 20011

Male Manekin outfit banner #1.

EVENT_MALE_OUTFIT2 class-attribute instance-attribute

EVENT_MALE_OUTFIT2 = 20012

Male Manekin outfit banner #2.

PERMANENT class-attribute instance-attribute

PERMANENT = 1000

Permanent standard banner.

STANDARD class-attribute instance-attribute

STANDARD = 1000

Permanent standard banner.

MWWish pydantic-model

Wish made on Genshin Miliastra Wonderland banner.

Fields:

• id (int)
• uid (int)
• rarity (int)
• tz_offset (int)
• time (datetime)
• item_id (int)
• type (str)
• is_up (bool)
• name (str)
• banner_id (int)
• banner_type (MWBannerType)

Validators:

• __cast_rarity → rarity
• __parse_time → time

banner_id pydantic-field

banner_id: int

banner_type pydantic-field

banner_type: MWBannerType

is_up pydantic-field

is_up: bool

item_id pydantic-field

item_id: int

name pydantic-field

name: str

type pydantic-field

type: str

SignalSearch pydantic-model

Signal Search made on any banner.

Fields:

• id (int)
• uid (int)
• name (str)
• rarity (int)
• tz_offset (int)
• time (datetime)
• item_id (int)
• type (str)
• banner_type (ZZZBannerType)

Validators:

• __cast_rarity → rarity
• __parse_time → time
• __cast_banner_type → banner_type

banner_type pydantic-field

banner_type: ZZZBannerType

item_id pydantic-field

item_id: int

type pydantic-field

type: str

__cast_banner_type pydantic-validator

__cast_banner_type(v: Any) -> int

from_chronicle_data classmethod

from_chronicle_data(data: Mapping[str, Any], uid: int, tz_offset: int, banner_type: ZZZBannerType) -> SignalSearch

Create a ZZZChronicleWish from chronicle data.

StarRailBannerType

Banner types in wish histories.

Attributes:

• CHARACTER –

  Rotating character banner.

• FATE_CHARACTER –

  FGO collab character banner.

• FATE_WEAPON –

  FGO collab light cone banner.

• NOVICE –

  Temporary novice banner.

• PERMANENT –

  Permanent standard banner.

• STANDARD –

  Permanent standard banner.

• WEAPON –

  Rotating light cone banner.

CHARACTER class-attribute instance-attribute

CHARACTER = 11

Rotating character banner.

FATE_CHARACTER class-attribute instance-attribute

FATE_CHARACTER = 21

FGO collab character banner.

FATE_WEAPON class-attribute instance-attribute

FATE_WEAPON = 22

FGO collab light cone banner.

NOVICE class-attribute instance-attribute

NOVICE = 2

Temporary novice banner.

PERMANENT class-attribute instance-attribute

PERMANENT = 1

Permanent standard banner.

STANDARD class-attribute instance-attribute

STANDARD = 1

Permanent standard banner.

WEAPON class-attribute instance-attribute

WEAPON = 12

Rotating light cone banner.

Warp pydantic-model

Warp made on any banner.

Fields:

• id (int)
• uid (int)
• name (str)
• rarity (int)
• tz_offset (int)
• time (datetime)
• item_id (int)
• type (str)
• banner_type (StarRailBannerType)
• banner_id (int)

Validators:

• __cast_rarity → rarity
• __parse_time → time
• __cast_banner_type → banner_type

banner_id pydantic-field

banner_id: int

banner_type pydantic-field

banner_type: StarRailBannerType

item_id pydantic-field

item_id: int

type pydantic-field

type: str

__cast_banner_type pydantic-validator

__cast_banner_type(v: Any) -> int

Wish pydantic-model

Wish made on any banner.

Fields:

• id (int)
• uid (int)
• name (str)
• rarity (int)
• tz_offset (int)
• time (datetime)
• type (str)
• banner_type (GenshinBannerType)

Validators:

• __cast_rarity → rarity
• __parse_time → time
• __cast_banner_type → banner_type

banner_type pydantic-field

banner_type: GenshinBannerType

type pydantic-field

type: str

__cast_banner_type pydantic-validator

__cast_banner_type(v: Any) -> int

ZZZBannerType

Banner types in wish histories.

Methods:

• to_chronicle_type –

  Get the chronicle type string for this banner type.

Attributes:

• BANGBOO –

  Bangboo banner.

• CHARACTER –

  Rotating character banner.

• EXCLUSIVE_RESCREENING –

  Exclusive rescreening banner.

• PERMANENT –

  Permanent standard banner.

• REVERBERATION –

  W-Engine reverberation banner.

• STANDARD –

  Permanent standard banner.

• WEAPON –

  Rotating w-engine banner.

BANGBOO class-attribute instance-attribute

BANGBOO = 5

Bangboo banner.

CHARACTER class-attribute instance-attribute

CHARACTER = 2

Rotating character banner.

EXCLUSIVE_RESCREENING class-attribute instance-attribute

EXCLUSIVE_RESCREENING = 102

Exclusive rescreening banner.

PERMANENT class-attribute instance-attribute

PERMANENT = 1

Permanent standard banner.

REVERBERATION class-attribute instance-attribute

REVERBERATION = 103

W-Engine reverberation banner.

STANDARD class-attribute instance-attribute

STANDARD = 1

Permanent standard banner.

WEAPON class-attribute instance-attribute

WEAPON = 3

Rotating w-engine banner.

to_chronicle_type

to_chronicle_type() -> str

Get the chronicle type string for this banner type.