seerapi-models 1.0.0__py3-none-any.whl

seerapi_models/__init__.py

@@ -0,0 +1,244 @@
+from .battle_effect import (
+    BattleEffect,
+    BattleEffectCategory,
+    BattleEffectCategoryORM,
+    BattleEffectORM,
+)
+from .effect import (
+    PetEffect,
+    PetEffectGroup,
+    PetEffectGroupORM,
+    PetEffectORM,
+    VariationEffect,
+    VariationEffectORM,
+)
+from .element_type import (
+    ElementType,
+    ElementTypeORM,
+    TypeCombination,
+    TypeCombinationORM,
+)
+from .items import (
+    EnergyBead,
+    EnergyBeadBuffAttrORM,
+    EnergyBeadORM,
+    Equip,
+    EquipBonus,
+    EquipBonusAttrORM,
+    EquipBonusORM,
+    EquipEffectiveOccasion,
+    EquipEffectiveOccasionORM,
+    EquipORM,
+    EquipType,
+    EquipTypeORM,
+    Gem,
+    GemCategory,
+    GemCategoryORM,
+    GemGen1,
+    GemGen1PartORM,
+    GemGen2,
+    GemGen2PartORM,
+    GemGenCategory,
+    GemGenCategoryORM,
+    GemORM,
+    Item,
+    ItemORM,
+    SkillActivationItem,
+    SkillActivationItemORM,
+    SkillStone,
+    SkillStoneCategory,
+    SkillStoneCategoryORM,
+    SkillStoneEffect,
+    SkillStoneEffectORM,
+    SkillStoneORM,
+    Suit,
+    SuitBonus,
+    SuitBonusAttrORM,
+    SuitBonusORM,
+    SuitORM,
+)
+from .metadata import ApiMetadata, ApiMetadataORM
+from .mintmark import (
+    AbilityMintmark,
+    AbilityPartORM,
+    Mintmark,
+    MintmarkBaseAttrORM,
+    MintmarkClassCategory,
+    MintmarkClassCategoryORM,
+    MintmarkExtraAttrORM,
+    MintmarkMaxAttrORM,
+    MintmarkORM,
+    MintmarkRarityCategory,
+    MintmarkRarityCategoryORM,
+    MintmarkTypeCategory,
+    MintmarkTypeCategoryORM,
+    SkillMintmark,
+    SkillMintmarkEffect,
+    SkillPartORM,
+    UniversalMintmark,
+    UniversalPartORM,
+)
+from .pet import (
+    BaseStatORM,
+    DiyStatsRangeORM,
+    Pet,
+    PetArchiveStoryBook,
+    PetArchiveStoryBookORM,
+    PetArchiveStoryEntry,
+    PetArchiveStoryEntryORM,
+    PetClass,
+    PetClassORM,
+    PetEncyclopediaEntry,
+    PetEncyclopediaEntryORM,
+    PetGenderCategory,
+    PetGenderORM,
+    PetMountTypeCategory,
+    PetMountTypeORM,
+    PetORM,
+    PetSkin,
+    PetSkinCategory,
+    PetSkinCategoryORM,
+    PetSkinORM,
+    PetVipBuffCategory,
+    PetVipBuffORM,
+    SkillInPet,
+    SkillInPetORM,
+    Soulmark,
+    SoulmarkORM,
+    SoulmarkTagCategory,
+    SoulmarkTagORM,
+    YieldingEvORM,
+)
+from .skill import (
+    Skill,
+    SkillCategory,
+    SkillCategoryORM,
+    SkillEffectParam,
+    SkillEffectParamInType,
+    SkillEffectParamInTypeORM,
+    SkillEffectParamORM,
+    SkillEffectType,
+    SkillEffectTypeORM,
+    SkillEffectTypeTag,
+    SkillEffectTypeTagORM,
+    SkillHideEffect,
+    SkillHideEffectORM,
+    SkillORM,
+)
+
+__all__ = [
+    'AbilityMintmark',
+    'AbilityPartORM',
+    'ApiMetadata',
+    'ApiMetadataORM',
+    'BaseStatORM',
+    'BattleEffect',
+    'BattleEffectCategory',
+    'BattleEffectCategoryORM',
+    'BattleEffectORM',
+    'DiyStatsRangeORM',
+    'ElementType',
+    'ElementTypeORM',
+    'EnergyBead',
+    'EnergyBeadBuffAttrORM',
+    'EnergyBeadORM',
+    'Equip',
+    'EquipBonus',
+    'EquipBonusAttrORM',
+    'EquipBonusORM',
+    'EquipEffectiveOccasion',
+    'EquipEffectiveOccasionORM',
+    'EquipORM',
+    'EquipType',
+    'EquipTypeORM',
+    'Gem',
+    'GemCategory',
+    'GemCategoryORM',
+    'GemGen1',
+    'GemGen1PartORM',
+    'GemGen2',
+    'GemGen2PartORM',
+    'GemGenCategory',
+    'GemGenCategoryORM',
+    'GemORM',
+    'Item',
+    'ItemORM',
+    'Mintmark',
+    'MintmarkBaseAttrORM',
+    'MintmarkClassCategory',
+    'MintmarkClassCategoryORM',
+    'MintmarkExtraAttrORM',
+    'MintmarkMaxAttrORM',
+    'MintmarkORM',
+    'MintmarkRarityCategory',
+    'MintmarkRarityCategoryORM',
+    'MintmarkTypeCategory',
+    'MintmarkTypeCategoryORM',
+    'Pet',
+    'PetArchiveStoryBook',
+    'PetArchiveStoryBookORM',
+    'PetArchiveStoryEntry',
+    'PetArchiveStoryEntryORM',
+    'PetClass',
+    'PetClassORM',
+    'PetEffect',
+    'PetEffectGroup',
+    'PetEffectGroupORM',
+    'PetEffectORM',
+    'PetEncyclopediaEntry',
+    'PetEncyclopediaEntryORM',
+    'PetGenderCategory',
+    'PetGenderORM',
+    'PetMountTypeCategory',
+    'PetMountTypeORM',
+    'PetORM',
+    'PetSkin',
+    'PetSkinCategory',
+    'PetSkinCategoryORM',
+    'PetSkinORM',
+    'PetVipBuffCategory',
+    'PetVipBuffORM',
+    'Skill',
+    'SkillActivationItem',
+    'SkillActivationItemORM',
+    'SkillCategory',
+    'SkillCategoryORM',
+    'SkillEffectParam',
+    'SkillEffectParamInType',
+    'SkillEffectParamInTypeORM',
+    'SkillEffectParamORM',
+    'SkillEffectType',
+    'SkillEffectTypeORM',
+    'SkillEffectTypeTag',
+    'SkillEffectTypeTagORM',
+    'SkillHideEffect',
+    'SkillHideEffectORM',
+    'SkillInPet',
+    'SkillInPetORM',
+    'SkillMintmark',
+    'SkillMintmarkEffect',
+    'SkillORM',
+    'SkillPartORM',
+    'SkillStone',
+    'SkillStoneCategory',
+    'SkillStoneCategoryORM',
+    'SkillStoneEffect',
+    'SkillStoneEffectORM',
+    'SkillStoneORM',
+    'Soulmark',
+    'SoulmarkORM',
+    'SoulmarkTagCategory',
+    'SoulmarkTagORM',
+    'Suit',
+    'SuitBonus',
+    'SuitBonusAttrORM',
+    'SuitBonusORM',
+    'SuitORM',
+    'TypeCombination',
+    'TypeCombinationORM',
+    'UniversalMintmark',
+    'UniversalPartORM',
+    'VariationEffect',
+    'VariationEffectORM',
+    'YieldingEvORM',
+]

