dataops-sdk 0.5.4__tar.gz → 0.5.6__tar.gz

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataops-sdk
-Version: 0.5.4
+Version: 0.5.6
 Summary: Python SDK for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/__init__.py

@@ -79,8 +79,14 @@ from .services import (  # noqa: F401
     service_ref_backward,
     service_ref_forward,
     service_set_application,
+    service_skill_bind_ontology,
     service_skill_call_by_code,
     service_skill_download,
+    service_skill_followup_add,
+    service_skill_followup_list,
+    service_skill_followup_remove,
+    service_skill_followup_set,
+    service_skill_get_bindings,
     service_skill_update,
     service_skill_upload,
     service_skill_upload_sub_file,
@@ -93,4 +99,4 @@ from .services import (  # noqa: F401
 )
 from .session import dataops_base_url_context, request_context
 
-__version__ = "0.5.4"
+__version__ = "0.5.6"

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/schemas/__init__.py

@@ -4,7 +4,7 @@
 dataops_sdk.schemas import ...`` 使用。
 """
 
-from .api import ApiMeta, HttpInterfaceData
+from .api import ApiCallResult, ApiMeta, HttpInterfaceData
 from .common import DataOpsResponse
 from .data_table import DataTableData, MetaDataTable
 from .datasource import DataDataSource
@@ -47,7 +47,15 @@ from .ontology import (
 )
 from .query import PageParam, SqlCondition, SqlFilter, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
-from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
+from .skill import (
+    DataSkill,
+    DataSkillSubFile,
+    MetaSkill,
+    SkillCallResult,
+    SkillFollowupItem,
+    SkillFollowupRef,
+    SkillOntologyRef,
+)
 from .table import (
     ColumnItem,
     DataBaseColumnDictExternal,

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/schemas/api.py

@@ -5,9 +5,10 @@
 """
 
 from collections.abc import Mapping
-from typing import Annotated
+from typing import Annotated, Any
 
 from pydantic import BaseModel, Field, JsonValue
+from pydantic_core import from_json
 
 from .meta import Meta
 
@@ -57,3 +58,27 @@ class ApiMeta(Meta[HttpInterfaceData]):
 
     标准 ``Meta`` 容器，``data`` 承载 ``HttpInterfaceData``。
     """
+
+
+class ApiCallResult(BaseModel):
+    """平台代发 API 的调用结果.
+
+    目标接口的 HTTP 状态在 ``statusCode`` 中，平台调用本身失败时抛 ``DataOpsError``。
+
+    Attributes:
+        statusCode: 目标接口 HTTP 状态码。
+        headers: 目标接口响应头，多值头为字符串列表。
+        mimeType: 响应 Content-Type 的 type/subtype。
+        body: 响应体原文。
+        envCode: 实际使用的 API 环境编码。
+    """
+
+    statusCode: Annotated[int, Field(description="目标接口 HTTP 状态码")]
+    headers: Annotated[Mapping[str, JsonValue] | None, Field(description="目标接口响应头")] = None
+    mimeType: Annotated[str | None, Field(description="响应 MIME 类型")] = None
+    body: Annotated[str | None, Field(description="响应体原文")] = None
+    envCode: Annotated[str | None, Field(description="实际使用的 API 环境编码")] = None
+
+    @property
+    def json(self) -> Any:
+        return from_json(self.body)

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/schemas/skill.py

@@ -5,31 +5,66 @@
 """
 
 from collections.abc import Mapping
-from typing import Annotated, Any, Union
+from typing import Annotated, Any, Literal, Union
 
-from pydantic import AliasChoices, BaseModel, Field, JsonValue
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, JsonValue
 
 from dataops_sdk.schemas.meta import Meta
 
 
+class SkillOntologyRef(BaseModel):
+    """技能归属本体，对齐前端 ``meta.data.ref``."""
+
+    type: Annotated[Literal["ontology"], Field(description="引用类型")] = "ontology"
+    code: Annotated[str, Field(description="本体 meta code")]
+
+
+class SkillFollowupRef(BaseModel):
+    """后续动作目标引用."""
+
+    type: Annotated[Literal["skill", "workflow"], Field(description="目标类型")]
+    code: Annotated[str, Field(description="目标 meta code")]
+
+
+class SkillFollowupItem(BaseModel):
+    """技能后续动作，对齐前端 ``meta.data.followup``."""
+
+    id: Annotated[str, Field(description="条目 ID")]
+    ref: Annotated[SkillFollowupRef, Field(description="目标引用")]
+    title: Annotated[str, Field(description="目标标题")]
+    description: Annotated[str | None, Field(description="推荐描述")] = None
+
+
 class DataSkill(BaseModel):
     """技能实体 rawData 私有字段.
 
     字段命名参考前端 ``SkillFile.vue`` 与后端 ``SkillService`` 的约定：
     - ``editor``: TipTap JSON 文档结构（用于编辑器渲染）
     - ``args``: 技能对外入参定义列表
+    - ``ref``: 归属本体
+    - ``followup``: 后续动作列表
 
     Attributes:
-        markdown: SKILL.md Markdown 内容。
         editor: TipTap JSON 文档结构。
         args: 技能对外入参定义。
+        ref: 归属本体引用。
+        followup: 后续动作。
+        description: 技能描述。
     """
 
+    model_config = ConfigDict(extra="allow")
+
     editor: Annotated[Mapping[str, JsonValue], Field(description="TipTap JSON 文档结构")]
     args: Annotated[
         list[Mapping[str, JsonValue]] | None,
         Field(description="技能对外入参定义"),
     ] = None
+    ref: Annotated[SkillOntologyRef | None, Field(description="归属本体")] = None
+    followup: Annotated[
+        list[SkillFollowupItem] | None,
+        Field(description="后续动作"),
+    ] = None
+    description: Annotated[str | None, Field(description="技能描述")] = None
 
 
 class DataSkillSubFileDoc(BaseModel):

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/services/__init__.py

@@ -1,4 +1,8 @@
-from .api import service_get_api_by_code, service_get_api_by_name
+from .api import (
+    service_call_api,
+    service_get_api_by_code,
+    service_get_api_by_name,
+)
 from .auth import (
     service_get_current_application,
     service_list_applications,
@@ -94,18 +98,24 @@ from .skill import (
     service_list_skill_files,
     service_list_skills,
     service_pack_skill_zip,
+    service_skill_bind_ontology,
     service_skill_call_by_code,
     service_skill_call_by_name,
     service_skill_delete_sub_file,
     service_skill_download,
-    service_skill_update,
+    service_skill_file,
+    service_skill_files,
+    service_skill_followup_add,
+    service_skill_followup_list,
+    service_skill_followup_remove,
+    service_skill_followup_set,
+    service_skill_get_bindings,
     service_skill_get_subfile_by_code,
     service_skill_get_subfile_by_name,
-    service_skill_files,
-    service_skill_file,
+    service_skill_list_skill_codes_by_ontology,
+    service_skill_update,
     service_skill_upload,
     service_skill_upload_sub_file,
-    service_skill_list_skill_codes_by_ontology,
 )
 from .table import (
     service_count_table_by_code,
@@ -161,6 +171,7 @@ from .workflow import (
 )
 
 __all__ = [
+    "service_call_api",
     "service_get_api_by_code",
     "service_get_api_by_name",
     "service_get_current_application",
@@ -253,6 +264,12 @@ __all__ = [
     "service_skill_file",
     "service_skill_upload",
     "service_skill_upload_sub_file",
+    "service_skill_bind_ontology",
+    "service_skill_followup_add",
+    "service_skill_followup_list",
+    "service_skill_followup_remove",
+    "service_skill_followup_set",
+    "service_skill_get_bindings",
     "service_skill_list_skill_codes_by_ontology",
     "service_count_table_by_code",
     "service_count_table_by_name",

dataops_sdk-0.5.6/src/dataops_sdk/services/api.py

@@ -0,0 +1,116 @@
+"""API 接口服务模块.
+
+为 API 接口实体 (MetaType.API) 提供基于编码或名称的元数据查询封装，
+以及按平台配置代发 HTTP 请求。
+查询底层调用 ``release_list_get_by_code`` / ``release_list_get_by_name``，返回 ``HttpInterfaceData`` 模型.
+调用走 ``POST /data/api/call``，环境解析与参数合并在平台侧完成.
+"""
+
+from collections.abc import Mapping
+from typing import Any
+
+from pydantic_core import to_json
+
+from dataops_sdk.schemas import ApiCallResult, HttpInterfaceData, MetaType
+from dataops_sdk.services.meta import release_list_get_by_code, release_list_get_by_name
+from dataops_sdk.session import get_session, vaild_respone
+from dataops_sdk.utils.utils import encrypt_body
+
+__all__ = [
+    "service_call_api",
+    "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 数据
+
+    Raises:
+        NotFoundError: 找不到对应 API 接口时.
+        DataOpsError: API 返回错误时.
+        AuthenticationError: 未认证或认证失败时.
+    """
+    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 数据
+
+    Raises:
+        NotFoundError: 找不到对应 API 接口时.
+        DataOpsError: API 返回错误时.
+        AuthenticationError: 未认证或认证失败时.
+    """
+    return release_list_get_by_name(MetaType.API, name, _class=HttpInterfaceData)
+
+
+def service_call_api(
+    code: str,
+    *,
+    query: Mapping[str, Any] | None = None,
+    path: Mapping[str, Any] | None = None,
+    headers: Mapping[str, str] | None = None,
+    body: str | Mapping[str, Any] | list[Any] | None = None,
+    timeout: float | None = None,
+    env_code: str | None = None,
+) -> ApiCallResult:
+    """按编码调用平台上配置的 API.
+
+    未传 ``env_code`` 时，由平台按 ``fmind.core.envCode``、接口绑定的 ``env_code``、
+    ``fmind.core.defaultEnvCode`` 决定环境。``body`` 为 ``None`` 时不发送请求体。
+    query、path、header 只发送调用方传入的键，不读取接口定义里的默认值。
+
+    Args:
+        code: API 接口编码。
+        query: 查询参数。
+        path: 路径参数。
+        headers: 请求头。
+        body: 请求体。字符串原样发送，dict 或 list 会序列化为 JSON。
+        timeout: 目标请求超时时间，单位秒。未传时不写入请求体，由平台决定；HTTP 客户端此时也不设超时。
+            传入正数时写入 ``payload["timeout"]``，且客户端等待时间比它多 1 秒。
+        env_code: API 环境编码，只能用关键字传入。未传时由平台解析。
+
+    Returns:
+        目标接口的状态码、响应头、MIME、响应体，以及实际使用的环境编码。
+        目标接口返回 4xx/5xx 时不抛异常，状态在 ``statusCode`` 中。
+
+    Raises:
+        NotFoundError: 找不到对应 API 接口时.
+        DataOpsError: 平台返回错误时.
+        AuthenticationError: 未认证或认证失败时.
+    """
+    payload: dict[str, Any] = {"code": code}
+    if query is not None:
+        payload["query"] = dict(query)
+    if path is not None:
+        payload["path"] = dict(path)
+    if headers is not None:
+        payload["headers"] = dict(headers)
+    if body is not None:
+        payload["body"] = body if isinstance(body, str) else to_json(body).decode("utf-8")
+    if env_code is not None:
+        payload["env_code"] = env_code
+    session_timeout: float | None = None
+    if timeout is not None:
+        if timeout <= 0:
+            raise ValueError("timeout must be positive")
+        payload["timeout"] = timeout
+        session_timeout = timeout + 1
+
+    with get_session(timeout=session_timeout) as session:
+        resp = session.post("/data/api/call", content=to_json(encrypt_body(payload)))
+        resp_body = vaild_respone(resp, check_data=True, _class=ApiCallResult)
+    return resp_body.data

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/services/data_table.py

@@ -130,7 +130,7 @@ def service_get_data_table_data_by_code(
 
     meta = meta or service_get_data_table_by_code(code)
 
-    with get_session(timeout=15, sub_system=meta.subSystem) as session:
+    with get_session(sub_system=meta.subSystem) as session:
         resp = session.post(
             f"/data/table/list/{code}",
             content=to_json(
@@ -180,7 +180,7 @@ def service_get_data_table_data_ext_by_code(
     meta = meta or service_get_data_table_by_code(code)
     assert meta.data, "元数据为空 is None"
 
-    with get_session(timeout=15, sub_system=meta.subSystem) as session:
+    with get_session(sub_system=meta.subSystem) as session:
         resp = session.post(
             url,
             content=to_json(
@@ -344,7 +344,7 @@ def service_get_data_table_total(
     body = {
         "queryParam": query_param,
     }
-    with get_session(timeout=15, sub_system=meta.subSystem) as session:
+    with get_session(sub_system=meta.subSystem) as session:
         resp = session.post(
             f"/data/table/total/{code}", content=to_json(encrypt_body(dict(queryParam=query_param)))
         )
@@ -378,7 +378,7 @@ def service_get_data_table_reference_list(
         "pageParam": page_param or PageParam(),
         "queryParam": query_param or SqlQueryParam(),
     }
-    with get_session(timeout=15, sub_system=meta.subSystem) as session:
+    with get_session(sub_system=meta.subSystem) as session:
         resp = session.post(
             f"/data/table/referenceList/{code}/{subcode}", content=to_json(encrypt_body(body))
         )

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/services/dataset.py

@@ -89,7 +89,7 @@ def service_count_dataset_by_code(
         "queryParam": query_param,
     }
 
-    with get_session(timeout=15) as session:
+    with get_session() as session:
         response = session.post(
             "/data/dataset/countData",
             content=to_json(encrypt_body(body)),
@@ -144,7 +144,7 @@ def service_get_dataset_data_by_code(
     }
 
     # 复用统一会话发送请求，encrypt_body 负责按项目约定包装请求体。
-    with get_session(timeout=15) as session:
+    with get_session() as session:
         response = session.post(
             "/data/dataset/findData",
             content=to_json(encrypt_body(body)),

{dataops_sdk-0.5.4 → dataops_sdk-0.5.6}/src/dataops_sdk/services/meta.py

@@ -8,6 +8,9 @@ CLI 命令请使用 meta_cli 模块。
 from collections.abc import Mapping, Sequence
 from typing import cast
 
+from pydantic import BaseModel, JsonValue
+from pydantic_core import to_json
+
 from dataops_sdk.exceptions import (
     AuthenticationError,
     DataOpsError,
@@ -29,8 +32,6 @@ from dataops_sdk.schemas import (
 )
 from dataops_sdk.session import get_session, vaild_respone
 from dataops_sdk.utils import encrypt_body
-from pydantic import JsonValue
-from pydantic_core import to_json
 
 
 def release_list_list_by_parent_id(
@@ -431,6 +432,7 @@ def release_list_update(
     *,
     datasource: str | None = None,
     _class: type[META_DATA_TYPE] = DEFAULT_META_DATA_TYPE,
+    exclude_none_data: bool = False,
 ) -> Meta[META_DATA_TYPE]:
     """更新 Meta 对象.
 
@@ -450,7 +452,10 @@ def release_list_update(
     """
     meta_payload = meta.model_dump(mode="json", exclude={"data"})
     if meta.data is not None:
-        meta_payload["rawData"] = to_json(meta.data).decode()
+        payload = meta.data
+        if exclude_none_data and isinstance(payload, BaseModel):
+            payload = payload.model_dump(mode="json", exclude_none=True)
+        meta_payload["rawData"] = to_json(payload).decode()
     body = {"meta": meta_payload, "params": []}
 
     try: