dataops-sdk 0.3.0__py3-none-any.whl

dataops_sdk/services/data_table.py

@@ -0,0 +1,485 @@
+"""多维表格 (DataTable) 的 SDK 服务层.
+
+纯 Python 接口，返回原始 Pydantic 模型，不依赖 typer/Rich。
+"""
+
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+
+from pydantic import JsonValue, TypeAdapter
+from pydantic_core import to_json
+
+from dataops_sdk.schemas import (
+    DataTableData,
+    Meta,
+    MetaCreate,
+    MetaType,
+    PageParam,
+    SqlQueryParam,
+)
+from dataops_sdk.services.meta import (
+    release_list_create,
+    release_list_get_by_code,
+    release_list_get_by_name,
+)
+from dataops_sdk.session import get_session
+from dataops_sdk.utils import encrypt_body
+
+__all__ = [
+    "service_get_data_table_by_name",
+    "service_get_data_table_by_code",
+    "service_create_data_table",
+    "service_get_data_table_data_by_code",
+    "service_get_data_table_data_by_name",
+    "service_get_data_table_total",
+    "service_get_data_table_reference_list",
+    "service_get_data_table_record_by_id",
+    "service_create_data_table_record",
+    "service_update_data_table_record_by_id",
+    "service_update_data_table_record_by_id_list",
+    "service_delete_data_table_record_by_id",
+    "service_delete_data_table_record_by_id_list",
+]
+
+
+def service_get_data_table_by_name(datasource: str, name: str) -> Meta[DataTableData]:
+    """根据名称获取多维表格.
+
+    Args:
+        datasource: 数据源
+        name: 多维表格名称
+
+    Returns:
+        MetaDataTable 对象
+
+    Raises:
+        NotFoundError: 找不到对应多维表格时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    return release_list_get_by_name(
+        MetaType.DATA_TABLE, name, _class=DataTableData, datasource=datasource
+    )
+
+
+def service_get_data_table_by_code(code: str) -> Meta[DataTableData]:
+    """根据编码获取多维表格.
+
+    Args:
+        code: 多维表格编码
+
+    Returns:
+        MetaDataTable 对象
+
+    Raises:
+        NotFoundError: 找不到对应多维表格时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    return release_list_get_by_code(MetaType.DATA_TABLE, code, _class=DataTableData)
+
+
+def service_get_data_table_data_by_code(
+    code: str,
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+    show_invisible: bool = False,
+    translate: bool = True,
+    *,
+    meta: Meta[DataTableData] | None = None,
+) -> list[Mapping[str, JsonValue]]:
+    """根据编码获取多维表格的数据.
+
+    Args:
+        code: 数据表编码
+        page_param: 分页参数，默认为 PageParam()（第一页，每页 20 条）
+        query_param: 查询过滤条件，默认为 SqlQueryParam()
+        datasource: 数据源标识，指定从哪个子系统查询（可选）
+        show_invisible: 是否显示未标记 visible 的字段，默认为 False
+        translate: 是否对 DICT 类型字段进行值翻译，默认为 True
+
+    Returns:
+        字典列表，每条记录 key 为中文字段标题，value 已做字典翻译
+
+    Raises:
+        NotFoundError: 找不到对应多维表格时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    if translate:
+        url = f"/data/table/records/{code}"
+    else:
+        url = f"/data/table/list/{code}"
+
+    if page_param is None:
+        page_param = PageParam()
+    if query_param is None:
+        query_param = SqlQueryParam()
+
+    meta = meta or service_get_data_table_by_code(code)
+
+    body = {
+        "subSystem": meta.subSystem,
+        "code": code,
+        "pageParam": page_param,
+        "queryParam": query_param,
+    }
+
+    with get_session(timeout=15) as session:
+        resp = session.post(url, content=to_json(encrypt_body(body)))
+        resp_body = resp.json()
+
+    adapter = TypeAdapter(list[Mapping[str, JsonValue]])
+
+    if translate:
+        datas = adapter.validate_python(resp_body.get("data", {}).get("list", []))
+    else:
+        datas = adapter.validate_python(resp_body.get("data", []))
+
+    # 过滤不需要显示的字段，建立字段名映射
+    all_fields = meta.data.fields
+    show_fields = all_fields if show_invisible else [f for f in all_fields if f.visible]
+    field_name_map = {f.dbName: f.title for f in show_fields}
+    show_db_names = frozenset(field_name_map.keys())
+
+    # 预处理字典字段映射（只执行一次过滤）
+    dict_fields_name: set[str] = set()
+    dict_field_map: dict[str, dict[str, str]] = {}
+    if translate:
+        relations: dict[str, dict[str, str]] = resp_body.get("data", {}).get("relations", {})
+        dict_fields = [f for f in all_fields if f.type == MetaType.DICT.value]
+        for key, relation in relations.items():
+            if key.startswith("dict"):
+                # 查找匹配的字段（通过 ref.code 匹配）
+                field = next(
+                    (f for f in dict_fields if f.type_ext.get("ref", {}).get("code")),
+                    None,
+                )
+                if field:
+                    dict_field_map[field.dbName] = relation
+                    dict_fields_name.add(field.dbName)
+
+    # 单次遍历完成所有转换： lowercase -> 过滤 -> 字典翻译 -> 字段名映射
+    datas = [
+        {
+            field_name_map[k_lower]: (
+                dict_field_map[k_lower][str(v)]["_LABEL"] if k_lower in dict_fields_name else v
+            )
+            for k, v in data.items()
+            if (k_lower := k.lower()) in show_db_names
+        }
+        for data in datas
+    ]
+
+    return datas
+
+
+def service_get_data_table_data_by_name(
+    datasource: str,
+    name: str,
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+    show_invisible: bool = False,
+    translate: bool = True,
+):
+    meta = service_get_data_table_by_name(datasource, name)
+    return service_get_data_table_data_by_code(
+        meta.code,
+        page_param=page_param,
+        query_param=query_param,
+        show_invisible=show_invisible,
+        translate=translate,
+        meta=meta,
+    )
+
+
+def service_create_data_table(meta: MetaCreate[DataTableData]) -> dict:
+    """创建多维表格."""
+    return release_list_create(
+        meta,
+        _class=DataTableData,
+    )
+
+
+# def service_update_data_table(
+#     code: str,
+#     title: str,
+#     data: dict,
+#     *,
+#     name: str | None = None,
+#     cuid: str | None = None,
+#     sub_type: str | None = None,
+# ) -> dict:
+#     """更新多维表格.
+
+#     Args:
+#         code: 多维表格编码
+#         title: 中文标题
+#         data: meta.data 字典，结构参考 DataTableData
+#         name: 名称 (默认为 code)
+#         cuid: 元数据 CUID (更新时必传)
+#         sub_type: 子类型 (可选)
+
+#     Returns:
+#         API 返回的 data 字典
+
+#     Raises:
+#         DataOpsError: API 返回错误时
+#         AuthenticationError: 未认证或认证失败时
+#     """
+#     return release_list_update(
+#         MetaType.DATA_TABLE,
+#         code=code,
+#         name=name or code,
+#         title=title,
+#         data=data,
+#         cuid=cuid,
+#         sub_type=sub_type,
+#     )
+
+
+def service_get_data_table_total(
+    code: str,
+    query_param: SqlQueryParam | None = None,
+    *,
+    meta: Meta[DataTableData] | None = None,
+) -> int:
+    """统计多维表格数据总数.
+
+    Args:
+        code: 数据表编码
+        query_param: 查询过滤条件，默认为 SqlQueryParam()
+
+    Returns:
+        记录总数
+
+    Raises:
+        NotFoundError: 找不到对应多维表格时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    meta = meta or service_get_data_table_by_code(code)
+
+    body = {
+        "subSystem": meta.subSystem,
+        "code": code,
+        "queryParam": query_param or SqlQueryParam(),
+    }
+
+    with get_session(timeout=15) as session:
+        resp = session.post(f"/data/table/total/{code}", content=to_json(encrypt_body(body)))
+        resp_body = resp.json()
+
+    return int(resp_body.get("data", 0))
+
+
+def service_get_data_table_reference_list(
+    code: str,
+    subcode: str,
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+) -> list[str]:
+    """查询多维表格的引用记录列表.
+
+    Args:
+        code: 主表编码
+        subcode: 子表编码
+        page_param: 分页参数，默认为 PageParam()（第一页，每页 20 条）
+        query_param: 查询过滤条件，默认为 SqlQueryParam()
+
+    Returns:
+        引用编码集合列表
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    if page_param is None:
+        page_param = PageParam()
+
+    body = {
+        "pageParam": page_param,
+        "queryParam": query_param or SqlQueryParam(),
+    }
+
+    with get_session(timeout=15) as session:
+        resp = session.post(
+            f"/data/table/referenceList/{code}/{subcode}",
+            content=to_json(encrypt_body(body)),
+        )
+        resp_body = resp.json()
+
+    return resp_body.get("data", [])
+
+
+def service_get_data_table_record_by_id(code: str, id: str) -> dict[str, JsonValue]:
+    """根据 ID 获取多维表格单条记录.
+
+    Args:
+        code: 数据表编码
+        id: 主键 ID
+
+    Returns:
+        单条记录字典
+
+    Raises:
+        NotFoundError: 找不到对应记录时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    with get_session(timeout=15) as session:
+        resp = session.get(f"/data/table/getById/{code}/{id}")
+        resp_body = resp.json()
+
+    if resp_body.get("data") is None:
+        from dataops_sdk.exceptions import NotFoundError
+
+        raise NotFoundError(f"无法找到 {code} 中 ID 为 {id} 的记录")
+
+    return resp_body["data"]
+
+
+def service_create_data_table_record(
+    code: str,
+    data: Mapping[str, JsonValue],
+    *,
+    meta: Meta[DataTableData] | None = None,
+) -> str:
+    """新增多维表格单条记录.
+
+    Args:
+        code: 数据表编码
+        data: 记录数据字典
+        meta: 多维表格元数据对象（可选，用于获取 subSystem）
+
+    Returns:
+        新增记录的主键 ID
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    if meta is None:
+        meta = service_get_data_table_by_code(code)
+
+    body = dict(subSystem=meta.subSystem, **data) if meta.subSystem else dict(**data)
+
+    with get_session(timeout=15) as session:
+        resp = session.post(f"/data/table/create/{code}", content=to_json(encrypt_body(body)))
+        resp_body = resp.json()
+
+    return str(resp_body.get("data", ""))
+
+
+def service_update_data_table_record_by_id(
+    code: str,
+    id: str,
+    data: Mapping[str, JsonValue],
+) -> bool:
+    """按 ID 更新多维表格记录.
+
+    Args:
+        code: 数据表编码
+        id: 主键 ID
+        data: 要更新的字段数据
+
+    Returns:
+        更新是否成功
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    with get_session(timeout=15) as session:
+        resp = session.post(
+            f"/data/table/updateById/{code}/{id}",
+            content=to_json(encrypt_body(data)),
+        )
+        resp_body = resp.json()
+
+    return resp_body.get("data", False)
+
+
+def service_update_data_table_record_by_id_list(
+    code: str,
+    id_list: Sequence[str],
+    data: Mapping[str, JsonValue],
+) -> bool:
+    """按 ID 列表批量更新多维表格记录.
+
+    Args:
+        code: 数据表编码
+        id_list: 主键 ID 列表
+        data: 要更新的字段数据
+
+    Returns:
+        更新是否成功
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = {
+        "idList": id_list,
+        "data": data,
+    }
+
+    with get_session(timeout=15) as session:
+        resp = session.post(
+            f"/data/table/updateByIdList/{code}",
+            content=to_json(encrypt_body(body)),
+        )
+        resp_body = resp.json()
+
+    return resp_body.get("data", False)
+
+
+def service_delete_data_table_record_by_id(code: str, id: str) -> bool:
+    """按 ID 删除多维表格单条记录.
+
+    Args:
+        code: 数据表编码
+        id: 主键 ID
+
+    Returns:
+        删除是否成功
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    with get_session(timeout=15) as session:
+        resp = session.post(f"/data/table/deleteById/{code}/{id}")
+        resp_body = resp.json()
+
+    return resp_body.get("data", False)
+
+
+def service_delete_data_table_record_by_id_list(
+    code: str,
+    id_list: Sequence[str],
+) -> bool:
+    """按 ID 列表批量删除多维表格记录.
+
+    Args:
+        code: 数据表编码
+        id_list: 主键 ID 列表
+
+    Returns:
+        删除是否成功
+
+    Raises:
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+    """
+    body = {"idList": id_list}
+
+    with get_session(timeout=15) as session:
+        resp = session.post(
+            f"/data/table/deleteByIdList/{code}",
+            content=to_json(encrypt_body(body)),
+        )
+        resp_body = resp.json()
+
+    return resp_body.get("data", False)

dataops_sdk/services/dataset.py

@@ -0,0 +1,127 @@
+from collections.abc import Mapping
+
+from pydantic import ConfigDict, JsonValue, TypeAdapter
+from pydantic_core import to_json
+
+from dataops_sdk.exceptions import DataOpsError
+from dataops_sdk.schemas import (
+    DataDataBase,
+    Meta,
+    MetaRelease,
+    MetaType,
+    PageParam,
+    SqlQueryParam,
+)
+from dataops_sdk.services.meta import release_list_get_by_code, release_list_list
+from dataops_sdk.session import get_session
+from dataops_sdk.utils import encrypt_body
+
+__all__ = [
+    "service_count_dataset_by_code",
+    "service_get_dataset_data_by_code",
+    "service_get_dataset_detail_by_code",
+    "service_list_datasets",
+]
+
+
+def service_list_datasets() -> list[MetaRelease]:
+    """搜索数据源中的表.
+
+    Returns:
+        MetaRelease 对象列表
+
+    Raises:
+        DataOpsError: API 请求失败时
+        AuthenticationError: 未认证时
+    """
+    return release_list_list(MetaType.DATASET)
+
+
+def service_get_dataset_detail_by_code(code: str) -> Meta[DataDataBase]:
+    """指定数据集详情.
+
+    Args:
+        code: 表编码
+
+    Returns:
+        数据源 DDL 模型
+
+    Raises:
+        ValueError: 无效类型
+        NotFoundError: 数据源不存在
+        DataOpsError: API 请求失败
+        AuthenticationError: 未认证
+    """
+    meta = release_list_get_by_code(MetaType.DATASET, code, _class=DataDataBase)
+    return meta
+
+
+def service_count_dataset_by_code(
+    code: str,
+    query_param: SqlQueryParam | None = None,
+) -> int:
+    """按数据集编码统计数据量。"""
+    if query_param is None:
+        query_param = SqlQueryParam()
+
+    body = {
+        "type": MetaType.DATASET,
+        "code": code,
+        "queryParam": query_param,
+    }
+
+    with get_session(timeout=15) as session:
+        response = session.post(
+            "/data/dataset/countData",
+            content=to_json(encrypt_body(body)),
+        )
+        response_body = response.json()
+
+    if response.status_code != 200:
+        raise DataOpsError(
+            f"统计失败，{response_body.get('msg', f'HTTP {response.status_code}')}",
+            response.status_code,
+        )
+
+    return response_body.get("data") or 0
+
+
+def service_get_dataset_data_by_code(
+    code: str,
+    page_param: PageParam | None = None,
+    query_param: SqlQueryParam | None = None,
+) -> list[Mapping[str, JsonValue]]:
+    """按数据集编码读取真实数据，支持分页和条件查询。"""
+    if page_param is None:
+        page_param = PageParam()
+    if query_param is None:
+        query_param = SqlQueryParam()
+
+    # 请求体遵循 DataOps 数据集接口契约；具体的认证请求头由 get_session 统一注入。
+    body = {
+        "type": MetaType.DATASET,
+        "code": code,
+        "pageParam": page_param,
+        "queryParam": query_param,
+    }
+
+    # 复用统一会话发送请求，encrypt_body 负责按项目约定包装请求体。
+    with get_session(timeout=15) as session:
+        response = session.post(
+            "/data/dataset/findData",
+            content=to_json(encrypt_body(body)),
+        )
+        response_body = response.json()
+
+    if response.status_code != 200:
+        raise DataOpsError(
+            f"查询失败，{response_body.get('msg', f'HTTP {response.status_code}')}",
+            response.status_code,
+        )
+
+    # 后端返回的是动态列数据，因此使用通用 Mapping，而不是固定业务 schema。
+    adapter = TypeAdapter(
+        list[Mapping[str, JsonValue]],
+        config=ConfigDict(str_to_lower=True),
+    )
+    return adapter.validate_python(response_body.get("data") or [])

dataops_sdk/services/datasource.py

@@ -0,0 +1,57 @@
+from dataclasses import dataclass
+
+from dataops_sdk.exceptions import AuthenticationError, DataOpsError
+from dataops_sdk.schemas import DataDataSource, Meta
+from dataops_sdk.schemas.enums import InnerMetaType
+from dataops_sdk.services.meta import release_list_get_by_name
+from dataops_sdk.session import get_application, get_session
+from dataops_sdk.utils import encrypt_body
+from pydantic_core import to_json
+
+
+def service_get_datasource_config_by_application_id(
+    *, prod_id: str | None = None, param_name: str | None = None
+) -> Meta[DataDataSource]:
+    url = "/sys/application/getDatasource"
+    if prod_id is None:
+        application = get_application()
+        prod_id = application.CUID
+    body = {"prodId": prod_id, "datasourceParamName": param_name}
+    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)
+        resp.json()
+    data = resp_body["data"]
+    if not isinstance(data, dict):
+        raise DataOpsError(f"返回的数据格式不正确, 预期为字典, 实际为 {type(data)}")
+
+    return Meta[DataDataSource].model_validate(data)
+
+
+@dataclass
+class DatasourceConfig:
+    main: Meta[DataDataSource]
+    hazard_read: Meta[DataDataSource]
+    hazard_write: Meta[DataDataSource]
+
+
+def service_get_main_datasource_config_by_application(app_id: str | None = None) -> DatasourceConfig:
+    if app_id is None:
+        application = get_application()
+        app_id = application.CUID
+    # 主数据源
+    datasource_main = service_get_datasource_config_by_application_id(prod_id=app_id)
+    # 隐患读数据源
+    datasource_hazard_read = service_get_datasource_config_by_application_id(prod_id=app_id, param_name="datasource_hazard_read")
+    # 隐患写数据源
+    datasource_hazard_write = service_get_datasource_config_by_application_id(prod_id=app_id, param_name="datasource_hazard_write")
+    return DatasourceConfig(datasource_main, datasource_hazard_read, datasource_hazard_write)
+
+
+def service_get_datasource_by_name(name: str) -> Meta[DataDataSource]:
+    """获取数据源 Meta"""
+    return release_list_get_by_name(InnerMetaType.DATASOURCE.value, name, _class=DataDataSource)