codosdk 1.0.55__tar.gz → 1.0.57__tar.gz

{codosdk-1.0.55 → codosdk-1.0.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codosdk
-Version: 1.0.55
+Version: 1.0.57
 Summary: CODO项目的Python SDK
 Home-page: https://github.com/ss1917/codo_sdk/
 Author: shenshuo

codosdk-1.0.57/README.md

@@ -0,0 +1,231 @@
+# CODO SDK
+
+[![Python](https://img.shields.io/badge/Python-%3E%3D3.9-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-GPLv3-green)](https://www.gnu.org/licenses/gpl-3.0.html)
+[![Version](https://img.shields.io/badge/version-1.0.55-brightgreen)](https://pypi.org/project/codosdk/)
+
+CODO项目的官方Python SDK，提供企业级Web应用开发框架和运维工具集成。基于Tornado，集成数据库、缓存、消息队列、认证等核心组件。
+
+## 核心特性
+
+- **Tornado Web框架** - 异步请求处理，内置认证和权限管理
+- **数据库支持** - SQLAlchemy ORM，支持主从库配置
+- **Redis缓存** - 多连接池管理
+- **消息队列** - RabbitMQ集成
+- **多种认证** - JWT、LDAP、Session
+- **API集成** - 预定义CODO各平台API接口
+- **数据验证** - Pydantic模型验证
+- **工具支持** - 各类常用工具封装
+
+## 安装
+
+```bash
+# 从PyPI安装
+pip install codosdk
+
+# 从GitHub安装最新版
+pip install -U git+https://github.com/ss1917/ops_sdk.git
+```
+
+## 快速开始
+
+### 创建Web应用
+
+```python
+from websdk2.application import Application
+from websdk2.base_handler import BaseHandler
+
+class HelloHandler(BaseHandler):
+    def get(self):
+        self.write({'code': 0, 'msg': 'Hello CODO!'})
+
+handlers = [
+    (r'/api/hello/', HelloHandler, {'handle_name': '问候接口', 'method': ['GET']}),
+]
+
+app = Application(handlers)
+app.start_server()
+```
+
+### 使用数据库
+
+```python
+from websdk2.db_context import DBContextV2 as DBContext
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.ext.declarative import declarative_base
+
+Base = declarative_base()
+
+class User(Base):
+    __tablename__ = 'users'
+    id = Column(Integer, primary_key=True)
+    username = Column(String(50), unique=True)
+
+# 查询
+with DBContext('r') as session:
+    user = session.query(User).filter(User.username == 'admin').first()
+
+# 创建/更新
+with DBContext('w') as session:
+    user = User(username='new_user')
+    session.add(user)
+```
+
+### 使用缓存
+
+```python
+from websdk2.cache_context import cache_conn
+
+redis_conn = cache_conn()
+redis_conn.set('key', 'value', ex=3600)
+value = redis_conn.get('key')
+```
+
+### JWT认证
+
+```python
+from websdk2.jwt_token import AuthToken
+
+auth = AuthToken()
+
+# 生成Token
+token = auth.encode_auth_token(
+    user_id='123',
+    username='admin',
+    exp_time=7  # 7天过期
+)
+
+# 验证Token
+user_info = auth.decode_auth_token(token)
+```
+
+### 开放 API（AK/SK）
+
+适用于 CI、集成方等编程访问。网关校验 `CODO1-HMAC-SHA256` 签名后签发短时内部 JWT。
+
+```python
+from websdk2.openapi_client import OpenAPIClient
+
+client = OpenAPIClient(
+    endpoint="https://gw.example.com",
+    access_key="your-ak",
+    secret_key="your-sk",
+)
+resp = client.request("GET", "/api/p/v4/biz/list/")
+print(resp.status_code, resp.text)
+```
+
+### 消息队列
+
+```python
+from websdk2.mqhelper import MessageQueueBase
+import json
+
+# 发送消息（with语句自动管理连接）
+msg = json.dumps({'task_id': '123', 'status': 'running'})
+with MessageQueueBase('bpm_task_log', 'direct', 'the_log') as mq:
+    mq.publish_message(msg)
+
+# 消费消息（继承MessageQueueBase）
+class TaskConsumer(MessageQueueBase):
+    def __init__(self):
+        super().__init__(
+            exchange='bpm_task_log',
+            exchange_type='direct',
+            routing_key='the_log',
+            queue_name='task_queue'
+        )
+
+    def on_message(self, body):
+        """处理接收到的消息"""
+        print(f"收到消息: {body}")
+
+# 启动消费
+consumer = TaskConsumer()
+consumer.start_consuming()
+```
+
+## 配置示例
+
+### 数据库配置
+
+```python
+from websdk2.consts import const
+
+db_config = {
+    const.DB_CONFIG_ITEM: {
+        const.DEFAULT_DB_KEY: {
+            const.DBHOST_KEY: 'localhost',
+            const.DBPORT_KEY: 3306,
+            const.DBUSER_KEY: 'root',
+            const.DBPWD_KEY: 'password',
+            const.DBNAME_KEY: 'codo_db',
+        }
+    }
+}
+```
+
+### Redis配置
+
+```python
+from websdk2.consts import const
+redis_config = {
+    const.REDIS_CONFIG_ITEM: {
+        const.DEFAULT_RD_KEY: {
+            const.RD_HOST_KEY: 'localhost',
+            const.RD_PORT_KEY: 6379,
+            const.RD_DB_KEY: 0,
+            const.RD_PASSWORD_KEY: 'password',
+        }
+    }
+}
+```
+
+## 项目结构
+
+```
+ops_sdk/
+├── websdk2/                        # Web开发SDK（主模块）
+│   ├── apis/                       # CODO平台API集合
+│   │   ├── admin_apis.py          # 用户管理API
+│   │   ├── mgv4_apis.py           # 后台管理API
+│   │   ├── cmdb_apis.py           # CMDB配置API
+│   │   ├── agent_apis.py          # Agent代理API
+│   │   ├── task_apis.py           # 任务调度API
+│   │   ├── kerrigan_apis.py       # 配置文件管理API
+│   │   └── notice_apis.py         # 通知告警API
+│   │
+│   ├── cloud/                     # 云厂商SDK
+│   │
+│   ├── utils/                     # 工具集
+│   │   ├── pydantic_utils.py      # Pydantic数据验证
+│   │   ├── date_format.py         # 日期格式化
+│   │   └── cc_crypto.py           # 加密解密
+│   │
+│   ├── application.py              # Tornado应用定制
+│   ├── base_handler.py             # 请求处理基类（认证、授权）
+│   ├── db_context.py               # 数据库连接管理
+│   ├── cache.py / cache_context.py # Redis缓存管理
+│   ├── crud_utils.py               # CRUD工具（分页、验证）
+│   ├── sqlalchemy_pagination.py    # ORM分页组件
+│   ├── model_utils.py              # 模型转换工具
+│   ├── jwt_token.py                # JWT认证
+│   ├── mqhelper.py                 # RabbitMQ消息队列
+│   ├── client.py                   # API调用客户端
+│   ├── ldap.py                     # LDAP认证
+│   ├── configs.py                  # 配置管理
+│   ├── consts.py                   # 常量定义
+│   ├── error.py                    # 自定义异常
+│   ├── logger.py                   # 日志配置
+│   └── ...                         # 其他工具模块
+│
+├── opssdk/                         # 运维SDK（原始模块）
+│   └── utils/                      # 运维工具集
+│
+├── setup.py                        # 包配置
+└── pyproject.toml                  # 项目配置
+```
+
+## License
+
+Everything is [GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.html).

{codosdk-1.0.55 → codosdk-1.0.57}/codosdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codosdk
-Version: 1.0.55
+Version: 1.0.57
 Summary: CODO项目的Python SDK
 Home-page: https://github.com/ss1917/codo_sdk/
 Author: shenshuo

{codosdk-1.0.55 → codosdk-1.0.57}/codosdk.egg-info/SOURCES.txt

@@ -10,6 +10,8 @@ codosdk.egg-info/requires.txt
 codosdk.egg-info/top_level.txt
 opssdk/__init__.py
 opssdk/utils/__init__.py
+tests/__init__.py
+tests/test_openapi_sign.py
 websdk2/__init__.py
 websdk2/api_set.py
 websdk2/application.py
@@ -29,6 +31,8 @@ websdk2/ldap.py
 websdk2/logger.py
 websdk2/model_utils.py
 websdk2/mqhelper.py
+websdk2/openapi_client.py
+websdk2/openapi_sign.py
 websdk2/program.py
 websdk2/salt_api.py
 websdk2/sqlalchemy_pagination.py

{codosdk-1.0.55 → codosdk-1.0.57}/codosdk.egg-info/top_level.txt

@@ -1,2 +1,3 @@
 opssdk
+tests
 websdk2

{codosdk-1.0.55 → codosdk-1.0.57}/setup.py

@@ -2,14 +2,14 @@
 # -*-coding:utf-8-*-
 """"
 author : shenshuo
-date   : 2024年12月12日
+date   : 2026年07月29日
 desc   : CODO SDK
 """
 
 import sys
 from setuptools import setup, find_packages
 
-VERSION = '1.0.55'
+VERSION = '1.0.57'
 
 if sys.version_info < (2, 7) or (3, 0) <= sys.version_info < (3, 6):
     print('This program requires at least Python 2.7 or 3.6 to run.')

codosdk-1.0.57/tests/test_openapi_sign.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from websdk2.openapi_sign import build_auth_headers, sign
+
+
+def test_get_vector():
+    ak = "codoAKTEST0001"
+    sk = "testSecretKeyForOpenAPISign0001"
+    ts = "1700000000"
+    nonce = "nonce-fixed-001"
+    headers = {
+        "x-codo-access-key": ak,
+        "x-codo-timestamp": ts,
+        "x-codo-nonce": nonce,
+    }
+    sig = sign(sk, "GET", "/api/p/v4/biz/list/", {}, headers, b"", ts)
+    assert sig == "ce94e413a8f752ed75a7c129c184f14892d8b24f30222607994276174339e07f"
+
+
+def test_post_vector():
+    ak = "codoAKTEST0001"
+    sk = "testSecretKeyForOpenAPISign0001"
+    ts = "1700000000"
+    nonce = "nonce-fixed-001"
+    headers = {
+        "content-type": "application/json",
+        "x-codo-access-key": ak,
+        "x-codo-timestamp": ts,
+        "x-codo-nonce": nonce,
+    }
+    body = b'{"page":1}'
+    sig = sign(sk, "POST", "/api/p/v4/user/", {}, headers, body, ts)
+    assert sig == "4a2adef69ff58b92bc99c04474811e78082a5e3f5675a3c1d26e19ed3e7dc163"
+
+
+def test_build_auth_headers_keys():
+    h = build_auth_headers(
+        "ak", "sk", "GET", "/api/x/", query=None, body=None, timestamp=1700000000, nonce="n1"
+    )
+    assert "X-Codo-Access-Key" in h
+    assert "X-Codo-Signature" in h

codosdk-1.0.57/websdk2/openapi_client.py

@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+"""开放 API 客户端：AK/SK 签名请求 CODO 网关。"""
+
+import json
+import logging
+from typing import Any, Dict, Optional
+from urllib.parse import urlencode, urlparse
+import requests
+from .configs import configs
+from .consts import const
+from .openapi_sign import build_auth_headers
+
+logger = logging.getLogger(__name__)
+
+
+class OpenAPIClient:
+    def __init__(
+        self,
+        access_key: str,
+        secret_key: str,
+        endpoint: str = None,
+        request_timeout: int = 10,
+    ):
+        self.access_key = access_key
+        self.secret_key = secret_key
+        self.request_timeout = request_timeout
+        if endpoint:
+            self.endpoint = endpoint.rstrip("/")
+        else:
+            self.endpoint = (configs.get(const.WEBSITE_API_GW_URL) or "http://gw.opendevops.cn").rstrip(
+                "/"
+            )
+
+    def _path_and_query(self, url: str, params: Optional[dict]):
+        if url.startswith("http://") or url.startswith("https://"):
+            parsed = urlparse(url)
+            path = parsed.path or "/"
+            # merge query from url
+            q = {}
+            if parsed.query:
+                from urllib.parse import parse_qs
+
+                for k, vs in parse_qs(parsed.query, keep_blank_values=True).items():
+                    q[k] = vs[0] if len(vs) == 1 else vs
+            if params:
+                q.update(params)
+            return path, q, f"{parsed.scheme}://{parsed.netloc}"
+        path = url if url.startswith("/") else "/" + url
+        return path, params or {}, self.endpoint
+
+    def request(
+        self,
+        method: str,
+        url: str,
+        params: dict = None,
+        data: Any = None,
+        json_body: Any = None,
+        headers: dict = None,
+    ) -> requests.Response:
+        path, query, base = self._path_and_query(url, params)
+        method_u = method.upper()
+        body_bytes = None
+        content_type = None
+        if json_body is not None:
+            body_bytes = json.dumps(json_body, ensure_ascii=False, separators=(",", ":")).encode(
+                "utf-8"
+            )
+            content_type = "application/json"
+        elif data is not None:
+            if isinstance(data, (dict, list)):
+                body_bytes = json.dumps(data, ensure_ascii=False, separators=(",", ":")).encode(
+                    "utf-8"
+                )
+                content_type = "application/json"
+            elif isinstance(data, str):
+                body_bytes = data.encode("utf-8")
+            else:
+                body_bytes = data
+
+        auth_headers = build_auth_headers(
+            self.access_key,
+            self.secret_key,
+            method_u,
+            path,
+            query=query,
+            body=body_bytes,
+            content_type=content_type,
+        )
+        final_headers = dict(headers or {})
+        final_headers.update(auth_headers)
+
+        full_url = f"{base}{path}"
+        if query:
+            full_url = f"{full_url}?{urlencode(query, doseq=True)}"
+
+        return requests.request(
+            method_u,
+            full_url,
+            headers=final_headers,
+            data=body_bytes,
+            timeout=self.request_timeout,
+        )
+
+    def with_params_data_url(self, **kwargs):
+        url = kwargs.get("url")
+        method = kwargs.get("method") or "GET"
+        params = kwargs.get("params")
+        body = kwargs.get("body")
+        req_json = kwargs.get("json")
+        if method.upper() in ("GET", "DELETE", "HEAD"):
+            return dict(method=method, url=url, params=params)
+        return dict(method=method, url=url, params=params, body=body, json=req_json)
+
+    def do_action(self, **kwargs) -> str:
+        return self.do_action_v2(**kwargs).text
+
+    def do_action_v2(self, **kwargs) -> requests.Response:
+        return self.do_action_v3(**kwargs)
+
+    def do_action_v3(self, **kwargs) -> requests.Response:
+        method = kwargs.get("method") or "GET"
+        url = kwargs.get("url")
+        params = kwargs.get("params")
+        if kwargs.get("json") is not None:
+            return self.request(method, url, params=params, json_body=kwargs.get("json"))
+        body = kwargs.get("body")
+        return self.request(method, url, params=params, data=body)

codosdk-1.0.57/websdk2/openapi_sign.py

@@ -0,0 +1,120 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""CODO1-HMAC-SHA256 签名（与网关 / Go SDK 对齐）。"""
+
+import hashlib
+import hmac
+import secrets
+import time
+from typing import Dict, Mapping, Optional, Union
+from urllib.parse import quote
+
+
+def sha256_hex(data: Union[bytes, str, None]) -> str:
+    if data is None:
+        data = b""
+    if isinstance(data, str):
+        data = data.encode("utf-8")
+    return hashlib.sha256(data).hexdigest()
+
+
+def hmac_sha256_hex(key: str, msg: str) -> str:
+    return hmac.new(key.encode("utf-8"), msg.encode("utf-8"), hashlib.sha256).hexdigest()
+
+
+def canonical_query(params: Optional[Mapping] = None) -> str:
+    if not params:
+        return ""
+    items = []
+    for k in sorted(params.keys()):
+        v = params[k]
+        if isinstance(v, (list, tuple)):
+            for vv in sorted(str(x) for x in v):
+                items.append(f"{quote(str(k), safe='-_.~')}={quote(str(vv), safe='-_.~')}")
+        elif v is None:
+            continue
+        else:
+            items.append(f"{quote(str(k), safe='-_.~')}={quote(str(v), safe='-_.~')}")
+    return "&".join(items)
+
+
+def build_canonical_request(
+    method: str,
+    uri: str,
+    query: Optional[Mapping],
+    headers: Mapping[str, str],
+    body: Union[bytes, str, None],
+) -> str:
+    if body is None:
+        body_b = b""
+    elif isinstance(body, str):
+        body_b = body.encode("utf-8")
+    else:
+        body_b = body
+    normalized = {str(k).lower(): str(v).strip() for k, v in headers.items()}
+    names = sorted(normalized.keys())
+    canonical_headers = "".join(f"{n}:{normalized[n]}\n" for n in names)
+    signed_headers = ";".join(names)
+    return "\n".join(
+        [
+            method.upper(),
+            uri,
+            canonical_query(query),
+            canonical_headers,
+            signed_headers,
+            sha256_hex(body_b),
+        ]
+    )
+
+
+def build_string_to_sign(timestamp: Union[str, int], canonical_request: str) -> str:
+    return "\n".join(
+        ["CODO1-HMAC-SHA256", str(timestamp), sha256_hex(canonical_request.encode("utf-8"))]
+    )
+
+
+def sign(
+    secret_key: str,
+    method: str,
+    uri: str,
+    query: Optional[Mapping],
+    headers: Mapping[str, str],
+    body: Union[bytes, str, None],
+    timestamp: Union[str, int],
+) -> str:
+    cr = build_canonical_request(method, uri, query, headers, body)
+    sts = build_string_to_sign(timestamp, cr)
+    return hmac_sha256_hex(secret_key, sts)
+
+
+def build_auth_headers(
+    access_key: str,
+    secret_key: str,
+    method: str,
+    uri: str,
+    query: Optional[Mapping] = None,
+    body: Union[bytes, str, None] = None,
+    content_type: Optional[str] = None,
+    timestamp: Optional[Union[str, int]] = None,
+    nonce: Optional[str] = None,
+) -> Dict[str, str]:
+    ts = str(timestamp if timestamp is not None else int(time.time()))
+    n = nonce or secrets.token_hex(8)
+    sign_headers = {
+        "x-codo-access-key": access_key,
+        "x-codo-timestamp": ts,
+        "x-codo-nonce": n,
+    }
+    body_b = b"" if body is None else (body.encode("utf-8") if isinstance(body, str) else body)
+    if content_type and body_b:
+        sign_headers["content-type"] = content_type
+    signature = sign(secret_key, method, uri, query, sign_headers, body_b, ts)
+    out = {
+        "X-Codo-Access-Key": access_key,
+        "X-Codo-Timestamp": ts,
+        "X-Codo-Nonce": n,
+        "X-Codo-Signature": signature,
+    }
+    if content_type:
+        out["Content-Type"] = content_type
+    return out

{codosdk-1.0.55 → codosdk-1.0.57}/websdk2/sqlalchemy_pagination.py

@@ -48,6 +48,7 @@ def paginate(query, order_by: str = None, **query_params):
     else:
         items = query.all() if page_size >= 200 else query.limit(page_size).offset((page - 1) * page_size).all()
 
-    total = query.count()
+    # 计算总数：去掉排序避免 filesort
+    total = query.order_by(None).count()
     if not items_not_to_list: items = queryset_to_list(items)
     return Page(items, page, page_size, total)

codosdk-1.0.55/README.md

@@ -1,58 +0,0 @@
-## 安装
-
-### python3安装
-
-[python链接](https://www.python.org/)
-
-##### python3.9以上
-
-##### SDK 安装
-
-```bash
-$ pip3 install -U git+https://github.com/ss1917/ops_sdk.git
-```
-
-## 结构
-
-```
-├── README.md    项目readme
-└── opssdk
-    ├── logs     日志模块
-    ├── install  安装模块
-    ├── get_info 配置获取
-    └── operate  运维操作
-        ├── check           系统参数检查和获取
-        ├── mysql           mysql 操作
-        ├── mail            发送邮件
-        └── centralization  集中化管理工具 salt
-    ├── websdk2      web开发使用
-    ├── application.py           tornado application
-    ├── base_handler.py          tornado  基类
-    ├── cache.py                 处理redis缓存
-    ├── configs.py               配置文件管理
-    ├── consts.py                常量
-    ├── db_context.py            MySQL 处理类
-    ├── error.py                 异常
-    ├── crud_utils.py            API CRUD类
-    ├── model_utils.py           数据库模型处理类 sqlalchemy_pagination
-    ├── sqlalchemy_pagination.py 分页
-    ├── fetch_coroutine.py      
-    ├── jwt_token.py             JWT处理
-    ├── mqhelper.py              MQ 处理类
-    ├── program.py              
-    ├── salt_api.py              salt 处理类 可以移到工具类
-    ├── ldap.py                  LDAP 处理
-    ├── sms.py                   发送短信     可以移到工具类
-    ├── tools.py                 工具类
-    ├── clent.py                 API调用客户端封装
-    └── apis                     API集合
-        ├── mgv4_apis       后台API集合
-        ├── cmdb_apis       配置平台API
-        ├── agent_apis      Agent
-        ├── kerrigan_apis   配置文件管理
-        └── notice_apis       待补充
-```
-
-## License
-
-Everything is [GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.html).