Refactor (#39)

* 重构类型

* 更换回到datetime

* Refactor: 项目类型，CI/CD，格式

* fix: some wrong

* 更改版本号，namespace

---------

Co-authored-by: MrlingXD <[email protected]>

Author: JohnRichard4096

.github/workflows/CI.yml

@@ -40,7 +40,10 @@ jobs:
         with:
           python-path: ${{ env.PYTHON_BIN }}
           pylance-version: latest-release
-
+      - name: Check code format
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: check . --exit-non-zero-on-fix
 
       - name: Build package
         run: uv build  # 生成构建产物到dist目录

.github/workflows/PR.yml

@@ -40,8 +40,10 @@ jobs:
         with:
           python-path: ${{ env.PYTHON_BIN }}
           pylance-version: latest-release
-
-
+      - name: Check code format
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: check . --exit-non-zero-on-fix
       - name: Build package
         run: uv build  # 生成构建产物到dist目录
 

.gitignore

@@ -8,3 +8,13 @@ wheels/
 
 # Virtual environments
 .venv
+uv.toml
+
+# Conda environments
+.conda
+
+# PyCharm
+.idea/
+
+# Ruff
+.ruff_cache/

README.md

@@ -68,4 +68,4 @@ plugins = ["nonebot_plugin_value"]
 
 1. 升级 nonebot_plugin_value 到最新版本
 
-2. 运行迁移脚本(（如果Bot根目录下**没有**迁移脚本目录，请使用`nb orm init`来初始化。）在bot根目录使用`nb orm revison`再`nb orm upgrade`进行迁移)
+2. 运行迁移脚本(（如果 Bot 根目录下**没有**迁移脚本目录，请使用`nb orm init`来初始化。）在 bot 根目录使用`nb orm revison`再`nb orm upgrade`进行迁移)

docs/apis/advanced.md

@@ -1,8 +1,8 @@
-# Value-高级API文档
+# Value-高级 API 文档
 
-> **本API为服务层API，包含有关数据库操作的核心逻辑**
+> **本 API 为服务层 API，包含有关数据库操作的核心逻辑**
 
-## currency-API(`~~`代指`~.db_api.balance`)
+## currency-API(`~~`代指`~.services.balance`)
 
 <details>
 
@@ -103,12 +103,11 @@ async def get_default_currency(session: AsyncSession) -> CurrencyMeta:
     ...
 ```
 
-
 </details>
 
 ---
 
-## balance-API(`~~`代指`~.db_api.balance`)
+## balance-API(`~~`代指`~.services.balance`)
 
 <details>
 
@@ -175,18 +174,18 @@ async def del_balance(
     amount: float,
     source: str = "",
     session: AsyncSession | None = None,
-) -> dict[str, Any]:
+) -> ActionResult:
     """异步减少余额
 
     Args:
         user_id (str): 用户ID
         currency_id (str): 货币ID
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 来源说明. Defaults to "".
         session (AsyncSession | None, optional): 数据库异步会话. Defaults to None.
 
     Returns:
-        dict[str, Any]: 包含是否成功的说明
+        ActionResult: 包含是否成功的说明
     """
     ...
 ```
@@ -200,18 +199,18 @@ async def add_balance(
     amount: float,
     source: str = "",
     session: AsyncSession | None = None,
-) -> dict[str, Any]:
+) -> ActionResult:
     """异步增加余额
 
     Args:
         user_id (str): 用户ID
         currency_id (str): 货币ID
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 来源说明. Defaults to "".
         session (AsyncSession | None, optional): 数据库异步会话. Defaults to None.
 
     Returns:
-        dict[str, Any]: 是否成功("success")，消息说明("message")
+        ActionResult: 是否成功("success")，消息说明("message")
     """
     ...
 ```
@@ -226,29 +225,28 @@ async def transfer_funds(
     amount: float,
     source: str = "transfer",
     session: AsyncSession | None = None,
-) -> dict[str, Any]:
+) -> TransferResult:
     """异步转账
 
     Args:
         fromuser_id (str): 源用户ID
         touser_id (str): 目标用户ID
         currency_id (str): 货币ID
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 源说明. Defaults to "transfer".
         session (AsyncSession | None, optional): 数据库异步Session. Defaults to None.
 
     Returns:
-        dict[str, Any]: 如果成功则包含"from_balance"（源账户现在的balance），"to_balance"（目标账户现在的balance），否则包含"message"（错误消息）字段
+        TransferResult: 如果成功则"from_balance"（源账户现在的balance），"to_balance"（目标账户现在的balance）字段不为None
     """
     ...
 ```
 
-
 </details>
 
 ---
 
-## transaction-API(`~~`代指`~.db_api.transaction`)
+## transaction-API(`~~`代指`~.services.transaction`)
 
 <details>
 

docs/apis/kernel.md

@@ -1,13 +1,14 @@
-# Value-底层API文档
+# Value-底层 API 文档
 
-> **本API为数据层API，包含操作数据库的底层逻辑**
+> **本 API 为数据层 API，包含操作数据库的底层逻辑**
 
 ## Repository(`~.repository`)
 
 ### 变量定义：
+
 ```python
 DEFAULT_NAME = "DEFAULT_CURRENCY_USD"
-DEFAULT_CURRENCY_UUID = uuid5(uuid.NAMESPACE_X500, "nonebot_plugin_value")
+DEFAULT_CURRENCY_UUID = uuid5(NAMESPACE_VALUE, "nonebot_plugin_value")
 ```
 
 ---

docs/apis/standard.md

@@ -1,6 +1,6 @@
-# Value-标准API文档
+# Value-标准 API 文档
 
-> **标准API文档**
+> **标准 API 文档**
 
 ## balance-API(`~~`代指`~.api.api_balance`)
 
@@ -67,7 +67,7 @@ async def add_balance(
 
     Args:
         user_id (str): 用户ID
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 源描述. Defaults to "_transfer".
         currency_id (str | None, optional): 货币ID(不填使用默认). Defaults to None.
 
@@ -121,7 +121,7 @@ async def transfer_funds(
     Args:
         from_id (str): 源账户
         to_id (str): 目标账户
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 来源说明. Defaults to "from {from_id} to {to_id}".
         currency_id (str | None, optional): 货币ID（不填则使用默认货币）. Defaults to None.
 
@@ -134,7 +134,6 @@ async def transfer_funds(
     ...
 ```
 
-
 </details>
 
 ---
@@ -259,7 +258,7 @@ async def get_transaction_history(
 
     Args:
         account_id (str): 账户ID
-        limit (int, optional): 最大数量. Defaults to 10.
+        limit (int, optional): 数量. Defaults to 10.
 
     Returns:
         list[TransactionData]: 包含交易数据的列表

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-value"
-version = "0.0.7"
+version = "0.0.8.dev1"
 description = "Value API for NoneBot2"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -42,4 +42,4 @@ ignore = [
 ]
 
 [tool.pyright]
-typeCheckingMode = "standard"
+typeCheckingMode = "strict"

src/nonebot_plugin_value/__init__.py

@@ -6,13 +6,13 @@
 from . import action_type, repository
 from .api import api_balance, api_currency, api_transaction
 from .api.api_currency import get_or_create_currency
-from .db_api import balance, transaction
-from .db_api import currency as currency_api
 from .hook import context, exception, hooks_manager, hooks_type
 from .models import currency
 from .pyd_models import balance_pyd, base_pyd, currency_pyd
 from .pyd_models.currency_pyd import CurrencyData
 from .repository import DEFAULT_CURRENCY_UUID
+from .services import balance, transaction
+from .services import currency as currency_api
 
 __plugin_meta__ = PluginMetadata(
     name="Value",

src/nonebot_plugin_value/api/api_balance.py

@@ -1,12 +1,12 @@
 from nonebot_plugin_orm import get_session
 
-from ..db_api.balance import add_balance as _a_balance
-from ..db_api.balance import del_account as _del_account
-from ..db_api.balance import del_balance as _d_balance
-from ..db_api.balance import get_or_create_account as _go_account
-from ..db_api.balance import list_accounts as _list_accounts
-from ..db_api.balance import transfer_funds as _transfer
 from ..pyd_models.balance_pyd import UserAccountData
+from ..services.balance import add_balance as _a_balance
+from ..services.balance import del_account as _del_account
+from ..services.balance import del_balance as _d_balance
+from ..services.balance import get_or_create_account as _go_account
+from ..services.balance import list_accounts as _list_accounts
+from ..services.balance import transfer_funds as _transfer
 from .api_currency import get_default_currency as _get_default
 
 
@@ -84,7 +84,7 @@ async def add_balance(
 
     Args:
         user_id (str): 用户ID
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 源描述. Defaults to "_transfer".
         currency_id (str | None, optional): 货币ID(不填使用默认). Defaults to None.
 
@@ -98,8 +98,8 @@ async def add_balance(
     if currency_id is None:
         currency_id = (await _get_default()).id
     data = await _a_balance(user_id, currency_id, amount, source)
-    if not data.get("success", False):
-        raise RuntimeError(data.get("message", ""))
+    if not data.success:
+        raise RuntimeError(data.message)
     return await get_or_create_account(user_id, currency_id)
 
 
@@ -126,8 +126,8 @@ async def del_balance(
     if currency_id is None:
         currency_id = (await _get_default()).id
     data = await _d_balance(user_id, currency_id, amount, source)
-    if not data.get("success", False):
-        raise RuntimeError(data.get("message", ""))
+    if not data.success:
+        raise RuntimeError(data.message)
     return await get_or_create_account(user_id, currency_id)
 
 
@@ -143,7 +143,7 @@ async def transfer_funds(
     Args:
         from_id (str): 源账户
         to_id (str): 目标账户
-        amount (float): 数量
+        amount (float): 金额
         source (str, optional): 来源说明. Defaults to "from {from_id} to {to_id}".
         currency_id (str | None, optional): 货币ID（不填则使用默认货币）. Defaults to None.
 
@@ -155,9 +155,9 @@ async def transfer_funds(
     """
     if currency_id is None:
         currency_id = (await _get_default()).id
-    if source == "":
+    if not source:
         source = f"from '{from_id}' to '{to_id}'"
     data = await _transfer(from_id, to_id, currency_id, amount, source)
-    if not data.get("success", False):
-        raise RuntimeError(data.get("message", ""))
+    if not data.success:
+        raise RuntimeError(data.message)
     return await get_or_create_account(to_id, currency_id)