dataops-sdk 0.3.0__py3-none-any.whl

dataops_sdk/schemas/workflow.py

@@ -0,0 +1,63 @@
+from collections.abc import Mapping
+from typing import Annotated, Generic, TypeVar
+
+from pydantic import (
+    BaseModel,
+    Field,
+    JsonValue,
+)
+
+from dataops_sdk.schemas.meta import Meta
+
+# 注意：用传统 TypeVar + Generic[T] 写法以兼容 Python 3.11+。
+# PEP 695 ``class Foo[T](Bar)`` 语法需要 Python 3.12+，且其 default 参数需 3.13+，
+# 故此处不使用 PEP 695 语法。
+T = TypeVar("T")
+
+
+class WorkflowNodeData(BaseModel, Generic[T]):
+    """Workflow node data schema."""
+
+    label: Annotated[str, Field(description="Node label")]
+    config: Annotated[T, Field(description="Node config", exclude=True)]
+
+
+class WorkflowEdge(BaseModel):
+    """Workflow edge schema."""
+
+    id: Annotated[str, Field(description="Edge id", exclude=True)]
+    source: Annotated[str, Field(description="Edge source")]
+    target: Annotated[str, Field(description="Edge target")]
+    sourceHandle: Annotated[str | None, Field(description="Edge source handle")] = None
+    targetHandle: Annotated[str | None, Field(description="Edge target handle")] = None
+    label: Annotated[str, Field(description="Edge label", exclude=True)] = ""
+
+
+class WorkflowNode(BaseModel, Generic[T]):
+    """Workflow node schema."""
+
+    id: Annotated[str, Field(description="Node id")]
+    type: Annotated[str, Field(description="Node type")]
+    # name: Annotated[str, Field(description="Node name")]
+    initialized: Annotated[bool, Field(description="Node initialized", exclude=True)]
+    data: Annotated[WorkflowNodeData[T], Field(description="Node data")]
+
+
+class WorkflowGraph(BaseModel):
+    """Workflow graph schema."""
+
+    nodes: Annotated[
+        list[WorkflowNode[Mapping[str, JsonValue]]],
+        Field(description="Nodes", default_factory=list),
+    ]
+    edges: Annotated[list[WorkflowEdge], Field(description="Edges", default_factory=list)]
+
+
+class DataWorkflow(BaseModel):
+    """Workflow data schema."""
+
+    graph: Annotated[WorkflowGraph, Field(description="Workflow graph")]
+
+
+class MetaWorkflow(Meta[DataWorkflow]):
+    """Workflow meta schema."""

dataops_sdk/services/__init__.py

