pixelarraythirdparty 1.1.0__py3-none-any.whl → 1.1.2__py3-none-any.whl

pixelarraythirdparty/__init__.py

@@ -11,7 +11,7 @@ PixelArray 第三方微服务客户端
 - unified_login: 统一登录模块
 """
 
-__version__ = "1.1.0"
+__version__ = "1.1.2"
 __author__ = "Lu qi"
 __email__ = "qi.lu@pixelarrayai.com"
 

pixelarraythirdparty/client.py

@@ -34,3 +34,22 @@ class AsyncClient:
                         # 如果不是JSON响应，返回空
                         pass
                 return {}, False
+
+    async def _request_raw(
+        self, method: str, url: str, **kwargs
+    ) -> Tuple[int, Dict[str, Any]]:
+        headers = self.headers.copy()
+        if "headers" in kwargs:
+            headers.update(kwargs["headers"])
+            kwargs = {k: v for k, v in kwargs.items() if k != "headers"}
+
+        async with aiohttp.ClientSession() as session:
+            req_method = getattr(session, method.lower())
+            async with req_method(
+                f"{self.base_url}{url}", headers=headers, **kwargs
+            ) as resp:
+                try:
+                    data = await resp.json()
+                except:
+                    data = {}
+                return resp.status, data

pixelarraythirdparty/cron/cron.py

@@ -4,24 +4,15 @@ from pixelarraythirdparty.client import AsyncClient
 class CronManagerAsync(AsyncClient):
     async def get_cron_status(self):
         """
-        获取Cron服务状态（异步版本）
-
-        功能说明：
-            获取Cron服务的运行状态，包括已注册的任务、工作节点状态等。
-
-        输入参数：
-            无
-
-        返回字段：
-            data (dict): Cron服务状态信息
-                - registered_tasks (dict): 已注册的任务列表，按工作节点分组
-                - worker_stats (dict): 工作节点统计信息
-                - scheduled_task_count (int): 定时任务数量
-                - timestamp (str): 状态获取时间
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 获取Cron状态失败：返回错误信息"获取Cron状态失败"
+        description:
+            获取Cron服务状态，包括已注册的任务、工作节点状态等。
+        return:
+            data(dict): Cron服务状态信息
+                - registered_tasks(dict): 已注册的任务列表，按工作节点分组
+                - worker_stats(dict): 工作节点统计信息
+                - scheduled_task_count(int): 定时任务数量
+                - timestamp(str): 状态获取时间
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", "/api/cron/status")
         if not success:
@@ -30,23 +21,14 @@ class CronManagerAsync(AsyncClient):
 
     async def get_cron_tasks(self):
         """
-        获取已注册任务列表（异步版本）
-
-        功能说明：
+        description:
             获取所有已注册的Cron任务列表。
-
-        输入参数：
-            无
-
-        返回字段：
-            data (dict): 任务列表信息
-                - tasks (list): 已注册的任务名称列表
-                - count (int): 任务数量
-                - timestamp (str): 获取时间
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 获取任务列表失败：返回错误信息"获取任务列表失败"
+        return:
+            data(dict): 任务列表信息
+                - tasks(list): 已注册的任务名称列表
+                - count(int): 任务数量
+                - timestamp(str): 获取时间
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", "/api/cron/tasks")
         if not success:
@@ -55,35 +37,26 @@ class CronManagerAsync(AsyncClient):
 
     async def get_cron_tasks_scheduled(self):
         """
-        获取定时任务列表（异步版本）
-
-        功能说明：
+        description:
             获取所有配置的定时任务列表，包括任务详情、执行时间、状态等。
-
-        输入参数：
-            无
-
-        返回字段：
-            data (dict): 定时任务列表信息
-                - tasks (list): 定时任务列表
-                    - id (str): 任务ID
-                    - name (str): 任务名称
-                    - description (str): 任务描述
-                    - schedule (str): 执行时间
-                    - enabled (bool): 是否启用
-                    - task_name (str): 任务函数名
-                    - module_name (str): 模块名
-                    - function_name (str): 函数名
-                    - file_path (str): 文件路径
-                    - parameters (list): 参数列表
-                    - task_config (dict): 任务配置
-                    - registration_info (dict): 注册信息
-                - count (int): 任务数量
-                - timestamp (str): 获取时间
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 获取定时任务列表失败：返回错误信息"获取定时任务列表失败"
+        return:
+            data(dict): 定时任务列表信息
+                - tasks(list): 定时任务列表
+                    - id(str): 任务ID
+                    - name(str): 任务名称
+                    - description(str): 任务描述
+                    - schedule(str): 执行时间
+                    - enabled(bool): 是否启用
+                    - task_name(str): 任务函数名
+                    - module_name(str): 模块名
+                    - function_name(str): 函数名
+                    - file_path(str): 文件路径
+                    - parameters(list): 参数列表
+                    - task_config(dict): 任务配置
+                    - registration_info(dict): 注册信息
+                - count(int): 任务数量
+                - timestamp(str): 获取时间
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", "/api/cron/tasks/scheduled")
         if not success:
@@ -92,30 +65,22 @@ class CronManagerAsync(AsyncClient):
 
     async def get_cron_tasks_detail(self, task_name: str):
         """
-        获取任务详情（异步版本）
-
-        功能说明：
+        description:
             根据任务名称获取指定任务的详细信息。
-
-        输入参数：
-            task_name (str): 任务名称，必填，需要URL编码
-
-        返回字段：
-            data (dict): 任务详细信息
-                - task_name (str): 任务名称
-                - module_name (str): 模块名
-                - function_name (str): 函数名
-                - file_path (str): 文件路径
-                - description (str): 任务描述
-                - parameters (list): 参数列表
-                - task_config (dict): 任务配置
-                - registration_info (dict): 注册信息
-                - timestamp (str): 获取时间
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 任务不存在：返回错误信息"任务不存在"
-            - 获取任务详情失败：返回错误信息"获取任务详情失败"
+        parameters:
+            task_name(str): 任务名称
+        return:
+            data(dict): 任务详细信息
+                - task_name(str): 任务名称
+                - module_name(str): 模块名
+                - function_name(str): 函数名
+                - file_path(str): 文件路径
+                - description(str): 任务描述
+                - parameters(list): 参数列表
+                - task_config(dict): 任务配置
+                - registration_info(dict): 注册信息
+                - timestamp(str): 获取时间
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", f"/api/cron/tasks/{task_name}")
         if not success:
@@ -124,27 +89,19 @@ class CronManagerAsync(AsyncClient):
 
     async def trigger_cron_task(self, task_name: str, args: list, kwargs: dict):
         """
-        触发任务执行（异步版本）
-
-        功能说明：
+        description:
             手动触发指定任务的执行，支持传递参数。
-
-        输入参数：
-            task_name (str): 任务名称，必填，需要URL编码
-            args (list): 任务参数列表，可选
-            kwargs (dict): 任务关键字参数，可选
-
-        返回字段：
-            data (dict): 任务触发信息
-                - task_id (str): 任务ID
-                - task_name (str): 任务名称
-                - status (str): 任务状态，初始为"PENDING"
-                - message (str): 触发消息
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 任务不存在：返回错误信息"任务不存在"
-            - 任务触发失败：返回错误信息"任务触发失败"
+        parameters:
+            task_name(str): 任务名称
+            args(list): 任务参数列表
+            kwargs(dict): 任务关键字参数
+        return:
+            data(dict): 任务触发信息
+                - task_id(str): 任务ID
+                - task_name(str): 任务名称
+                - status(str): 任务状态，初始为"PENDING"
+                - message(str): 触发消息
+            success(bool): 操作是否成功
         """
         data, success = await self._request(
             "POST",

pixelarraythirdparty/order/order.py

@@ -10,37 +10,27 @@ class OrderManagerAsync(AsyncClient):
         payment_channel: str = "WECHAT",
     ):
         """
-        创建订单（异步版本）
-
-        功能说明：
+        description:
             根据产品ID创建新的订单，系统会自动生成订单号，获取产品价格信息，并创建对应的支付订单。
