data-ops-cli 0.4.4__tar.gz → 0.4.5__tar.gz

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-ops-cli
-Version: 0.4.4
+Version: 0.4.5
 Summary: Command-line wrapper around dataops_sdk for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/data_ops_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-ops-cli
-Version: 0.4.4
+Version: 0.4.5
 Summary: Command-line wrapper around dataops_sdk for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/data_ops_cli.egg-info/SOURCES.txt

@@ -24,8 +24,8 @@ src/dataops_cli/cli/datasource.py
 src/dataops_cli/cli/dict_.py
 src/dataops_cli/cli/factory.py
 src/dataops_cli/cli/hazard.py
-src/dataops_cli/cli/kb.py
 src/dataops_cli/cli/metrics.py
+src/dataops_cli/cli/ontology.py
 src/dataops_cli/cli/ref.py
 src/dataops_cli/cli/report.py
 src/dataops_cli/cli/skill.py

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/dataops_cli/__init__.py

@@ -14,4 +14,4 @@ groups command modules under :mod:`dataops_cli.cli` and re-exports the package
     removed in ``dataops_cli`` 1.0.
 """
 
-__version__ = "0.4.4"
+__version__ = "0.4.5"

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/dataops_cli/cli/data_table.py

@@ -13,8 +13,8 @@ from dataops_sdk.schemas import MetaType, PageParam, SqlFilter, SqlQueryParam
 from dataops_sdk.services import (
     service_get_data_table_by_code,
     service_get_data_table_by_name,
-    service_get_data_table_data_by_code,
-    service_get_data_table_data_by_name,
+    service_get_data_table_data_ext_by_code,
+    service_get_data_table_data_ext_by_name,
     service_get_data_table_total,
 )
 from dataops_sdk.services.meta import release_list_list
@@ -285,9 +285,9 @@ def get_datatable_data(
 
     try:
         datas = (
-            service_get_data_table_data_by_name(arg1, name, pp, qp)
+            service_get_data_table_data_ext_by_name(arg1, name, pp, qp)
             if name
-            else service_get_data_table_data_by_code(arg1, pp, qp)
+            else service_get_data_table_data_ext_by_code(arg1, pp, qp)
         )
     except DataOpsError as e:
         typer.echo(f"错误: {e.message}", err=True)

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/dataops_cli/cli/dataset.py

@@ -1,40 +1,29 @@
 """数据集管理命令组.
 
