TermiNexus
9be878b84a
P1 通用查询：auth/managers.py 新增 20 个查询方法（Role/Company/Department/Position/Menu/Tenant 六个 Manager）；auth/ram.py 新增 RAMManager.ListPolicyResourceUUIDs；stats/manager.py 新增 StatsManager.ListAutoResetConfigs。 P2 App 体系：models.py 新增 App/TenantApp/CompanyApp/UserApp/AppConfig 五个 managed=False 镜像模型，字段与业务侧逐一对齐。 P3 工具下沉：新增 config.py 配置注入层与 money/json_encoder/celery_utils/exception_handler/redis_lock/ip_filter/storage/datetime_utils/string_utils 九个工具模块；model_utils.UUIDObj 增加 PascalCase 别名 Str/Bytes/UUID 与模块级转换函数。 同时移除 commission/stats/CashBook 镜像模型的重复索引声明，消除 Django models.E030。
381 lines
15 KiB
Python
381 lines
15 KiB
Python
"""GVSDS SDK — GVSDS 分布式 SDK
|
||
|
||
GVSDS 分布式服务间通信 SDK，作为子服务器（如 ATestCServer）和主服务器（gvsds）
|
||
之间的统一通信桥梁。实现原生位于 gvsdsdk 内（非封装层），可脱离 gvsds 独立部署。
|
||
|
||
设计原则：
|
||
1. 原生实现：全部逻辑位于 gvsdsdk（含 msync 通信底座），不依赖 gvsds
|
||
2. 独立部署：屏蔽 gvsds 包后所有子模块可独立导入运行
|
||
3. PascalCase：全部公开 API 使用 PascalCase
|
||
4. 惰性加载：仅访问属性时才 import ORM 依赖模块（避免 Django 未初始化时报错）
|
||
|
||
包结构：
|
||
gvsdsdk/
|
||
├── auth/ # 用户认证与权限模块
|
||
│ ├── crypto.py # 密码哈希 + AES 加密
|
||
│ ├── middleware.py # CurrentRoleMiddleware
|
||
│ ├── permissions.py # RBAC/ABAC 权限
|
||
│ └── managers.py # RoleManager（UserManager 在 models.py）
|
||
├── msync/ # MSYNC 服务间通信（完整实现）
|
||
│ ├── models.py # 服务节点/令牌/OGM/分布式事务模型
|
||
│ ├── registry.py # 服务注册发现
|
||
│ ├── ogm.py # OGM 对象全局映射
|
||
│ ├── transaction.py # Saga 远程事务编排
|
||
│ ├── local_tx.py # 本地事务步骤处理器
|
||
│ ├── auth.py # HMAC 签名 + 令牌编解码 + 服务端签发/验证
|
||
│ ├── sio.py # Socket.IO 服务端
|
||
│ ├── views.py # REST API 视图
|
||
│ └── ...
|
||
├── commission/ # 分佣引擎
|
||
├── payment/ # 支付网关
|
||
├── order/ # 订单模板与订单
|
||
├── models.py # SAAS 核心数据模型
|
||
├── model_base.py # QModel
|
||
├── model_utils.py # UUIDObj
|
||
├── secrets.py # secrets.ini 配置读取
|
||
├── serializer_base.py # PascalCase DRF 序列化器基类
|
||
└── fluent.py # FluentQuery ORM 查询层
|
||
|
||
使用示例：
|
||
from gvsdsdk import ServiceRegistry, OGMManager, TransactionManager
|
||
from gvsdsdk.auth import PermissionVerifier
|
||
from gvsdsdk.commission import CommissionEngine
|
||
from gvsdsdk.payment import PaymentManager
|
||
print(gvsdsdk.__version__) # '1.1.0'
|
||
"""
|
||
|
||
import os as _os
|
||
import sys as _sys
|
||
import platform as _platform
|
||
from typing import Optional, Tuple
|
||
|
||
|
||
# === 版本定义（单一来源） ===
|
||
|
||
#: 主版本号
|
||
VERSION_MAJOR = 1
|
||
#: 次版本号
|
||
VERSION_MINOR = 1
|
||
#: 补丁版本号
|
||
VERSION_PATCH = 0
|
||
#: 预发布标签（如 'a1', 'b2', 'rc1'）
|
||
VERSION_PRERELEASE = ''
|
||
|
||
#: 完整版本字符串（PEP 440 兼容）
|
||
__version__ = f'{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}{VERSION_PRERELEASE}'
|
||
|
||
|
||
# === 包元数据 ===
|
||
|
||
#: 物理安装路径（pkg.__file__ 所在目录）
|
||
_PKG_DIR = _os.path.dirname(_os.path.abspath(__file__))
|
||
|
||
|
||
def get_version() -> str:
|
||
"""返回 SDK 版本字符串"""
|
||
return __version__
|
||
|
||
|
||
def get_version_info() -> dict:
|
||
"""返回详细版本信息字典
|
||
|
||
Returns:
|
||
包含 version, location, python_version, platform 等字段
|
||
"""
|
||
return {
|
||
'Version': __version__,
|
||
'Major': VERSION_MAJOR,
|
||
'Minor': VERSION_MINOR,
|
||
'Patch': VERSION_PATCH,
|
||
'Prerelease': VERSION_PRERELEASE,
|
||
'Location': _PKG_DIR,
|
||
'Python': _sys.version.split()[0],
|
||
'Platform': _platform.platform(),
|
||
'Machine': _platform.machine(),
|
||
}
|
||
|
||
|
||
def check_min_version(min_version: str) -> Tuple[bool, str]:
|
||
"""检查当前版本是否 >= 给定最低版本
|
||
|
||
Args:
|
||
min_version: 形如 '1.0.0' 的最低版本字符串
|
||
|
||
Returns:
|
||
(is_ok, message) 元组
|
||
"""
|
||
def parse(v: str):
|
||
parts = v.split('.')
|
||
major = int(parts[0]) if len(parts) > 0 else 0
|
||
minor = int(parts[1]) if len(parts) > 1 else 0
|
||
patch_str = parts[2] if len(parts) > 2 else '0'
|
||
digits = ''
|
||
for c in patch_str:
|
||
if c.isdigit():
|
||
digits += c
|
||
else:
|
||
break
|
||
patch = int(digits) if digits else 0
|
||
return (major, minor, patch)
|
||
|
||
current = parse(__version__)
|
||
required = parse(min_version)
|
||
|
||
if current >= required:
|
||
return True, f'OK: SDK {__version__} >= {min_version}'
|
||
return False, f'FAIL: SDK {__version__} < {min_version} (required)'
|
||
|
||
|
||
# === 惰性加载（PEP 562）===
|
||
|
||
def _load_msync():
|
||
from gvsdsdk import msync as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_auth():
|
||
from gvsdsdk import auth as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_commission():
|
||
from gvsdsdk import commission as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_payment():
|
||
from gvsdsdk import payment as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_order():
|
||
from gvsdsdk import order as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_stats():
|
||
from gvsdsdk import stats as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_models():
|
||
from gvsdsdk import models as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_fluent():
|
||
from gvsdsdk import fluent as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_model_base():
|
||
from gvsdsdk import model_base as _mod
|
||
return _mod
|
||
|
||
|
||
def _load_model_utils():
|
||
from gvsdsdk import model_utils as _mod
|
||
return _mod
|
||
|
||
|
||
_LAZY_SYMBOLS = {
|
||
# ── MSYNC 服务间通信 ──────────────────────────────────
|
||
'SignPayload': ('msync', 'SignPayload'),
|
||
'VerifySignature': ('msync', 'VerifySignature'),
|
||
'GenerateChallenge': ('msync', 'GenerateChallenge'),
|
||
'BuildAuthPayload': ('msync', 'BuildAuthPayload'),
|
||
'SignAuthPayload': ('msync', 'SignAuthPayload'),
|
||
'VerifyAuthPayload': ('msync', 'VerifyAuthPayload'),
|
||
'ServiceTokenEncoder': ('msync', 'ServiceTokenEncoder'),
|
||
'AuthenticateService': ('msync', 'AuthenticateService'),
|
||
'RefreshServiceToken': ('msync', 'RefreshServiceToken'),
|
||
'ValidateAccessToken': ('msync', 'ValidateAccessToken'),
|
||
'IssueServiceToken': ('msync', 'IssueServiceToken'),
|
||
'ServiceRegistry': ('msync', 'ServiceRegistry'),
|
||
'RegistryError': ('msync', 'RegistryError'),
|
||
'OGMManager': ('msync', 'OGMManager'),
|
||
'OGMError': ('msync', 'OGMError'),
|
||
'TransactionManager': ('msync', 'TransactionManager'),
|
||
'TransactionError': ('msync', 'TransactionError'),
|
||
'StepExecutionError': ('msync', 'StepExecutionError'),
|
||
'LocalTransactionManager': ('msync', 'LocalTransactionManager'),
|
||
'StepHandler': ('msync', 'StepHandler'),
|
||
'local_tx': ('msync', 'local_tx'),
|
||
'ServiceClient': ('msync', 'ServiceClient'),
|
||
'ServiceClientError': ('msync', 'ServiceClientError'),
|
||
|
||
# ── 用户认证与权限 ────────────────────────────────────
|
||
'GetDefaultAvatar': ('auth', 'GetDefaultAvatar'),
|
||
'HashPassword': ('auth', 'HashPassword'),
|
||
'VerifyPassword': ('auth', 'VerifyPassword'),
|
||
'SymmetricEncrypt': ('auth', 'SymmetricEncrypt'),
|
||
'SymmetricDecrypt': ('auth', 'SymmetricDecrypt'),
|
||
'FileSHA1': ('auth', 'FileSHA1'),
|
||
'FileSHA256': ('auth', 'FileSHA256'),
|
||
'BytesSHA1': ('auth', 'BytesSHA1'),
|
||
'BytesSHA256': ('auth', 'BytesSHA256'),
|
||
'CurrentRoleMiddleware': ('auth', 'CurrentRoleMiddleware'),
|
||
'IsAdminUser': ('auth', 'IsAdminUser'),
|
||
'IsCompanyMember': ('auth', 'IsCompanyMember'),
|
||
'CompanyScopedMixin': ('auth', 'CompanyScopedMixin'),
|
||
'PermissionVerifier': ('auth', 'PermissionVerifier'),
|
||
'RoleManager': ('auth', 'RoleManager'),
|
||
'ShopManager': ('auth', 'ShopManager'),
|
||
'PositionManager': ('auth', 'PositionManager'),
|
||
'AuthManager': ('auth', 'AuthManager'),
|
||
'AdminUserManager': ('auth', 'AdminUserManager'),
|
||
'TenantManager': ('auth', 'TenantManager'),
|
||
'CompanyManager': ('auth', 'CompanyManager'),
|
||
'DepartmentManager': ('auth', 'DepartmentManager'),
|
||
'MessageManager': ('auth', 'MessageManager'),
|
||
'UserService': ('auth', 'UserService'),
|
||
'RAMManager': ('auth', 'RAMManager'),
|
||
|
||
# ── 分佣引擎 ──────────────────────────────────────────
|
||
'CommissionEngine': ('commission', 'CommissionEngine'),
|
||
'CommissionError': ('commission', 'CommissionError'),
|
||
'CommissionEvent': ('commission', 'CommissionEvent'),
|
||
'RateTable': ('commission', 'RateTable'),
|
||
'RateEntry': ('commission', 'RateEntry'),
|
||
'CommissionRule': ('commission', 'CommissionRule'),
|
||
'CommissionRecord': ('commission', 'CommissionRecord'),
|
||
'PreSettlement': ('commission', 'PreSettlement'),
|
||
'CreateStrategy': ('commission', 'CreateStrategy'),
|
||
'PercentageStrategy': ('commission', 'PercentageStrategy'),
|
||
'FixedStrategy': ('commission', 'FixedStrategy'),
|
||
'TieredStrategy': ('commission', 'TieredStrategy'),
|
||
'RemainderStrategy': ('commission', 'RemainderStrategy'),
|
||
'WithdrawalFeeStrategy': ('commission', 'WithdrawalFeeStrategy'),
|
||
|
||
# ── 支付网关 ──────────────────────────────────────────
|
||
'PaymentManager': ('payment', 'PaymentManager'),
|
||
'PaymentError': ('payment', 'PaymentError'),
|
||
'PaymentGatewayConfig': ('payment', 'PaymentGatewayConfig'),
|
||
'PaymentTransaction': ('payment', 'PaymentTransaction'),
|
||
'EncryptField': ('payment', 'EncryptField'),
|
||
'PaymentCredentials': ('payment', 'PaymentCredentials'),
|
||
'PaymentRequest': ('payment', 'PaymentRequest'),
|
||
'PaymentResponse': ('payment', 'PaymentResponse'),
|
||
'RefundRequest': ('payment', 'RefundRequest'),
|
||
'RefundResponse': ('payment', 'RefundResponse'),
|
||
'TransferRequest': ('payment', 'TransferRequest'),
|
||
'TransferResponse': ('payment', 'TransferResponse'),
|
||
'QueryResponse': ('payment', 'QueryResponse'),
|
||
'AbstractPaymentGateway': ('payment', 'AbstractPaymentGateway'),
|
||
'GatewayRegistry': ('payment', 'GatewayRegistry'),
|
||
'payment_registry': ('payment', 'payment_registry'),
|
||
'WechatPaymentGateway': ('payment', 'WechatPaymentGateway'),
|
||
'AlipayPaymentGateway': ('payment', 'AlipayPaymentGateway'),
|
||
'BankPaymentGateway': ('payment', 'BankPaymentGateway'),
|
||
|
||
# ── 订单模板与订单 ────────────────────────────────────
|
||
'OrderTemplate': ('order', 'OrderTemplate'),
|
||
'OrderTemplateItem': ('order', 'OrderTemplateItem'),
|
||
'OrderLevel': ('order', 'OrderLevel'),
|
||
'Order': ('order', 'Order'),
|
||
'OrderItem': ('order', 'OrderItem'),
|
||
|
||
# ── 统计引擎 ──────────────────────────────────────────
|
||
'StatsManager': ('stats', 'StatsManager'),
|
||
'StatMetric': ('stats', 'StatMetric'),
|
||
'StatDimension': ('stats', 'StatDimension'),
|
||
'StatRecord': ('stats', 'StatRecord'),
|
||
'StatRanking': ('stats', 'StatRanking'),
|
||
'StatConfig': ('stats', 'StatConfig'),
|
||
|
||
# ── 数据模型 ──────────────────────────────────────────
|
||
'User': ('models', 'User'),
|
||
'Role': ('models', 'Role'),
|
||
'Permission': ('models', 'Permission'),
|
||
'UserRole': ('models', 'UserRole'),
|
||
'UUIDField': ('models', 'UUIDField'),
|
||
'UserManager': ('models', 'UserManager'),
|
||
'User2FA': ('models', 'User2FA'),
|
||
'UserPending2FA': ('models', 'UserPending2FA'),
|
||
'UserAvatar': ('models', 'UserAvatar'),
|
||
'UserLoginLog': ('models', 'UserLoginLog'),
|
||
'AccountActivation': ('models', 'AccountActivation'),
|
||
'RolePermission': ('models', 'RolePermission'),
|
||
'RAMGrant': ('models', 'RAMGrant'),
|
||
'UserABAC': ('models', 'UserABAC'),
|
||
'Password': ('models', 'Password'),
|
||
'Shop': ('models', 'Shop'),
|
||
'RoleShop': ('models', 'RoleShop'),
|
||
'Position': ('models', 'Position'),
|
||
'PositionCategory': ('models', 'PositionCategory'),
|
||
'PositionTemplate': ('models', 'PositionTemplate'),
|
||
'PositionTemplatePermission': ('models', 'PositionTemplatePermission'),
|
||
'Menu': ('models', 'Menu'),
|
||
'WorkOrder': ('models', 'WorkOrder'),
|
||
'AuditLog': ('models', 'AuditLog'),
|
||
'UserRoleDepartment': ('models', 'UserRoleDepartment'),
|
||
'UserRoleWorkgroup': ('models', 'UserRoleWorkgroup'),
|
||
'UserRoleDepartmentPosition': ('models', 'UserRoleDepartmentPosition'),
|
||
'AppPosition': ('models', 'AppPosition'),
|
||
'AppVirtualPosition': ('models', 'AppVirtualPosition'),
|
||
'AppVirtualBinding': ('models', 'AppVirtualBinding'),
|
||
'Message': ('models', 'Message'),
|
||
'UserIDCard': ('models', 'UserIDCard'),
|
||
'PersonalPage': ('models', 'PersonalPage'),
|
||
'UserSettings': ('models', 'UserSettings'),
|
||
'Tenant': ('models', 'Tenant'),
|
||
'Company': ('models', 'Company'),
|
||
'Department': ('models', 'Department'),
|
||
'CompanyInfo': ('models', 'CompanyInfo'),
|
||
'DepartmentSMTM': ('models', 'DepartmentSMTM'),
|
||
'Workgroup': ('models', 'Workgroup'),
|
||
'SimulatedTrigger': ('models', 'SimulatedTrigger'),
|
||
'CashReceiptsPaymentsLedger': ('models', 'CashReceiptsPaymentsLedger'),
|
||
'Asset': ('models', 'Asset'),
|
||
'Liability': ('models', 'Liability'),
|
||
'FixedBinaryField': ('models', 'FixedBinaryField'),
|
||
'QModel': ('model_base', 'QModel'),
|
||
'QModelBase': ('model_base', 'QModelBase'),
|
||
|
||
# ── ORM 查询层 ────────────────────────────────────────
|
||
'FluentQuery': ('fluent', 'FluentQuery'),
|
||
'Session': ('fluent', 'Session'),
|
||
'db': ('fluent', 'db'),
|
||
'func': ('fluent', 'func'),
|
||
'FQ': ('fluent', 'FQ'),
|
||
'FieldExpression': ('model_base', 'FieldExpression'),
|
||
|
||
# ── 工具 ──────────────────────────────────────────────
|
||
'UUIDObj': ('model_utils', 'UUIDObj'),
|
||
}
|
||
|
||
_LOADERS = {
|
||
'msync': _load_msync,
|
||
'auth': _load_auth,
|
||
'commission': _load_commission,
|
||
'payment': _load_payment,
|
||
'order': _load_order,
|
||
'stats': _load_stats,
|
||
'models': _load_models,
|
||
'fluent': _load_fluent,
|
||
'model_base': _load_model_base,
|
||
'model_utils': _load_model_utils,
|
||
}
|
||
|
||
|
||
def __getattr__(name):
|
||
"""惰性加载——仅在被访问时才 import 真正的模块"""
|
||
if name in _LAZY_SYMBOLS:
|
||
module_name, attr = _LAZY_SYMBOLS[name]
|
||
mod = _LOADERS[module_name]()
|
||
value = getattr(mod, attr)
|
||
globals()[name] = value
|
||
return value
|
||
raise AttributeError(f"module 'gvsdsdk' has no attribute {name!r}")
|
||
|
||
|
||
__all__ = list(_LAZY_SYMBOLS.keys()) + [
|
||
'get_version',
|
||
'get_version_info',
|
||
'check_min_version',
|
||
'__version__',
|
||
'VERSION_MAJOR',
|
||
'VERSION_MINOR',
|
||
'VERSION_PATCH',
|
||
]
|