dataops-sdk 0.3.0__py3-none-any.whl

dataops_sdk/schemas/data_table.py

@@ -0,0 +1,437 @@
+"""多维表格 (DataTable) 的 Schema 定义.
+
+对应前端 meta.data 的完整结构定义，参考:
+- data-ops-frame-work/apps/web-data-ops/src/pages/data_table
+"""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Annotated, Any, Literal
+
+from pydantic import (
+    AliasChoices,
+    BaseModel,
+    BeforeValidator,
+    ConfigDict,
+    Field,
+    JsonValue,
+)
+
+from dataops_sdk.schemas.enums import ColumnType, SqlExpression
+
+from .meta import Meta, MetaCreate
+
+
+def insert_dict_by_none(v):
+    if v is None:
+        return {}
+    return v
+
+
+# ---------------------------------------------------------------------------
+# Field typeExt sub-models
+# ---------------------------------------------------------------------------
+
+
+class TextFieldTypeExt(BaseModel):
+    """text 类型扩展配置."""
+
+    length: Annotated[int, Field(description="最大字符数", default=200)] = 200
+    default_value: Annotated[str | None, Field(description="默认值")] = None
+
+
+class NumberFieldTypeExt(BaseModel):
+    """number 类型扩展配置."""
+
+    format: Annotated[
+        Literal[
+            "integer",
+            "thousand",
+            "thousand_decimal",
+            "decimal1",
+            "decimal2",
+            "decimal3",
+            "decimal4",
+            "decimal5",
+            "decimal6",
+            "decimal7",
+            "decimal8",
+            "decimal9",
+            "percentage",
+            "percentage_decimal",
+        ]
+        | None,
+        Field(description="数字格式"),
+    ] = None
+    length: Annotated[int | None, Field(description="数字总长度")] = None
+    decimal_place: Annotated[int | None, Field(description="小数位数")] = None
+    default_value: Annotated[float | None, Field(description="默认值")] = None
+
+
+class DateFieldTypeExt(BaseModel):
+    """date 类型扩展配置."""
+
+    format: Annotated[str | None, Field(description="显示格式，如 YYYY-MM-DD")] = None
+    default_value_type: Annotated[
+        Literal["custom", "create_time"] | None, Field(description="默认值类型")
+    ] = None
+    default_value: Annotated[str | None, Field(description="具体默认日期")] = None
+
+
+class DatetimeFieldTypeExt(BaseModel):
+    """datetime 类型扩展配置."""
+
+    format: Annotated[str | None, Field(description="显示格式")] = None
+    value_format: Annotated[str | None, Field(description="值格式")] = None
+    picker_type: Annotated[Literal["date", "datetime"] | None, Field(description="选择器类型")] = (
+        None
+    )
+    default_value_type: Annotated[
+        Literal["custom", "create_time"] | None, Field(description="默认值类型")
+    ] = None
+    default_value: Annotated[str | None, Field(description="具体默认值")] = None
+
+
+class SelectOption(BaseModel):
+    """单选/多选选项."""
+
+    id: Annotated[str, Field(description="选项ID")]
+    value: Annotated[str, Field(description="选项值")]
+    color: Annotated[str | None, Field(description="选项颜色 (hex)")] = None
+
+
+class SelectRef(BaseModel):
+    """select/reference 模式的数据源引用."""
+
+    type: Annotated[Literal["data_table"], Field(description="引用类型")]
+    code: Annotated[str, Field(description="引用的数据表编码")]
+    subtype: Annotated[Literal["field"] | None, Field(description="子类型")] = None
+    subcode: Annotated[str | None, Field(description="引用的字段ID")] = None
+
+
+class SelectFieldTypeExt(BaseModel):
+    """select 类型扩展配置 (也用于 multiSelect)."""
+
+    mode: Annotated[Literal["custom", "reference"] | None, Field(description="选项模式")] = None
+    options: Annotated[list[SelectOption] | None, Field(description="自定义选项列表")] = None
+    show_color: Annotated[bool | None, Field(description="是否显示颜色")] = None
+    ref: Annotated[SelectRef | None, Field(description="引用模式的数据源")] = None
+    default_value: Annotated[Any | None, Field(description="默认值")] = None
+
+
+class RelationRef(BaseModel):
+    """relation 字段的关联目标."""
+
+    type: Annotated[Literal["data_table", "table"], Field(description="关联类型")]
+    code: Annotated[str, Field(description="关联对象编码")]
+    value_field: Annotated[str | None, Field(description="值字段 (table类型)")] = None
+    display_field: Annotated[str | None, Field(description="显示字段 (table类型)")] = None
+
+
+class FilterCondition(BaseModel):
+    """过滤条件."""
+
+    name: Annotated[str | None, Field(description="字段名/参数名")] = None
+    expression: Annotated[SqlExpression | None, Field(description="表达式")] = None
+    value: Annotated[Any | None, Field(description="过滤值")] = None
+    value_ext: Annotated[Any | None, Field(description="扩展值")] = None
+
+
+class RelationFieldTypeExt(BaseModel):
+    """relation 类型扩展配置."""
+
+    ref: Annotated[RelationRef | None, Field(description="关联目标")] = None
+    multiple: Annotated[bool, Field(description="是否允许多选", default=False)] = False
+    range_type: Annotated[Literal["all", "filter"] | None, Field(description="可关联数据范围")] = (
+        None
+    )
+    filters: Annotated[list[FilterCondition] | None, Field(description="筛选条件")] = None
+
+
+class SubTableRef(BaseModel):
+    """subtable 关联目标."""
+
+    type: Annotated[Literal["data_table"], Field(description="关联类型")]
+    code: Annotated[str, Field(description="关联的多维表格编码")]
+
+
+class SubTableFieldSelect(BaseModel):
+    """subtable 选择显示的字段."""
+
+    name: Annotated[str, Field(description="字段名")]
+
+
+class SubTableQueryParamCondition(BaseModel):
+    """subtable 条件映射."""
+
+    source_field: Annotated[str, Field(description="源字段名")]
+    target_field: Annotated[str, Field(description="目标字段名")]
+
+
+class SubTableQueryParam(BaseModel):
+    """subtable 查询参数."""
+
+    condition_list: Annotated[
+        list[SubTableQueryParamCondition] | None, Field(description="条件映射列表")
+    ] = None
+
+
+class SubTableFieldTypeExt(BaseModel):
+    """subtable 类型扩展配置."""
+
+    ref: Annotated[SubTableRef | None, Field(description="关联的多维表格")]
+    fields: Annotated[list[SubTableFieldSelect] | None, Field(description="选择显示的字段")]
+    allow_add: Annotated[bool, Field(description="是否允许新增", default=True)] = True
+    allow_delete: Annotated[bool, Field(description="是否允许删除", default=True)] = True
+    query_param: Annotated[SubTableQueryParam | None, Field(description="查询参数")] = None
+
+
+class DictRef(BaseModel):
+    """dict 类型引用."""
+
+    type: Annotated[Literal["dict"], Field(description="引用类型")]
+    code: Annotated[str, Field(description="字典编码")]
+
+
+class DictFieldTypeExt(BaseModel):
+    """dict 类型扩展配置."""
+
+    ref: Annotated[DictRef | None, Field(description="字典引用")]
+    multiple: Annotated[bool, Field(description="是否允许多选", default=False)] = False
+
+
+class UserFieldTypeExt(BaseModel):
+    """user 类型扩展配置."""
+
+    multiple: Annotated[bool, Field(description="是否允许多选用户", default=False)] = False
+
+
+class FileFieldTypeExt(BaseModel):
+    """file 类型扩展配置."""
+
+    limit: Annotated[int, Field(description="最大文件数量", default=1)] = 1
+    accept: Annotated[str | None, Field(description="接受的文件类型")] = None
+
+
+# ---------------------------------------------------------------------------
+# FieldTypeExt discriminated union
+# ---------------------------------------------------------------------------
+
+
+class DataTableFieldTypeExt(BaseModel):
+    """联合的 typeExt 类型，兼容所有字段类型."""
+
+    text: Annotated[TextFieldTypeExt | None, Field(description="text 类型配置")] = None
+    number: Annotated[NumberFieldTypeExt | None, Field(description="number 类型配置")] = None
+    date: Annotated[DateFieldTypeExt | None, Field(description="date 类型配置")] = None
+    datetime: Annotated[DatetimeFieldTypeExt | None, Field(description="datetime 类型配置")] = None
+    select: Annotated[SelectFieldTypeExt | None, Field(description="select 类型配置")] = None
+    multi_select: Annotated[
+        SelectFieldTypeExt | None, Field(description="multiSelect 类型配置")
+    ] = None
+    relation: Annotated[RelationFieldTypeExt | None, Field(description="relation 类型配置")] = None
+    dict_type: Annotated[DictFieldTypeExt | None, Field(description="dict 类型配置")] = None
+    user: Annotated[UserFieldTypeExt | None, Field(description="user 类型配置")] = None
+    file: Annotated[FileFieldTypeExt | None, Field(description="file 类型配置")] = None
+    subtable: Annotated[SubTableFieldTypeExt | None, Field(description="subtable 类型配置")] = None
+
+
+# ---------------------------------------------------------------------------
+# Field Definition
+# ---------------------------------------------------------------------------
+
+
+class DataTableField(BaseModel):
+    """多维表格字段定义."""
+
+    id: Annotated[str | None, Field(description="字段唯一标识 (UUID)", exclude=True)] = None
+
+    dbName: Annotated[str, Field(description="字段名称/列名 (存储在数据库中的名称)")]
+    dbType: Annotated[ColumnType, Field(description="字段类型")]
+
+    title: Annotated[str | None, Field(description="显示标题")]
+    name: Annotated[str, Field(description="字段名称/列名 (前端显示的名称)")]
+    type: Annotated[str, Field(description="字段类型")]
+
+    # 数据属性
+    pk: Annotated[bool, Field(description="是否主键")] = False
+    label: Annotated[bool, Field(description="是否标签字段 (用于卡片/记录展示)")] = False
+    visible: Annotated[bool, Field(description="是否在表格中可见")] = True
+    width: Annotated[int | None, Field(description="列宽 (默认 200)")] = None
+    required: Annotated[bool, Field(description="是否必填")] = False
+
+    # 布局属性
+    fixed: Annotated[Literal["left", "right"] | None, Field(description="固定列位置")] = None
+    align: Annotated[
+        Literal["left", "center", "right"] | None, Field(description="文本对齐方式")
+    ] = None
+
+    # 默认值
+    default_value: Annotated[Any | None, Field(description="新增记录时的默认值")] = None
+
+    # 类型扩展配置
+    type_ext: Annotated[
+        Mapping[str, JsonValue],
+        BeforeValidator(insert_dict_by_none),
+        Field(description="类型扩展配置", validation_alias=AliasChoices("typeExt", "type_ext")),
+    ] = None
+
+    model_config = ConfigDict(str_to_lower=True, extra="allow")
+
+
+# ---------------------------------------------------------------------------
+# Fill Color (Conditional Styling)
+# ---------------------------------------------------------------------------
+
+
+class FillColor(BaseModel):
+    """填色规则 (条件单元格/行/列样式)."""
+
+    id: Annotated[str | None, Field(description="规则ID")] = None
+    color: Annotated[str, Field(description="填充颜色 (hex 带透明度，如 #FFCCCC)")] = ""
+    mode: Annotated[Literal["cell", "row", "column"], Field(description="填充模式")] = "cell"
+    field_id: Annotated[str | None, Field(description="字段ID (用于单元格和整行模式)")] = None
+    expression: Annotated[SqlExpression | None, Field(description="过滤表达式")] = None
+    value: Annotated[Any | None, Field(description="过滤值")] = None
+    value_ext: Annotated[Any | None, Field(description="扩展值 (用于 between 等表达式)")] = None
+
+
+# ---------------------------------------------------------------------------
+# Custom Button
+# ---------------------------------------------------------------------------
+
+
+class CustomButtonAttrs(BaseModel):
+    """自定义按钮属性."""
+
+    type: Annotated[
+        Literal["primary", "success", "warning", "danger", "info", ""] | None,
+        Field(description="按钮样式类型"),
+    ] = None
+    size: Annotated[Literal["large", "default", "small"] | None, Field(description="按钮尺寸")] = (
+        None
+    )
+    plain: Annotated[bool | None, Field(description="是否朴素按钮")] = None
+    round: Annotated[bool | None, Field(description="是否圆角按钮")] = None
+    bg: Annotated[bool | None, Field(description="是否背景按钮")] = None
+    icon: Annotated[str | None, Field(description="Lucide 图标名称")] = None
+    link: Annotated[str | None, Field(description="链接地址 (type=link)")] = None
+    target: Annotated[Literal["_self", "_blank"] | None, Field(description="打开方式")] = None
+    actions: Annotated[
+        list[Literal["create", "update", "batch_update"]] | None,
+        Field(description="允许的动作 (type=form)"),
+    ] = None
+
+
+class CustomButton(BaseModel):
+    """自定义按钮定义."""
+
+    id: Annotated[str | None, Field(description="按钮ID")] = None
+    title: Annotated[str, Field(description="按钮显示文字")]
+    type: Annotated[Literal["link", "form", "code"], Field(description="按钮类型")]
+    attrs: Annotated[CustomButtonAttrs | None, Field(description="按钮属性")] = None
+
+
+# ---------------------------------------------------------------------------
+# Query Configuration
+# ---------------------------------------------------------------------------
+
+
+class QueryCondition(BaseModel):
+    """查询条件 (公开级别)."""
+
+    id: Annotated[str | None, Field(description="条件ID")] = None
+    name: Annotated[str, Field(description="字段名")]
+    title: Annotated[str | None, Field(description="显示标题")]
+    condition: Annotated[dict[SqlExpression, Any], Field(description="条件表达式和值")] = Field(
+        default_factory=dict
+    )
+
+
+class QueryFormParams(BaseModel):
+    """查询表单布局配置."""
+
+    label_position: Annotated[Literal["left", "top"] | None, Field(description="标签对齐方式")] = (
+        None
+    )
+
+
+class QueryForm(BaseModel):
+    """查询表单配置."""
+
+    columns_each_row: Annotated[int | None, Field(description="每行列数 (1-6)")] = None
+    params: Annotated[QueryFormParams | None, Field(description="表单参数")] = None
+
+
+# ---------------------------------------------------------------------------
+# DataTableData (meta.data)
+# ---------------------------------------------------------------------------
+
+
+class DataTableModel(BaseModel):
+    """数据源模型配置."""
+
+    datasource: Annotated[str, Field(description="数据源编码")]
+    ref_code: Annotated[
+        str, Field(description="引用模型编码", validation_alias=AliasChoices("refCode", "ref_code"))
+    ]
+    ref_type: Annotated[
+        str, Field(description="引用模型类型", validation_alias=AliasChoices("refType", "ref_type"))
+    ]
+    table_name: Annotated[
+        str, Field(description="表名", validation_alias=AliasChoices("tableName", "table_name"))
+    ]
+
+
+class DataTableData(BaseModel):
+    """多维表格 meta.data 完整结构."""
+
+    # 模型配置
+    model: Annotated[DataTableModel, Field(description="数据源模型配置")]
+
+    # 字段定义
+    fields: Annotated[list[DataTableField], Field(description="字段列表", default_factory=list)] = (
+        Field(default_factory=list)
+    )
+
+    # 条件样式
+    fill_colors: Annotated[list[FillColor] | None, Field(description="填色规则列表")] = None
+
+    # 显示设置
+    line_height: Annotated[
+        Literal["default", "compact", "comfortable"] | None,
+        Field(description="行高设置"),
+    ] = None
+
+    # # 自定义按钮
+    # custom_buttons: Annotated[
+    #     list[CustomButton] | None,
+    #     Field(
+    #         description="自定义按钮列表",
+    #         validation_alias=AliasChoices("customButtons", "custom_buttons"),
+    #         default_factory=list,
+    #     ),
+    # ]
+
+    # 数据分组
+    group_field: Annotated[str | None, Field(description="分组字段名")] = None
+
+    # 查询配置
+    querys: Annotated[list[QueryCondition] | None, Field(description="查询条件列表")] = None
+    query_form: Annotated[QueryForm | None, Field(description="查询表单配置")] = None
+
+
+# ---------------------------------------------------------------------------
+# MetaDataTable
+# ---------------------------------------------------------------------------
+
+
+class MetaDataTable(Meta[DataTableData]):
+    """多维表格 Meta schema."""
+
+    pass
+
+
+class MetaCreateDataTable(MetaCreate[DataTableData]):
+    """多维表格 Meta schema."""

