py_wisharetec_toolkit 3.0.2__tar.gz → 3.0.3__tar.gz

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py_wisharetec_toolkit
-Version: 3.0.2
+Version: 3.0.3
 Summary: 浙江慧享科技有限公司 - 善数・慧享云运营平台 Python 扩展包，提供接口调用封装
 Author-email: guolei <174000902@qq.com>
 License: MIT
@@ -243,10 +243,29 @@ asyncio.run(main())
 ### 接口注意事项
 
 - 园区、房产、楼幢、车场、业主、车辆、车位、审批等接口的 `conditions` 需携带 `spaceTreeId` 与 `flag`。
-- 住户档案接口需传入空条件：`conditions={}`。
+- 住户档案接口需传入空条件：`conditions={}`；商城订单、服务订单接口需传入 `conditions={"fields": []}`（不能携带 `spaceTreeId`、`flag`，否则后端返回“系统内部报错”）。
 - 工单档案接口要求 `conditions` 中额外携带 `appCode=WORK_ORDER`。
 - 审批详情需先通过审批列表接口获取 `procInstId`，节点 ID 固定为 `node_433279443693`；业主详情需先获取 `userId` / `communityId` / `spaceId`，再调用详情接口。
 
+## 示例代码
+
+完整可运行示例位于 `examples/shanshu/`，覆盖全部接口的同步与异步调用，命名规则为 `example_*.py`（同步）与 `example_async_*.py`（异步）。
+
+1. 复制模板并填写真实账号：
+
+```bash
+cp examples/shanshu/.env.example examples/shanshu/.env
+```
+
+2. 运行示例（以园区档案为例）：
+
+```bash
+python examples/shanshu/example_community_page.py
+python examples/shanshu/example_async_community_page.py
+```
+
+公共配置与查询条件集中在 `examples/shanshu/example_common.py`，统一从 `examples/shanshu/.env` 读取 `SHANSHU_*` 变量。
+
 ## 运行测试
 
 测试用例位于 `tests/shanshu/`，基于 pytest + pytest-asyncio，统一从 `tests/shanshu/.env` 读取配置，公共夹具定义在 `tests/shanshu/conftest.py`。
@@ -274,7 +293,7 @@ pytest tests/shanshu -q
 - `ShanshuDiskCacheTokenCache`：基于 diskcache 的持久化缓存（需安装 `[cache]` 依赖）
 - `ShanshuRedisTokenCache`：基于 redis 的缓存（需安装 `[cache]` 依赖）
 
-缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization_token:{account}`，便于缓存不同用户的登录 token。
+缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization:{account}`，便于缓存不同用户的登录 token。
 
 ## 目录结构
 
@@ -293,6 +312,13 @@ tests/
     ├── conftest.py      # 公共夹具（客户端、登录、查询条件）
     ├── .env.example     # 测试配置模板
     └── test_*.py        # 各接口的同步 / 异步测试用例