seerapi_models/_utils.py

@@ -0,0 +1,27 @@
+def move_to_last(lst: list, index: int) -> None:
+    """
+    将列表中指定索引位置的元素移动到列表的最后一位。
+
+    Args:
+            lst: 要操作的列表
+            index: 要移动的元素的索引位置
+
+    """
+    if 0 <= index < len(lst):
+        # 弹出指定位置的元素并添加到列表末尾
+        element = lst.pop(index)
+        lst.append(element)
+
+
+def move_to_first(lst: list, index: int) -> None:
+    """
+    将列表中指定索引位置的元素移动到列表的第一位。
+
+    Args:
+            lst: 要操作的列表
+            index: 要移动的元素的索引位置
+
+    """
+    if 0 <= index < len(lst):
+        element = lst.pop(index)
+        lst.insert(0, element)

seerapi_models/achievement.py

@@ -0,0 +1,257 @@
+# from sqlmodel import Field, Relationship
+
+# from ..model import BaseGeneralModel, BaseResModel, ConvertToORM, ResourceRef
+# from ..base import Analyzer, DataImportConfig
+# from ..typing_ import AnalyzeResult
+
+
+# TREE_RESOURCE_NAME = "achievement_tree"
+
+
+# class RootNodeBase(BaseResModel):
+# name: str = Field(description="根节点名称")
+
+# @classmethod
+# def resource_name(cls) -> str:
+# return "achievement_tree_root"
+
+
+# class RootNode(RootNodeBase, ConvertToORM["RootNodeORM"]):
+# branches: list["BranchNode"] = Field(
+# default_factory=list, description="分支节点列表"
+# )
+
+# @classmethod
+# def get_orm_model(cls) -> type["RootNodeORM"]:
+# return RootNodeORM
+
+# def to_orm(self) -> "RootNodeORM":
+# return RootNodeORM(
+# id=self.id, name=self.name, branches=[
+# b.to_orm() for b in self.branches
+# ]
+# )
+
+
+# class RootNodeORM(RootNodeBase, table=True):
+# branches: list["BranchNodeORM"] = Relationship(back_populates="parent")
+
+
+# class BranchNodeBase(BaseResModel):
+# name: str = Field(description="分支节点名称")
+
+# @classmethod
+# def resource_name(cls) -> str:
+# return "achievement_tree_branch"
+
+
+# class BranchNode(BranchNodeBase, ConvertToORM["BranchNodeORM"]):
+# parent: ResourceRef[RootNode] = Field(description="父节点（RootNode）资源引用")
+# rules: list["RuleNode"] = Field(default_factory=list, description="规则节点列表")
+
+# @classmethod
+# def get_orm_model(cls) -> type["BranchNodeORM"]:
+# return BranchNodeORM
+
+# def to_orm(self) -> "BranchNodeORM":
+# return BranchNodeORM(
+# id=self.id,
+# name=self.name,
+# parent_id=self.parent.id,
+# rules=[r.to_orm() for r in self.rules],
+# )
+
+
+# class BranchNodeORM(BranchNodeBase, table=True):
+# parent_id: int | None = Field(
+# default=None,
+# foreign_key="achievement_tree_root.id"
+# )
+# parent: "RootNodeORM" = Relationship(back_populates="branches")
+# rules: list["RuleNodeORM"] = Relationship(back_populates="parent")
+
+
+# class RuleNodeBase(BaseResModel):
+# name: str = Field(description="规则节点名称")
+# intro: str | None = Field(description="规则节点简介")
+
+# @classmethod
+# def resource_name(cls) -> str:
+# return "achievement_tree_rule"
+
+
+# class RuleNode(RuleNodeBase, ConvertToORM["RuleNodeORM"]):
+# parent: ResourceRef[BranchNode] = Field(
+# description="父节点（BranchNode）资源引用"
+# )
+# achievements: list["AchievementNode"] = Field(
+# default_factory=list, description="成就节点列表"
+# )
+
+# @classmethod
+# def get_orm_model(cls) -> type["RuleNodeORM"]:
+# return RuleNodeORM
+
+# def to_orm(self) -> "RuleNodeORM":
+# return RuleNodeORM(
+# id=self.id,
+# name=self.name,
+# intro=self.intro,
+# parent_id=self.parent.id,
+# achievements=[a.to_orm() for a in self.achievements],
+# )
+
+
+# class RuleNodeORM(RuleNodeBase, table=True):
+# parent_id: int | None = Field(
+# default=None, foreign_key="achievement_tree_branch.id")
+# parent: "BranchNodeORM" = Relationship(back_populates="rules")
+
+# achievements: list["AchievementNodeORM"] = Relationship(
+# back_populates="parent")
+
+# @classmethod
+# def resource_name(cls) -> str:
+# return "achievement_tree_rule"
+
+
+# class AchievementNodeBase(BaseResModel, BaseGeneralModel):
+# name: str = Field(description="成就名称")
+# point: int = Field(description="成就点数")
+# title: str | None = Field(description="成就称号")
+# desc: str = Field(description="成就描述")
+# is_ability: bool = Field(description="是否是能力加成成就")
+# ability_desc: str | None = Field(
+# description="能力加成成就描述，仅在该成就为能力加成成就时有效"
+# )
+
+# @classmethod
+# def resource_name(cls) -> str:
+# return "achievement"
+
+# @classmethod
+# def schema_path(cls) -> str:
+# return "achievement_node.json"
+
+
+# class AchievementNode(AchievementNodeBase, ConvertToORM["AchievementNodeORM"]):
+# parent: ResourceRef[RuleNode] = Field(description="父节点引用")
+
+# @classmethod
+# def get_orm_model(cls) -> type["AchievementNodeORM"]:
+# return AchievementNodeORM
+
+# def to_orm(self) -> "AchievementNodeORM":
+# return AchievementNodeORM(
+# id=self.id,
+# name=self.name,
+# point=self.point,
+# title=self.title,
+# desc=self.desc,
+# is_ability=self.is_ability,
+# ability_desc=self.ability_desc,
+# parent_id=self.parent.id,
+# )
+
+
+# class AchievementNodeORM(AchievementNodeBase, table=True):
+# parent_id: int | None = Field(
+# default=None, foreign_key="achievement_tree_rule.id")
+# parent: "RuleNodeORM" = Relationship(back_populates="achievements")
+
+
+# class AchievementsAnalyzer(Analyzer):
+# """成就数据分析器"""
+
+# @classmethod
+# def get_data_import_config(cls) -> DataImportConfig:
+# return DataImportConfig(
+# html5_paths=("xml/achievements.json",),
+# )
+
+# def analyze(self) -> tuple[AnalyzeResult, ...]:
+# achievements_data = self._get_data('html5', 'xml/achievements.json')["AchievementRules"]["type"]
+# achievement_tree: dict[int, RootNode] = {}
+# all_achievements: dict[int, AchievementNode] = {}
+# ability_achievements: dict[int, AchievementNode] = {}
+# branch_id = 1
+# rule_id = 1
+# achievement_id = 1
+# for ach_type in achievements_data:
+# root_id = ach_type.get("ID")
+# root_name = ach_type.get("Desc")
+# root_node = RootNode(
+# id=root_id,
+# name=root_name,
+# branches=[],
+# )
+# achievement_tree[root_id] = root_node
+# for branches in ach_type.get("Branches", []):
+# # branch_id = branches.get("ID")
+# branch_name = branches.get("Desc")
+# branch_node = BranchNode(
+# id=branch_id,
+# name=branch_name,
+# rules=[],
+# parent=ResourceRef(
+# id=root_id,
+# path=f'{root_id}',
+# resource_name=TREE_RESOURCE_NAME,
+# ),
+# )
+# branch_id += 1
+# root_node.branches.append(branch_node)
+# for branch in branches.get("Branch", []):
+# # rule_id = branch.get("ID")
+# rule_name = branch.get("Desc")
+# rule_intro = branch.get("introl")
+# rule_node = RuleNode(
+# id=rule_id,
+# name=rule_name,
+# intro=rule_intro,
+# achievements=[],
+# parent=ResourceRef(
+# id=branch_id,
+# resource_name=TREE_RESOURCE_NAME,
+# ),
+# )
+# rule_id += 1
+# branch_node.rules.append(rule_node)
+# for rule in branch.get("Rule", []):
+# achievement = AchievementNode(
+# id=achievement_id,
+# name=rule.get("achName", rule_name),
+# point=rule.get("AchievementPoint"),
+# title=rule.get("title"),
+# desc=rule.get("Desc"),
+# is_ability=bool(rule.get("AbilityTitle")),
+# ability_desc=rule.get("abtext"),
+# parent=ResourceRef(
+# id=rule_id,
+# resource_name=TREE_RESOURCE_NAME,
+# path=f'{root_id}/{branch_id}/{rule_id}',
+# ),
+# )
+# rule_node.achievements.append(achievement)
+# if achievement.is_ability:
+# ability_achievements[achievement_id] = achievement
+# else:
+# all_achievements[achievement_id] = achievement
+# achievement_id += 1
+
+# return (
+# AnalyzeResult(
+# model=RootNode,
+# data=achievement_tree,
+# ),
+# AnalyzeResult(
+# model=AchievementNode,
+# data=all_achievements,
+# output_mode='json',
+# ),
+# AnalyzeResult(
+# model=AchievementNode,
+# data=ability_achievements,
+# output_mode='json',
+# ),
+# )

seerapi_models/battle_effect.py

@@ -0,0 +1,78 @@
+from sqlmodel import Field, Relationship, SQLModel
+
+from seerapi_models.build_model import BaseCategoryModel, BaseResModel, ConvertToORM
+from seerapi_models.common import ResourceRef
+
+
+class BattleEffectCategoryLink(SQLModel, table=True):
+    battle_effect_id: int | None = Field(
+        default=None, foreign_key='battle_effect.id', primary_key=True
+    )
+    type_id: int | None = Field(
+        default=None, foreign_key='battle_effect_type.id', primary_key=True
+    )
+
+
+class BattleEffectBase(BaseResModel):
+    name: str = Field(description='状态名称')
+    desc: str = Field(description='状态描述')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'battle_effect'
+
+
+class BattleEffect(BattleEffectBase, ConvertToORM['BattleEffectORM']):
+    type: list[ResourceRef['BattleEffectCategory']] = Field(
+        default_factory=list,
+        description='状态类型，可能同时属于多个类型，例如瘫痪同时属于控制类和限制类异常',
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> 'type[BattleEffectORM]':
+        return BattleEffectORM
+
+    def to_orm(self) -> 'BattleEffectORM':
+        return BattleEffectORM(
+            id=self.id,
+            name=self.name,
+            desc=self.desc,
+        )
+
+
+class BattleEffectORM(BattleEffectBase, table=True):
+    type: list['BattleEffectCategoryORM'] = Relationship(
+        back_populates='effect', link_model=BattleEffectCategoryLink
+    )
+
+
+class BattleEffectCategoryBase(BaseCategoryModel):
+    name: str = Field(description='状态类型名称')
+
+    @classmethod
+    def resource_name(cls) -> str:
+        return 'battle_effect_type'
+
+
+class BattleEffectCategory(
+    BattleEffectCategoryBase, ConvertToORM['BattleEffectCategoryORM']
+):
+    effect: list[ResourceRef['BattleEffect']] = Field(
+        default_factory=list, description='异常状态列表'
+    )
+
+    @classmethod
+    def get_orm_model(cls) -> type['BattleEffectCategoryORM']:
+        return BattleEffectCategoryORM
+
+    def to_orm(self) -> 'BattleEffectCategoryORM':
+        return BattleEffectCategoryORM(
+            id=self.id,
+            name=self.name,
+        )
+
+
+class BattleEffectCategoryORM(BattleEffectCategoryBase, table=True):
+    effect: list['BattleEffectORM'] = Relationship(
+        back_populates='type', link_model=BattleEffectCategoryLink
+    )

seerapi_models/build_model/__init__.py

@@ -0,0 +1,66 @@
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from sqlalchemy.orm import declared_attr
+from sqlmodel import Field, SQLModel
+
+_TModel = TypeVar('_TModel', bound=SQLModel)
+
+
+class ResModelMixin(SQLModel, ABC):
+    @classmethod
+    @abstractmethod
+    def resource_name(cls) -> str:
+        pass
+
+    @declared_attr  # type: ignore
+    def __tablename__(cls) -> str:  # type: ignore
+        return cls.resource_name()
+
+
+class BaseResModel(ResModelMixin, ABC):
+    """资源模型抽象基类"""
+
+    id: int = Field(description='资源ID', primary_key=True)
+
+
+class BaseResModelWithOptionalId(ResModelMixin, ABC):
+    """资源模型抽象基类"""
+
+    id: int | None = Field(
+        default=None,
+        primary_key=True,
+        exclude=True,
+    )
+
+
+class ConvertToORM(ABC, Generic[_TModel]):
+    @classmethod
+    @abstractmethod
+    def get_orm_model(cls) -> type[_TModel]:
+        """获取SQLModel ORM模型类型"""
+        pass
+
+    @abstractmethod
+    def to_orm(self) -> _TModel:
+        """将Pydantic模型转为SQLModel ORM模型"""
+        pass
+
+
+class BaseGeneralModel(SQLModel, ABC):
+    @classmethod
+    @abstractmethod
+    def schema_path(cls) -> str:
+        pass
+
+
+class BaseCategoryModel(BaseResModel, ABC, Generic[_TModel]): ...
+
+
+__all__ = [
+    'BaseCategoryModel',
+    'BaseGeneralModel',
+    'BaseResModel',
+    'BaseResModelWithOptionalId',
+    'ConvertToORM',
+]