dataops-sdk 0.3.4__tar.gz → 0.3.6__tar.gz

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataops-sdk
-Version: 0.3.4
+Version: 0.3.6
 Summary: Python SDK for the DataOps platform.
 Requires-Python: >=3.11
 Requires-Dist: pydantic<3,>=2

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/__init__.py

@@ -28,8 +28,11 @@ from .services import (  # noqa: F401
     service_count_widget_by_code,
     service_create_data_table,
     service_create_data_table_record,
+    service_create_table_record,
     service_delete_data_table_record_by_id,
     service_delete_data_table_record_by_id_list,
+    service_delete_table_record_by_id,
+    service_delete_table_record_by_id_list,
     service_exec_sql_by_datasource,
     service_find_alarm_table_data,
     service_find_meta_by_codes,
@@ -63,6 +66,9 @@ from .services import (  # noqa: F401
     service_get_table_data_by_name,
     service_get_table_detail_by_code,
     service_get_table_detail_by_name,
+    service_get_table_list_by_code,
+    service_get_table_records_by_code,
+    service_get_table_total_by_code,
     service_get_widget_data_by_code,
     service_get_widget_detail_by_code,
     service_get_workflow_by_code,
@@ -96,6 +102,9 @@ from .services import (  # noqa: F401
     service_trigger_hazard_task,
     service_update_data_table_record_by_id,
     service_update_data_table_record_by_id_list,
+    service_update_table_record_by_id,
+    service_update_table_record_by_id_list,
 )
+from .session import dataops_base_url_context, request_context
 
-__version__ = "0.3.4"
+__version__ = "0.3.6"

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/__init__.py

@@ -4,7 +4,15 @@
 dataops_sdk.schemas import ...`` 使用。
 """
 
-from .alarm import AlarmRuleItem
+from .alarm import (
+    AlarmActionItem,
+    AlarmBuiltinFunctionItem,
+    AlarmDetail,
+    AlarmPreprocessItem,
+    AlarmRuleItem,
+    AlarmRuleMatchItem,
+    AlarmSpecItem,
+)
 from .api import ApiMeta, HttpInterfaceData
 from .data_table import DataTableData, MetaDataTable
 from .datasource import DataDataSource
@@ -19,12 +27,12 @@ from .meta import (
     MetaBase,
     MetaCreate,
     MetaRef,
-    MetaRelease,
     MetaUpdate,
+    MetaPageData,
 )
 from .query import PageParam, SqlCondition, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
-from .skill import DataSkill, MetaSkill, SkillCallResult
+from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
 from .table import (
     ColumnItem,
     DataBaseColumnDictExternal,
@@ -36,3 +44,4 @@ from .table import (
 from .user import Application, UserInfo
 from .widget import WidgetMeta, WidgetMetaData
 from .workflow import DataWorkflow, MetaWorkflow
+from .common import DataOpsResponse

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/alarm.py

@@ -1,14 +1,14 @@
 """告警 (Alarm) 相关实体的 Schema 定义.
 
 对应平台告警规则、规则规格、处理动作与匹配项等数据模型，
-统一继承自 ``MetaRelease`` 并复用了启用状态相关字段。
+统一继承自 ``MetaBase`` 并复用了启用状态相关字段。
 """
 
 from typing import Annotated
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, JsonValue
 
-from dataops_sdk.schemas.meta import MetaRelease
+from dataops_sdk.schemas.meta import Meta, MetaBase, MetaRelease
 
 
 class AlarmExternal(BaseModel):
@@ -21,7 +21,7 @@ class AlarmExternal(BaseModel):
     N_IS_ENABLED: Annotated[str, Field(description="是否启用名称")]
 
 
-class AlarmRuleItem(MetaRelease, AlarmExternal):
+class AlarmRuleItem(MetaBase, AlarmExternal):
     """告警规则条目.
 
     Attributes:
@@ -33,7 +33,7 @@ class AlarmRuleItem(MetaRelease, AlarmExternal):
     DESCRIPTION: Annotated[str, Field(description="描述")] = ""
 
 
-class AlarmSpecItem(MetaRelease, AlarmExternal):
+class AlarmSpecItem(MetaBase, AlarmExternal):
     """告警规则规格条目.
 
     Attributes:
@@ -46,12 +46,12 @@ class AlarmSpecItem(MetaRelease, AlarmExternal):
 
     INDUSTRY: Annotated[str, Field(description="行业")]
     N_INDUSTRY: Annotated[str, Field(description="行业名称")]
-    BUSINESS_DOMAIN: Annotated[str, Field(description="业务域")]
-    N_BUSINESS_DOMAIN: Annotated[str, Field(description="业务域名称")]
-    KAFKA_TOPICS: Annotated[str, Field(description="Kafka主题列表")]
+    BUSINESS_DOMAIN: Annotated[str | None, Field(description="业务域")] = None
+    N_BUSINESS_DOMAIN: Annotated[str | None, Field(description="业务域名称")] = None
+    KAFKA_TOPICS: Annotated[str | None, Field(description="Kafka主题列表")] = None
 
 
-class AlarmActionItem(MetaRelease, AlarmExternal):
+class AlarmActionItem(MetaBase, AlarmExternal):
     """告警处理动作条目.
 
     Attributes:
@@ -66,7 +66,7 @@ class AlarmActionItem(MetaRelease, AlarmExternal):
     SCRIPT_CONTENT: Annotated[str, Field(description="脚本内容")]
 
 
-class AlarmRuleMatchItem(MetaRelease, AlarmExternal):
+class AlarmRuleMatchItem(MetaBase, AlarmExternal):
     """告警规则匹配条目.
 
     Attributes:
@@ -82,3 +82,38 @@ class AlarmRuleMatchItem(MetaRelease, AlarmExternal):
     N_SPEC_TYPE: Annotated[str, Field(description="规则类型名称")]
     RULE_TYPE: Annotated[str, Field(description="规则类型")]
     N_RULE_TYPE: Annotated[str, Field(description="规则类型名称")]
+
+
+class AlarmPreprocessItem(MetaRelease, AlarmExternal):
+    """预处理脚本列表条目。
+
+    前端列表接口返回大写字段；说明、脚本内容和专业名称可能为空，
+    因此这里不把这些展示字段设置为必填。
+    """
+
+    N_SPEC_TYPE: Annotated[str | None, Field(description="关联专业名称")] = None
+    DESCRIPTION: Annotated[str | None, Field(description="脚本说明")] = None
+    SCRIPT_CONTENT: Annotated[str | None, Field(description="脚本内容")] = None
+
+    model_config = ConfigDict(extra="allow", str_to_lower=False)
+
+
+class AlarmBuiltinFunctionItem(MetaRelease, AlarmExternal):
+    """内置函数列表条目。"""
+
+    CLAZZ: Annotated[str | None, Field(description="类全路径")] = None
+    SCRIPT: Annotated[str | None, Field(description="函数脚本")] = None
+    REMARK: Annotated[str | None, Field(description="备注")] = None
+
+    model_config = ConfigDict(extra="allow", str_to_lower=False)
+
+
+class AlarmDetail(BaseModel):
+    """告警详情的统一返回结构。
+
+    ``meta`` 来自主体接口，``params`` 来自 Meta 参数接口；data 使用 JSON
+    映射保留前端可能新增的字段，避免详情查询因未知字段失败。
+    """
+
+    meta: Meta[dict[str, JsonValue]]
+    params: dict[str, JsonValue] = Field(default_factory=dict)

dataops_sdk-0.3.6/src/dataops_sdk/schemas/common.py

@@ -0,0 +1,9 @@
+from typing_extensions import Annotated, TypeVar, Generic
+from pydantic import BaseModel, JsonValue, Field, NonNegativeInt
+
+DataVar = TypeVar("DataVar", default=JsonValue | None)
+
+class DataOpsResponse(BaseModel, Generic[DataVar]):
+    code: Annotated[NonNegativeInt, Field(description="响应码")]
+    msg: Annotated[str | None, Field(description="响应消息")]
+    data: Annotated[DataVar, Field(description="响应数据")]

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/data_table.py

@@ -435,7 +435,7 @@ class DataTableField(BaseModel):
         Field(description="类型扩展配置", validation_alias=AliasChoices("typeExt", "type_ext")),
     ] = None
 
-    model_config = ConfigDict(str_to_lower=True, extra="allow")
+    model_config = ConfigDict(extra="allow")
 
 
 # ---------------------------------------------------------------------------

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/meta.py

@@ -1,7 +1,6 @@
 """平台 Meta 通用 Schema 定义.
 
 集中管理 ``Meta`` 体系的基类与容器，包括:
-- ``MetaRelease``: 后端返回的发布态基类，字段采用大写下划线。
 - ``MetaBase``: list 接口使用的基类，字段采用小驼峰 + alias。
 - ``Meta``: 详情响应容器，承载 ``data`` 字段并按需自动反序列化 ``rawData``。
 - ``MetaRef``: 引用形态元数据。
@@ -70,7 +69,7 @@ class MetaRelease(BaseModel):
     LAST_MODIFY_TIME: Annotated[datetime, Field(description="最后修改时间")]
     LAST_MODIFY_USER: Annotated[str, Field(description="最后修改人")]
 
-    model_config = ConfigDict(extra="allow", str_to_lower=True)
+    model_config = ConfigDict(extra="allow")
 
 
 class MetaBase(BaseModel):
@@ -101,68 +100,117 @@ class MetaBase(BaseModel):
         version: 版本号。
     """
 
-    id: Annotated[str, Field(description="元数据ID", validation_alias=AliasChoices("id", "cuid"))]
+    id: Annotated[
+        str, Field(description="元数据ID", validation_alias=AliasChoices("id", "cuid", "CUID"))
+    ]
     parentId: Annotated[
         str | None,
-        Field(description="父ID", validation_alias=AliasChoices("parentId", "parent_id")),
+        Field(
+            description="父ID", validation_alias=AliasChoices("parentId", "parent_id", "PARENT_ID")
+        ),
     ]
-    code: Annotated[str, Field(description="编码")]
+    code: Annotated[str, Field(description="编码", validation_alias=AliasChoices("code", "CODE"))]
 
     groupCode: Annotated[
         str | None,
-        Field(description="组编码", validation_alias=AliasChoices("groupCode", "group_code")),
+        Field(
+            description="组编码",
+            validation_alias=AliasChoices("groupCode", "group_code", "GROUP_CODE"),
+        ),
     ]
-    groupName: Annotated[str | None, Field(description="组名称")] = None
-    spaceName: Annotated[str | None, Field(description="空间名称")] = None
+    groupName: Annotated[
+        str | None,
+        Field(
+            description="组名称",
+            validation_alias=AliasChoices("groupName", "group_name", "GROUP_NAME"),
+        ),
+    ] = None
+    spaceName: Annotated[
+        str | None,
+        Field(description="空间名称", validation_alias=AliasChoices("spaceName", "space_name", "SPACE_NAME")),
+    ] = None
 
     subSystem: Annotated[
-        str, Field(description="子系统", validation_alias=AliasChoices("subSystem", "sub_system"))
+        str,
+        Field(
+            description="子系统",
+            validation_alias=AliasChoices("subSystem", "sub_system", "SUB_SYSTEM"),
+        ),
     ]
 
-    type: Annotated[str, Field(description="类型")]
+    type: Annotated[str, Field(description="类型", validation_alias=AliasChoices("type", "TYPE"))]
     subType: Annotated[
         str | None,
-        Field(description="子类型", validation_alias=AliasChoices("subType", "sub_type")),
+        Field(
+            description="子类型", validation_alias=AliasChoices("subType", "sub_type", "SUB_TYPE")
+        ),
     ]
 
-    name: Annotated[str, Field(description="名称")]
-    title: Annotated[str, Field(description="中文名称")]
-    digest: Annotated[str | None, Field(description="摘要")]
+    name: Annotated[str, Field(description="名称", validation_alias=AliasChoices("name", "NAME"))]
+    title: Annotated[
+        str, Field(description="中文名称", validation_alias=AliasChoices("title", "TITLE"))
+    ]
+    digest: Annotated[
+        str | None, Field(description="摘要", validation_alias=AliasChoices("digest", "DIGEST"))
+    ]
 
-    remark: Annotated[str | None, Field(description="备注")]
+    remark: Annotated[
+        str | None, Field(description="备注", validation_alias=AliasChoices("remark", "REMARK"))
+    ]
 
     createUser: Annotated[
-        str, Field(description="创建人", validation_alias=AliasChoices("createUser", "create_user"))
+        str,
+        Field(
+            description="创建人",
+            validation_alias=AliasChoices("createUser", "create_user", "CREATE_USER"),
+        ),
     ]
     createTime: Annotated[
         datetime,
-        Field(description="创建时间", validation_alias=AliasChoices("createTime", "create_time")),
+        Field(
+            description="创建时间",
+            validation_alias=AliasChoices("createTime", "create_time", "CREATE_TIME"),
+        ),
     ]
     lastModifyUser: Annotated[
         str,
         Field(
             description="最后修改人",
-            validation_alias=AliasChoices("lastModifyUser", "last_modify_user"),
+            validation_alias=AliasChoices("lastModifyUser", "last_modify_user", "LAST_MODIFY_USER"),
         ),
     ]
     lastModifyTime: Annotated[
         datetime,
         Field(
             description="最后修改时间",
-            validation_alias=AliasChoices("lastModifyTime", "last_modify_time"),
+            validation_alias=AliasChoices("lastModifyTime", "last_modify_time", "LAST_MODIFY_TIME"),
         ),
     ]
 
     tenantId: Annotated[
-        str, Field(description="租户ID", validation_alias=AliasChoices("tenantId", "tenant_id"))
+        str,
+        Field(
+            description="租户ID",
+            validation_alias=AliasChoices("tenantId", "tenant_id", "TENANT_ID"),
+        ),
     ]
     prodCode: Annotated[
-        str, Field(description="产品编码", validation_alias=AliasChoices("prodCode", "prod_code"))
+        str,
+        Field(
+            description="产品编码",
+            validation_alias=AliasChoices("prodCode", "prod_code", "PROD_CODE"),
+        ),
     ]
-    release: Annotated[str, Field(description="版本")]
+    release: Annotated[
+        str | None, Field(description="版本", validation_alias=AliasChoices("release", "RELEASE"))
+    ] = None
 
-    action: Annotated[str, Field(description="操作")]
-    version: Annotated[str, Field(description="版本")]
+    action: Annotated[
+        str, Field(description="操作", validation_alias=AliasChoices("action", "ACTION"))
+    ]
+    version: Annotated[
+        str, Field(description="版本", validation_alias=AliasChoices("version", "VERSION"))
+    ]
 
     model_config = ConfigDict(extra="allow")
 
@@ -288,3 +336,10 @@ class MetaUpdate(BaseModel, Generic[META_DATA_TYPE]):
     data: Annotated[
         META_DATA_TYPE | None, Field(description="元数据", exclude_if=lambda x: x is None)
     ] = None
+
+
+class MetaPageData(BaseModel):
+    total: Annotated[int, Field(description="总数")]
+    page_num: Annotated[int, Field(description="页码", validation_alias=AliasChoices("pageNum", "page_num"))]
+    page_size: Annotated[int, Field(description="页大小", validation_alias=AliasChoices("pageSize", "page_size"))]
+    records: list[MetaBase] = Field(default_factory=list, description="数据")

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/query.py

@@ -32,6 +32,7 @@ class SqlConditionBase(BaseModel):
 
     name: Annotated[str, Field(description="字段名")]
     value: Annotated[Any, Field(description="字段值")]
+    expression: Annotated[SqlExpression, Field(description="条件表达式")] = SqlExpression.EQ
 
 
 class SqlCondition(SqlConditionBase):
@@ -45,7 +46,6 @@ class SqlCondition(SqlConditionBase):
     """
 
     alias: Annotated[str | None, Field(description="表别名")] = None
-    expression: Annotated[SqlExpression, Field(description="条件表达式")]
 
 
 class SqlSort(BaseModel):
@@ -85,7 +85,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value))
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.EQ))
 
     @classmethod
     def ne(cls, name: str, value: Any):