@@ -0,0 +1,110 @@
+from .alarm import (
+    service_count_alarm_action,
+    service_count_alarm_rule_matches,
+    service_count_alarm_rules,
+    service_count_alarm_specs,
+    service_find_alarm_table_data,
+    service_find_meta_by_codes,
+    service_get_alarm_rule_enums,
+    service_get_alarm_table_columns,
+    service_get_rel_table_columns,
+    service_list_alarm_rule_matches,
+    service_list_alarm_rules,
+    service_list_alarm_specs,
+)
+from .api import service_get_api_by_code, service_get_api_by_name
+from .auth import (
+    service_get_current_application,
+    service_list_applications,
+    service_login,
+    service_logout,
+    service_set_application,
+)
+from .data_table import (
+    service_create_data_table,
+    service_create_data_table_record,
+    service_delete_data_table_record_by_id,
+    service_delete_data_table_record_by_id_list,
+    service_get_data_table_by_code,
+    service_get_data_table_by_name,
+    service_get_data_table_data_by_code,
+    service_get_data_table_data_by_name,
+    service_get_data_table_record_by_id,
+    service_get_data_table_reference_list,
+    service_get_data_table_total,
+    service_update_data_table_record_by_id,
+    service_update_data_table_record_by_id_list,
+)
+from .dataset import (
+    service_count_dataset_by_code,
+    service_get_dataset_data_by_code,
+    service_get_dataset_detail_by_code,
+    service_list_datasets,
+)
+from .datasource import (
+    service_get_datasource_by_name,
+    service_get_datasource_config_by_application_id,
+    service_get_main_datasource_config_by_application,
+)
+from .dict_ import (
+    service_get_dict_detail_by_code,
+    service_get_dict_detail_by_name,
+    service_list_dicts,
+)
+from .hazard import (
+    service_clear_hazard_history_records,
+    service_dispatch_hazard_callback,
+    service_get_hazard_task_log_records,
+    service_get_hazard_task_logs,
+    service_list_hazard_history_records,
+    service_list_hazard_records,
+    service_trigger_hazard_task,
+)
+from .meta import (
+    release_list_create,
+    release_list_get_by_code,
+    release_list_get_by_name,
+    release_list_list,
+    release_list_page,
+    release_list_total,
+    release_list_update,
+    release_ref_list,
+    release_ref_list_by_ref,
+)
+from .metrics import service_get_metrics, service_list_metrics
+from .ref import service_ref_backward, service_ref_forward
+from .report import service_get_report, service_list_reports
+from .skill import (
+    service_call_skill_by_code,
+    service_delete_skill,
+    service_delete_sub_file,
+    service_get_skill_by_code,
+    service_get_skill_by_name,
+    service_import_skill,
+    service_list_skill_files,
+    service_list_skills,
+    service_upload_sub_file,
+)
+from .table import (
+    service_count_table_by_code,
+    service_count_table_by_name,
+    service_exec_sql_by_datasource,
+    service_get_table_data_by_code,
+    service_get_table_data_by_name,
+    service_get_table_detail_by_code,
+    service_get_table_detail_by_name,
+    service_list_tables,
+)
+from .widget import (
+    service_count_widget_by_code,
+    service_get_widget_data_by_code,
+    service_get_widget_detail_by_code,
+    service_list_widgets,
+)
+from .workflow import (
+    service_get_workflow_by_code,
+    service_get_workflow_by_name,
+    service_list_workflows,
+    service_start_workflow,
+    service_start_workflow_async,
+)

dataops_sdk/services/alarm.py

