dataops-sdk 0.3.5__tar.gz → 0.4.0__tar.gz

dataops_sdk-0.4.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: dataops-sdk
+Version: 0.4.0
+Summary: Python SDK for the DataOps platform.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: pydantic-core
+Requires-Dist: pydantic-settings>=2.14.2
+Requires-Dist: httpx2>=2.5.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: markdown-it-py[plugins]
+Requires-Dist: cryptography>=49.0.0
+Requires-Dist: PyYaml
+Provides-Extra: runner
+Requires-Dist: paramiko>4; extra == "runner"
+Requires-Dist: pandas; extra == "runner"
+Requires-Dist: sqlalchemy; extra == "runner"
+Requires-Dist: pymysql; extra == "runner"
+Requires-Dist: doris-python>=1.0.3; extra == "runner"
+Requires-Dist: oracledb~=4.0.1; extra == "runner"
+Requires-Dist: neo4j; extra == "runner"
+Requires-Dist: kafka-python>3; extra == "runner"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+# dataops-sdk
+
+Python SDK for the DataOps platform.
+
+## 安装
+
+```bash
+# 基础安装
+pip install dataops_sdk
+
+# 含数据库驱动
+pip install "dataops_sdk[runner]"
+```
+
+## 快速开始
+
+```python
+from dataops_sdk.session import configure
+from dataops_sdk.services import service_list_tables, service_get_table_data_by_code
+
+# 配置认证
+configure(base_url="https://your-platform.com", api_key="your-api-key")
+
+# 查询数据表
+tables = service_list_tables("doris")
+print(tables)
+```
+
+## 核心模块
+
+### session — 认证配置
+
+```python
+from dataops_sdk.session import configure, get_session
+
+configure(base_url, api_key)  # 设置全局会话
+```
+
+### schemas — 数据模型
+
+| 模块 | 说明 |
+|------|------|
+| `MetaType` | 元数据类型枚举 |
+| `SqlQueryParam` | SQL 查询参数 |
+| `Meta` | 元数据通用模型 |
+| `Datasource` | 数据源模型 |
+| `DataTable` | 数据表模型 |
+| `Dataset` | 数据集模型 |
+| `Metrics` | 指标模型 |
+| `Report` | 报表模型 |
+| `Widget` | 组件模型 |
+| `Workflow` | 工作流模型 |
+| `Alarm` | 告警模型 |
+| `Hazard` | 隐患模型 |
+| `Api` | API 模型 |
+| `Dict` | 字典模型 |
+| `Skill` | 技能模型 |
+| `Ref` | 引用模型 |
+
+### services — 平台操作
+
+每个服务模块对应一类实体的操作，提供 `list`、`detail` 等通用接口：
+
+- `service_*_list` — 列表查询
+- `service_*_detail` — 详情查询
+- `service_*_create` — 创建
+- `service_*_update` — 更新
+- `service_*_delete` — 删除
+
+## 依赖
+
+- Python >= 3.11
+- pydantic >= 2
+- httpx2 >= 2.5.0
+- pydantic-settings >= 2.14.2
+- jinja2 >= 3.1.6
+- cryptography >= 49.0.0
+
+## 可选依赖 (runner)
+
+- paramiko > 4 — 文件传输
+- pandas — 数据分析
+- sqlalchemy / pymysql / doris-python / oracledb — 关系数据库
+- neo4j — 图数据库
+- kafka-python > 3 — 队列驱动

dataops_sdk-0.4.0/README.md

@@ -0,0 +1,85 @@
+# dataops-sdk
+
+Python SDK for the DataOps platform.
+
+## 安装
+
+```bash
+# 基础安装
+pip install dataops_sdk
+
+# 含数据库驱动
+pip install "dataops_sdk[runner]"
+```
+
+## 快速开始
+
+```python
+from dataops_sdk.session import configure
+from dataops_sdk.services import service_list_tables, service_get_table_data_by_code
+
+# 配置认证
+configure(base_url="https://your-platform.com", api_key="your-api-key")
+
+# 查询数据表
+tables = service_list_tables("doris")
+print(tables)
+```
+
+## 核心模块
+
+### session — 认证配置
+
+```python
+from dataops_sdk.session import configure, get_session
+
+configure(base_url, api_key)  # 设置全局会话
+```
+
+### schemas — 数据模型
+
+| 模块 | 说明 |
+|------|------|
+| `MetaType` | 元数据类型枚举 |
+| `SqlQueryParam` | SQL 查询参数 |
+| `Meta` | 元数据通用模型 |
+| `Datasource` | 数据源模型 |
+| `DataTable` | 数据表模型 |
+| `Dataset` | 数据集模型 |
+| `Metrics` | 指标模型 |
+| `Report` | 报表模型 |
+| `Widget` | 组件模型 |
+| `Workflow` | 工作流模型 |
+| `Alarm` | 告警模型 |
+| `Hazard` | 隐患模型 |
+| `Api` | API 模型 |
+| `Dict` | 字典模型 |
+| `Skill` | 技能模型 |
+| `Ref` | 引用模型 |
+
+### services — 平台操作
+
+每个服务模块对应一类实体的操作，提供 `list`、`detail` 等通用接口：
+
+- `service_*_list` — 列表查询
+- `service_*_detail` — 详情查询
+- `service_*_create` — 创建
+- `service_*_update` — 更新
+- `service_*_delete` — 删除
+
+## 依赖
+
+- Python >= 3.11
+- pydantic >= 2
+- httpx2 >= 2.5.0
+- pydantic-settings >= 2.14.2
+- jinja2 >= 3.1.6
+- cryptography >= 49.0.0
+
+## 可选依赖 (runner)
+
+- paramiko > 4 — 文件传输
+- pandas — 数据分析
+- sqlalchemy / pymysql / doris-python / oracledb — 关系数据库
+- neo4j — 图数据库
+- kafka-python > 3 — 队列驱动

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/pyproject.toml

@@ -7,6 +7,7 @@ name = "dataops-sdk"
 dynamic = ["version"]
 description = "Python SDK for the DataOps platform."
 requires-python = ">=3.11"
+readme = "README.md"
 dependencies = [
     "pydantic>=2,<3",
     "pydantic-core",

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/__init__.py

@@ -67,9 +67,7 @@ from .services import (  # noqa: F401
     service_get_table_detail_by_code,
     service_get_table_detail_by_name,
     service_get_table_list_by_code,
-    service_get_table_record_by_id,
     service_get_table_records_by_code,
-    service_get_table_reference_list,
     service_get_table_total_by_code,
     service_get_widget_data_by_code,
     service_get_widget_detail_by_code,
@@ -109,4 +107,4 @@ from .services import (  # noqa: F401
 )
 from .session import dataops_base_url_context, request_context
 
-__version__ = "0.3.5"
+__version__ = "0.4.0"

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/runner/utils/__init__.py

@@ -19,7 +19,14 @@ Example:
     >>> from dataops_sdk.runner.utils import DatabaseConn, encrypt_body
 """
 
-from .common import decrypt_body, encrypt_body, generate_uuid, parse_args, print_json
+from .common import (
+    decrypt_body,
+    encrypt_body,
+    generate_uuid,
+    parse_args,
+    parse_trigger_time,
+    print_json,
+)
 from .dbConn_sync import DatabaseConn
 from .ftp_file_transfer import FTPFileTransfer
 from .nacos import get_service_instance
@@ -39,4 +46,5 @@ __all__ = [
     "FTPFileTransfer",
     "SFTPFileTransfer",
     "parse_args",
+    "parse_trigger_time",
 ]

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/__init__.py

@@ -14,10 +14,18 @@ from .alarm import (
     AlarmSpecItem,
 )
 from .api import ApiMeta, HttpInterfaceData
+from .common import DataOpsResponse
 from .data_table import DataTableData, MetaDataTable
 from .datasource import DataDataSource
 from .dict_ import DataDict, DictItem
-from .enums import InnerMetaType, MetaType
+from .enums import (
+    InnerMetaType,
+    MetaSkillFileSubType,
+    MetaSkillSubType,
+    MetaTemplateSubType,
+    MetaType,
+    MetaWidgetSubType,
+)
 from .group import GroupNode
 from .hazard import HazardRecordDTO, HazardTaskDTO
 from .meta import (
@@ -26,10 +34,11 @@ from .meta import (
     Meta,
     MetaBase,
     MetaCreate,
+    MetaPageData,
     MetaRef,
     MetaUpdate,
 )
-from .query import PageParam, SqlCondition, SqlQueryParam, SqlSort
+from .query import PageParam, SqlCondition, SqlFilter, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
 from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
 from .table import (

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

@@ -0,0 +1,11 @@
+from typing import Annotated, Generic, TypeVar
+
+from pydantic import BaseModel, Field, JsonValue, 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.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/data_table.py

@@ -410,7 +410,7 @@ class DataTableField(BaseModel):
 
     title: Annotated[str | None, Field(description="显示标题")]
     name: Annotated[str, Field(description="字段名称/列名 (前端显示的名称)")]
-    type: Annotated[str, Field(description="字段类型")]
+    type: Annotated[str | None, Field(description="字段类型")] = None
 
     # 数据属性
     pk: Annotated[bool, Field(description="是否主键")] = False
@@ -608,7 +608,7 @@ class DataTableData(BaseModel):
     """
 
     # 模型配置
-    model: Annotated[DataTableModel, Field(description="数据源模型配置")]
+    model: Annotated[DataTableModel | None, Field(description="数据源模型配置")] = None
 
     # 字段定义
     fields: Annotated[list[DataTableField], Field(description="字段列表", default_factory=list)] = (
@@ -641,6 +641,8 @@ class DataTableData(BaseModel):
     querys: Annotated[list[QueryCondition] | None, Field(description="查询条件列表")] = None
     query_form: Annotated[QueryForm | None, Field(description="查询表单配置")] = None
 
+    model_config = ConfigDict(extra="allow")
+
 
 # ---------------------------------------------------------------------------
 # MetaDataTable

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/enums.py

@@ -76,17 +76,17 @@ class SqlExpression(StrEnum):
     用于查询条件构造，对应后端 ``SqlExpression``。
     """
 
-    EQ = "="
+    EQ = "eq"
     """相等 (=)。"""
-    NE = "!="
+    NE = "ne"
     """不相等 (!=)。"""
-    GT = ">"
+    GT = "gt"
     """大于 (>)。"""
-    GE = ">="
+    GE = "ge"
     """大于等于 (>=)。"""
-    LT = "<"
+    LT = "lt"
     """小于 (<)。"""
-    LE = "<="
+    LE = "le"
     """小于等于 (<=)。"""
     IN = "in"
     """属于 (IN)。"""
@@ -116,16 +116,16 @@ class SqlExpression(StrEnum):
         Returns:
             str: 中文标题，例如 ``"相等"``、``"属于"`` 等。
         """
-        return _EXPRESSION_TITLES[self]
+        return _EXPRESSION_TITLES[self.value]
 
 
 _EXPRESSION_TITLES: dict[str, str] = {
-    "=": "相等",
-    "!=": "不相等",
-    ">": "大于",
-    ">=": "大于等于",
-    "<": "小于",
-    "<=": "小于等于",
+    "eq": "相等",
+    "ne": "不相等",
+    "gt": "大于",
+    "ge": "大于等于",
+    "lt": "小于",
+    "le": "小于等于",
     "in": "属于",
     "notin": "不属于",
     "like": "匹配",
@@ -209,3 +209,42 @@ class ColumnType(StrEnum):
     """子表类型。"""
     STRING = "string"
     """字符串类型。"""
+
+
+class MetaWidgetSubType(StrEnum):
+    """卡片子类型枚举."""
+
+    CHART = "chart"
+    TABLE = "table"
+    DETAIL = "detail"
+    STATISTIC = "statistic"
+    STATISTIC_V2 = "statistic-v2"
+    GIS = "gis"
+    METRIC = "metric"
+    TOPOLOGY = "topology"
+    AMIS = "amis"
+
+
+class MetaTemplateSubType(StrEnum):
+    """模板子类型枚举."""
+
+    REPORT = "report"
+    PYTHON = "python"
+    JAVASCRIPT = "javascript"
+
+
+class MetaSkillSubType(StrEnum):
+    """技能子类型枚举."""
+
+    LLM = "llm"
+    API = "api"
+    REPORT = "report"
+    FORM_SAVE = "form-save"
+
+
+class MetaSkillFileSubType(StrEnum):
+    """技能子文件类型枚举."""
+
+    DOC = "doc"
+    CODE = "code"
+    IMAGE = "image"

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/meta.py

@@ -129,7 +129,7 @@ class MetaBase(BaseModel):
         str | None,
         Field(
             description="空间名称",
-            validate_alias=AliasChoices("spaceName", "space_name", "SPACE_NAME"),
+            validation_alias=AliasChoices("spaceName", "space_name", "SPACE_NAME"),
         ),
     ] = None
 
@@ -339,3 +339,14 @@ 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.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/query.py

@@ -3,6 +3,7 @@
 承载分页参数、SQL 条件、排序、过滤等查询相关模型，供 SDK services 层拼装 SQL 查询时复用。
 """
 
+from collections.abc import Sequence
 from typing import Annotated, Any, Literal
 
 from pydantic import BaseModel, Field, JsonValue
@@ -32,6 +33,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 +47,6 @@ class SqlCondition(SqlConditionBase):
     """
 
     alias: Annotated[str | None, Field(description="表别名")] = None
-    expression: Annotated[SqlExpression, Field(description="条件表达式")]
 
 
 class SqlSort(BaseModel):
@@ -59,20 +60,33 @@ class SqlSort(BaseModel):
 
     alias: Annotated[str | None, Field(description="表别名")] = None
     name: Annotated[str, Field(description="字段名")]
-    asc: Annotated[bool, Field(description="是否ASE")] = True
+    asc: Annotated[bool, Field(description="是否升序")] = True
 
 
-class SqlFilter(BaseModel):
-    """单条件过滤器，封装一个 ``SqlConditionBase``.
+class SqlFilter(SqlConditionBase):
+    """条件过滤器"""
 
-    提供 ``eq``/``ne``/``gt``/``ge``/``lt``/``le``/``in_``/``not_in``/``like``/``not_like``
-    等便捷工厂方法构造等值或不等值过滤。
+    @classmethod
+    def from_str(cls, value: str) -> "SqlFilter":
+        """解析查询参数.
 
-    Attributes:
-        condition: 基础条件。
-    """
+        Returns:
+            SqlFilter: 解析后的查询参数。
+        """
+        return cls.model_validate_json(value)
+
+    def to_condition(self, alias: str | None = None) -> SqlCondition:
+        """将过滤器转换为条件.
 
-    condition: Annotated[SqlConditionBase, Field(description="条件")]
+        Args:
+            alias: 可选表别名。
+
+        Returns:
+            SqlCondition: 转换后的条件。
+        """
+        return SqlCondition(
+            alias=alias, name=self.name, value=self.value, expression=self.expression
+        )
 
     @classmethod
     def eq(cls, name: str, value: Any):
@@ -85,7 +99,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value))
+        return cls(name=name, value=value, expression=SqlExpression.EQ)
 
     @classmethod
     def ne(cls, name: str, value: Any):
@@ -98,7 +112,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NE))
+        return cls(name=name, value=value, expression=SqlExpression.NE)
 
     @classmethod
     def gt(cls, name: str, value: Any):
