dataops-sdk 0.3.0__py3-none-any.whl

dataops_sdk/services/dict_.py

@@ -0,0 +1,69 @@
+from dataops_sdk.schemas import DataDict, Meta, MetaRelease, MetaType, SqlQueryParam
+from dataops_sdk.services.meta import (
+    release_list_get_by_code,
+    release_list_get_by_name,
+    release_list_list,
+)
+
+__all__ = [
+    "service_list_dicts",
+    "service_get_dict_detail_by_name",
+    "service_get_dict_detail_by_code",
+]
+
+
+def service_list_dicts(datasource: str) -> list[MetaRelease]:
+    """搜索数据源中的字典.
+
+    Args:
+        datasource: 数据源名称
+
+    Returns:
+        MetaRelease 对象列表
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证时
+    """
+    headers = {"x-sub-system": datasource}
+    filters = (SqlQueryParam().add_eq("sub_system", datasource, "mrl"),)
+    return release_list_list(MetaType.DICT, filters=filters, headers=headers)
+
+
+def service_get_dict_detail_by_name(datasource: str, name: str) -> Meta[DataDict]:
+    """指定数据源字典详情.
+
+    Args:
+        datasource: 数据源名称
+        name: 字典名称
+
+    Returns:
+        数据源 DDL 模型
+
+    Raises:
+        ValueError: 无效类型
+        NotFoundError: 数据源不存在
+        DataOpsError: API 请求失败
+        AuthenticationError: 未认证
+    """
+    meta = release_list_get_by_name(MetaType.DICT, name, _class=DataDict, datasource=datasource)
+    return meta
+
+
+def service_get_dict_detail_by_code(code: str) -> Meta[DataDict]:
+    """指定数据源字典详情.
+
+    Args:
+        code: 字典编码
+
+    Returns:
+        数据源 DDL 模型
+
+    Raises:
+        ValueError: 无效类型
+        NotFoundError: 数据源不存在
+        DataOpsError: API 请求失败
+        AuthenticationError: 未认证
+    """
+    meta = release_list_get_by_code(MetaType.DICT, code, _class=DataDict)
+    return meta

dataops_sdk/services/hazard.py