@@ -0,0 +1,324 @@
+"""告警服务模块.
+
+提供告警规则的查询与配置能力，覆盖后端 /alarm/rule/* 接口。
+
+- 服务层函数 (service_*)：纯 Python 接口，返回原始数据
+- CLI 命令：基于服务层的薄包装，负责格式化输出
+"""
+
+from collections.abc import Iterable, Mapping
+from typing import Any, Literal, overload
+
+from pydantic import ConfigDict, JsonValue, TypeAdapter
+from pydantic_core import to_json
+
+from dataops_sdk.exceptions import AuthenticationError, DataOpsError
+from dataops_sdk.schemas.alarm import (
+    AlarmActionItem,
+    AlarmRuleItem,
+    AlarmRuleMatchItem,
+    AlarmSpecItem,
+)
+from dataops_sdk.schemas.query import PageParam, SqlQueryParam
+from dataops_sdk.session import get_session
+from dataops_sdk.utils import encrypt_body
+
+__all__ = [
+    "service_list_alarm_rules",
+    "service_get_alarm_rule_enums",
+    "service_find_meta_by_codes",
+    "service_get_alarm_table_columns",
+    "service_get_rel_table_columns",
+    "service_find_alarm_table_data",
+]
+
+
+@overload
+def _post_alarm(
+    url: str,
+    count: Literal[False],
+    query_param: SqlQueryParam | None = None,
+    page_param: PageParam | None = None,
+) -> list[Mapping[str, JsonValue]]: ...
+
+
+@overload
+def _post_alarm(
+    url: str,
+    count: Literal[True],
+    query_param: SqlQueryParam | None = None,
+) -> int: ...
+
+
+def _post_alarm(
+    url: str,
+    count: bool = False,
+    query_param: SqlQueryParam | None = None,
+    page_param: PageParam | None = None,
+) -> Any:
+    """告警模块 POST 请求，返回 resp_body["data"].
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = dict(pageParam=page_param, queryParam=query_param, count=count)
+    try:
+        with get_session() as session:
+            resp = session.post(url, content=to_json(encrypt_body(body)))
+            resp_body = resp.json()
+            if resp.status_code == 401:
+                raise AuthenticationError("认证失败，请先登录")
+            if resp.status_code != 200:
+                raise DataOpsError(
+                    resp_body.get("msg", f"HTTP {resp.status_code}"), resp.status_code
+                )
+        return resp_body.get("data")
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+
+
+def _get_alarm(url: str) -> Any:
+    """告警模块 GET 请求，返回 resp_body["data"].
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    try:
+        with get_session() as session:
+            resp = session.get(url)
+            resp_body = resp.json()
+            if resp.status_code == 401:
+                raise AuthenticationError("认证失败，请先登录")
+            if resp.status_code != 200:
+                raise DataOpsError(
+                    resp_body.get("msg", f"HTTP {resp.status_code}"), resp.status_code
+                )
+        if resp_body.get("data"):
+            return resp_body.get("data")
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+
+
+def service_list_alarm_rules(
+    page: int = 0,
+    size: int = 50,
+    query: str | None = None,
+    enabled: bool | None = None,
+):
+    url = "/alarm/ruleType/list"
+    page_param = PageParam(start=page * max(0, size), limit=size)
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if query:
+        query_param.add_like("title", query, "mrl")
+
+    results = _post_alarm(url, False, page_param, query_param)
+    return TypeAdapter(list[AlarmRuleItem], config=ConfigDict(str_to_lower=True)).validate_python(
+        results
+    )
+
+
+def service_count_alarm_rules(
+    query: str | None = None,
+    enabled: bool | None = None,
+):
+    url = "/alarm/ruleType/list"
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if query:
+        query_param.add_like("title", query, "mrl")
+    return _post_alarm(url, True, query_param)
+
+
+def service_list_alarm_specs(
+    page: int = 0,
+    size: int = 50,
+    query: str | None = None,
+    enabled: bool | None = None,
+):
+    url = "/alarm/specType/list"
+    page_param = PageParam(start=page * max(0, size), limit=size)
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if query:
+        query_param.add_like("title", query, "mrl")
+    results = _post_alarm(url, False, page_param, query_param)
+    return TypeAdapter(list[AlarmSpecItem], config=ConfigDict(str_to_lower=True)).validate_python(
+        results
+    )
+
+
+def service_count_alarm_specs(
+    query: str | None = None,
+    enabled: bool | None = None,
+):
+    url = "/alarm/specType/list"
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if query:
+        query_param.add_like("title", query, "mrl")
+    return _post_alarm(url, True, query_param)
+
+
+def service_list_alarm_rule_matches(
+    page: int = 0,
+    size: int = 50,
+    query: str | None = None,
+    enabled: bool | None = None,
+    specs: Iterable[str] | None = None,
+):
+    url = "/alarm/rule/list"
+    page_param = PageParam(start=page * max(0, size), limit=size)
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if specs:
+        query_param.varMap["specType"] = ",".join(specs)
+    if query:
+        query_param.add_like("title", query, "mrl")
+    results = _post_alarm(url, False, page_param, query_param)
+    return TypeAdapter(
+        list[AlarmRuleMatchItem], config=ConfigDict(str_to_lower=True)
+    ).validate_python(results)
+
+
+def service_count_alarm_rule_matches(
+    query: str | None = None,
+    enabled: bool | None = None,
+    specs: Iterable[str] | None = None,
+) -> int:
+    url = "/alarm/rule/list"
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if specs:
+        query_param.varMap["specType"] = ",".join(specs)
+    if query:
+        query_param.add_like("title", query, "mrl")
+    return _post_alarm(url, True, query_param)
+
+
+def service_list_alarm_action(
+    page: int = 0,
+    size: int = 50,
+    query: str | None = None,
+    enabled: bool | None = None,
+    rules: Iterable[str] | None = None,
+):
+    url = "/alarm/action/list"
+    page_param = PageParam(start=page * max(0, size), limit=size)
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if rules:
+        query_param.varMap["ruleType"] = ",".join(rules)
+    if query:
+        query_param.add_like("title", query, "mrl")
+    results = _post_alarm(url, False, page_param, query_param)
+    return TypeAdapter(list[AlarmActionItem], config=ConfigDict(str_to_lower=True)).validate_python(
+        results
+    )
+
+
+def service_count_alarm_action(
+    query: str | None = None,
+    enabled: bool | None = None,
+    rules: Iterable[str] | None = None,
+):
+    url = "/alarm/action/list"
+    query_param = SqlQueryParam()
+    if enabled is not None:
+        query_param.varMap["isEnabled"] = "1" if enabled else "0"
+    if rules:
+        query_param.varMap["ruleType"] = ",".join(rules)
+    if query:
+        query_param.add_like("title", query, "mrl")
+    return _post_alarm(url, True, query_param)
+
+
+def service_get_alarm_rule_enums() -> dict:
+    """获取告警规则枚举配置.
+
+    Returns:
+        枚举项字典
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    return _get_alarm("/alarm/rule/enums") or {}
+
+
+def service_find_meta_by_codes(codes: list[str]) -> list[dict]:
+    """根据告警规则编码批量查询关联元数据.
+
+    Args:
+        codes: 告警规则编码列表
+
+    Returns:
+        元数据列表
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    data = _post_alarm("/alarm/rule/findMetaByCodes", {"codes": codes})
+    return data or []
+
+
+def service_get_alarm_table_columns(spec_type: str) -> list[dict]:
+    """获取指定 specType 对应的告警表列定义.
+
+    Args:
+        spec_type: 告警规格类型
+
+    Returns:
+        列定义列表
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    data = _post_alarm(f"/alarm/rule/getAlarmTableColumns/{spec_type}")
+    return data or []
+
+
+def service_get_rel_table_columns(code: str) -> list[dict]:
+    """获取指定告警规则关联表列.
+
+    Args:
+        code: 告警规则编码
+
+    Returns:
+        列定义列表
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    data = _post_alarm(f"/alarm/rule/getRelTableColumns/{code}")
+    return data or []
+
+
+def service_find_alarm_table_data(code: str, query: Mapping[str, JsonValue] | None = None) -> dict:
+    """查询告警表数据.
+
+    Args:
+        code: 告警规则编码
+        query: 可选的查询条件
+
+    Returns:
+        查询结果（结构由后端定义）
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = {"code": code, "query": query or {}}
+    return _post_alarm("/alarm/rule/findTableData", body) or {}

dataops_sdk/services/api.py

@@ -0,0 +1,28 @@
+from dataops_sdk.schemas import HttpInterfaceData, MetaType
+from dataops_sdk.services.meta import release_list_get_by_code, release_list_get_by_name
+
+__all__ = ["service_get_api_by_code", "service_get_api_by_name"]
+
+
+def service_get_api_by_code(code: str):
+    """根据编码获取 API 接口详情.
+
+    Args:
+        code: API 接口编码
+
+    Returns:
+        ApiMeta 对象，包含 HttpInterfaceData 数据
+    """
+    return release_list_get_by_code(MetaType.API, code, _class=HttpInterfaceData)
+
+
+def service_get_api_by_name(name: str):
+    """根据名称获取 API 接口详情.
+
+    Args:
+        name: API 接口名称
+
+    Returns:
+        ApiMeta 对象，包含 HttpInterfaceData 数据
+    """
+    return release_list_get_by_name(MetaType.API, name, _class=HttpInterfaceData)

dataops_sdk/services/auth.py

@@ -0,0 +1,120 @@
+import re
+
+from pydantic import TypeAdapter
+from pydantic_core import to_json
+
+from dataops_sdk.constants import APPLICATION_FILE, DEFAULT_SECRET_KEY, USER_INFO_FILE
+from dataops_sdk.exceptions import AuthenticationError
+from dataops_sdk.schemas.user import Application, UserInfo
+from dataops_sdk.session import (
+    get_config,
+    get_session,
+)
+from dataops_sdk.utils import (
+    encrypt_body,
+    encrypt_hex,
+    get_work_dir,
+)
+
+
+def service_login(
+    username: str,
+    password: str,
+    *,
+    secret_key: str = DEFAULT_SECRET_KEY,
+) -> UserInfo:
+    """登录 DataOps 并保存 token。
+
+    Args:
+        username: 登录用户名
+        password: 登录密码（将使用 AES 加密后传输）
+        secret_key: AES 加密密钥
+
+    Returns:
+        UserInfo 对象（包含 access_token 等）
+
+    Raises:
+        AuthenticationError: 登录失败时
+    """
+    config = get_config()
+    url = f"{config.base_url}/oauth/token"
+    params = {
+        "username": username,
+        "password": encrypt_hex(password, secret_key),
+        "grant_type": "captcha",
+    }
+    with get_session(False) as session:
+        response = session.post(url, params=params, headers={"x-client-id": "admin-web"})
+        response_body = response.json()
+    if response.status_code == 200 and response_body.get("code") == 200:
+        user_info = UserInfo.model_validate(response_body["data"])
+        target_path = get_work_dir(USER_INFO_FILE)
+        target_path.write_bytes(to_json(user_info))
+        return user_info
+    else:
+        raise AuthenticationError(
+            f"Login failed: {response_body.get('msg', f'HTTP {response.status_code}')}"
+        )
+
+
+def service_logout() -> bool:
+    """清除本地存储的认证信息。"""
+    target_path = get_work_dir(USER_INFO_FILE)
+    if target_path.exists() and target_path.is_file():
+        target_path.unlink()
+        return True
+    else:
+        return False
+
+
+def service_list_applications(query: str | None = None) -> list[Application]:
+    """列出当前用户可访问的应用。
+
+    Args:
+        query: 关键字过滤（匹配 LABEL_CN）
+
+    Returns:
+        Application 对象列表
+    """
+    url = "/sys/application/findAccessible"
+    with get_session(False) as session:
+        response = session.post(url, content=to_json(encrypt_body(b"{}")))
+        response_body = response.json()
+    applications = TypeAdapter(list[Application]).validate_python(response_body["data"])
+    if query:
+        pattern = re.compile(query)
+        applications = [app for app in applications if pattern.search(app.LABEL_CN)]
+    return applications
+
+
+def service_set_application(code: str) -> Application:
+    """设置当前应用。
+
+    Args:
+        code: 应用编码
+
+    Returns:
+        设置的 Application 对象
+
+    Raises:
+        ValueError: 应用编码不存在时
+    """
+    url = "/sys/application/findAccessible"
+    with get_session(strict=False) as session:
+        response = session.post(url, content=b"{}")
+        response_body = response.json()
+    applications = TypeAdapter(list[Application]).validate_python(response_body["data"])
+    application = next((app for app in applications if code == app.CODE), None)
+    if application is None:
+        raise ValueError(f"Application with code '{code}' not found")
+    target_path = get_work_dir(APPLICATION_FILE)
+    target_path.write_bytes(to_json(application, indent=2))
+    return application
+
+
+def service_get_current_application() -> Application | None:
+    """获取当前已设置的应用信息。"""
+    target_path = get_work_dir(APPLICATION_FILE)
+    if not target_path.exists():
+        return None
+    return Application.model_validate_json(target_path.read_bytes())