data-ops-cli 0.2.3__tar.gz → 0.3.0__tar.gz

data_ops_cli-0.3.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: data-ops-cli
+Version: 0.3.0
+Summary: Command-line wrapper around dataops_sdk for the DataOps platform.
+Requires-Python: >=3.11
+Requires-Dist: dataops_sdk[runner]<1.0,>=0.1.0
+Requires-Dist: typer
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"

data_ops_cli-0.3.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "data-ops-cli"
+dynamic = ["version"]
+description = "Command-line wrapper around dataops_sdk for the DataOps platform."
+requires-python = ">=3.11"
+dependencies = [
+    "dataops_sdk[runner]>=0.1.0,<1.0",
+    "typer",
+    "rich",
+]
+
+[project.scripts]
+data-ops-cli = "dataops_cli.cli:app"
+
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]
+
+[tool.uv.sources]
+dataops_sdk = { workspace = true }
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "dataops_cli.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["dataops_cli*"]
+
+[tool.setuptools.package-data]
+dataops_cli = ["py.typed"]

data_ops_cli-0.3.0/src/data_ops_cli.egg-info/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: data-ops-cli
+Version: 0.3.0
+Summary: Command-line wrapper around dataops_sdk for the DataOps platform.
+Requires-Python: >=3.11
+Requires-Dist: dataops_sdk[runner]<1.0,>=0.1.0
+Requires-Dist: typer
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"

data_ops_cli-0.3.0/src/data_ops_cli.egg-info/SOURCES.txt

@@ -0,0 +1,33 @@
+pyproject.toml
+src/data_ops_cli.egg-info/PKG-INFO
+src/data_ops_cli.egg-info/SOURCES.txt
+src/data_ops_cli.egg-info/dependency_links.txt
+src/data_ops_cli.egg-info/entry_points.txt
+src/data_ops_cli.egg-info/requires.txt
+src/data_ops_cli.egg-info/top_level.txt
+src/dataops_cli/__init__.py
+src/dataops_cli/_compat.py
+src/dataops_cli/exceptions.py
+src/dataops_cli/runner.py
+src/dataops_cli/schems.py
+src/dataops_cli/sdk.py
+src/dataops_cli/session.py
+src/dataops_cli/utils.py
+src/dataops_cli/cli/__init__.py
+src/dataops_cli/cli/alarm.py
+src/dataops_cli/cli/api.py
+src/dataops_cli/cli/auth.py
+src/dataops_cli/cli/data_table.py
+src/dataops_cli/cli/dataset.py
+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/metrics.py
+src/dataops_cli/cli/ref.py
+src/dataops_cli/cli/report.py
+src/dataops_cli/cli/skill.py
+src/dataops_cli/cli/table.py
+src/dataops_cli/cli/utils.py
+src/dataops_cli/cli/widget.py
+src/dataops_cli/cli/workflow.py

data_ops_cli-0.3.0/src/data_ops_cli.egg-info/requires.txt

@@ -0,0 +1,7 @@
+dataops_sdk[runner]<1.0,>=0.1.0
+typer
+rich
+
+[dev]
+pytest
+ruff

data_ops_cli-0.3.0/src/dataops_cli/__init__.py

@@ -0,0 +1,11 @@
+"""CLI package for DataOps.
+
+.. deprecated::
+    Importing ``dataops_cli.sdk`` / ``dataops_cli.schems`` / ``dataops_cli.runner`` /
+    ``dataops_cli.exceptions`` / ``dataops_cli.session`` / ``dataops_cli.utils`` directly
+    is deprecated; use the new ``dataops_sdk`` package instead. The CLI itself
+    (``dataops_cli.cli``) is unchanged. The deprecation shims will be removed in
+    ``dataops_cli`` 1.0.
+"""
+
+__version__ = "0.3.0"

data_ops_cli-0.3.0/src/dataops_cli/_compat.py