@@ -111,7 +125,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.GT))
+        return cls(name=name, value=value, expression=SqlExpression.GT)
 
     @classmethod
     def ge(cls, name: str, value: Any):
@@ -124,7 +138,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.GE))
+        return cls(name=name, value=value, expression=SqlExpression.GE)
 
     @classmethod
     def lt(cls, name: str, value: Any):
@@ -137,7 +151,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LT))
+        return cls(name=name, value=value, expression=SqlExpression.LT)
 
     @classmethod
     def le(cls, name: str, value: Any):
@@ -150,7 +164,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LE))
+        return cls(name=name, value=value, expression=SqlExpression.LE)
 
     @classmethod
     def in_(cls, name: str, value: list):
@@ -163,7 +177,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.IN))
+        return cls(name=name, value=value, expression=SqlExpression.IN)
 
     @classmethod
     def not_in(cls, name: str, value: list):
@@ -176,9 +190,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(
-            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NOT_IN)
-        )
+        return cls(name=name, value=value, expression=SqlExpression.NOT_IN)
 
     @classmethod
     def like(cls, name: str, value: str):
@@ -191,9 +203,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(
-            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.LIKE)
-        )
+        return cls(name=name, value=value, expression=SqlExpression.LIKE)
 
     @classmethod
     def not_like(cls, name: str, value: str):