-提供数据集的列表查询、详情、数据量统计与实际数据获取。
+提供数据集的列表查询、详情、数据量统计与实际数据获取能力。
 """
 
-from pathlib import Path
 from typing import Annotated
 
 import typer
-from pydantic_core import to_json
-
 from dataops_sdk.exceptions import DataOpsError
-from dataops_sdk.schemas import MetaType, PageParam, SqlFilter, SqlQueryParam
+from dataops_sdk.schemas import PageParam, SqlFilter, SqlQueryParam
 from dataops_sdk.services import (
-    release_list_get_by_code,
     release_list_update,
     service_count_dataset_by_code,
     service_get_dataset_data_by_code,
     service_get_dataset_detail_by_code,
     service_list_datasets,
 )
-from dataops_sdk.session import get_session
-from dataops_sdk.utils import encrypt_body, filter_nodes_by_pattern
+from dataops_sdk.utils import filter_nodes_by_pattern
 
 from dataops_cli.cli.utils import print_list, print_table_column_detail
 
-# 数据集 rawData 中承载 SQL 定义的字段名（subType=sql 的数据集均有此字段）。
-SQL_FIELD = "text"
-
-
 dataset_typer = typer.Typer(name="dataset", help="Manage dataset.", no_args_is_help=True)
 update_typer = typer.Typer(name="update", help="变更", no_args_is_help=True)
 dataset_typer.add_typer(update_typer)
 column_typer = typer.Typer(name="column", help="列变更", no_args_is_help=True)
 update_typer.add_typer(column_typer)
-sql_typer = typer.Typer(name="sql", help="SQL 编辑", no_args_is_help=True)
-update_typer.add_typer(sql_typer)
 
 
 @dataset_typer.command("list")
@@ -252,84 +241,3 @@ def update_dataset_column(
         typer.echo(f"错误: {e.message}")
         raise typer.Exit(code=1) from None
     typer.echo(f"修改数据集 {code} 字段 {column_item.name} 完成")
-
-
-def _load_sql(code: str):
-    """校验数据集存在 SQL 字段并返回 Meta；失败统一报错退出."""
-    try:
-        meta = release_list_get_by_code(MetaType.DATASET, code)
-    except DataOpsError as e:
-        typer.echo(f"错误: {e.message}", err=True)
-        raise typer.Exit(code=1) from None
-    data = meta.data
-    if not isinstance(data, dict) or not isinstance(data.get(SQL_FIELD), str):
-        typer.echo(f"数据集 {code} 未找到 SQL 字段({SQL_FIELD})", err=True)
-        raise typer.Exit(code=1)
-    return meta
-
-
-def _save_sql(meta, sql: str) -> None:
-    """整段替换 SQL 并保存：先解析字段回填 columns（失败仅警告），保存失败统一报错."""
-    meta.data[SQL_FIELD] = sql
-    try:
-        meta_payload = meta.model_dump(mode="json", exclude={"data"})
-        meta_payload["rawData"] = to_json(meta.data).decode()
-        with get_session() as session:
-            resp = session.post(
-                "/data/dataset/analysis",
-                content=to_json(encrypt_body({"meta": meta_payload, "params": []})),
-            )
-            resp.raise_for_status()
-            meta.data["columns"] = resp.json()["data"]["columns"]
-            typer.echo(f"字段解析完成（{len(meta.data['columns'])} 列）")
-    except Exception as e:
-        typer.echo(f"⚠️ 字段解析失败，仅保存 SQL: {e}", err=True)
-    try:
-        release_list_update(meta)
-    except DataOpsError as e:
-        typer.echo(f"错误: {e.message}", err=True)
-        raise typer.Exit(code=1) from None
-
-
-@sql_typer.command("edit", no_args_is_help=True)
-def edit_dataset_sql(
-    code: Annotated[str, typer.Argument(help="数据集编码")],
-    old_texts: Annotated[
-        list[str],
-        typer.Option("--old-text", help="待替换文本（可多次传入，与 --new-text 一一对应）"),
-    ],
-    new_texts: Annotated[
-        list[str],
-        typer.Option("--new-text", help="替换后的文本（与 --old-text 一一对应）"),
-    ],
-) -> None:
-    """按 --old-text/--new-text 成对精准替换 SQL 文本."""
-    if len(old_texts) != len(new_texts):
-        typer.echo("参数 --old-text 与 --new-text 数量不一致", err=True)
-        raise typer.Exit(code=1)
-    meta = _load_sql(code)
-    content = meta.data[SQL_FIELD]
-    for idx, (old, new) in enumerate(zip(old_texts, new_texts), start=1):
-        if old not in content:
-            typer.echo(f"[{idx}] 未找到匹配文本 {old}", err=True)
-            raise typer.Exit(code=1)
-        content = content.replace(old, new, count=1)
-    _save_sql(meta, content)
-    typer.echo(f"数据集 {code} SQL 更新成功")
-
-
-@sql_typer.command("write", no_args_is_help=True)
-def write_dataset_sql(
-    code: Annotated[str, typer.Argument(help="数据集编码")],
-    file: Annotated[Path | None, typer.Argument(help="输入文件路径")] = None,
-    content: Annotated[str | None, typer.Option("--content", help="SQL 内容")] = None,
-) -> None:
-    """整段写入 SQL，file 与 --content 至少指定一个."""
-    if file:
-        content = file.read_text(encoding="utf-8")
-    elif not content:
-        typer.echo("参数 file 或 --content 必须指定一个", err=True)
-        raise typer.Exit(code=1)
-    meta = _load_sql(code)
-    _save_sql(meta, content)
-    typer.echo(f"数据集 {code} SQL 写入成功")

data_ops_cli-0.4.5/src/dataops_cli/cli/dict_.py

@@ -0,0 +1,119 @@
+"""字典（dict）管理命令组.
+
+提供数据源字典的列表查询与详情查看能力。
+"""
+
+from typing import Annotated
+
+import typer
+from dataops_sdk.exceptions import DataOpsError
+from dataops_sdk.services.dict_ import (
+    service_get_dict_detail_by_code,
+    service_get_dict_detail_by_name,
+    service_list_dicts,
+    servive_tree_dict,
+)
+from dataops_sdk.utils import filter_nodes_by_pattern
+
+from dataops_cli.cli.utils import print_group_tree, print_list
+
+dict_typer = typer.Typer(name="dict", help="Manage dict.", no_args_is_help=True)
+
+
+@dict_typer.command("list")
+def list_dict(
+    datasource: Annotated[str, typer.Argument(help="数据源")],
+    query: Annotated[str | None, typer.Option("-q", "--query", help="字典名称关键字")] = None,
+) -> None:
+    """列出数据源中的字典列表。
+
+    支持通过关键字过滤字典名称，并支持正则表达式匹配。
+
+    Args:
+        datasource: 数据源名称。
+        query: 可选字典名称关键字（支持正则）。
+
+    Examples:
+        # 列出指定数据源的所有字典
+        >>> data-ops-cli dict list <datasource>
+
+        # 列出数据源中名称包含 "user" 的字典
+        >>> data-ops-cli dict list <datasource> -q user
+
+        # 使用正则过滤字典名
+        >>> data-ops-cli dict list <datasource> -q "^user_.*"
+    """
+    try:
+        group_nodes = service_list_dicts(datasource)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    if not group_nodes:
+        print("未查询到匹配字典")
+        return
+
+    if query:
+        group_nodes = filter_nodes_by_pattern(group_nodes, query)
+
+    print_list(
+        ["code", "name", "alias"],
+        [[column.code, column.name, column.title] for column in group_nodes],
+    )
+
+
+@dict_typer.command("detail", no_args_is_help=True)
+def get_dict_detail(
+    arg1: Annotated[str, typer.Argument(help="编码或数据源")],
+    name: Annotated[str | None, typer.Argument(help="字典名称")] = None,
+    # full: Annotated[bool, typer.Option("--full", help="是否显示完整信息")] = False,
+) -> None:
+    """获取字典详情信息。
+
+    支持两种查询方式:
+
+    1. 通过字典编码(CODE)直接查询
+    2. 通过数据源名称和字典名称组合查询
+
+    默认只显示字典选项的基本信息(label/value)
+
+    Args:
+        arg1: 字典编码；当同时提供 ``name`` 时为数据源名称。
+        name: 可选字典名称。
+        full: 是否显示完整信息。
+
+    Examples:
+        # 通过字典编码查询字典结构
+        >>> data-ops-cli dict detail dict_code_123
+
+        # 通过数据源和字典名查询
+        >>> data-ops-cli dict detail <datasource> my_dict
+    """
+    try:
+        meta = (
+            service_get_dict_detail_by_name(arg1, name)
+            if name
+            else service_get_dict_detail_by_code(arg1)
+        )
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+    print(f"{meta.name}({meta.title})")
+    print_list(["value", "label"], [[option.value, option.label] for option in meta.data.options])
+
+
+@dict_typer.command("tree")
+def tree_dict(
+    query: Annotated[str | None, typer.Option("-q", "--query", help="字典名称关键字")] = None,
+) -> None:
+    """展示字典树结构。
+
+    Args:
+        query: 字典名称关键字（支持正则）。
+    """
+    try:
+        tree = servive_tree_dict()
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+    print_group_tree(tree, query)

{data_ops_cli-0.4.4 → data_ops_cli-0.4.5}/src/dataops_cli/cli/factory.py

@@ -53,8 +53,8 @@ def create_app():
     from dataops_cli.cli.datasource import datasource_typer
     from dataops_cli.cli.dict_ import dict_typer
     from dataops_cli.cli.hazard import hazard_typer
-    from dataops_cli.cli.kb import kb_typer
     from dataops_cli.cli.metrics import metrics_typer
+    from dataops_cli.cli.ontology import ontology_typer
     from dataops_cli.cli.ref import ref_typer
     from dataops_cli.cli.report import report_typer
     from dataops_cli.cli.skill import skill_typer
@@ -79,11 +79,12 @@ def create_app():
     app.add_typer(report_typer)
     app.add_typer(skill_typer)
     app.add_typer(metrics_typer)
+    app.add_typer(ontology_typer)
     app.add_typer(data_table_typer)
     app.add_typer(widget_typer)
     app.add_typer(dict_typer)
     app.add_typer(hazard_typer)
-    app.add_typer(kb_typer)
+    # app.add_typer(kb_typer)  # TODO: kb CLI 尚未实现
     app.add_typer(tag_typer)
 
     app.registered_callback = TyperInfo(callback=main)

data_ops_cli-0.4.5/src/dataops_cli/cli/ontology.py

@@ -0,0 +1,291 @@
+"""本体（Ontology）管理命令组.
+
+提供本体的目录树、列表、配置详情与分段更新。
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Annotated, Any
+
+import typer
+from dataops_sdk.exceptions import DataOpsError
+from dataops_sdk.services.ontology import (
+    service_get_ontology_by_code,
+    service_get_ontology_by_name,
+    service_list_ontologies,
+    service_tree_ontology,
+    service_update_ontology_basic,
+    service_update_ontology_constraints,
+    service_update_ontology_notes,
+    service_update_ontology_relations,
+)
+
+from dataops_cli.cli.utils import print_group_tree, print_list
+
+ontology_typer = typer.Typer(name="ontology", help="本体管理", no_args_is_help=True)
+update_typer = typer.Typer(name="update", help="更新本体配置", no_args_is_help=True)
+ontology_typer.add_typer(update_typer)
+
+
+def _read_json_payload(
+    file: Path | None,
+    content: str | None,
+) -> Any:
+    """从 ``--file`` 或 ``--content`` 读取 JSON（二选一）."""
+    if not file and content is None:
+        typer.echo("参数 --file 或 --content 必须指定一个", err=True)
+        raise typer.Exit(code=1)
+    if file and content is not None:
+        typer.echo("参数 --file 与 --content 不能同时指定", err=True)
+        raise typer.Exit(code=1)
+    if file:
+        try:
+            text = file.read_text(encoding="utf-8")
+        except OSError as e:
+            typer.echo(f"错误: 无法读取文件 {file}: {e}", err=True)
+            raise typer.Exit(code=1) from None
+    else:
+        text = content or ""
+    try:
+        return json.loads(text)
+    except json.JSONDecodeError as e:
+        typer.echo(f"错误: JSON 解析失败: {e}", err=True)
+        raise typer.Exit(code=1) from None
+
+
+def _read_text_payload(
+    file: Path | None,
+    content: str | None,
+) -> str:
+    """从 ``--file`` 或 ``--content`` 读取文本（二选一）."""
+    if not file and content is None:
+        typer.echo("参数 --file 或 --content 必须指定一个", err=True)
+        raise typer.Exit(code=1)
+    if file and content is not None:
+        typer.echo("参数 --file 与 --content 不能同时指定", err=True)
+        raise typer.Exit(code=1)
+    if file:
+        try:
+            return file.read_text(encoding="utf-8")
+        except OSError as e:
+            typer.echo(f"错误: 无法读取文件 {file}: {e}", err=True)
+            raise typer.Exit(code=1) from None
+    return content or ""
+
+
+@ontology_typer.command("list")
+def list_ontologies(
+    query: Annotated[str | None, typer.Option("-q", "--query", help="正则关键词")] = None,
+) -> None:
+    """列出所有本体。
+
+    Examples:
+        >>> data-ops-cli ontology list
+        >>> data-ops-cli ontology list -q "^dev_.*"
+    """
+    try:
+        items = service_list_ontologies(query=query)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    if not items:
+        print("未查询到匹配的本体")
+        return
+
+    print_list(
+        ["code", "name", "title", "remark"],
+        [[item.code, item.name, item.title, item.remark or ""] for item in items],
+    )
+
+
+@ontology_typer.command("detail", no_args_is_help=True)
+def detail_ontology(
+    name: Annotated[str, typer.Argument(help="本体编码或业务名")],
+    raw: Annotated[bool, typer.Option("--raw", help="仅输出 rawData JSON")] = False,
+) -> None:
+    """查看本体配置详情。
+
+    默认输出摘要；加 ``--raw`` 时输出完整 ``meta.data`` JSON。
+
+    Examples:
+        >>> data-ops-cli ontology detail dev_ne
+        >>> data-ops-cli ontology detail dev_ne --raw
+    """
+    try:
+        meta = service_get_ontology_by_name(name)
+    except DataOpsError:
+        try:
+            meta = service_get_ontology_by_code(name)
+        except DataOpsError as e:
+            typer.echo(f"错误: {e.message}")
+            raise typer.Exit(code=1) from None
+
+    if meta.data is None:
+        typer.echo(f"错误: 本体({name})不存在")
+        raise typer.Exit(code=1) from None
+
+    if raw:
+        print(meta.data.model_dump_json(mode="json"))
+        return
+
+    data = meta.data
+    print(f"本体: {meta.name} ({meta.title})")
+    print(f"备注: {meta.remark or '-'}")
+    print(f"多维表格: {data.data_table or '-'}")
+    print(f"场景数: {len(data.scenarios)}")
+    print(f"约束数: {len(data.constraints)}")
+    print(f"关系数: {len(data.relations)}")
+    if data.notes:
+        print(f"\n说明:\n{data.notes}")
+
+
+@ontology_typer.command("tree")
+def tree_ontology(
+    query: Annotated[str | None, typer.Option("-q", "--query", help="节点关键字")] = None,
+    types: Annotated[
+        list[str] | None,
+        typer.Option("--type", "-t", help="节点类型过滤 (group/ontology)"),
+    ] = None,
+) -> None:
+    """展示本体目录树。
+
+    Examples:
+        >>> data-ops-cli ontology tree
+        >>> data-ops-cli ontology tree -q dev
+    """
+    try:
+        tree = service_tree_ontology()
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+    print_group_tree(tree, query, types=types)
+
+
+@update_typer.command("basic", no_args_is_help=True)
+def update_basic(
+    name: Annotated[str, typer.Argument(help="本体编码或业务名")],
+    new_name: Annotated[
+        str | None,
+        typer.Option("--name", help="新业务名（英文字母开头，仅字母数字下划线）"),
+    ] = None,
+    title: Annotated[str | None, typer.Option("--title", help="中文标题")] = None,
+    remark: Annotated[str | None, typer.Option("--remark", help="备注/描述")] = None,
+    data_table: Annotated[
+        str | None,
+        typer.Option("--data-table", help="绑定的多维表格编码"),
+    ] = None,
+) -> None:
+    """更新本体基础配置（title / remark / name / data_table）。
+
+    仅覆盖显式传入的字段；至少一个选项必填。
+
+    Examples:
+        >>> data-ops-cli ontology update basic dev_ne --title "网元" --data-table dt_ne
+        >>> data-ops-cli ontology update basic dev_ne --name dev_ne_v2 --remark "传输网元"
+    """
+    if new_name is None and title is None and remark is None and data_table is None:
+        typer.echo("请至少指定一个要更新的字段（--name/--title/--remark/--data-table）", err=True)
+        raise typer.Exit(code=1)
+    try:
+        result = service_update_ontology_basic(
+            name,
+            title=title,
+            remark=remark,
+            name=new_name,
+            data_table=data_table,
+        )
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}", err=True)
+        raise typer.Exit(code=1) from None
+    typer.echo(f"本体 {result.name} 基础配置更新成功")
+
+
+@update_typer.command("constraints", no_args_is_help=True)
+def update_constraints(
+    name: Annotated[str, typer.Argument(help="本体编码或业务名")],
+    file: Annotated[
+        Path | None,
+        typer.Option("--file", "-f", help="约束 JSON 文件路径（数组）"),
+    ] = None,
+    content: Annotated[
+        str | None,
+        typer.Option("--content", "-c", help="约束 JSON 内容（数组）"),
+    ] = None,
+) -> None:
+    """全量替换本体约束列表。
+
+    Examples:
+        >>> data-ops-cli ontology update constraints dev_ne --file constraints.json
+        >>> data-ops-cli ontology update constraints dev_ne --content '[{"type":"唯一","rule":"code唯一"}]'
+    """
+    payload = _read_json_payload(file, content)
+    if not isinstance(payload, list):
+        typer.echo("错误: 约束内容必须是 JSON 数组", err=True)
+        raise typer.Exit(code=1)
+    try:
+        result = service_update_ontology_constraints(name, payload)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}", err=True)
+        raise typer.Exit(code=1) from None
+    assert result.data is not None
+    typer.echo(f"本体 {result.name} 约束已更新（共 {len(result.data.constraints)} 条）")
+
+
+@update_typer.command("notes", no_args_is_help=True)
+def update_notes(
+    name: Annotated[str, typer.Argument(help="本体编码或业务名")],
+    file: Annotated[
+        Path | None,
+        typer.Option("--file", "-f", help="说明文本文件路径"),
+    ] = None,
+    content: Annotated[
+        str | None,
+        typer.Option("--content", "-c", help="说明文本内容"),
+    ] = None,
+) -> None:
+    """全量替换本体其他说明。
+
+    Examples:
+        >>> data-ops-cli ontology update notes dev_ne --content "说明文本"
+        >>> data-ops-cli ontology update notes dev_ne --file notes.md
+    """
+    text = _read_text_payload(file, content)
+    try:
+        result = service_update_ontology_notes(name, text)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}", err=True)
+        raise typer.Exit(code=1) from None
+    typer.echo(f"本体 {result.name} 其他说明已更新")
+
+
+@update_typer.command("relations", no_args_is_help=True)
+def update_relations(
+    name: Annotated[str, typer.Argument(help="本体编码或业务名")],
+    file: Annotated[
+        Path | None,
+        typer.Option("--file", "-f", help="关系 JSON 文件路径（数组）"),
+    ] = None,
+    content: Annotated[
+        str | None,
+        typer.Option("--content", "-c", help="关系 JSON 内容（数组）"),
+    ] = None,
+) -> None:
+    """全量替换本体关联关系列表。
+
+    Examples:
+        >>> data-ops-cli ontology update relations dev_ne --file relations.json
+    """
+    payload = _read_json_payload(file, content)
+    if not isinstance(payload, list):
+        typer.echo("错误: 关系内容必须是 JSON 数组", err=True)
+        raise typer.Exit(code=1)
+    try:
+        result = service_update_ontology_relations(name, payload)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}", err=True)
+        raise typer.Exit(code=1) from None
+    assert result.data is not None
+    typer.echo(f"本体 {result.name} 关联关系已更新（共 {len(result.data.relations)} 条）")