+
+examples/
+└── shanshu/
+    ├── example_common.py     # 示例公共辅助（读取配置、构造客户端、查询条件）
+    ├── .env.example          # 示例配置模板
+    ├── example_*.py          # 各接口同步示例
+    └── example_async_*.py    # 各接口异步示例
 ```
 
 ## 参数说明

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/README.md

@@ -210,10 +210,29 @@ asyncio.run(main())
 ### 接口注意事项
 
 - 园区、房产、楼幢、车场、业主、车辆、车位、审批等接口的 `conditions` 需携带 `spaceTreeId` 与 `flag`。
-- 住户档案接口需传入空条件：`conditions={}`。
+- 住户档案接口需传入空条件：`conditions={}`；商城订单、服务订单接口需传入 `conditions={"fields": []}`（不能携带 `spaceTreeId`、`flag`，否则后端返回“系统内部报错”）。
 - 工单档案接口要求 `conditions` 中额外携带 `appCode=WORK_ORDER`。
 - 审批详情需先通过审批列表接口获取 `procInstId`，节点 ID 固定为 `node_433279443693`；业主详情需先获取 `userId` / `communityId` / `spaceId`，再调用详情接口。
 
+## 示例代码
+
+完整可运行示例位于 `examples/shanshu/`，覆盖全部接口的同步与异步调用，命名规则为 `example_*.py`（同步）与 `example_async_*.py`（异步）。
+
+1. 复制模板并填写真实账号：
+
+```bash
+cp examples/shanshu/.env.example examples/shanshu/.env
+```
+
+2. 运行示例（以园区档案为例）：
+
+```bash
+python examples/shanshu/example_community_page.py
+python examples/shanshu/example_async_community_page.py
+```
+
+公共配置与查询条件集中在 `examples/shanshu/example_common.py`，统一从 `examples/shanshu/.env` 读取 `SHANSHU_*` 变量。
+
 ## 运行测试
 
 测试用例位于 `tests/shanshu/`，基于 pytest + pytest-asyncio，统一从 `tests/shanshu/.env` 读取配置，公共夹具定义在 `tests/shanshu/conftest.py`。
@@ -241,7 +260,7 @@ pytest tests/shanshu -q
 - `ShanshuDiskCacheTokenCache`：基于 diskcache 的持久化缓存（需安装 `[cache]` 依赖）
 - `ShanshuRedisTokenCache`：基于 redis 的缓存（需安装 `[cache]` 依赖）
 
-缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization_token:{account}`，便于缓存不同用户的登录 token。
+缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization:{account}`，便于缓存不同用户的登录 token。
 
 ## 目录结构
 
@@ -260,6 +279,13 @@ tests/
     ├── conftest.py      # 公共夹具（客户端、登录、查询条件）
     ├── .env.example     # 测试配置模板
     └── test_*.py        # 各接口的同步 / 异步测试用例
+
+examples/
+└── shanshu/
+    ├── example_common.py     # 示例公共辅助（读取配置、构造客户端、查询条件）
+    ├── .env.example          # 示例配置模板
+    ├── example_*.py          # 各接口同步示例
+    └── example_async_*.py    # 各接口异步示例
 ```
 
 ## 参数说明

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "py_wisharetec_toolkit"
-version = "3.0.2"
+version = "3.0.3"
 description = "浙江慧享科技有限公司 - 善数・慧享云运营平台 Python 扩展包，提供接口调用封装"
 readme = "README.md"
 requires-python = ">=3.8"

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/src/py_wisharetec_toolkit/__init__.py

@@ -5,7 +5,7 @@
 可供他人通过 `import py_wisharetec_toolkit` 导入。
 """
 
-__version__ = "3.0.2"
+__version__ = "3.0.3"
 __all__ = ["shanshu"]
 
 from . import shanshu  # noqa: E402

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/src/py_wisharetec_toolkit/shanshu/__init__.py

@@ -7,7 +7,7 @@
 `from py_wisharetec_toolkit.shanshu import client, models, auth` 导入。
 """
 
-__version__ = "3.0.2"
+__version__ = "3.0.3"
 __all__ = ["client", "models", "auth"]
 
 from . import client  # noqa: E402

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/src/py_wisharetec_toolkit/shanshu/auth.py

@@ -6,7 +6,7 @@
 提供基于 httpx 的 ``/api/user/loginInteractive`` 接口调用，
 并支持 memory / diskcache / redis 三种 Token 缓存后端。
 
-缓存 key 格式：py_wisharetec_toolkit:shanshu:authorization_token:{account}
+缓存 key 格式：py_wisharetec_toolkit:shanshu:authorization:{account}
 便于缓存不同用户的登录 token。
 """
 
@@ -17,13 +17,13 @@ import threading
 from typing import Any, Protocol, runtime_checkable
 
 LOGIN_PATH = "api/user/loginInteractive"
-CACHE_KEY_PREFIX = "py_wisharetec_toolkit:shanshu:authorization_token"
+CACHE_KEY_PREFIX = "py_wisharetec_toolkit:shanshu:authorization"
 
 
 def cache_key(account: str) -> str:
     """构造 Token 缓存 key。
 
-    格式：py_wisharetec_toolkit:shanshu:authorization_token:{account}
+    格式：py_wisharetec_toolkit:shanshu:authorization:{account}
     """
     return f"{CACHE_KEY_PREFIX}:{account}"
 

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/src/py_wisharetec_toolkit/shanshu/client.py

@@ -219,7 +219,7 @@ class ShanshuClient:
         - 请求头固定携带 ``client=co-pc``。
         - 返回体若不包含 ``code`` 字段，视为登录成功。
         - 成功后从响应 headers 中提取 ``authorization`` 值，按
-          ``py_wisharetec_toolkit:shanshu:authorization_token:{account}`` 缓存。
+          ``py_wisharetec_toolkit:shanshu:authorization:{account}`` 缓存。
         """
         cache = token_cache or self._token_cache
         key = cache_key(account)
