Genshin Abyss Models

abyss

Classes:

• AbyssCharacter –

  Character with just a level.

• AbyssRankCharacter –

  Character with a value of a rank.

• Battle –

  Battle in the spiral abyss.

• Chamber –

  Chamber of the spiral abyss.

• CharacterRanks –

  Collection of rankings achieved during spiral abyss runs.

• Floor –

  Floor of the spiral abyss.

• SpiralAbyss –

  Information about Spiral Abyss runs during a specific season.

• SpiralAbyssEnemy –

  An enemy in Spiral Abyss.

• SpiralAbyssPair –

  Pair of both current and previous spiral abyss.

__all__ module-attribute

__all__ = ['AbyssCharacter', 'AbyssRankCharacter', 'Battle', 'Chamber', 'CharacterRanks', 'Floor', 'SpiralAbyss', 'SpiralAbyssEnemy', 'SpiralAbyssPair']

AbyssCharacter pydantic-model

Character with just a level.

Fields:

• id (int)
• name (str)
• element (str)
• rarity (int)
• icon (str)
• collab (bool)
• level (int)

level pydantic-field

level: int

AbyssRankCharacter pydantic-model

Character with a value of a rank.

Fields:

• name (str)
• element (str)
• rarity (int)
• collab (bool)
• id (int)
• icon (str)
• value (int)

icon pydantic-field

icon: str

id pydantic-field

id: int

value pydantic-field

value: int

Battle pydantic-model

Battle in the spiral abyss.

Fields:

• half (int)
• timestamp (UnixDateTime)
• characters (Sequence[AbyssCharacter])

characters pydantic-field

characters: Sequence[AbyssCharacter]

half pydantic-field

half: int

timestamp pydantic-field

timestamp: UnixDateTime

Chamber pydantic-model

Chamber of the spiral abyss.

Fields:

• chamber (int)
• stars (int)
• max_stars (Literal[3])
• battles (Sequence[Battle])
• first_half_enemies (Sequence[SpiralAbyssEnemy])
• second_half_enemies (Sequence[SpiralAbyssEnemy])

battles pydantic-field

battles: Sequence[Battle]

chamber pydantic-field

chamber: int

first_half_enemies pydantic-field

first_half_enemies: Sequence[SpiralAbyssEnemy] = []

max_stars pydantic-field

max_stars: Literal[3]

second_half_enemies pydantic-field

second_half_enemies: Sequence[SpiralAbyssEnemy] = []

stars pydantic-field

stars: int

CharacterRanks pydantic-model

Collection of rankings achieved during spiral abyss runs.

Fields:

• most_played (Sequence[AbyssRankCharacter])
• most_kills (Sequence[AbyssRankCharacter])
• strongest_strike (Sequence[AbyssRankCharacter])
• most_damage_taken (Sequence[AbyssRankCharacter])
• most_bursts_used (Sequence[AbyssRankCharacter])
• most_skills_used (Sequence[AbyssRankCharacter])

Validators:

• __filter_invalid_chars → most_played, most_kills, strongest_strike, most_damage_taken, most_bursts_used, most_skills_used

most_bursts_used pydantic-field

most_bursts_used: Sequence[AbyssRankCharacter] = []

most_damage_taken pydantic-field

most_damage_taken: Sequence[AbyssRankCharacter] = []

most_kills pydantic-field

most_kills: Sequence[AbyssRankCharacter] = []

most_played pydantic-field

most_played: Sequence[AbyssRankCharacter] = []

most_skills_used pydantic-field

most_skills_used: Sequence[AbyssRankCharacter] = []

strongest_strike pydantic-field

strongest_strike: Sequence[AbyssRankCharacter] = []

__filter_invalid_chars pydantic-validator

__filter_invalid_chars(v: List[Dict[str, Any]]) -> List[Dict[str, Any]]

Floor pydantic-model

Floor of the spiral abyss.

Fields:

• floor (int)
• unlocked (Literal[True])
• stars (int)
• max_stars (Literal[9])
• chambers (Sequence[Chamber])

chambers pydantic-field

chambers: Sequence[Chamber]

floor pydantic-field

floor: int

max_stars pydantic-field

max_stars: Literal[9]

stars pydantic-field

stars: int

unlocked pydantic-field

unlocked: Literal[True]

SpiralAbyss pydantic-model

Information about Spiral Abyss runs during a specific season.

Fields:

• unlocked (bool)
• season (int)
• start_time (UnixDateTime)
• end_time (UnixDateTime)
• total_battles (int)
• total_wins (int)
• max_floor (str)
• total_stars (int)
• ranks (CharacterRanks)
• floors (Sequence[Floor])

Validators:

• __nest_ranks

end_time pydantic-field

end_time: UnixDateTime

floors pydantic-field

floors: Sequence[Floor]

max_floor pydantic-field

max_floor: str

ranks pydantic-field

ranks: CharacterRanks

season pydantic-field

season: int

start_time pydantic-field

start_time: UnixDateTime

total_battles pydantic-field

total_battles: int

total_stars pydantic-field

total_stars: int

total_wins pydantic-field

total_wins: int

unlocked pydantic-field

unlocked: bool

__nest_ranks pydantic-validator

__nest_ranks(values: dict[str, Any]) -> dict[str, AbyssCharacter]

By default ranks are for some reason on the same level as the rest of the abyss.

SpiralAbyssEnemy pydantic-model

An enemy in Spiral Abyss.

Fields:

• name (str)
• icon (str)
• level (int)

icon pydantic-field

icon: str

level pydantic-field

level: int

name pydantic-field

name: str

SpiralAbyssPair pydantic-model

Pair of both current and previous spiral abyss.

This may not be a namedtuple due to how pydantic handles them.

Fields:

• current (SpiralAbyss)
• previous (SpiralAbyss)

current pydantic-field

current: SpiralAbyss

previous pydantic-field

previous: SpiralAbyss