@@ -222,11 +222,9 @@ class SqlQueryParam(BaseModel):
     """
 
     conjunction: Annotated[Literal["and", "or"], Field(description="条件连接符")] = "and"
-    conditionList: Annotated[
-        list[SqlCondition], Field(description="条件列表", default_factory=list)
-    ]
-    sorts: Annotated[list[SqlSort], Field(description="排序列表", default_factory=list)]
-    varMap: Annotated[dict[str, JsonValue], Field(description="变量映射", default_factory=dict)]
+    conditionList: list[SqlCondition] = Field(description="条件列表", default_factory=list)
+    sorts: list[SqlSort] = Field(description="排序列表", default_factory=list)
+    varMap: dict[str, JsonValue] = Field(description="变量映射", default_factory=dict)
 
     def add(self, *condition: SqlCondition):
         """追加条件.

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/schemas/skill.py

@@ -6,17 +6,17 @@
 
 from collections.abc import Mapping
 from enum import StrEnum
-from typing import Annotated, Any
-
-from pydantic import AliasChoices, BaseModel, Field, JsonValue
+from typing import Annotated, Any, Union
 
 from dataops_sdk.schemas.meta import Meta
+from pydantic import AliasChoices, BaseModel, Field, JsonValue
 
 
 class MetaSkillSubType(StrEnum):
     LLM = "llm"
     API = "api"
     REPORT = "report"
+    FORM = "form"
 
 
 class MetaSkillFileSubType(StrEnum):
@@ -62,6 +62,9 @@ class DataSkillSubFileImage(BaseModel):
     language: Annotated[str, Field(description="编程语言")]
 
 
+DataSkillSubFile = Union[DataSkillSubFileDoc, DataSkillSubFileCode, DataSkillSubFileImage]
+
+
 class MetaSkill(Meta[DataSkill]):
     """技能详情，继承通用 Meta 字段并附加 DataSkill data.
 

{dataops_sdk-0.3.4 → dataops_sdk-0.3.6}/src/dataops_sdk/services/__init__.py

@@ -5,11 +5,20 @@ from .alarm import (
     service_count_alarm_specs,
     service_find_alarm_table_data,
     service_find_meta_by_codes,
+    service_get_alarm_action_detail,
+    service_get_alarm_builtin_function_detail,
+    service_get_alarm_preprocess_detail,
+    service_get_alarm_rule_detail,
+    service_get_alarm_rule_type_detail,
     service_get_alarm_rule_enums,
     service_get_alarm_table_columns,
     service_get_rel_table_columns,
+    service_get_alarm_spec_detail,
+    service_list_alarm_builtin_functions,
+    service_list_alarm_action,
     service_list_alarm_rule_matches,
     service_list_alarm_rules,
+    service_list_alarm_preprocess,
     service_list_alarm_specs,
 )
 from .api import service_get_api_by_code, service_get_api_by_name
@@ -64,6 +73,7 @@ from .meta import (
     release_list_create,
     release_list_get_by_code,
     release_list_get_by_name,
+    release_list_params_get_rel_by_code,
     release_list_list,
     release_list_list_by_parent_id,
     release_list_page,
@@ -94,12 +104,20 @@ from .skill import (
 from .table import (
     service_count_table_by_code,
     service_count_table_by_name,
+    service_create_table_record,
+    service_delete_table_record_by_id,
+    service_delete_table_record_by_id_list,
     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_get_table_list_by_code,
+    service_get_table_records_by_code,
+    service_get_table_total_by_code,
     service_list_tables,
+    service_update_table_record_by_id,
+    service_update_table_record_by_id_list,
 )
 from .widget import (
     service_count_widget_by_code,