@@ -0,0 +1,260 @@
+"""隐患服务模块.
+
+提供隐患任务触发、日志查询与记录管理能力，覆盖后端 /hazard/task/* 与 /hazard/record/* 接口。
+
+- 服务层函数 (service_*)：纯 Python 接口，返回原始数据
+- CLI 命令：基于服务层的薄包装，负责格式化输出
+
+后端协议约定（FMIND-base64 解码后）：
+
+- POST /hazard/task/trigger/{code}    body: {triggerTime?, sync?}
+- POST /hazard/task/logs/{taskCode}   body: {pageParam?, count?}
+- POST /hazard/task/log/records/{id}  body: {pageParam?, count?}
+- POST /hazard/record/list            body: {pageParam?, queryParam?, count?}
+- POST /hazard/record/his/list        body: {pageParam?, queryParam?, count?}
+- POST /hazard/record/dispatch/callback body: {cuid, orderNo, dispatchStatus}
+- POST /hazard/record/his/clear       body: {cuid, clearNotifyStatus?}
+"""
+
+from collections.abc import Mapping
+from datetime import datetime
+from typing import Any
+
+from pydantic import JsonValue
+from pydantic_core import to_json
+
+from dataops_sdk.exceptions import AuthenticationError, DataOpsError
+from dataops_sdk.schemas.query import PageParam, SqlQueryParam
+from dataops_sdk.session import get_session
+from dataops_sdk.utils import encrypt_body
+
+__all__ = [
+    "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",
+]
+
+
+def _post_hazard(url: str, body: Mapping[str, JsonValue] | None = None) -> Any:
+    """隐患模块 POST 请求，返回 ``resp_body['data']``.
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    payload = dict(body) if body else {}
+    try:
+        with get_session() as session:
+            resp = session.post(url, content=to_json(encrypt_body(payload)))
+            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
+                )
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+    return resp_body.get("data")
+
+
+def _build_list_body(
+    page_param: PageParam | None,
+    query_param: SqlQueryParam | None,
+    *,
+    count: bool,
+) -> dict:
+    """构造 list / his-list / logs 接口的标准 body."""
+    body: dict = {"count": count}
+    if page_param is not None:
+        body["pageParam"] = page_param
+    if query_param is not None:
+        body["queryParam"] = query_param
+    return body
+
+
+def service_trigger_hazard_task(
+    code: str,
+    *,
+    trigger_time: datetime | None = None,
+    sync: bool = False,
+) -> bool:
+    """触发指定编码的隐患任务.
+
+    Args:
+        code: 隐患任务编码.
+        trigger_time: 可选触发时间；为空时立即触发；提供后定时触发.
+        sync: 是否同步执行（默认异步，通过 Job 模板）.
+
+    Returns:
+        后端是否接受触发（业务成功/失败需根据任务日志判断）.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body: dict = {}
+    if trigger_time is not None:
+        body["triggerTime"] = trigger_time.isoformat()
+    if sync:
+        body["sync"] = True
+    return bool(_post_hazard(f"/hazard/task/trigger/{code}", body))
+
+
+def service_get_hazard_task_logs(
+    task_code: str,
+    page_param: PageParam | None = None,
+    *,
+    count: bool = False,
+) -> list[dict] | int:
+    """获取隐患任务日志列表或总数.
+
+    后端固定按 ``task_code`` 与 ``START_TIME DESC`` 过滤排序，调用方只能指定分页.
+
+    Args:
+        task_code: 隐患任务编码.
+        page_param: 分页参数（默认 ``PageParam(0, 20)``）.
+        count: 为 True 时返回记录数，否则返回记录列表.
+
+    Returns:
+        ``count=True`` 时返回 ``int``，否则返回 ``list[dict]``.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = _build_list_body(page_param, None, count=count)
+    data = _post_hazard(f"/hazard/task/logs/{task_code}", body)
+    return data if count else (data or [])
+
+
+def service_get_hazard_task_log_records(
+    task_id: str,
+    page_param: PageParam | None = None,
+    *,
+    count: bool = False,
+) -> list[dict] | int:
+    """获取隐患任务结果记录或总数.
+
+    后端固定按 ``task_id`` 与 ``CREATE_TIME DESC`` 过滤排序.
+
+    Args:
+        task_id: 隐患任务实例 ID.
+        page_param: 分页参数.
+        count: 为 True 时返回记录数.
+
+    Returns:
+        ``count=True`` 时返回 ``int``，否则返回 ``list[dict]``.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = _build_list_body(page_param, None, count=count)
+    data = _post_hazard(f"/hazard/task/log/records/{task_id}", body)
+    return data if count else (data or [])
+
+
+def service_list_hazard_records(
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+    *,
+    count: bool = False,
+) -> list[dict] | int:
+    """分页查询活动隐患记录.
+
+    Args:
+        page_param: 分页参数.
+        query_param: SQL 查询条件（如按 status、hazardLevel 等过滤）.
+        count: 为 True 时返回记录数.
+
+    Returns:
+        ``count=True`` 时返回 ``int``，否则返回 ``list[dict]``.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = _build_list_body(page_param, query_param, count=count)
+    data = _post_hazard("/hazard/record/list", body)
+    return data if count else (data or [])
+
+
+def service_list_hazard_history_records(
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+    *,
+    count: bool = False,
+) -> list[dict] | int:
+    """分页查询归档隐患记录.
+
+    Args:
+        page_param: 分页参数.
+        query_param: SQL 查询条件.
+        count: 为 True 时返回记录数.
+
+    Returns:
+        ``count=True`` 时返回 ``int``，否则返回 ``list[dict]``.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = _build_list_body(page_param, query_param, count=count)
+    data = _post_hazard("/hazard/record/his/list", body)
+    return data if count else (data or [])
+
+
+def service_clear_hazard_history_records(
+    cuid: str,
+    *,
+    clear_notify_status: int | None = None,
+) -> bool:
+    """清理指定归档隐患记录.
+
+    Args:
+        cuid: 隐患记录的 meta ID.
+        clear_notify_status: 可选清除通知状态码.
+
+    Returns:
+        后端是否成功清除.
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body: dict = {"cuid": cuid}
+    if clear_notify_status is not None:
+        body["clearNotifyStatus"] = clear_notify_status
+    return bool(_post_hazard("/hazard/record/his/clear", body))
+
+
+def service_dispatch_hazard_callback(
+    cuid: str,
+    order_no: str,
+    dispatch_status: int,
+) -> bool:
+    """隐患派单结果回调（外部工单系统回写派遣状态）.
+
+    Args:
+        cuid: 隐患记录的 meta ID.
+        order_no: 外部工单号.
+        dispatch_status: 派遣状态码（具体枚举由业务约定，如 1=成功 / 2=失败）.
+
+    Returns:
+        后端是否成功写入回调.
+
+    Raises:
+        DataOpsError: API 请求失败（如 cuid 不存在）时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = {
+        "cuid": cuid,
+        "orderNo": order_no,
+        "dispatchStatus": dispatch_status,
+    }
+    return bool(_post_hazard("/hazard/record/dispatch/callback", body))