dataops_sdk/schemas/datasource.py

@@ -0,0 +1,26 @@
+from typing import Annotated
+
+from dataops_sdk.schemas.enums import DataSourceType
+from pydantic import BaseModel, BeforeValidator, Field
+
+
+def str_to_number(v: str):
+    assert v.isnumeric(), "must be number"
+    return int(v)
+
+
+class DataDataSource(BaseModel):
+    """Data source"""
+
+    type: Annotated[DataSourceType, Field(description="数据源类型")] = DataSourceType.MYSQL
+    port: Annotated[
+        int, BeforeValidator(str_to_number), Field(description="数据源端口", le=65535, gt=0)
+    ]
+    ip: Annotated[str, Field(description="数据源主机")]
+    username: Annotated[str, Field(description="数据源用户名")]
+    password: Annotated[str, Field(description="数据源密码")]
+    database: Annotated[str, Field(description="数据库名称")]
+
+    category: Annotated[str, Field(description="数据源分类")] = "database"
+
+    bootstrap_servers: Annotated[str | None, Field(description="kafka bootstrap servers")] = None

dataops_sdk/schemas/dict_.py

@@ -0,0 +1,13 @@
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+
+class DictItem(BaseModel):
+    id: Annotated[str, Field(description="id", exclude=True)]
+    value: Annotated[str | int, Field(description="值")]
+    label: Annotated[str, Field(description="名")]
+
+
+class DataDict(BaseModel):
+    options: Annotated[list[DictItem], Field(description="字典数据", default_factory=list)]

dataops_sdk/schemas/enums.py

@@ -0,0 +1,120 @@
+from enum import StrEnum
+
+
+class InnerMetaType(StrEnum):
+    DATASOURCE = "datasource"
+
+    def __repr__(self):
+        return self.value
+
+
+class MetaType(StrEnum):
+    # 技能
+    SKILL = "skill"
+    # 技能子文件
+    SKILL_FILE = "skill_file"
+    # 文档
+    REPORT = "report"
+    # 多维表格
+    DATA_TABLE = "data_table"
+    # 指标
+    METRICS = "metrics"
+    # 卡片
+    WIDGET = "widget"
+    # 工作流
+    WORKFLOW = "workflow"
+    # 模板
+    TEMPLATE = "template"
+    # API
+    API = "api"
+    # 表
+    TABLE = "table"
+    # 数据集
+    DATASET = "dataset"
+    # 字典
+    DICT = "dict"
+
+    def __repr__(self):
+        return self.value
+
+
+class SqlExpression(StrEnum):
+    EQ = "="
+    NE = "!="
+    GT = ">"
+    GE = ">="
+    LT = "<"
+    LE = "<="
+    IN = "in"
+    NOT_IN = "notin"
+    LIKE = "like"
+    NOT_LIKE = "notlike"
+    BETWEEN = "between"
+    NOT_BETWEEN = "notbetween"
+    IS_NULL = "isnull"
+    IS_NOT_NULL = "isnotnull"
+    EXISTS = "exists"
+    APPEND = "append"
+
+    @property
+    def title(self) -> str:
+        return _EXPRESSION_TITLES[self]
+
+
+_EXPRESSION_TITLES: dict[str, str] = {
+    "=": "相等",
+    "!=": "不相等",
+    ">": "大于",
+    ">=": "大于等于",
+    "<": "小于",
+    "<=": "小于等于",
+    "in": "属于",
+    "notin": "不属于",
+    "like": "匹配",
+    "notlike": "不匹配",
+    "between": "范围",
+    "notbetween": "不在范围",
+    "isnull": "为空",
+    "isnotnull": "不为空",
+    "exists": "存在",
+    "append": "追加",
+}
+
+
+class DataSourceType(StrEnum):
+    MYSQL = "mysql"
+    POSTGRESQL = "postgresql"
+    DORIS = "doris"
+    ORACLE = "oracle"
+    DM = "dm"
+    NEO4J = "neo4j"
+
+
+class ColumnTag(StrEnum):
+    # 核心
+    CORE = "core"
+    # 描述
+    DESC = "desc"
+    # 拓展
+    EXTEND = "extend"
+    # 技术
+    TECH = "tech"
+    # 冗余
+    REDU = "redu"
+
+
+class ColumnType(StrEnum):
+    """字段类型枚举."""
+
+    TEXT = "text"
+    NUMBER = "number"
+    DATE = "date"
+    DATETIME = "datetime"
+    SELECT = "select"
+    MULTI_SELECT = "multiSelect"
+    RELATION = "relation"
+    DICT = "dict"
+    USER = "user"
+    FILE = "file"
+    SUBTABLE = "subtable"
+    STRING = "string"

dataops_sdk/schemas/group.py

@@ -0,0 +1,40 @@
+from typing import Annotated
+
+from pydantic import AliasChoices, BaseModel, Field
+
+
+class GroupNode(BaseModel):
+    """分组节点模型.
+
+    用于表示数据源目录树中的分组节点，包含节点的基本信息
+    和层级关系。
+
+    Attributes:
+        code: 节点编码/ID
+        type: 节点类型
+        subType: 子类型（可选）
+        name: 节点名称
+        label: 中文名称
+        remark: 备注信息（可选）
+        params: 扩展参数映射（可选）
+        children: 子节点列表（可选）
+    """
+
+    code: Annotated[str, Field(description="节点", validation_alias=AliasChoices("id"))]
+    type: Annotated[str, Field(description="类型")]
+    subType: Annotated[
+        str | None,
+        Field(
+            description="子类型",
+            validation_alias=AliasChoices("subType", "sub_type"),
+            exclude=True,
+        ),
+    ]
+    name: Annotated[str, Field(description="名称")]
+    label: Annotated[str, Field(description="中文名称")]
+    remark: Annotated[str | None, Field(description="备注")]
+    params: Annotated[
+        dict[str, str | int | float | bool | None] | None,
+        Field(description="参数", exclude=True),
+    ]
+    children: Annotated[list["GroupNode"] | None, Field(description="子节点")]