Module genshin.models.starrail.chronicle.characters

Starrail chronicle character.

Classes

class ModifyRelicProperty (**data: Any)

Expand source code

class ModifyRelicProperty(APIModel):
    """Modify relic property."""

    property_type: int
    modify_property_type: int

Modify relic property.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• APIModel
• pydantic.main.BaseModel

Class variables

var model_config : pydantic.config.ConfigDict

var modify_property_type : int

var property_type : int

class RecommendProperty (**data: Any)

Expand source code

class RecommendProperty(APIModel):
    """Character recommended and preferred properties."""

    recommend_relic_properties: typing.Sequence[int]
    custom_relic_properties: typing.Sequence[int]
    is_custom_property_valid: bool

Character recommended and preferred properties.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• APIModel
• pydantic.main.BaseModel

Class variables

var custom_relic_properties : Sequence[int]

var is_custom_property_valid : bool

var model_config : pydantic.config.ConfigDict

var recommend_relic_properties : Sequence[int]

class StarRailDetailCharacterResponse (**data: Any)

Expand source code

class StarRailDetailCharacterResponse(StarRailSimpleCharacterResponse):
    """HSR characters endpoint response model for when viewed by the user."""

    avatar_list: Sequence[character.StarRailDetailCharacter]

HSR characters endpoint response model for when viewed by the user.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• StarRailSimpleCharacterResponse
• APIModel
• pydantic.main.BaseModel

Class variables

var avatar_list : Sequence[StarRailDetailCharacter]

var model_config : pydantic.config.ConfigDict

class StarRailSimpleCharacterResponse (**data: Any)

Expand source code

class StarRailSimpleCharacterResponse(APIModel):
    """HSR characters endpoint response model for when viewed by other players."""

    avatar_list: Sequence[character.StarRailSimpleCharacter]
    equip_wiki: Mapping[str, str]
    relic_wiki: Mapping[str, str]
    property_info: Mapping[str, character.PropertyInfo]
    recommend_property: Mapping[str, RecommendProperty]
    relic_properties: Sequence[ModifyRelicProperty]

    @pydantic.model_validator(mode="before")
    def __fill_additional_fields(cls, values: Mapping[str, typing.Any]) -> Mapping[str, typing.Any]:
        """Fill additional fields for convenience."""
        characters = values.get("avatar_list", [])
        props_info = values.get("property_info", {})
        rec_props = values.get("recommend_property", {})
        equip_wiki = values.get("equip_wiki", {})
        relic_wiki = values.get("relic_wiki", {})

        for char in characters:
            char_id = str(char["id"])
            char_rec_props = rec_props[char_id]["recommend_relic_properties"]
            char_custom_props = rec_props[char_id]["custom_relic_properties"]

            servant = char.get("servant_detail", {})
            if servant:
                for prop in servant["servant_properties"]:
                    prop_type = prop["property_type"]
                    prop["info"] = props_info[str(prop_type)]

            for relic in char["relics"] + char["ornaments"]:
                if relic["main_property"] is None:
                    # Relic has no main stat and substats when the profile is viewed by other players
                    continue

                prop_type = relic["main_property"]["property_type"]
                relic["main_property"]["info"] = props_info[str(prop_type)]
                relic["main_property"]["recommended"] = prop_type in char_rec_props
                relic["main_property"]["preferred"] = prop_type in char_custom_props

                for prop in relic["properties"]:
                    prop_type = prop["property_type"]
                    prop["recommended"] = prop_type in char_rec_props
                    prop["preferred"] = prop_type in char_custom_props
                    prop["info"] = props_info[str(prop_type)]

                relic["wiki"] = relic_wiki.get(str(relic["id"]), "")

            for prop in char["properties"]:
                prop_type = prop["property_type"]
                prop["recommended"] = prop_type in char_rec_props
                prop["preferred"] = prop_type in char_custom_props
                prop["info"] = props_info[str(prop_type)]

            if char["equip"]:
                char["equip"]["wiki"] = equip_wiki.get(str(char["equip"]["id"]), "")

        return values

HSR characters endpoint response model for when viewed by other players.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• APIModel
• pydantic.main.BaseModel

Subclasses

• StarRailDetailCharacterResponse

Class variables

var avatar_list : Sequence[StarRailSimpleCharacter]

var equip_wiki : Mapping[str, str]

var model_config : pydantic.config.ConfigDict

var property_info : Mapping[str, PropertyInfo]

var recommend_property : Mapping[str, RecommendProperty]

var relic_properties : Sequence[ModifyRelicProperty]

var relic_wiki : Mapping[str, str]