@@ -0,0 +1,53 @@
+"""Build a deprecation-shim module via PEP 562 ``__getattr__``.
+
+Each top-level shim (``dataops_cli.sdk`` / ``dataops_cli.schems`` / ...) is a tiny
+file whose body is a single call to :func:`make_shim`. The returned namespace
+exposes ``__all__`` and a ``__getattr__`` that proxies to the underlying
+``dataops_sdk`` module while emitting a single ``DeprecationWarning`` per
+attribute name (so logging stays bounded).
+
+Removed in ``dataops_cli`` 1.0.
+"""
+
+from __future__ import annotations
+
+import importlib
+import sys
+import warnings
+from types import ModuleType
+from typing import Any
+
+_OLD_TO_NEW = {
+    "dataops_cli.sdk": "dataops_sdk.services",
+    "dataops_cli.schems": "dataops_sdk.schemas",
+    "dataops_cli.runner": "dataops_sdk.runner",
+    "dataops_cli.exceptions": "dataops_sdk.exceptions",
+    "dataops_cli.session": "dataops_sdk.session",
+    "dataops_cli.utils": "dataops_sdk.utils",
+}
+
+
+def make_shim(old_path: str) -> ModuleType:
+    """Create (and register in ``sys.modules``) a shim module proxying to ``new_path``."""
+    new_path = _OLD_TO_NEW[old_path]
+    target = importlib.import_module(new_path)
+    warned: set[str] = set()
+
+    def __getattr__(name: str) -> Any:
+        if name not in warned:
+            warned.add(name)
+            warnings.warn(
+                f"Importing '{name}' from '{old_path}' is deprecated; "
+                f"import it from '{new_path}' instead. "
+                "This shim will be removed in dataops_cli 1.0.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return getattr(target, name)
+
+    module = ModuleType(old_path)
+    module.__getattr__ = __getattr__  # type: ignore[attr-defined]
+    module.__all__ = getattr(target, "__all__", [])  # type: ignore[attr-defined]
+    module.__dir__ = lambda: list(dir(target))  # type: ignore[attr-defined]
+    sys.modules[old_path] = module
+    return module

data_ops_cli-0.3.0/src/dataops_cli/cli/alarm.py

@@ -0,0 +1,381 @@
+"""告警管理模块.
+
+提供告警规则的查询与配置能力，覆盖后端 /alarm/rule/* 接口。
+
+- 服务层函数 (service_*)：纯 Python 接口，返回原始数据
+- CLI 命令：基于服务层的薄包装，负责格式化输出
+"""
+
+import json
+from typing import Annotated, Any, Optional
+
+import typer
+from pydantic_core import to_json
+from rich.console import Console
+from rich.table import Table
+
+from dataops_cli.cli.utils import print_list
+from dataops_sdk.exceptions import DataOpsError
+from dataops_sdk.schemas.query import SqlQueryParam
+from dataops_sdk.services.alarm import (
+    service_count_alarm_action,
+    service_count_alarm_rule_matches,
+    service_count_alarm_rules,
+    service_count_alarm_specs,
+    service_find_alarm_table_data,
+    service_find_meta_by_codes,
+    service_get_alarm_rule_enums,
+    service_get_alarm_table_columns,
+    service_get_rel_table_columns,
+    service_list_alarm_action,
+    service_list_alarm_rule_matches,
+    service_list_alarm_rules,
+    service_list_alarm_specs,
+)
+
+# ---------------------------------------------------------------------------
+# CLI 命令（薄包装，负责输出渲染）
+# ---------------------------------------------------------------------------
+
+alarm_typer = typer.Typer(name="alarm", help="告警相关命令", no_args_is_help=True)
+alarm_rule_typer = typer.Typer(name="rule", help="告警规则命令", no_args_is_help=True)
+alarm_spec_typer = typer.Typer(name="spec", help="告警专业命令", no_args_is_help=True)
+alarm_action_typer = typer.Typer(name="action", help="告警动作命令", no_args_is_help=True)
+rule_match_typer = typer.Typer(name="match", help="规则匹配命令", no_args_is_help=True)
+alarm_typer.add_typer(alarm_rule_typer, no_args_is_help=True)
+alarm_typer.add_typer(alarm_spec_typer, no_args_is_help=True)
+alarm_rule_typer.add_typer(rule_match_typer, no_args_is_help=True)
+alarm_typer.add_typer(alarm_action_typer, no_args_is_help=True)
+
+
+def _safe_str(value: Any) -> str:
+    if value is None:
+        return ""
+    if isinstance(value, (dict, list)):
+        return to_json(value).decode("utf-8")
+    return str(value)
+
+
+def _extract_column_list(data: Any) -> list:
+    """从响应中提取列数组。
+
+    后端返回可能是:
+    - list[...] 直接列表
+    - dict {"columns": [...], "indexes": [...]} 嵌套结构
+    - None / 其他 空
+    """
+    if isinstance(data, list):
+        return data
+    if isinstance(data, dict):
+        columns = data.get("columns")
+        if isinstance(columns, list):
+            return columns
+    return []
+
+
+def _print_column_list(data: Any) -> None:
+    """统一渲染列数组（list[dict] → 平面表；其他 → JSON）."""
+    columns = _extract_column_list(data)
+    if not columns:
+        print("(空)")
+        return
+    if isinstance(columns[0], dict):
+        headers = list(columns[0].keys())
+        rows = [[_safe_str(c.get(h)) for h in headers] for c in columns]
+        print_list(headers, rows)
+    else:
+        print(to_json(columns).decode("utf-8"))
+
+
+@rule_match_typer.command("count", help="查询告警匹配规则数量")
+def count_alarm_rules_match(
+    spec: Annotated[list[str], typer.Option(help="专业值", default_factory=list)],
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    try:
+        total = service_count_alarm_rule_matches(query, enabled, spec)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+    print(total)
+
+
+@rule_match_typer.command("list", help="查询告警匹配规则")
+def list_alarm_rules_match(
+    spec: Annotated[list[str], typer.Option(help="专业值", default_factory=list)],
+    page: Annotated[int, typer.Option("-p", "--page", help="页码")] = 0,
+    size: Annotated[int, typer.Option("-s", "--size", help="每页条数")] = 20,
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    try:
+        group_nodes = service_list_alarm_rule_matches(page, size, query, enabled, spec)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    if not group_nodes:
+        print("未查询到匹配告警规则")
+        return
+    print_list(
+        [
+            "告警匹配规则名称",
+            "规则类型(值)",
+            "启用状态",
+            "所属区域",
+            "专业类型(值)",
+            "创建人",
+            "更新时间",
+        ],
+        [
+            [
+                column.TITLE,
+                f"{column.N_RULE_TYPE}({column.RULE_TYPE})",
+                column.N_IS_ENABLED,
+                column.AREA,
+                f"{column.N_SPEC_TYPE}({column.SPEC_TYPE})",
+                column.CREATE_USER,
+                column.LAST_MODIFY_TIME,
+            ]
+            for column in group_nodes
+        ],
+    )
+
+
+@alarm_spec_typer.command("list", help="查询告警专业")
+def list_alarm_specs(
+    page: Annotated[int, typer.Option("-p", "--page", help="页码")] = 0,
+    size: Annotated[int, typer.Option("-s", "--size", help="每页条数")] = 20,
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    active: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    query_param = SqlQueryParam()
+    if active is not None:
+        query_param.varMap["isEnabled"] = "1" if active else "0"
+    if query:
+        query_param.add_like("title", query, "mrl")
+    group_nodes = service_list_alarm_specs(page, size, query_param)
+
+    print_list(
+        ["专业名称", "值", "行业", "启用状态", "创建人", "更新时间"],
+        [
+            [
+                column.TITLE,
+                column.CODE,
+                column.N_INDUSTRY,
+                column.N_IS_ENABLED,
+                column.CREATE_USER,
+                column.LAST_MODIFY_TIME,
+            ]
+            for column in group_nodes
+        ],
+    )
+
+
+@alarm_spec_typer.command("count", help="查询告警专业数量")
+def count_alarm_specs(
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    total = service_count_alarm_specs(query, enabled)
+    print(total)
+
+
+@alarm_rule_typer.command("list", help="查询告警规则")
+def list_alarm_rules(
+    page: Annotated[int, typer.Option("-p", "--page", help="页码")] = 0,
+    size: Annotated[int, typer.Option("-s", "--size", help="每页条数")] = 20,
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    group_nodes = service_list_alarm_rules(page, size, query, enabled)
+
+    print_list(
+        ["规则名称", "值", "启用状态", "创建人", "更新时间"],
+        [
+            [
+                column.TITLE,
+                column.CODE,
+                column.N_IS_ENABLED,
+                column.CREATE_USER,
+                column.LAST_MODIFY_TIME,
+            ]
+            for column in group_nodes
+        ],
+    )
+
+
+@alarm_spec_typer.command("count", help="查询告警规则数量")
+def count_alarm_specs(
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    total = service_count_alarm_rules(query, enabled)
+    print(total)
+
+
+@alarm_action_typer.command("list", help="查询告警动作")
+def list_alarm_actions(
+    rule: Annotated[list[str], typer.Option(help="专业值", default_factory=list)],
+    page: Annotated[int, typer.Option("-p", "--page", help="页码")] = 0,
+    size: Annotated[int, typer.Option("-s", "--size", help="每页条数")] = 20,
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    try:
+        group_nodes = service_list_alarm_action(page, size, query, enabled, rule)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    if not group_nodes:
+        print("未查询到匹配告警动作")
+        return
+    print_list(
+        [
+            "动作名称",
+            "值",
+            "规则类型(值)",
+            "启用状态",
+            "创建人",
+            "更新时间",
+        ],
+        [
+            [
+                column.TITLE,
+                column.CODE,
+                f"{column.N_RULE_TYPE}({column.RULE_TYPE})",
+                column.N_IS_ENABLED,
+                column.CREATE_USER,
+                column.LAST_MODIFY_TIME,
+            ]
+            for column in group_nodes
+        ],
+    )
+
+
+@alarm_action_typer.command("count", help="查询告警动作数量")
+def count_alarm_actions(
+    rule: Annotated[list[str], typer.Option(help="专业值", default_factory=list)],
+    query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
+    enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
+):
+    try:
+        total = service_count_alarm_action(query, enabled, rule)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+    print(total)
+
+
+@alarm_rule_typer.command("enums")
+def get_alarm_rule_enums() -> None:
+    """获取告警规则枚举配置.
+
+    示例:
+        >>> data-ops-cli alarm rule enums
+    """
+    try:
+        data = service_get_alarm_rule_enums()
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    if not data:
+        print("(空)")
+        return
+
+    if isinstance(data, dict):
+        table = Table("key", "value", show_header=False)
+        for k, v in data.items():
+            table.add_row(k, _safe_str(v))
+        console = Console(no_color=True)
+        console.print(table)
+    else:
+        print(to_json(data).decode("utf-8"))
+
+
+@alarm_rule_typer.command("find-meta-by-codes", no_args_is_help=True)
+def find_meta_by_codes(
+    codes: Annotated[list[str], typer.Argument(help="告警规则编码列表")],
+) -> None:
+    """根据告警规则编码批量查询关联元数据.
+
+    示例:
+        >>> data-ops-cli alarm rule find-meta-by-codes code1 code2
+    """
+    try:
+        data = service_find_meta_by_codes(list(codes))
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    print(to_json(data).decode("utf-8"))
+
+
+@alarm_rule_typer.command("alarm-columns", no_args_is_help=True)
+def get_alarm_table_columns(
+    spec_type: Annotated[str, typer.Argument(help="告警规格类型")],
+) -> None:
+    """获取指定 specType 对应的告警表列定义.
+
+    示例:
+        >>> data-ops-cli alarm rule alarm-columns MY_SPEC_TYPE
+    """
+    try:
+        columns = service_get_alarm_table_columns(spec_type)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    _print_column_list(columns)
+
+
+@alarm_rule_typer.command("rel-columns", no_args_is_help=True)
+def get_rel_table_columns(
+    code: Annotated[str, typer.Argument(help="告警规则编码")],
+) -> None:
+    """获取指定告警规则关联表列.
+
+    示例:
+        >>> data-ops-cli alarm rule rel-columns rule_code_001
+    """
+    try:
+        columns = service_get_rel_table_columns(code)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    _print_column_list(columns)
+
+
+@alarm_rule_typer.command("data", no_args_is_help=True)
+def find_alarm_table_data(
+    code: Annotated[str, typer.Option(help="告警规则编码")],
+    query: Annotated[
+        str | None,
+        typer.Option(help="查询条件 JSON 字符串"),
+    ] = None,
+) -> None:
+    """查询告警表数据.
+
+    示例:
+        >>> data-ops-cli alarm rule data --code rule_code_001
+
+        带查询条件
+        >>> data-ops-cli alarm rule data --code rule_code_001 --query '{"date":"2026-07-16"}'
+    """
+    try:
+        query_dict = json.loads(query) if query else None
+    except json.JSONDecodeError as e:
+        typer.echo(f"错误: --query 不是合法 JSON: {e}")
+        raise typer.Exit(code=1) from None
+
+    try:
+        data = service_find_alarm_table_data(code, query_dict)
+    except DataOpsError as e:
+        typer.echo(f"错误: {e.message}")
+        raise typer.Exit(code=1) from None
+
+    print(to_json(data).decode("utf-8"))