py-wisharetec 0.1.0__py3-none-any.whl

py_wisharetec/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-

py_wisharetec/saas/__init__.py

@@ -0,0 +1,374 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+import hashlib
+from typing import Optional, Union
+
+import diskcache
+import httpx
+import redis
+from pydantic import HttpUrl
+
+from py_wisharetec.saas.utils import json_is_valid
+
+
+class Saas:
+    def __init__(
+            self,
+            base_url: Optional[HttpUrl] = "https://saas.wisharetec.com/",
+            account: Optional[str] = None,
+            password: Optional[str] = None,
+            cache_config: Optional[dict] = None,
+            client_kwargs: Optional[dict] = None
+    ):
+        self.base_url = base_url or "https://saas.wisharetec.com/"
+        self.base_url = self.base_url[:-1] if self.base_url.endswith("/") else self.base_url
+
+        # 处理账号密码
+        self.account = account or ""
+        self.password = password or ""
+        self.cache_config = cache_config or {}
+        self.cache_config = {
+            **{
+                "instance": None,
+                "key": f"py_wisharetec_saas_{self.account}",
+                "expire": 7100,
+            },
+            **self.cache_config,
+        }
+        self.client_kwargs = client_kwargs or {}
+        self.client_kwargs = {
+            **{
+                "base_url": self.base_url,
+                "timeout": 60,
+                "verify": False,
+                "headers": {
+                    "client": "co-pc"
+                }
+            },
+            **self.client_kwargs,
+        }
+        self.token = ""
+
+    def client(self) -> httpx.Client:
+        """
+        创建并返回同步HTTP客户端
+
+        Returns:
+            httpx.Client: 配置好的同步HTTP客户端实例
+        """
+        return httpx.Client(**self.client_kwargs)
+
+    def async_client(self) -> httpx.AsyncClient:
+        """
+        创建并返回异步HTTP客户端
+
+        Returns:
+            httpx.AsyncClient: 配置好的异步HTTP客户端实例
+        """
+        return httpx.AsyncClient(**self.client_kwargs)
+
+    def query_space_manage_tree(self, client: Optional[httpx.Client] = None, **kwargs) -> httpx.Response:
+        """
+        查询空间管理树
+
+        :param client: 可选的同步客户端实例
+        :param **kwargs: 传递给request的额外参数
+        :return: httpx.Response - HTTP响应对象
+        """
+
+        kwargs = kwargs or {}
+        kwargs = {
+            **{
+                "method": "GET",
+                "url": "/api/space/space/manageTree",
+                "headers": {
+                    "client": "co-pc",
+                    "authorization": self.token,
+                },
+                "json": {
+                    "account": self.account,
+                    "password": hashlib.md5(self.password.encode("utf-8")).hexdigest(),
+                },
+            },
+            **kwargs,
+        }
+
+        # 发送请求
+        if isinstance(client, httpx.Client):
+            response = client.request(**kwargs)
+        else:
+            with self.client() as _client:
+                response = _client.request(**kwargs)
+        return response
+
+    def login(self, client: Optional[httpx.Client] = None, **kwargs) -> httpx.Response:
+        """
+        登录 SaaS 系统
+
+        :param client: 可选的同步客户端实例
+        :param kwargs: 传递给request的额外参数
+        :return: httpx.Response - HTTP响应对象
+        """
+        kwargs = kwargs or {}
+        kwargs = {
+            **{
+                "method": "POST",
+                "url": "/api/user/loginInteractive",
+                "headers": {
+                    "client": "co-pc"
+                },
+                "json": {
+                    "account": self.account,
+                    "password": hashlib.md5(self.password.encode("utf-8")).hexdigest(),
+                },
+            },
+            **kwargs,
+        }
+
+        # 发送请求
+        if isinstance(client, httpx.Client):
+            response = client.request(**kwargs)
+        else:
+            with self.client() as _client:
+                response = _client.request(**kwargs)
+
+        if response.is_success:
+            if json_is_valid(
+                    schema={
+                        "type": "object",
+                        "properties": {
+                            # "tenantSimpleInfoVList": {"type": "array", "minItems": 1},
+                            "userLoginV": {
+                                "type": "object",
+                                "properties": {
+                                    "userInfoV": {
+                                        "type": "object",
+                                        "properties": {
+                                            "id": {"type": "string", "minLength": 1}
+                                        },
+                                        "required": ["id"]
+                                    },
+                                },
+                                "required": ["userInfoV"]
+                            }
+                        },
+                        "required": ["userLoginV"],
+                    },
+                    data=response.json(),
+            ):
+                self.token = response.headers.get("authorization", "")
+            else:
+                self.token = ""
+
+        return response
+
+    def refresh_token(
+            self,
+            login_func_kwargs: Optional[dict] = None,
+            query_space_manage_tree_func_kwargs: Optional[dict] = None,
+    ) -> "Saas":
+        login_func_kwargs = login_func_kwargs or {}
+        query_space_manage_tree_func_kwargs = query_space_manage_tree_func_kwargs or {}
+        cache_key = self.cache_config.get("key", f"py_wisharetec_saas_{self.account}")
+        cache_expire = self.cache_config.get("expire", 7100)
+        cache_instance = self.cache_config.get("instance", None)
+        if not isinstance(cache_instance, Union[diskcache.Cache, redis.Redis]):
+            self.login(**login_func_kwargs)
+        else:
+            self.token = cache_instance.get(cache_key)
+            if not isinstance(self.token, str) or not len(self.token):
+                self.login(**login_func_kwargs)
+            response_json = self.query_space_manage_tree(**query_space_manage_tree_func_kwargs).json()
+            if not json_is_valid(
+                    schema={
+                        "type": "array",
+                        "minItems": 1,
+                    },
+                    data=response_json,
+            ):
+                self.login(**login_func_kwargs)
+            if json_is_valid(
+                    schema={
+                        "type": "array",
+                        "minItems": 1,
+                    },
+                    data=response_json,
+            ):
+                if isinstance(cache_instance, diskcache.Cache):
+                    cache_instance.set(cache_key, self.token, expire=cache_expire)
+                elif isinstance(cache_instance, redis.Redis):
+                    cache_instance.set(cache_key, self.token, ex=cache_expire)
+        return self
+
+    def request(self, client: Optional[httpx.Client] = None, **kwargs) -> httpx.Response:
+        kwargs = kwargs or {}
+        kwargs = {
+            "headers": {
+                "client": "co-pc",
+                "authorization": self.token,
+            },
+            **kwargs,
+        }
+        if isinstance(client, httpx.Client):
+            response = client.request(**kwargs)
+        else:
+            with self.client() as _client:
+                response = _client.request(**kwargs)
+        return response
+
+    async def async_query_space_manage_tree(self, client: Optional[httpx.AsyncClient] = None,
+                                            **kwargs) -> httpx.Response:
+        """
+        查询空间管理树
+
+        :param client: 可选的同步客户端实例
+        :param **kwargs: 传递给request的额外参数
+        :return: httpx.Response - HTTP响应对象
+        """
+
+        kwargs = kwargs or {}
+        kwargs = {
+            **{
+                "method": "GET",
+                "url": "/api/space/space/manageTree",
+                "headers": {
+                    "client": "co-pc",
+                    "authorization": self.token,
+                },
+                "json": {
+                    "account": self.account,
+                    "password": hashlib.md5(self.password.encode("utf-8")).hexdigest(),
+                },
+            },
+            **kwargs,
+        }
+
+        # 发送请求
+        if isinstance(client, httpx.AsyncClient):
+            response = await client.request(**kwargs)
+        else:
+            async with self.async_client() as _client:
+                response = await _client.request(**kwargs)
+        return response
+
+    async def async_login(self, client: Optional[httpx.AsyncClient] = None, **kwargs) -> httpx.Response:
+        """
+        登录 SaaS 系统
+
+        :param client: 可选的异步客户端实例
+        :param kwargs: 传递给request的额外参数
+        :return: httpx.Response - HTTP响应对象
+        """
+        kwargs = kwargs or {}
+        kwargs = {
+            **{
+                "method": "POST",
+                "url": "/api/user/loginInteractive",
+                "headers": {
+                    "client": "co-pc"
+                },
+                "json": {
+                    "account": self.account,
+                    "password": hashlib.md5(self.password.encode("utf-8")).hexdigest(),
+                },
+            },
+            **kwargs,
+        }
+
+        # 发送请求
+        if isinstance(client, httpx.AsyncClient):
+            response = await client.request(**kwargs)
+        else:
+            async with self.async_client() as _client:
+                response = await _client.request(**kwargs)
+
+        if response.is_success:
+            if json_is_valid(
+                    schema={
+                        "type": "object",
+                        "properties": {
+                            # "tenantSimpleInfoVList": {"type": "array", "minItems": 1},
+                            "userLoginV": {
+                                "type": "object",
+                                "properties": {
+                                    "userInfoV": {
+                                        "type": "object",
+                                        "properties": {
+                                            "id": {"type": "string", "minLength": 1}
+                                        },
+                                        "required": ["id"]
+                                    },
+                                },
+                                "required": ["userInfoV"]
+                            }
+                        },
+                        "required": ["userLoginV"],
+                    },
+                    data=response.json(),
+            ):
+                self.token = response.headers.get("authorization", "")
+            else:
+                self.token = ""
+
+        return response
+
+    async def async_refresh_token(
+            self,
+            login_func_kwargs: Optional[dict] = None,
+            query_space_manage_tree_func_kwargs: Optional[dict] = None,
+    ) -> "Saas":
+        login_func_kwargs = login_func_kwargs or {}
+        query_space_manage_tree_func_kwargs = query_space_manage_tree_func_kwargs or {}
+        cache_key = self.cache_config.get("key", f"py_wisharetec_saas_{self.account}")
+        cache_expire = self.cache_config.get("expire", 7100)
+        cache_instance = self.cache_config.get("instance", None)
+        if not isinstance(cache_instance, Union[diskcache.Cache, redis.Redis]):
+            await self.async_login(**login_func_kwargs)
+        else:
+            self.token = cache_instance.get(cache_key)
+            if not isinstance(self.token, str) or not len(self.token):
+                await self.async_login(**login_func_kwargs)
+            response = await self.async_query_space_manage_tree(**query_space_manage_tree_func_kwargs)
+            if not json_is_valid(
+                    schema={
+                        "type": "object",
+                        "properties": {
+                            "children": {"type": "array", "minItems": 1},
+                        },
+                        "required": ["children"],
+                    },
+                    data=response.json(),
+            ):
+                await self.async_login(**login_func_kwargs)
+            response = await self.async_query_space_manage_tree(**query_space_manage_tree_func_kwargs)
+            if json_is_valid(
+                    schema={
+                        "type": "object",
+                        "properties": {
+                            "children": {"type": "array", "minItems": 1},
+                        },
+                        "required": ["children"],
+                    },
+                    data=response.json(),
+            ):
+                if isinstance(cache_instance, diskcache.Cache):
+                    cache_instance.set(cache_key, self.token, expire=cache_expire)
+                elif isinstance(cache_instance, redis.Redis):
+                    cache_instance.set(cache_key, self.token, ex=cache_expire)
+        return self
+
+    async def async_request(self, client: Optional[httpx.AsyncClient] = None, **kwargs) -> httpx.Response:
+        kwargs = kwargs or {}
+        kwargs = {
+            "headers": {
+                "client": "co-pc",
+                "authorization": self.token,
+            },
+            **kwargs,
+        }
+        if isinstance(client, httpx.AsyncClient):
+            response = await client.request(**kwargs)
+        else:
+            async with self.async_client() as _client:
+                response = await _client.request(**kwargs)
+        return response

py_wisharetec/saas/utils.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+from datetime import datetime
+from typing import Any, Optional, Union
+
+import httpx
+from jsonpath_ng import parse
+from jsonschema.validators import Draft202012Validator
+
+
+def json_find_first(expression: str, data: Any) -> Any:
+    """
+    使用 JSONPath 表达式从数据中查找第一个匹配项
+
+    Args:
+        expression: JSONPath 表达式，用于指定要查找的数据路径
+        data: 待查询的 JSON 数据
+
+    Returns:
+        Any: 第一个匹配的值，如果没有匹配项则返回 None
+    """
+    results = [i.value for i in parse(expression).find(data)]
+    if isinstance(results, list) and len(results) > 0:
+        return results[0]
+    return None
+
+
+def json_is_valid(schema: Optional[dict], data: Any) -> bool:
+    """
+    校验 JSON 数据是否符合指定的 JSON Schema
+
+    Args:
+        schema: JSON Schema 字典
+        data: 待校验的 JSON 数据
+
+    Returns:
+        bool: 校验是否成功
+    """
+    return Draft202012Validator(schema).is_valid(data)

py_wisharetec-0.1.0.dist-info/METADATA

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: py-wisharetec
+Version: 0.1.0
+Summary: Wisharetec SaaS 系统的 Python 客户端库，提供同步和异步接口调用能力。
+Author-email: Guolei <174000902@qq.com>
+License: MIT License
+        
+        Copyright (c) 2026 郭磊
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://gitee.com/guolei19850528/py_wisharetec
+Project-URL: Repository, https://gitee.com/guolei19850528/py_wisharetec.git
+Keywords: wisharetec,python,client,api,wisharetec saas,saas
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: jsonpath-ng>=1.5.3
+Requires-Dist: jsonschema>=4.21.0
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: redis>=4.6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: setuptools>=61.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Dynamic: license-file
+
+# py_wisharetec
+
+Wisharetec SaaS 系统的 Python 客户端库，提供同步和异步接口调用能力。
+
+## 功能特性
+
+- 同步/异步 HTTP 客户端支持
+- 登录认证与令牌管理
+- 令牌缓存机制（支持 diskcache 和 Redis）
+- 请求封装与响应处理
+- JSON 数据校验与查询工具
+
+## 安装
+
+```bash
+pip install py_wisharetec
+```
+
+## 快速开始
+
+### 同步模式
+
+```python
+from py_wisharetec.saas import Saas
+
+# 初始化客户端
+saas = Saas(
+    base_url="https://saas.wisharetec.com/",
+    account="your_account",
+    password="your_password"
+)
+
+# 登录并刷新令牌
+saas.refresh_token()
+
+# 发起请求
+response = saas.request(
+    method="GET",
+    url="/api/your-endpoint"
+)
+
+print(response.json())
+```
+
+### 异步模式
+
+```python
+import asyncio
+from py_wisharetec.saas import Saas
+
+async def main():
+    # 初始化客户端
+    saas = Saas(
+        base_url="https://saas.wisharetec.com/",
+        account="your_account",
+        password="your_password"
+    )
+    
+    # 异步登录并刷新令牌
+    await saas.async_refresh_token()
+    
+    # 发起异步请求
+    response = await saas.async_request(
+        method="GET",
+        url="/api/your-endpoint"
+    )
+    
+    print(response.json())
+
+asyncio.run(main())
+```
+
+## 配置选项
+
+### 初始化参数
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| base_url | str | https://saas.wisharetec.com/ | SaaS 服务基础 URL |
+| account | str | None | 账号 |
+| password | str | None | 密码 |
+| cache_config | dict | {} | 缓存配置 |
+| client_kwargs | dict | {} | HTTP 客户端额外参数 |
+
+### 缓存配置
+
+```python
+cache_config = {
+    "instance": None,           # diskcache.Cache 或 redis.Redis 实例
+    "key": "py_wisharetec_saas_{account}",  # 缓存键名
+    "expire": 7100             # 过期时间（秒）
+}
+```
+
+### 客户端配置
+
+```python
+client_kwargs = {
+    "timeout": 60,             # 请求超时时间
+    "verify": False,           # 是否验证 SSL 证书
+    "headers": {
+        "client": "co-pc"
+    }
+}
+```
+
+## API 参考
+
+### Saas 类
+
+#### 同步方法
+
+- `client()` - 创建同步 HTTP 客户端
+- `login(**kwargs)` - 登录系统
+- `refresh_token(**kwargs)` - 刷新令牌
+- `request(**kwargs)` - 发起请求
+- `query_space_manage_tree(**kwargs)` - 查询空间管理树
+
+#### 异步方法
+
+- `async_client()` - 创建异步 HTTP 客户端
+- `async_login(**kwargs)` - 异步登录系统
+- `async_refresh_token(**kwargs)` - 异步刷新令牌
+- `async_request(**kwargs)` - 发起异步请求
+- `async_query_space_manage_tree(**kwargs)` - 异步查询空间管理树
+
+### 工具函数
+
+- `json_find_first(expression, data)` - 使用 JSONPath 查找第一个匹配项
+- `json_is_valid(schema, data)` - 校验 JSON 数据是否符合 Schema
+
+## 示例
+
+### 使用缓存
+
+```python
+import diskcache
+from py_wisharetec.saas import Saas
+
+# 创建缓存实例
+cache = diskcache.Cache("./cache")
+
+# 初始化客户端（带缓存）
+saas = Saas(
+    account="your_account",
+    password="your_password",
+    cache_config={
+        "instance": cache,
+        "expire": 7200
+    }
+)
+
+# 登录（自动使用缓存）
+saas.refresh_token()
+```
+
+## 依赖
+
+- httpx >= 0.27.0
+- pydantic >= 2.0.0
+- diskcache >= 5.0.0 (可选)
+- redis >= 5.0.0 (可选)
+- jsonpath-ng >= 1.6.0
+- jsonschema >= 4.0.0
+
+## 主页
+
+[https://gitee.com/guolei19850528/py_wisharetec](https://gitee.com/guolei19850528/py_wisharetec)
+
+## 许可证
+
+MIT License

py_wisharetec-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+py_wisharetec/__init__.py,sha256=_ZTg5hKBudrPm7yfzWY8oBRoNo5CbL9XHuXmgaCyXUU,47
+py_wisharetec/saas/__init__.py,sha256=96sd7Ddfu_wqWN7ObjW5cq8pUdgc6xsNZ_HYWCPN8yw,13733
+py_wisharetec/saas/utils.py,sha256=javvTs8Qs79dBaHHE9BSuUL88DE-jmdeaXQYsp-eAME,1053
+py_wisharetec-0.1.0.dist-info/licenses/LICENSE,sha256=HazFJNaQP3rbY1dvg3hAmO-FZ6v7DwM0YHwXvWsGG3A,1063
+py_wisharetec-0.1.0.dist-info/METADATA,sha256=zI8uCeRr4FpTXw8DICYrlFtCUqqtGA_az_IjTaK5QHo,6075
+py_wisharetec-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+py_wisharetec-0.1.0.dist-info/top_level.txt,sha256=xmDUuBaqaxh1JS1OLd9gdYW69_clZzeFu3pEU46x2xw,14
+py_wisharetec-0.1.0.dist-info/RECORD,,

py_wisharetec-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

py_wisharetec-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 郭磊
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_wisharetec-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+py_wisharetec