From a5c884aa0b80fbb220d9a3bd8c4939173a268522 Mon Sep 17 00:00:00 2001 From: KT Date: Sat, 10 Jun 2023 22:47:57 +0800 Subject: [PATCH] refactor: Adjust model class position --- mihomo/models/character.py | 66 +----------------------- mihomo/models/combat.py | 102 ++++++++++++++++++++----------------- mihomo/models/equipment.py | 3 +- mihomo/models/stat.py | 58 +++++++++++++++++++++ 4 files changed, 116 insertions(+), 113 deletions(-) create mode 100644 mihomo/models/stat.py diff --git a/mihomo/models/character.py b/mihomo/models/character.py index fb1a2572d..0eb724add 100644 --- a/mihomo/models/character.py +++ b/mihomo/models/character.py @@ -2,71 +2,9 @@ from typing import Any from pydantic import BaseModel, Field, root_validator -from .combat import Attribute, Element, Path, Property +from .combat import Element, Path, Trace, TraceTreeNode from .equipment import LightCone, Relic, RelicSet - - -class Trace(BaseModel): - """ - Represents a character's skill trace. - - Attributes: - - id (`int`): The ID of the trace. - - name (`str`): The name of the trace. - - level (`int`): The current level of the trace. - - max_level (`int`): The maximum level of the trace. - - element (`Element` | None): The element of the trace, or None if not applicable. - - type (`str`): The type of the trace. - - type_text (`str`): The type text of the trace. - - effect (`str`): The effect of the trace. - - effect_text (`str`): The effect text of the trace. - - simple_desc (`str`): The simple description of the trace. - - desc (`str`): The detailed description of the trace. - - icon (`str`): The trace icon. - """ - - id: int - """The ID of the trace""" - name: str - """The name of the trace""" - level: int - """The current level of the trace""" - max_level: int - """The maximum level of the trace""" - element: Element | None = None - """The element of the trace""" - type: str - """The type of the trace""" - type_text: str - """The type text of the trace""" - effect: str - """The effect of the trace""" - effect_text: str - """The effect text of the trace""" - simple_desc: str - """The simple description of the trace""" - desc: str - """The detailed description of the trace""" - icon: str - """The trace icon""" - - -class TraceTreeNode(BaseModel): - """ - Represents a node in the trace skill tree of a character. - - Attributes: - - id (`int`): The ID of the trace. - - level (`int`): The level of the trace. - - icon (`str`): The icon of the trace. - """ - - id: int - """The ID of the trace""" - level: int - """The level of the trace""" - icon: str - """The icon of the trace""" +from .stat import Attribute, Property class Character(BaseModel): diff --git a/mihomo/models/combat.py b/mihomo/models/combat.py index 8b9f57d61..ba254806f 100644 --- a/mihomo/models/combat.py +++ b/mihomo/models/combat.py @@ -1,4 +1,4 @@ -from pydantic import BaseModel, Field +from pydantic import BaseModel class Element(BaseModel): @@ -40,58 +40,64 @@ class Path(BaseModel): """The path icon""" -class Attribute(BaseModel): +class Trace(BaseModel): """ - Represents an attribute. + Represents a character's skill trace. Attributes: - - field (`str`): The field of the attribute. - - name (`str`): The name of the attribute. - - icon (`str`): The attribute icon image. - - value (`float`): The value of the attribute. - - displayed_value (`str`): The displayed value of the attribute. - - is_percent (`bool`): Indicates if the value is in percentage. + - id (`int`): The ID of the trace. + - name (`str`): The name of the trace. + - level (`int`): The current level of the trace. + - max_level (`int`): The maximum level of the trace. + - element (`Element` | None): The element of the trace, or None if not applicable. + - type (`str`): The type of the trace. + - type_text (`str`): The type text of the trace. + - effect (`str`): The effect of the trace. + - effect_text (`str`): The effect text of the trace. + - simple_desc (`str`): The simple description of the trace. + - desc (`str`): The detailed description of the trace. + - icon (`str`): The trace icon. """ - field: str - """The field of the attribute""" + id: int + """The ID of the trace""" name: str - """The name of the attribute""" - icon: str - """The attribute icon image""" - value: float - """The value of the attribute""" - displayed_value: str = Field(..., alias="display") - """The displayed value of the attribute""" - is_percent: bool = Field(..., alias="percent") - """Indicates if the value is in percentage""" - - -class Property(BaseModel): - """ - Represents a property. - - Attributes: - - type (`str`): The type of the property. - - field (`str`): The field of the property. - - name (`str`): The name of the property. - - icon (`str`): The property icon image. - - value (`float`): The value of the property. - - displayed_value (`str`): The displayed value of the property. - - is_percent (`bool`): Indicates if the value is in percentage. - """ - + """The name of the trace""" + level: int + """The current level of the trace""" + max_level: int + """The maximum level of the trace""" + element: Element | None = None + """The element of the trace""" type: str - """The type of the property""" - field: str - """The field of the property""" - name: str - """The name of the property""" + """The type of the trace""" + type_text: str + """The type text of the trace""" + effect: str + """The effect of the trace""" + effect_text: str + """The effect text of the trace""" + simple_desc: str + """The simple description of the trace""" + desc: str + """The detailed description of the trace""" icon: str - """The property icon image""" - value: float - """The value of the property""" - displayed_value: str = Field(..., alias="display") - """The displayed value of the property""" - is_percent: bool = Field(..., alias="percent") - """Indicates if the value is in percentage""" + """The trace icon""" + + +class TraceTreeNode(BaseModel): + """ + Represents a node in the trace skill tree of a character. + + Attributes: + - id (`int`): The ID of the trace. + - level (`int`): The level of the trace. + - icon (`str`): The icon of the trace. + """ + + id: int + """The ID of the trace""" + level: int + """The level of the trace""" + icon: str + """The icon of the trace""" diff --git a/mihomo/models/equipment.py b/mihomo/models/equipment.py index 122158f0f..8d188e7f9 100644 --- a/mihomo/models/equipment.py +++ b/mihomo/models/equipment.py @@ -1,6 +1,7 @@ from pydantic import BaseModel, Field -from .combat import Attribute, Path, Property +from .combat import Path +from .stat import Attribute, Property class LightCone(BaseModel): diff --git a/mihomo/models/stat.py b/mihomo/models/stat.py new file mode 100644 index 000000000..5dc5d5375 --- /dev/null +++ b/mihomo/models/stat.py @@ -0,0 +1,58 @@ +from pydantic import BaseModel, Field + + +class Attribute(BaseModel): + """ + Represents an attribute. + + Attributes: + - field (`str`): The field of the attribute. + - name (`str`): The name of the attribute. + - icon (`str`): The attribute icon image. + - value (`float`): The value of the attribute. + - displayed_value (`str`): The displayed value of the attribute. + - is_percent (`bool`): Indicates if the value is in percentage. + """ + + field: str + """The field of the attribute""" + name: str + """The name of the attribute""" + icon: str + """The attribute icon image""" + value: float + """The value of the attribute""" + displayed_value: str = Field(..., alias="display") + """The displayed value of the attribute""" + is_percent: bool = Field(..., alias="percent") + """Indicates if the value is in percentage""" + + +class Property(BaseModel): + """ + Represents a property. + + Attributes: + - type (`str`): The type of the property. + - field (`str`): The field of the property. + - name (`str`): The name of the property. + - icon (`str`): The property icon image. + - value (`float`): The value of the property. + - displayed_value (`str`): The displayed value of the property. + - is_percent (`bool`): Indicates if the value is in percentage. + """ + + type: str + """The type of the property""" + field: str + """The field of the property""" + name: str + """The name of the property""" + icon: str + """The property icon image""" + value: float + """The value of the property""" + displayed_value: str = Field(..., alias="display") + """The displayed value of the property""" + is_percent: bool = Field(..., alias="percent") + """Indicates if the value is in percentage"""