@@ -206,9 +216,7 @@ class SqlFilter(BaseModel):
         Returns:
             SqlFilter: 对应的过滤器实例。
         """
-        return cls(
-            condition=SqlConditionBase(name=name, value=value, expression=SqlExpression.NOT_LIKE)
-        )
+        return cls(name=name, value=value, expression=SqlExpression.NOT_LIKE)
 
 
 class SqlQueryParam(BaseModel):
@@ -222,11 +230,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):
         """追加条件.
@@ -336,7 +342,7 @@ class SqlQueryParam(BaseModel):
         )
         return self
 
-    def add_in(self, name: str, value: list, alias: str | None = None):
+    def add_in(self, name: str, value: Sequence[Any], alias: str | None = None):
         """追加 ``in`` 属于条件.
 
         Args:
@@ -352,7 +358,7 @@ class SqlQueryParam(BaseModel):
         )
         return self
 
-    def add_not_in(self, name: str, value: list, alias: str | None = None):
+    def add_not_in(self, name: str, value: Sequence[Any], alias: str | None = None):
         """追加 ``not in`` 不属于条件.
 
         Args:

{dataops_sdk-0.3.5 → dataops_sdk-0.4.0}/src/dataops_sdk/schemas/skill.py

@@ -5,23 +5,11 @@
 """
 
 from collections.abc import Mapping
-from enum import StrEnum
 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"
-
-
-class MetaSkillFileSubType(StrEnum):
-    DOC = "doc"
-    CODE = "code"
-    IMAGE = "image"
+from dataops_sdk.schemas.meta import Meta
 
 
 class DataSkill(BaseModel):
@@ -73,17 +61,6 @@ class MetaSkill(Meta[DataSkill]):
         content: 来自 ``data.markdown`` 的 Markdown 文本，若 ``data`` 为空时返回空字符串。
     """
 
-    @property
-    def content(self) -> str:
-        """便利访问：返回 markdown 文本（若存在）.
-
-        Returns:
-            str: Markdown 内容，缺失时返回空字符串。
-        """
-        if self.data is None:
-            return ""
-        return self.data.markdown or ""
-
 
 class SkillCallResult(BaseModel):
     """调用 skill 后的返回结果，对应 Java ``SkillResult``.