dataops-sdk 0.3.0__py3-none-any.whl

dataops_sdk/schemas/hazard.py

@@ -0,0 +1,151 @@
+from datetime import datetime
+from typing import Annotated
+
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field
+
+
+class HazardRecordDTO(BaseModel):
+    """隐患记录 DTO，对应 Java ``HazardRecordDTO``.
+
+    注意：list/his-list 接口实际返回 ``DbRecord``（key 全部大写下划线），
+    本模型供用户在已知单条记录结构时构造/校验对象使用。
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="ignore")
+
+    cuid: Annotated[str, Field(description="隐患记录主键 ID")]
+    rule_code: Annotated[
+        str | None,
+        Field(description="所属规则编码", validation_alias=AliasChoices("ruleCode", "rule_code")),
+    ] = None
+    rule_name: Annotated[
+        str | None,
+        Field(description="所属规则名称", validation_alias=AliasChoices("ruleName", "rule_name")),
+    ] = None
+    hazard_no: Annotated[
+        str | None,
+        Field(description="隐患编号", validation_alias=AliasChoices("hazardNo", "hazard_no")),
+    ] = None
+    hazard_title: Annotated[
+        str | None,
+        Field(description="隐患标题", validation_alias=AliasChoices("hazardTitle", "hazard_title")),
+    ] = None
+    hazard_desc: Annotated[
+        str | None,
+        Field(description="隐患描述", validation_alias=AliasChoices("hazardDesc", "hazard_desc")),
+    ] = None
+    hazard_level: Annotated[
+        str | None,
+        Field(description="隐患等级", validation_alias=AliasChoices("hazardLevel", "hazard_level")),
+    ] = None
+    object_type: Annotated[
+        str | None,
+        Field(
+            description="隐患对象类型", validation_alias=AliasChoices("objectType", "object_type")
+        ),
+    ] = None
+    object_type_name: Annotated[
+        str | None,
+        Field(
+            description="隐患对象类型名",
+            validation_alias=AliasChoices("objectTypeName", "object_type_name"),
+        ),
+    ] = None
+    object_id: Annotated[
+        str | None,
+        Field(description="隐患对象 ID", validation_alias=AliasChoices("objectId", "object_id")),
+    ] = None
+    object_name: Annotated[
+        str | None,
+        Field(
+            description="隐患对象名称", validation_alias=AliasChoices("objectName", "object_name")
+        ),
+    ] = None
+    status: Annotated[int | None, Field(description="隐患状态码")] = None
+    clear_time: Annotated[
+        datetime | None,
+        Field(description="清除时间", validation_alias=AliasChoices("clearTime", "clear_time")),
+    ] = None
+    order_no: Annotated[
+        str | None,
+        Field(description="外部工单号", validation_alias=AliasChoices("orderNo", "order_no")),
+    ] = None
+    clear_notify_status: Annotated[
+        int | None,
+        Field(
+            description="清除通知状态",
+            validation_alias=AliasChoices("clearNotifyStatus", "clear_notify_status"),
+        ),
+    ] = None
+    need_dispatch: Annotated[
+        bool | None,
+        Field(
+            description="是否需要派遣",
+            validation_alias=AliasChoices("needDispatch", "need_dispatch"),
+        ),
+    ] = None
+    check_start_time: Annotated[
+        datetime | None,
+        Field(
+            description="检查开始时间",
+            validation_alias=AliasChoices("checkStartTime", "check_start_time"),
+        ),
+    ] = None
+    check_end_time: Annotated[
+        datetime | None,
+        Field(
+            description="检查结束时间",
+            validation_alias=AliasChoices("checkEndTime", "check_end_time"),
+        ),
+    ] = None
+    create_time: Annotated[
+        datetime | None,
+        Field(description="创建时间", validation_alias=AliasChoices("createTime", "create_time")),
+    ] = None
+    last_modify_time: Annotated[
+        datetime | None,
+        Field(
+            description="最后修改时间",
+            validation_alias=AliasChoices("lastModifyTime", "last_modify_time"),
+        ),
+    ] = None
+
+
+class HazardTaskDTO(BaseModel):
+    """隐患任务 DTO，对应 Java ``HazardTaskDTO``.
+
+    主要在 ``/hazard/task/trigger/{code}`` 触发后由后端异步生成实例并写入日志；
+    SDK 不直接查询该 DTO，保留供用户在构造/序列化场景下使用。
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="ignore")
+
+    code: Annotated[str | None, Field(description="任务编码")] = None
+    name: Annotated[str | None, Field(description="任务名称")] = None
+    title: Annotated[str | None, Field(description="任务中文名")] = None
+    hazard_code: Annotated[
+        str | None,
+        Field(description="隐患编码", validation_alias=AliasChoices("hazardCode", "hazard_code")),
+    ] = None
+    check_object: Annotated[
+        dict | None,
+        Field(
+            description="检查对象配置",
+            validation_alias=AliasChoices("checkObject", "check_object"),
+        ),
+    ] = None
+    job_setting: Annotated[
+        dict | None,
+        Field(
+            description="任务调度配置",
+            validation_alias=AliasChoices("jobSetting", "job_setting"),
+        ),
+    ] = None
+    enabled: Annotated[bool | None, Field(description="是否启用")] = None
+    need_dispatch: Annotated[
+        bool | None,
+        Field(
+            description="是否需要派遣",
+            validation_alias=AliasChoices("needDispatch", "need_dispatch"),
+        ),
+    ] = None

dataops_sdk/schemas/meta.py

@@ -0,0 +1,175 @@
+from collections.abc import Mapping
+from datetime import datetime
+from typing import Annotated, Generic, TypeVar
+
+from pydantic import (
+    AliasChoices,
+    BaseModel,
+    ConfigDict,
+    Field,
+    JsonValue,
+    model_validator,
+)
+from pydantic_core import from_json
+
+DEFAULT_META_DATA_TYPE = Mapping[str, JsonValue]
+META_DATA_BOUND_TYPE = DEFAULT_META_DATA_TYPE | BaseModel
+
+META_DATA_TYPE = TypeVar("META_DATA_TYPE", bound=META_DATA_BOUND_TYPE)
+
+
+class MetaRelease(BaseModel):
+    CUID: Annotated[str, Field(description="元数据ID")]
+    TENANT_ID: Annotated[str, Field(description="租户ID")]
+    PROD_CODE: Annotated[str, Field(description="产品编码")]
+    RELEASE: Annotated[str, Field(description="版本")] = "1.0.0"
+
+    CODE: Annotated[str, Field(description="编码")]
+    TYPE: Annotated[str, Field(description="类型")]
+    SUB_TYPE: Annotated[str | None, Field(description="子类型")]
+    NAME: Annotated[str, Field(description="名称")]
+    TITLE: Annotated[str, Field(description="中文名称")]
+    REMARK: Annotated[str | None, Field(description="备注")]
+    DIGEST: Annotated[str | None, Field(description="摘要")]
+
+    CREATE_TIME: Annotated[datetime, Field(description="创建时间")]
+    CREATE_USER: Annotated[str, Field(description="创建人")]
+    LAST_MODIFY_TIME: Annotated[datetime, Field(description="最后修改时间")]
+    LAST_MODIFY_USER: Annotated[str, Field(description="最后修改人")]
+
+    model_config = ConfigDict(extra="allow", str_to_lower=True)
+
+
+class MetaBase(BaseModel):
+    id: Annotated[str, Field(description="元数据ID", validation_alias=AliasChoices("id", "cuid"))]
+    parentId: Annotated[
+        str | None,
+        Field(description="父ID", validation_alias=AliasChoices("parentId", "parent_id")),
+    ]
+    code: Annotated[str, Field(description="编码")]
+
+    groupCode: Annotated[
+        str | None,
+        Field(description="组编码", validation_alias=AliasChoices("groupCode", "group_code")),
+    ]
+    groupName: Annotated[str | None, Field(description="组名称")] = None
+    spaceName: Annotated[str | None, Field(description="空间名称")] = None
+
+    subSystem: Annotated[
+        str, Field(description="子系统", validation_alias=AliasChoices("subSystem", "sub_system"))
+    ]
+
+    type: Annotated[str, Field(description="类型")]
+    subType: Annotated[
+        str | None,
+        Field(description="子类型", validation_alias=AliasChoices("subType", "sub_type")),
+    ]
+
+    name: Annotated[str, Field(description="名称")]
+    title: Annotated[str, Field(description="中文名称")]
+    digest: Annotated[str | None, Field(description="摘要")]
+
+    remark: Annotated[str | None, Field(description="备注")]
+
+    createUser: Annotated[
+        str, Field(description="创建人", validation_alias=AliasChoices("createUser", "create_user"))
+    ]
+    createTime: Annotated[
+        datetime,
+        Field(description="创建时间", validation_alias=AliasChoices("createTime", "create_time")),
+    ]
+    lastModifyUser: Annotated[
+        str,
+        Field(
+            description="最后修改人",
+            validation_alias=AliasChoices("lastModifyUser", "last_modify_user"),
+        ),
+    ]
+    lastModifyTime: Annotated[
+        datetime,
+        Field(
+            description="最后修改时间",
+            validation_alias=AliasChoices("lastModifyTime", "last_modify_time"),
+        ),
+    ]
+
+    tenantId: Annotated[
+        str, Field(description="租户ID", validation_alias=AliasChoices("tenantId", "tenant_id"))
+    ]
+    prodCode: Annotated[
+        str, Field(description="产品编码", validation_alias=AliasChoices("prodCode", "prod_code"))
+    ]
+    release: Annotated[str, Field(description="版本")]
+
+    action: Annotated[str, Field(description="操作")]
+    version: Annotated[str, Field(description="版本")]
+
+    model_config = ConfigDict(extra="allow")
+
+
+class Meta(MetaBase, Generic[META_DATA_TYPE]):
+    data: Annotated[META_DATA_TYPE | None, Field(description="元数据")]
+
+    @model_validator(mode="before")
+    @classmethod
+    def parse_raw_data(cls, values):
+        raw = values.get("rawData")
+        if raw:
+            values["data"] = from_json(raw)
+        return values
+
+    model_config = ConfigDict(extra="ignore")
+
+
+class MetaRef(BaseModel):
+    """引用元数据"""
+
+    cuid: Annotated[str, Field(description="元数据ID", exclude=True)]
+    type: Annotated[str, Field(description="类型")]
+    code: Annotated[str, Field(description="编码")]
+    name: Annotated[str, Field(description="名称")]
+    title: Annotated[str, Field(description="中文名称")]
+
+    refType: Annotated[str, Field(description="引用类型")]
+    refCode: Annotated[str, Field(description="引用编码")]
+    refName: Annotated[str, Field(description="引用名称")]
+    refTitle: Annotated[str, Field(description="引用中文名称")]
+    refSubtype: Annotated[str | None, Field(description="引用子类型")]
+    refSubcode: Annotated[str | None, Field(description="引用子编码")] = None
+
+    valid: Annotated[bool, Field(description="是否有效")] = False
+
+
+class MetaCreate(BaseModel, Generic[META_DATA_TYPE]):
+    code: Annotated[str | None, Field(description="编码")] = None
+
+    type: Annotated[str, Field(description="类型")]
+    subType: Annotated[
+        str | None,
+        Field(description="子类型", validation_alias=AliasChoices("subType", "sub_type")),
+    ] = None
+
+    name: Annotated[str, Field(description="名称")]
+    title: Annotated[str, Field(description="中文名称")]
+    # digest: Annotated[str | None, Field(description="摘要")] = None
+
+    remark: Annotated[str | None, Field(description="备注")] = None
+
+    data: Annotated[META_DATA_TYPE, Field(description="元数据")]
+
+    groupCode: Annotated[
+        str | None,
+        Field(description="分组编码", validation_alias=AliasChoices("groupCode", "group_code")),
+    ] = None
+
+
+class MetaUpdate(BaseModel, Generic[META_DATA_TYPE]):
+    code: Annotated[str | None, Field(description="编码")] = None
+
+    name: Annotated[str | None, Field(description="名称")] = None
+    title: Annotated[str | None, Field(description="中文名称")] = None
+    remark: Annotated[str | None, Field(description="备注")] = None
+
+    data: Annotated[
+        META_DATA_TYPE | None, Field(description="元数据", exclude_if=lambda x: x is None)
+    ] = None

dataops_sdk/schemas/query.py

@@ -0,0 +1,175 @@
+from typing import Annotated, Any, Literal
+
+from pydantic import BaseModel, Field, JsonValue
+
+from dataops_sdk.schemas.enums import SqlExpression
+
+
+class PageParam(BaseModel):
+    start: Annotated[int, Field(description="起始位置")] = 0
+    limit: Annotated[int, Field(description="每页条数")] = 20
+
+
+class SqlConditionBase(BaseModel):
+    name: Annotated[str, Field(description="字段名")]
+    value: Annotated[Any, Field(description="字段值")]
+
+
+class SqlCondition(SqlConditionBase):
+    alias: Annotated[str | None, Field(description="表别名")] = None
+    expression: Annotated[SqlExpression, Field(description="条件表达式")]
+
+
+class SqlSort(BaseModel):
+    alias: Annotated[str | None, Field(description="表别名")] = None
+    name: Annotated[str, Field(description="字段名")]
+    asc: Annotated[bool, Field(description="是否ASE")] = True
+
+
+class SqlFilter(BaseModel):
+    condition: Annotated[SqlConditionBase, Field(description="条件")]
+
+    @classmethod
+    def eq(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value))
+
+    @classmethod
+    def ne(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NE))
+
+    @classmethod
+    def gt(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.GT))
+
+    @classmethod
+    def ge(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.GE))
+
+    @classmethod
+    def lt(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LT))
+
+    @classmethod
+    def le(cls, name: str, value: Any):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LE))
+
+    @classmethod
+    def in_(cls, name: str, value: list):
+        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.IN))
+
+    @classmethod
+    def not_in(cls, name: str, value: list):
+        return cls(
+            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NOT_IN)
+        )
+
+    @classmethod
+    def like(cls, name: str, value: str):
+        return cls(
+            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LIKE)
+        )
+
+    @classmethod
+    def not_like(cls, name: str, value: str):
+        return cls(
+            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NOT_LIKE)
+        )
+
+
+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)]
+
+    def add_eq(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.EQ)
+        )
+        return self
+
+    def add_ne(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.NE)
+        )
+        return self
+
+    def add_gt(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.GT)
+        )
+        return self
+
+    def add_ge(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.GE)
+        )
+        return self
+
+    def add_lt(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.LT)
+        )
+        return self
+
+    def add_le(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.LE)
+        )
+        return self
+
+    def add_in(self, name: str, value: list, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.IN)
+        )
+        return self
+
+    def add_not_in(self, name: str, value: list, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.NOT_IN)
+        )
+        return self
+
+    def add_like(self, name: str, value: str, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.LIKE)
+        )
+        return self
+
+    def add_not_like(self, name: str, value: str, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.NOT_LIKE)
+        )
+        return self
+
+    def add_between(self, name: str, value: tuple[Any, Any], alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.BETWEEN)
+        )
+        return self
+
+    def add_not_between(self, name: str, value: tuple[Any, Any], alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.NOT_BETWEEN)
+        )
+        return self
+
+    def add_is_null(self, name: str, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=None, expression=SqlExpression.IS_NULL)
+        )
+        return self
+
+    def add_is_not_null(self, name: str, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=None, expression=SqlExpression.IS_NOT_NULL)
+        )
+        return self
+
+    def add_exists(self, name: str, value: Any, alias: str | None = None):
+        self.conditionList.append(
+            SqlCondition(alias=alias, name=name, value=value, expression=SqlExpression.EXISTS)
+        )
+        return self

dataops_sdk/schemas/report.py

@@ -0,0 +1,22 @@
+from collections.abc import Mapping
+from typing import Annotated
+
+from pydantic import BaseModel, Field, JsonValue
+
+from dataops_sdk.tiptap import TipTapBuilder
+
+from .meta import Meta
+
+
+class ReportMetaData(BaseModel):
+    """Report metadata"""
+
+    editor: Annotated[Mapping[str, JsonValue], Field(description="tiptap 原始文档")]
+
+
+class ReportMeta(Meta[ReportMetaData]):
+    """文档 Meta"""
+
+    @property
+    def content(self) -> str:
+        return TipTapBuilder().build().serialize(self.data.editor).strip()

dataops_sdk/schemas/skill.py

@@ -0,0 +1,70 @@
+from collections.abc import Mapping
+from typing import Annotated, Any
+
+from pydantic import AliasChoices, BaseModel, Field, JsonValue
+
+from dataops_sdk.schemas.meta import Meta
+
+
+class DataSkill(BaseModel):
+    """skill 实体 rawData 私有字段.
+
+    字段命名参考前端 ``SkillFile.vue`` 与后端 ``SkillService`` 的约定：
+    - ``markdown``: SKILL.md 的 Markdown 正文（用于 LLM 子类型技能）
+    - ``editor``: TipTap JSON 文档结构（用于编辑器渲染）
+    - ``args``: 技能对外入参定义列表
+    - ``input_json_schema``: JSON Schema 格式的入参约束
+    """
+
+    markdown: Annotated[str | None, Field(description="SKILL.md Markdown 内容")] = None
+    editor: Annotated[Mapping[str, JsonValue] | None, Field(description="TipTap JSON 文档结构")] = (
+        None
+    )
+    args: Annotated[
+        list[Mapping[str, JsonValue]] | None,
+        Field(description="技能对外入参定义"),
+    ] = None
+    input_json_schema: Annotated[
+        Mapping[str, JsonValue] | None, Field(description="JSON Schema 入参约束")
+    ] = None
+
+
+class MetaSkill(Meta[DataSkill]):
+    """skill 实体详情，继承通用 Meta 字段并附加 DataSkill data."""
+
+    @property
+    def content(self) -> str:
+        """便利访问：返回 markdown 文本（若存在）."""
+        if self.data is None:
+            return ""
+        return self.data.markdown or ""
+
+
+class SkillCallResult(BaseModel):
+    """调用 skill 后的返回结果，对应 Java ``SkillResult``.
+
+    字段使用 snake_case，通过 ``validation_alias`` 兼容后端驼峰返回.
+    """
+
+    inst_id: Annotated[
+        str,
+        Field(
+            description="调用实例 ID",
+            validation_alias=AliasChoices("instId", "inst_id"),
+        ),
+    ]
+    status: Annotated[str, Field(description="执行状态 success/failure")]
+    output_data: Annotated[
+        Any,
+        Field(
+            description="Python 容器返回的业务数据",
+            validation_alias=AliasChoices("outputData", "output_data"),
+        ),
+    ] = None
+    error_message: Annotated[
+        str | None,
+        Field(
+            description="失败时的错误信息",
+            validation_alias=AliasChoices("errorMessage", "error_message"),
+        ),
+    ] = None

