fiuai-sdk-python 0.3.0__tar.gz → 0.3.2__tar.gz

{fiuai_sdk_python-0.3.0 → fiuai_sdk_python-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fiuai_sdk_python
-Version: 0.3.0
+Version: 0.3.2
 Summary: FiuAI Python SDK - 企业级AI服务集成开发工具包
 Project-URL: Homepage, https://github.com/fiuai/fiuai-sdk-python
 Project-URL: Documentation, https://github.com/fiuai/fiuai-sdk-python#readme
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.12
+Requires-Dist: fastapi>=0.118.2
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pytest>=8.4.1

{fiuai_sdk_python-0.3.0 → fiuai_sdk_python-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fiuai_sdk_python"
-version = "0.3.0"
+version = "0.3.2"
 description = "FiuAI Python SDK - 企业级AI服务集成开发工具包"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -24,6 +24,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Application Frameworks",
 ]
 dependencies = [
+    "fastapi>=0.118.2",
     "httpx>=0.28.1",
     "pydantic>=2.11.7",
     "pytest>=8.4.1",

{fiuai_sdk_python-0.3.0 → fiuai_sdk_python-0.3.2}/src/fiuai_sdk_python/__init__.py

@@ -1,12 +1,10 @@
 from .client import FiuaiSDK, get_client
-from .token import TokenConfig
 from .util import init_fiuai
 from .profile import UserProfileInfo
 from .type import UserProfile
 
 __all__ = [
     'FiuaiSDK',
-    'TokenConfig',
     'init_fiuai',
     'get_client',
     'UserProfileInfo',

fiuai_sdk_python-0.3.2/src/fiuai_sdk_python/auth/__init__.py

@@ -0,0 +1,25 @@
+from .header import parse_auth_headers, extract_auth_from_request
+from .type import AuthData, AuthHeader
+from .helper import (
+    get_auth_data,
+    get_current_user_id,
+    get_current_tenant_id,
+    get_current_company,
+    get_company_unique_no,
+    get_impersonation,
+    is_impersonating
+)
+
+__all__ = [
+    "parse_auth_headers",
+    "extract_auth_from_request",
+    "AuthData",
+    "AuthHeader",
+    "get_auth_data",
+    "get_current_user_id",
+    "get_current_tenant_id",
+    "get_current_company",
+    "get_company_unique_no",
+    "get_impersonation",
+    "is_impersonating",
+]

fiuai_sdk_python-0.3.2/src/fiuai_sdk_python/auth/header.py

@@ -0,0 +1,90 @@
+# -- coding: utf-8 --
+# Project: auth
+# Created Date: 2025-01-09
+# Author: liming
+# Email: lmlala@aliyun.com
+# Copyright (c) 2025 FiuAI
+
+from typing import Dict, Optional, Union, Literal
+from .type import AuthData
+from fastapi import Request
+
+
+def parse_auth_headers(headers: Dict[str, str]) -> Optional[AuthData]:
+    """
+    从 HTTP headers 中解析认证信息并转换为 AuthData
+    
+    Args:
+        headers: HTTP headers 字典
+        
+    Returns:
+        AuthData 对象，如果解析失败则返回 None
+        
+    Raises:
+        ValueError: 当必需的头信息缺失或格式错误时
+    """
+    try:
+        # 获取必需的头信息（注意：HTTP headers 会自动转换为小写）
+        user_id = headers.get("x-fiuai-user")
+        auth_tenant_id = headers.get("x-fiuai-auth-tenant-id")
+        current_company_str = headers.get("x-fiuai-current-company", "")
+        impersonation = headers.get("x-fiuai-impersonation", "")
+        
+        # 验证必需字段
+        if not user_id:
+            raise ValueError("Missing required header: x-fiuai-user")
+        if not auth_tenant_id:
+            raise ValueError("Missing required header: x-fiuai-auth-tenant-id")
+        
+        # 解析当前公司列表（逗号分隔）
+        current_company = []
+        if current_company_str:
+            current_company = [company.strip() for company in current_company_str.split(",") if company.strip()]
+        
+        # 检查是否有有效的公司信息
+        if not current_company:
+            raise ValueError("Missing required header: x-fiuai-current-company")
+            
+        return AuthData(
+            user_id=user_id,
+            auth_tenant_id=auth_tenant_id,
+            current_company=current_company[0],
+            impersonation=impersonation,
+            company_unique_no=current_company[0]
+        )
+        
+    except Exception as e:
+        # 记录错误但不抛出异常，返回 None 表示解析失败
+        
+        raise
+
+
+def extract_auth_from_request(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> Optional[AuthData]:
+    """
+    从请求对象中提取认证信息
+    
+    Args:
+        request: FastAPI Request 对象或原生 headers 字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        AuthData 对象，如果解析失败则返回 None, 或抛出异常
+        
+    Raises:
+        TypeError: 当 request 类型与 engine 不匹配时
+    """
+    if engine == "fastapi":
+        if not isinstance(request, Request):
+            raise TypeError("request must be a FastAPI Request object when engine='fastapi'")
+        headers = dict(request.headers)
+    elif engine == "dict":
+        if not isinstance(request, dict):
+            raise TypeError("request must be a dict when engine='dict'")
+        headers = request
+    else:
+        raise ValueError("engine must be either 'fastapi' or 'dict'")
+    
+    return parse_auth_headers(headers)

fiuai_sdk_python-0.3.2/src/fiuai_sdk_python/auth/helper.py

@@ -0,0 +1,161 @@
+# -- coding: utf-8 --
+# Project: auth
+# Created Date: 2025-01-09
+# Author: liming
+# Email: lmlala@aliyun.com
+# Copyright (c) 2025 FiuAI
+
+from fastapi import Request, HTTPException
+from typing import Optional, Union, Dict, Literal
+from .type import AuthData
+
+
+def get_auth_data(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> AuthData:
+    """
+    从请求中获取认证数据
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        AuthData: 认证数据
+        
+    Raises:
+        HTTPException: 当认证数据不存在时抛出 401 错误（仅限 FastAPI）
+        ValueError: 当使用 dict 引擎且认证数据不存在时
+    """
+    if engine == "fastapi":
+        if not isinstance(request, Request):
+            raise TypeError("request must be a FastAPI Request object when engine='fastapi'")
+        auth_data = getattr(request.state, 'auth_data', None)
+        if not auth_data:
+            raise HTTPException(
+                status_code=401,
+                detail={
+                    "error": "Unauthorized",
+                    "message": "Authentication data not found",
+                    "code": "AUTH_NOT_FOUND"
+                }
+            )
+        return auth_data
+    elif engine == "dict":
+        if not isinstance(request, dict):
+            raise TypeError("request must be a dict when engine='dict'")
+        auth_data = request.get('auth_data')
+        if not auth_data:
+            raise ValueError("Authentication data not found in request dict")
+        return auth_data
+    else:
+        raise ValueError("engine must be either 'fastapi' or 'dict'")
+
+
+def get_current_user_id(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> str:
+    """
+    获取当前用户ID
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        str: 用户ID
+    """
+    auth_data = get_auth_data(request, engine)
+    return auth_data.user_id
+
+
+def get_current_tenant_id(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> str:
+    """
+    获取当前租户ID
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        str: 租户ID
+    """
+    auth_data = get_auth_data(request, engine)
+    return auth_data.auth_tenant_id
+
+
+def get_current_company(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> str:
+    """
+    获取当前公司ID
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        str: 公司ID
+    """
+    auth_data = get_auth_data(request, engine)
+    return auth_data.current_company
+
+
+def get_company_unique_no(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> str:
+    """
+    获取当前公司唯一编号
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        str: 公司唯一编号
+    """
+    auth_data = get_auth_data(request, engine)
+    return auth_data.company_unique_no
+
+
+def get_impersonation(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> str:
+    """
+    获取当前代表的租户ID
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        str: 代表的租户ID
+    """
+    auth_data = get_auth_data(request, engine)
+    return auth_data.impersonation
+
+
+def is_impersonating(
+    request: Union[Request, Dict[str, str]], 
+    engine: Literal["fastapi", "dict"] = "fastapi"
+) -> bool:
+    """
+    检查是否正在代表其他租户
+    
+    Args:
+        request: FastAPI Request 对象或包含认证数据的字典
+        engine: 请求引擎类型，默认为 "fastapi"
+        
+    Returns:
+        bool: 是否正在代表其他租户
+    """
+    auth_data = get_auth_data(request, engine)
+    return bool(auth_data.impersonation and auth_data.impersonation != auth_data.auth_tenant_id)

fiuai_sdk_python-0.3.2/src/fiuai_sdk_python/auth/test_auth.py

@@ -0,0 +1,273 @@
+# -- coding: utf-8 --
+# Project: auth
+# Created Date: 2025-01-09
+# Author: liming
+# Email: lmlala@aliyun.com
+# Copyright (c) 2025 FiuAI
+
+"""
+认证功能测试
+"""
+
+import sys
+import os
+sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from .header import parse_auth_headers, extract_auth_from_request
+from .helper import (
+    get_auth_data,
+    get_current_user_id,
+    get_current_tenant_id,
+    get_current_company,
+    get_company_unique_no,
+    get_impersonation,
+    is_impersonating
+)
+from .type import AuthData
+from unittest.mock import Mock
+
+
+def test_parse_auth_headers_success():
+    """测试成功解析认证头信息"""
+    headers = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": "company1,company2",
+        "x-fiuai-impersonation": "imp_tenant789"
+    }
+    
+    auth_data = parse_auth_headers(headers)
+    
+    assert auth_data is not None
+    assert auth_data.user_id == "user123"
+    assert auth_data.auth_tenant_id == "tenant456"
+    assert auth_data.current_company == "company1"
+    assert auth_data.company_unique_no == "company1"
+    assert auth_data.impersonation == "imp_tenant789"
+
+
+def test_parse_auth_headers_missing_required():
+    """测试缺少必需头信息的情况"""
+    headers = {
+        "x-fiuai-user": "user123",
+        # 缺少 x-fiuai-auth-tenant-id
+        "x-fiuai-current-company": "company1",
+    }
+    
+    try:
+        auth_data = parse_auth_headers(headers)
+        assert False, "应该抛出 ValueError"
+    except ValueError as e:
+        assert "Missing required header: x-fiuai-auth-tenant-id" in str(e)
+
+
+def test_parse_auth_headers_empty_company():
+    """测试空公司列表的情况"""
+    headers = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": "",  # 空字符串
+        "x-fiuai-impersonation": ""
+    }
+    
+    try:
+        auth_data = parse_auth_headers(headers)
+        assert False, "应该抛出 ValueError"
+    except ValueError as e:
+        assert "Missing required header: x-fiuai-current-company" in str(e)
+
+
+def test_parse_auth_headers_multiple_companies():
+    """测试多个公司的情况"""
+    headers = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": "company1,company2,company3",
+        "x-fiuai-impersonation": ""
+    }
+    
+    auth_data = parse_auth_headers(headers)
+    
+    assert auth_data is not None
+    assert auth_data.current_company == "company1"  # 取第一个
+    assert auth_data.company_unique_no == "company1"
+
+
+def test_parse_auth_headers_with_spaces():
+    """测试包含空格的公司列表"""
+    headers = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": " company1 , company2 , company3 ",
+        "x-fiuai-impersonation": ""
+    }
+    
+    auth_data = parse_auth_headers(headers)
+    
+    assert auth_data is not None
+    assert auth_data.current_company == "company1"  # 取第一个，已去除空格
+    assert auth_data.company_unique_no == "company1"
+
+
+def test_extract_auth_from_request_fastapi():
+    """测试从 FastAPI Request 对象提取认证信息"""
+    # 模拟 FastAPI Request 对象
+    from fastapi import Request
+    mock_request = Mock(spec=Request)
+    mock_request.headers = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": "company1,company2",
+        "x-fiuai-impersonation": "imp_tenant789"
+    }
+    
+    auth_data = extract_auth_from_request(mock_request, engine="fastapi")
+    
+    assert auth_data is not None
+    assert auth_data.user_id == "user123"
+    assert auth_data.auth_tenant_id == "tenant456"
+    assert auth_data.current_company == "company1"
+    assert auth_data.company_unique_no == "company1"
+    assert auth_data.impersonation == "imp_tenant789"
+
+
+def test_extract_auth_from_request_dict():
+    """测试从原生字典提取认证信息"""
+    headers_dict = {
+        "x-fiuai-user": "user123",
+        "x-fiuai-auth-tenant-id": "tenant456",
+        "x-fiuai-current-company": "company1,company2",
+        "x-fiuai-impersonation": "imp_tenant789"
+    }
+    
+    auth_data = extract_auth_from_request(headers_dict, engine="dict")
+    
+    assert auth_data is not None
+    assert auth_data.user_id == "user123"
+    assert auth_data.auth_tenant_id == "tenant456"
+    assert auth_data.current_company == "company1"
+    assert auth_data.company_unique_no == "company1"
+    assert auth_data.impersonation == "imp_tenant789"
+
+
+def test_extract_auth_from_request_wrong_type():
+    """测试类型错误的情况"""
+    # 测试 FastAPI 引擎但传入字典
+    try:
+        extract_auth_from_request({"test": "value"}, engine="fastapi")
+        assert False, "应该抛出 TypeError"
+    except TypeError as e:
+        assert "request must be a FastAPI Request object" in str(e)
+    
+    # 测试 dict 引擎但传入 Request 对象
+    from fastapi import Request
+    mock_request = Mock(spec=Request)
+    try:
+        extract_auth_from_request(mock_request, engine="dict")
+        assert False, "应该抛出 TypeError"
+    except TypeError as e:
+        assert "request must be a dict" in str(e)
+
+
+def test_helper_functions_fastapi():
+    """测试 FastAPI 模式下的辅助函数"""
+    # 模拟 FastAPI Request 对象，包含认证数据
+    from fastapi import Request
+    mock_request = Mock(spec=Request)
+    auth_data = AuthData(
+        user_id="user123",
+        auth_tenant_id="tenant456",
+        current_company="company1",
+        impersonation="imp_tenant789",
+        company_unique_no="company1"
+    )
+    mock_request.state.auth_data = auth_data
+    
+    # 测试各种辅助函数
+    assert get_current_user_id(mock_request, engine="fastapi") == "user123"
+    assert get_current_tenant_id(mock_request, engine="fastapi") == "tenant456"
+    assert get_current_company(mock_request, engine="fastapi") == "company1"
+    assert get_company_unique_no(mock_request, engine="fastapi") == "company1"
+    assert get_impersonation(mock_request, engine="fastapi") == "imp_tenant789"
+    assert is_impersonating(mock_request, engine="fastapi") == True
+
+
+def test_helper_functions_dict():
+    """测试 dict 模式下的辅助函数"""
+    # 模拟包含认证数据的字典
+    auth_data = AuthData(
+        user_id="user123",
+        auth_tenant_id="tenant456",
+        current_company="company1",
+        impersonation="imp_tenant789",
+        company_unique_no="company1"
+    )
+    request_dict = {"auth_data": auth_data}
+    
+    # 测试各种辅助函数
+    assert get_current_user_id(request_dict, engine="dict") == "user123"
+    assert get_current_tenant_id(request_dict, engine="dict") == "tenant456"
+    assert get_current_company(request_dict, engine="dict") == "company1"
+    assert get_company_unique_no(request_dict, engine="dict") == "company1"
+    assert get_impersonation(request_dict, engine="dict") == "imp_tenant789"
+    assert is_impersonating(request_dict, engine="dict") == True
+
+
+def test_helper_functions_missing_auth_data():
+    """测试缺少认证数据的情况"""
+    # 测试 FastAPI 模式
+    from fastapi import Request
+    mock_request = Mock(spec=Request)
+    mock_request.state.auth_data = None
+    
+    try:
+        get_auth_data(mock_request, engine="fastapi")
+        assert False, "应该抛出 HTTPException"
+    except Exception as e:
+        assert "Authentication data not found" in str(e)
+    
+    # 测试 dict 模式
+    request_dict = {}
+    try:
+        get_auth_data(request_dict, engine="dict")
+        assert False, "应该抛出 ValueError"
+    except ValueError as e:
+        assert "Authentication data not found" in str(e)
+
+
+def test_is_impersonating_false():
+    """测试非代表模式的情况"""
+    auth_data = AuthData(
+        user_id="user123",
+        auth_tenant_id="tenant456",
+        current_company="company1",
+        impersonation="",  # 空字符串
+        company_unique_no="company1"
+    )
+    request_dict = {"auth_data": auth_data}
+    
+    assert is_impersonating(request_dict, engine="dict") == False
+    
+    # 测试 impersonation 等于 auth_tenant_id 的情况
+    auth_data.impersonation = "tenant456"
+    assert is_impersonating(request_dict, engine="dict") == False
+
+
+if __name__ == "__main__":
+    # 运行原有测试
+    test_parse_auth_headers_success()
+    test_parse_auth_headers_missing_required()
+    test_parse_auth_headers_empty_company()
+    test_parse_auth_headers_multiple_companies()
+    test_parse_auth_headers_with_spaces()
+    
+    # 运行新增的测试
+    test_extract_auth_from_request_fastapi()
+    test_extract_auth_from_request_dict()
+    test_extract_auth_from_request_wrong_type()
+    test_helper_functions_fastapi()
+    test_helper_functions_dict()
+    test_helper_functions_missing_auth_data()
+    test_is_impersonating_false()
+    
+    print("所有测试通过！")

fiuai_sdk_python-0.3.2/src/fiuai_sdk_python/auth/type.py

@@ -0,0 +1,31 @@
+# -- coding: utf-8 --
+# Project: auth
+# Created Date: 2025 09 Th
+# Author: liming
+# Email: lmlala@aliyun.com
+# Copyright (c) 2025 FiuAI
+
+
+from pydantic import BaseModel, Field
+from typing import List
+
+class AuthData(BaseModel):
+    user_id: str = Field(description="用户ID")
+    auth_tenant_id: str = Field(description="租户ID")
+    current_company: str = Field(description="当前公司ID列表")
+    impersonation: str = Field(description="当前代表的租户ID", default="")
+    company_unique_no: str = Field(description="当前公司唯一编号,正常情况等于current_company")
+
+
+
+    # edoc
+
+class AuthHeader(BaseModel):
+    """HTTP 认证头信息模型"""
+    x_fiuai_user: str = Field(alias="x-fiuai-user", description="用户ID")
+    x_fiuai_auth_tenant_id: str = Field(alias="x-fiuai-auth-tenant-id", description="租户ID")
+    x_fiuai_current_company: str = Field(alias="x-fiuai-current-company", default="", description="当前公司ID列表（逗号分隔）")
+    x_fiuai_impersonation: str = Field(alias="x-fiuai-impersonation", default="", description="当前代表的租户ID")
+    
+    class Config:
+        populate_by_name = True

{fiuai_sdk_python-0.3.0 → fiuai_sdk_python-0.3.2}/src/fiuai_sdk_python/bank.py

@@ -46,7 +46,7 @@ def get_bank_account(client: FiuaiSDK, bank_account_no: str) -> Optional[Company
         logger.error(f"bank_account_no is empty, return None")
         return None
     
-    _bank_account = client.get_doc(
+    _bank_account = client.internal_get(
         doctype="Bank Account",
         name=bank_account_no,
         fields=["name","bank_account_no", "account_name", "bank", "opening_bank_branch"]
@@ -58,7 +58,7 @@ def get_bank_account(client: FiuaiSDK, bank_account_no: str) -> Optional[Company
     
 
     # 获取银行信息
-    _bank_detail = client.get_doc(
+    _bank_detail = client.internal_get(
         doctype="Bank",
         name=_bank_account["bank"],
         fields=["name", "bank_name"]
@@ -68,7 +68,7 @@ def get_bank_account(client: FiuaiSDK, bank_account_no: str) -> Optional[Company
         return CompanyBankAccountSearchResult(exists=False)
     
     # 获取支行信息
-    _bank_branch = client.get_doc(
+    _bank_branch = client.internal_get(
         doctype="Bank Branch",
         name=_bank_account["opening_bank_branch"],
         fields=["name", "bank_branch_name"]
@@ -93,7 +93,7 @@ def get_bank_account_by_bank_id(client: FiuaiSDK, bank_id: str) -> BankAccount|N
     """
     根据银行账号id获取银行账号信息
     """
-    resp = client.get_doc(
+    resp = client.internal_get(
             doctype="Bank Account",
             filters=[["name", "=", bank_id]],
             fields=[
@@ -111,7 +111,7 @@ def get_bank_account_by_bank_id(client: FiuaiSDK, bank_id: str) -> BankAccount|N
     # 获取支行信息
     bank_branch = ""
     if resp["opening_bank_branch"] != "":
-        _bank_branch = client.get_doc(
+        _bank_branch = client.internal_get(
             doctype="Bank Branch",
             name=resp["opening_bank_branch"],
             fields=["name", "bank_branch_name"]
@@ -123,7 +123,7 @@ def get_bank_account_by_bank_id(client: FiuaiSDK, bank_id: str) -> BankAccount|N
             bank_branch = _bank_branch["bank_branch_name"]
 
     # 获取银行信息
-    _bank_detail = client.get_doc(
+    _bank_detail = client.internal_get(
         doctype="Bank",
         name=resp["bank"],
         fields=["name", "bank_name"]