-
-        输入参数：
-            product_id (str): 产品ID，必填，用于获取产品信息和价格
-            body (str, 可选): 商品描述，如果不提供则使用产品名称
-            remark (str, 可选): 订单备注信息
-            payment_channel (str, 可选): 支付渠道，默认为"WECHAT"（微信支付）
-
-        返回字段：
-            data (dict): 订单信息
-                - id (int): 订单ID
-                - out_trade_no (str): 商户订单号，格式为"ORD_时间戳_随机字符串"
-                - payment_status (str): 支付状态，初始为"PENDING"（待支付）
-                - payment_channel (str): 支付渠道
-                - product_id (str): 产品ID
-                - amount (str): 订单金额（元），格式为"99.00"
-                - total_fee (int): 订单金额（分），用于支付接口
-                - body (str): 商品描述
-                - remark (str): 订单备注
-                - created_at (str): 订单创建时间
-                - updated_at (str): 订单更新时间
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 产品ID为空：返回错误信息"产品ID不能为空"
-            - 产品不存在：返回错误信息"产品不存在"
-            - 产品价格无效：返回错误信息"产品价格无效"
-            - 创建订单失败：返回错误信息"创建订单失败"
+        parameters:
+            product_id(str): 产品ID
+            body(str): 商品描述
+            remark(str): 订单备注
+            payment_channel(str): 支付渠道，可选值："WECHAT"（微信支付）、"ALIPAY"（支付宝支付）
+        return:
+            data(dict): 订单信息
+                - id(int): 订单ID
+                - out_trade_no(str): 商户订单号，格式为"ORD_时间戳_随机字符串"
+                - payment_status(str): 支付状态，初始为"PENDING"（待支付）
+                - payment_channel(str): 支付渠道
+                - product_id(str): 产品ID
+                - amount(str): 订单金额（元），格式为"99.00"
+                - total_fee(int): 订单金额（分），用于支付接口
+                - body(str): 商品描述
+                - remark(str): 订单备注
+                - created_at(str): 订单创建时间
+                - updated_at(str): 订单更新时间
+            success(bool): 操作是否成功
         """
         data = {
             "product_id": product_id,
@@ -61,39 +51,28 @@ class OrderManagerAsync(AsyncClient):
         out_trade_no: str = None,
     ):
         """
-        获取订单列表（异步版本）
-
-        功能说明：
+        description:
             分页查询订单列表，支持按支付状态和订单号进行筛选。
-
-        输入参数：
-            page (int, 可选): 页码，默认为1，最小值为1
-            page_size (int, 可选): 每页数量，默认为10，范围为1-1000
-            payment_status (str, 可选): 支付状态筛选，可选值：
-                - "PENDING": 待支付
-                - "PAID": 已支付
-                - "REFUNDED": 已退款
-                - "CANCELLED": 已取消
-            out_trade_no (str, 可选): 订单号搜索，支持模糊匹配
-
-        返回字段：
-            data (dict): 订单列表信息
-                - orders (list): 订单列表
-                    - id (int): 订单ID
-                    - out_trade_no (str): 商户订单号
-                    - payment_status (str): 支付状态
-                    - payment_channel (str): 支付渠道
-                    - amount (str): 订单金额（元）
-                    - total_fee (int): 订单金额（分）
-                    - created_at (str): 订单创建时间
-                    - updated_at (str): 订单更新时间
-                - total (int): 总订单数量
-                - page (int): 当前页码
-                - page_size (int): 每页数量
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 获取订单列表失败：返回错误信息"获取订单列表失败"
+        parameters:
+            page(int): 页码
+            page_size(int): 每页数量
+            payment_status(str): 支付状态，可选值："PENDING"（待支付）、"PAID"（已支付）、"REFUNDED"（已退款）、"CANCELLED"（已取消）
+            out_trade_no(str): 订单号，支持模糊匹配
+        return:
+            data(dict): 订单列表信息
+                - orders(list): 订单列表
+                    - id(int): 订单ID
+                    - out_trade_no(str): 商户订单号
+                    - payment_status(str): 支付状态
+                    - payment_channel(str): 支付渠道
+                    - amount(str): 订单金额（元）
+                    - total_fee(int): 订单金额（分）
+                    - created_at(str): 订单创建时间
+                    - updated_at(str): 订单更新时间
+                - total(int): 总订单数量
+                - page(int): 当前页码
+                - page_size(int): 每页数量
+            success(bool): 操作是否成功
         """
         params = {
             "page": page,
@@ -111,39 +90,31 @@ class OrderManagerAsync(AsyncClient):
 
     async def get_order_detail(self, out_trade_no: str):
         """
-        获取订单详情（异步版本）
-
-        功能说明：
+        description:
             根据订单号获取订单的详细信息，包括支付状态、交易信息等。