dataops_sdk/schemas/table.py

@@ -0,0 +1,65 @@
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+from dataops_sdk.schemas.enums import ColumnType
+
+
+class DataBaseColumnReference(BaseModel):
+    type: Annotated[str, Field(description="引用类型")]
+    code: Annotated[str, Field(description="引用编码")]
+
+
+class DataBaseColumnReferenceValue(DataBaseColumnReference):
+    subtype: Annotated[str | None, Field(description="引用子类型")]
+    subcode: Annotated[str, Field(description="引用子编码")]
+
+
+class DataBaseColumnDictExternal(BaseModel):
+    ref__dict: Annotated[DataBaseColumnReference, Field(description="外部类型映射")]
+
+
+class DataBaseColumnTableExternal(BaseModel):
+    ref__table: Annotated[DataBaseColumnReference, Field(description="外部类型表")]
+    ref__valueField: Annotated[DataBaseColumnReferenceValue, Field(description="外部类型值字段")]
+    ref__displayField: Annotated[
+        DataBaseColumnReferenceValue | None,
+        Field(description="外部类型显示字段"),
+    ] = None
+
+
+class ColumnItem(BaseModel):
+    id: Annotated[str, Field(description="id")]
+    name: Annotated[str, Field(description="列名")]
+    title: Annotated[str, Field(description="列中文名")]
+    dbType: Annotated[ColumnType, Field(description="数据库类型")]
+    nullable: Annotated[bool, Field(description="是否可为空")] = True
+
+    length: Annotated[int | None, Field(description="长度")] = None
+    decimalPlace: Annotated[int | None, Field(description="小数位")] = None
+
+    type: Annotated[str | None, Field(description="类型")] = None
+
+    typeExt: Annotated[
+        DataBaseColumnDictExternal | DataBaseColumnTableExternal | None,
+        Field(description="类型扩展"),
+    ] = None
+
+    pk: Annotated[bool | None, Field(description="是否为主键")] = None
+    labelKey: Annotated[bool | None, Field(description="是否作为标签")] = None
+
+
+class IndexColumnItem(BaseModel):
+    column: Annotated[str, Field(description="列名")]
+    sort: Annotated[str | None, Field(description="排序方式")] = None
+
+
+class IndexItem(BaseModel):
+    id: Annotated[str, Field(description="id")]
+    name: Annotated[str, Field(description="索引名")]
+    columns: Annotated[list[IndexColumnItem], Field(description="索引列")]
+
+
+class DataDataBase(BaseModel):
+    columns: Annotated[list[ColumnItem], Field(description="列数据", default_factory=list)]
+    indexes: Annotated[list[IndexItem], Field(description="索引数据", default_factory=list)]