@@ -1301,7 +1301,7 @@ class AsyncShanshuClient:
         - 请求头固定携带 ``client=co-pc``。
         - 返回体若不包含 ``code`` 字段，视为登录成功。
         - 成功后从响应 headers 中提取 ``authorization`` 值，按
-          ``py_wisharetec_toolkit:shanshu:authorization_token:{account}`` 缓存。
+          ``py_wisharetec_toolkit:shanshu:authorization:{account}`` 缓存。
         """
         cache = token_cache or self._token_cache
         key = cache_key(account)

{py_wisharetec_toolkit-3.0.2 → py_wisharetec_toolkit-3.0.3}/src/py_wisharetec_toolkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py_wisharetec_toolkit
-Version: 3.0.2
+Version: 3.0.3
 Summary: 浙江慧享科技有限公司 - 善数・慧享云运营平台 Python 扩展包，提供接口调用封装
 Author-email: guolei <174000902@qq.com>
 License: MIT
@@ -243,10 +243,29 @@ asyncio.run(main())
 ### 接口注意事项
 
 - 园区、房产、楼幢、车场、业主、车辆、车位、审批等接口的 `conditions` 需携带 `spaceTreeId` 与 `flag`。
-- 住户档案接口需传入空条件：`conditions={}`。
+- 住户档案接口需传入空条件：`conditions={}`；商城订单、服务订单接口需传入 `conditions={"fields": []}`（不能携带 `spaceTreeId`、`flag`，否则后端返回“系统内部报错”）。
 - 工单档案接口要求 `conditions` 中额外携带 `appCode=WORK_ORDER`。
 - 审批详情需先通过审批列表接口获取 `procInstId`，节点 ID 固定为 `node_433279443693`；业主详情需先获取 `userId` / `communityId` / `spaceId`，再调用详情接口。
 
+## 示例代码
+
+完整可运行示例位于 `examples/shanshu/`，覆盖全部接口的同步与异步调用，命名规则为 `example_*.py`（同步）与 `example_async_*.py`（异步）。
+
+1. 复制模板并填写真实账号：
+
+```bash
+cp examples/shanshu/.env.example examples/shanshu/.env
+```
+
+2. 运行示例（以园区档案为例）：
+
+```bash
+python examples/shanshu/example_community_page.py
+python examples/shanshu/example_async_community_page.py
+```
+
+公共配置与查询条件集中在 `examples/shanshu/example_common.py`，统一从 `examples/shanshu/.env` 读取 `SHANSHU_*` 变量。
+
 ## 运行测试
 
 测试用例位于 `tests/shanshu/`，基于 pytest + pytest-asyncio，统一从 `tests/shanshu/.env` 读取配置，公共夹具定义在 `tests/shanshu/conftest.py`。
@@ -274,7 +293,7 @@ pytest tests/shanshu -q
 - `ShanshuDiskCacheTokenCache`：基于 diskcache 的持久化缓存（需安装 `[cache]` 依赖）
 - `ShanshuRedisTokenCache`：基于 redis 的缓存（需安装 `[cache]` 依赖）
 
-缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization_token:{account}`，便于缓存不同用户的登录 token。
+缓存 key 格式：`py_wisharetec_toolkit:shanshu:authorization:{account}`，便于缓存不同用户的登录 token。
 
 ## 目录结构
 
@@ -293,6 +312,13 @@ tests/
     ├── conftest.py      # 公共夹具（客户端、登录、查询条件）
     ├── .env.example     # 测试配置模板
     └── test_*.py        # 各接口的同步 / 异步测试用例
+
+examples/
+└── shanshu/
+    ├── example_common.py     # 示例公共辅助（读取配置、构造客户端、查询条件）
+    ├── .env.example          # 示例配置模板
+    ├── example_*.py          # 各接口同步示例
+    └── example_async_*.py    # 各接口异步示例
 ```
 
 ## 参数说明