-
-        输入参数：
-            out_trade_no (str): 商户订单号，必填
-
-        返回字段：
-            data (dict): 订单详细信息
-                - id (int): 订单ID
-                - out_trade_no (str): 商户订单号
-                - payment_status (str): 支付状态
-                - product_id (str): 产品ID
-                - amount (str): 订单金额（元）
-                - total_fee (int): 订单金额（分）
-                - body (str): 商品描述
-                - transaction_id (str): 微信交易号（支付成功后才有）
-                - openid (str): 用户openid（支付成功后才有）
-                - trade_type (str): 交易类型（支付成功后才有）
-                - bank_type (str): 银行类型（支付成功后才有）
-                - fee_type (str): 货币类型，默认为"CNY"
-                - is_subscribe (str): 是否关注公众号（支付成功后才有）
-                - time_end (str): 支付完成时间（支付成功后才有）
-                - created_at (str): 订单创建时间
-                - updated_at (str): 订单更新时间
-                - paid_at (str): 支付时间（支付成功后才有）
-                - remark (str): 订单备注
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 订单不存在：返回错误信息"订单不存在"
-            - 获取订单详情失败：返回错误信息"获取订单详情失败"
+        parameters:
+            out_trade_no(str): 商户订单号
+        return:
+            data(dict): 订单详细信息
+                - id(int): 订单ID
+                - out_trade_no(str): 商户订单号
+                - payment_status(str): 支付状态
+                - product_id(str): 产品ID
+                - amount(str): 订单金额（元）
+                - total_fee(int): 订单金额（分）
+                - body(str): 商品描述
+                - transaction_id(str): 微信交易号（支付成功后才有）
+                - openid(str): 用户openid（支付成功后才有）
+                - trade_type(str): 交易类型（支付成功后才有）
+                - bank_type(str): 银行类型（支付成功后才有）
+                - fee_type(str): 货币类型，默认为"CNY"
+                - is_subscribe(str): 是否关注公众号（支付成功后才有）
+                - time_end(str): 支付完成时间（支付成功后才有）
+                - created_at(str): 订单创建时间
+                - updated_at(str): 订单更新时间
+                - paid_at(str): 支付时间（支付成功后才有）
+                - remark(str): 订单备注
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", f"/api/orders/{out_trade_no}")
         if not success:
@@ -152,40 +123,27 @@ class OrderManagerAsync(AsyncClient):
 
     async def update_order_status(self, out_trade_no: str, payment_status: str):
         """
-        更新订单状态（异步版本）
-
-        功能说明：
+        description:
             更新指定订单的支付状态，仅支持状态修改，其他字段不可修改。
-
-        输入参数：
-            out_trade_no (str): 商户订单号，必填
-            payment_status (str): 支付状态，必填，可选值：
-                - "PENDING": 待支付
-                - "PAID": 已支付
-                - "REFUNDED": 已退款
-                - "CANCELLED": 已取消
-
-        返回字段：
-            data (dict): 更新后的订单信息
-                - id (int): 订单ID
-                - out_trade_no (str): 商户订单号
-                - payment_status (str): 更新后的支付状态
-                - transaction_id (str): 微信交易号（如果已支付）
-                - openid (str): 用户openid（如果已支付）
-                - trade_type (str): 交易类型（如果已支付）
-                - bank_type (str): 银行类型（如果已支付）
-                - fee_type (str): 货币类型
-                - is_subscribe (str): 是否关注公众号（如果已支付）
-                - time_end (str): 支付完成时间（如果已支付）
-                - paid_at (str): 支付时间（如果已支付）
-                - updated_at (str): 订单更新时间
-                - remark (str): 订单备注
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 支付状态为空：返回错误信息"支付状态不能为空"
-            - 订单不存在：返回错误信息"订单不存在"
-            - 更新订单状态失败：返回错误信息"更新订单状态失败"
+        parameters:
+            out_trade_no(str): 商户订单号
+            payment_status(str): 支付状态，可选值："PENDING"（待支付）、"PAID"（已支付）、"REFUNDED"（已退款）、"CANCELLED"（已取消）
+        return:
+            data(dict): 更新后的订单信息
+                - id(int): 订单ID
+                - out_trade_no(str): 商户订单号
+                - payment_status(str): 更新后的支付状态
+                - transaction_id(str): 微信交易号（如果已支付）
+                - openid(str): 用户openid（如果已支付）
+                - trade_type(str): 交易类型（如果已支付）
+                - bank_type(str): 银行类型（如果已支付）
+                - fee_type(str): 货币类型
+                - is_subscribe(str): 是否关注公众号（如果已支付）
+                - time_end(str): 支付完成时间（如果已支付）
+                - paid_at(str): 支付时间（如果已支付）
+                - updated_at(str): 订单更新时间
+                - remark(str): 订单备注
+            success(bool): 操作是否成功
         """
         data = {"payment_status": payment_status}
         data, success = await self._request(
@@ -197,21 +155,13 @@ class OrderManagerAsync(AsyncClient):
 
     async def delete_order(self, out_trade_no: str):
         """
-        删除订单（异步版本）
-
-        功能说明：
+        description:
             根据订单号删除指定的订单记录。
-
-        输入参数：
-            out_trade_no (str): 商户订单号，必填
-
-        返回字段：
-            data (None): 删除成功时返回None
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 订单不存在：返回错误信息"订单不存在"
-            - 删除订单失败：返回错误信息"删除订单失败"
+        parameters:
+            out_trade_no(str): 商户订单号
+        return:
+            data(None): 删除成功时返回None
+            success(bool): 操作是否成功
         """
         data, success = await self._request("DELETE", f"/api/orders/{out_trade_no}")
         if not success:
@@ -220,26 +170,17 @@ class OrderManagerAsync(AsyncClient):
 
     async def get_order_stats(self):
         """
-        获取订单统计信息（异步版本）
-
-        功能说明：
+        description:
             获取订单的统计汇总信息，包括总订单数、各状态订单数量、总金额等。
-
-        输入参数：
-            无
-
-        返回字段：
-            data (dict): 订单统计信息
-                - total_orders (int): 总订单数量
-                - pending_orders (int): 待支付订单数量
-                - paid_orders (int): 已支付订单数量
-                - refunded_orders (int): 已退款订单数量
-                - total_amount (float): 总订单金额（元）
-                - total_fee (int): 总订单金额（分）
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 获取订单统计信息失败：返回错误信息"获取订单统计信息失败"
+        return:
+            data(dict): 订单统计信息
+                - total_orders(int): 总订单数量
+                - pending_orders(int): 待支付订单数量
+                - paid_orders(int): 已支付订单数量
+                - refunded_orders(int): 已退款订单数量
+                - total_amount(float): 总订单金额（元）
+                - total_fee(int): 总订单金额（分）
+            success(bool): 操作是否成功
         """
         data, success = await self._request("GET", "/api/orders/stats/summary")
         if not success:
@@ -248,26 +189,16 @@ class OrderManagerAsync(AsyncClient):
 
     async def generate_qr_code(self, out_trade_no: str):
         """
-        生成支付二维码（异步版本）
-
-        功能说明：
+        description:
             为指定订单生成支付二维码，支持微信支付和支付宝。二维码会自动上传到OSS并返回访问URL。
             如果不指定payment_channel，会自动从订单详情中获取支付渠道。
-
-        输入参数：
-            out_trade_no (str): 商户订单号，必填
-
-        返回字段：
-            data (dict): 二维码信息
-                - qr_code_url (str): 二维码图片URL，可直接用于显示
-                - out_trade_no (str): 商户订单号
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 订单号为空：返回错误信息"订单号不能为空"
-            - 订单不存在：返回错误信息"订单不存在"
-            - 不支持的支付渠道：抛出ValueError异常
-            - 生成支付二维码失败：返回错误信息"生成支付二维码失败"
+        parameters:
+            out_trade_no(str): 商户订单号
+        return:
+            data(dict): 二维码信息
+                - qr_code_url(str): 二维码图片URL，可直接用于显示
+                - out_trade_no(str): 商户订单号
+            success(bool): 操作是否成功
         """
         order_detail, success = await self.get_order_detail(out_trade_no)
         print(order_detail)
@@ -296,28 +227,17 @@ class OrderManagerAsync(AsyncClient):
 
     async def refund_order(self, out_trade_no: str):
         """
-        申请订单退款（异步版本）
-
-        功能说明：
+        description:
             为指定订单申请退款，支持微信支付和支付宝。退款申请提交后，系统会处理退款并更新订单状态。
-
-        输入参数：
-            out_trade_no (str): 商户订单号，必填
-
-        返回字段：
-            data (dict): 退款信息
-                - out_refund_no (str): 退款单号，格式为"REFUND_订单号_时间戳"
-                - out_trade_no (str): 商户订单号
-                - total_fee (int): 退款金额（分，微信支付）
-                - refund_amount (float): 退款金额（元，支付宝）
-            success (bool): 操作是否成功
-
-        异常情况：
-            - 订单号为空：返回错误信息"订单号不能为空"
-            - 订单不存在：返回错误信息"订单不存在"
-            - 订单状态不允许退款：返回错误信息"订单状态不允许退款"
-            - 不支持的支付渠道：抛出ValueError异常
-            - 退款申请失败：返回错误信息"退款申请失败"
+        parameters:
+            out_trade_no(str): 商户订单号
+        return:
+            data(dict): 退款信息
+                - out_refund_no(str): 退款单号，格式为"REFUND_订单号_时间戳"
+                - out_trade_no(str): 商户订单号
+                - total_fee(int): 退款金额（分，微信支付）
+                - refund_amount(float): 退款金额（元，支付宝）
+            success(bool): 操作是否成功
         """
         order_detail, success = await self.get_order_detail(out_trade_no)
         if not success: