data-ops-cli 0.2.2__tar.gz → 0.2.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/PKG-INFO +1 -1
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/PKG-INFO +1 -1
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/SOURCES.txt +8 -0
- data_ops_cli-0.2.4/src/dataops_cli/__init__.py +1 -0
- data_ops_cli-0.2.4/src/dataops_cli/cli/api.py +227 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/auth.py +8 -5
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/data_table.py +5 -6
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/dataset.py +8 -9
- data_ops_cli-0.2.4/src/dataops_cli/cli/datasource.py +195 -0
- data_ops_cli-0.2.4/src/dataops_cli/cli/dict_.py +96 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/factory.py +4 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/metrics.py +5 -5
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/report.py +5 -5
- data_ops_cli-0.2.4/src/dataops_cli/cli/table.py +365 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/utils.py +12 -0
- data_ops_cli-0.2.4/src/dataops_cli/cli/widget.py +464 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/workflow.py +5 -5
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/constants.py +0 -1
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/dbConn_sync.py +16 -7
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/__init__.py +12 -3
- data_ops_cli-0.2.4/src/dataops_cli/schems/api.py +37 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/data_table.py +3 -41
- data_ops_cli-0.2.4/src/dataops_cli/schems/datasource.py +25 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/enums.py +39 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/meta.py +21 -5
- data_ops_cli-0.2.4/src/dataops_cli/schems/table.py +65 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/widget.py +107 -11
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/__init__.py +15 -3
- data_ops_cli-0.2.4/src/dataops_cli/sdk/api.py +28 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/auth.py +0 -8
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/data_table.py +5 -8
- data_ops_cli-0.2.4/src/dataops_cli/sdk/dataset.py +54 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/datasource.py +13 -6
- data_ops_cli-0.2.4/src/dataops_cli/sdk/dict_.py +69 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/meta.py +63 -38
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/table.py +124 -33
- data_ops_cli-0.2.4/src/dataops_cli/sdk/widget.py +99 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/session.py +40 -1
- data_ops_cli-0.2.2/src/dataops_cli/__init__.py +0 -1
- data_ops_cli-0.2.2/src/dataops_cli/cli/datasource.py +0 -99
- data_ops_cli-0.2.2/src/dataops_cli/cli/table.py +0 -210
- data_ops_cli-0.2.2/src/dataops_cli/cli/widget.py +0 -60
- data_ops_cli-0.2.2/src/dataops_cli/schems/datasource.py +0 -59
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/README.md +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/pyproject.toml +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/setup.cfg +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/dependency_links.txt +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/entry_points.txt +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/requires.txt +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/data_ops_cli.egg-info/top_level.txt +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/__init__.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/cli/ref.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/exceptions.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/__init__.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/__init__.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/config.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/constants.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/instance.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/nacos_exception.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/naming_param.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/naming_request.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/naming_response.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/preserved_metadata_key.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/schemas/nacos/service.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/__init__.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/common.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/dbConn_base.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/duckdb_manager.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/log.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/nacos.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/runner/utils/neo4j_sync.py +0 -0
- /data_ops_cli-0.2.2/src/dataops_cli/schems/table.py → /data_ops_cli-0.2.4/src/dataops_cli/schems/dict_.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/group.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/query.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/report.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/user.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/schems/workflow.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/ref.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/report.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/sdk/workflow.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/__init__.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/builder.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/constants.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/models.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/parse_utils.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/render_utils.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/renderers.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/tiptap/tool.py +0 -0
- {data_ops_cli-0.2.2 → data_ops_cli-0.2.4}/src/dataops_cli/utils.py +0 -0
|
@@ -12,10 +12,12 @@ src/dataops_cli/exceptions.py
|
|
|
12
12
|
src/dataops_cli/session.py
|
|
13
13
|
src/dataops_cli/utils.py
|
|
14
14
|
src/dataops_cli/cli/__init__.py
|
|
15
|
+
src/dataops_cli/cli/api.py
|
|
15
16
|
src/dataops_cli/cli/auth.py
|
|
16
17
|
src/dataops_cli/cli/data_table.py
|
|
17
18
|
src/dataops_cli/cli/dataset.py
|
|
18
19
|
src/dataops_cli/cli/datasource.py
|
|
20
|
+
src/dataops_cli/cli/dict_.py
|
|
19
21
|
src/dataops_cli/cli/factory.py
|
|
20
22
|
src/dataops_cli/cli/metrics.py
|
|
21
23
|
src/dataops_cli/cli/ref.py
|
|
@@ -44,8 +46,10 @@ src/dataops_cli/runner/utils/log.py
|
|
|
44
46
|
src/dataops_cli/runner/utils/nacos.py
|
|
45
47
|
src/dataops_cli/runner/utils/neo4j_sync.py
|
|
46
48
|
src/dataops_cli/schems/__init__.py
|
|
49
|
+
src/dataops_cli/schems/api.py
|
|
47
50
|
src/dataops_cli/schems/data_table.py
|
|
48
51
|
src/dataops_cli/schems/datasource.py
|
|
52
|
+
src/dataops_cli/schems/dict_.py
|
|
49
53
|
src/dataops_cli/schems/enums.py
|
|
50
54
|
src/dataops_cli/schems/group.py
|
|
51
55
|
src/dataops_cli/schems/meta.py
|
|
@@ -56,13 +60,17 @@ src/dataops_cli/schems/user.py
|
|
|
56
60
|
src/dataops_cli/schems/widget.py
|
|
57
61
|
src/dataops_cli/schems/workflow.py
|
|
58
62
|
src/dataops_cli/sdk/__init__.py
|
|
63
|
+
src/dataops_cli/sdk/api.py
|
|
59
64
|
src/dataops_cli/sdk/auth.py
|
|
60
65
|
src/dataops_cli/sdk/data_table.py
|
|
66
|
+
src/dataops_cli/sdk/dataset.py
|
|
61
67
|
src/dataops_cli/sdk/datasource.py
|
|
68
|
+
src/dataops_cli/sdk/dict_.py
|
|
62
69
|
src/dataops_cli/sdk/meta.py
|
|
63
70
|
src/dataops_cli/sdk/ref.py
|
|
64
71
|
src/dataops_cli/sdk/report.py
|
|
65
72
|
src/dataops_cli/sdk/table.py
|
|
73
|
+
src/dataops_cli/sdk/widget.py
|
|
66
74
|
src/dataops_cli/sdk/workflow.py
|
|
67
75
|
src/dataops_cli/tiptap/__init__.py
|
|
68
76
|
src/dataops_cli/tiptap/builder.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.2.4"
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
"""API 接口管理模块.
|
|
2
|
+
|
|
3
|
+
提供 API 接口的列表查询和详情功能。
|
|
4
|
+
|
|
5
|
+
- 服务层函数 (service_*):纯 Python 接口,返回原始数据
|
|
6
|
+
- CLI 命令:基于服务层的薄包装,负责格式化输出
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
import shutil
|
|
10
|
+
from typing import Annotated
|
|
11
|
+
|
|
12
|
+
import typer
|
|
13
|
+
|
|
14
|
+
from dataops_cli.exceptions import DataOpsError
|
|
15
|
+
from dataops_cli.schems import MetaType
|
|
16
|
+
from dataops_cli.sdk.api import service_get_api_by_code
|
|
17
|
+
from dataops_cli.sdk.meta import release_list_list
|
|
18
|
+
from dataops_cli.utils import filter_nodes_by_pattern
|
|
19
|
+
|
|
20
|
+
# ---------------------------------------------------------------------------
|
|
21
|
+
# 常量
|
|
22
|
+
# ---------------------------------------------------------------------------
|
|
23
|
+
|
|
24
|
+
_STATUS_MAP: dict[str, str] = {
|
|
25
|
+
"dev": "开发中",
|
|
26
|
+
"test": "测试中",
|
|
27
|
+
"prod": "已发布",
|
|
28
|
+
"deprecated": "将弃用",
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
_SCOPE_MAP: dict[str, str] = {
|
|
32
|
+
"public": "公开接口",
|
|
33
|
+
"internal": "内部接口",
|
|
34
|
+
"external": "外部接口",
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
# ---------------------------------------------------------------------------
|
|
38
|
+
# CLI 命令
|
|
39
|
+
# ---------------------------------------------------------------------------
|
|
40
|
+
|
|
41
|
+
api_typer = typer.Typer(
|
|
42
|
+
name="api",
|
|
43
|
+
help="Manage APIs",
|
|
44
|
+
no_args_is_help=True,
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def _first_line(text: str) -> str:
|
|
49
|
+
"""取文本的第一行."""
|
|
50
|
+
return text.split("\n")[0]
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
@api_typer.command("list", rich_help_panel="API 查询")
|
|
54
|
+
def list_apis(
|
|
55
|
+
query: Annotated[
|
|
56
|
+
str | None, typer.Option("-q", "--query", help="按名称/标题/备注正则过滤")
|
|
57
|
+
] = None,
|
|
58
|
+
) -> None:
|
|
59
|
+
"""列出所有 API 接口.
|
|
60
|
+
|
|
61
|
+
从元数据服务获取 API 接口列表,支持通过正则表达式按名称、标题或备注进行过滤。
|
|
62
|
+
|
|
63
|
+
示例:
|
|
64
|
+
列出所有 API 接口
|
|
65
|
+
>>> data-ops-cli api list
|
|
66
|
+
|
|
67
|
+
按名称/标题/备注过滤
|
|
68
|
+
>>> data-ops-cli api list --query ".*用户.*"
|
|
69
|
+
>>> data-ops-cli api list -q "用户"
|
|
70
|
+
"""
|
|
71
|
+
try:
|
|
72
|
+
group_nodes = release_list_list(MetaType.API)
|
|
73
|
+
except DataOpsError as e:
|
|
74
|
+
typer.echo(f"错误: {e.message}")
|
|
75
|
+
raise typer.Exit(code=1) from None
|
|
76
|
+
|
|
77
|
+
if query:
|
|
78
|
+
group_nodes = filter_nodes_by_pattern(group_nodes, query)
|
|
79
|
+
|
|
80
|
+
if not group_nodes:
|
|
81
|
+
print("(无结果)")
|
|
82
|
+
return
|
|
83
|
+
|
|
84
|
+
print("code title remark")
|
|
85
|
+
|
|
86
|
+
for node in group_nodes:
|
|
87
|
+
code = node.CODE
|
|
88
|
+
title = node.TITLE
|
|
89
|
+
remark_raw = node.REMARK or ""
|
|
90
|
+
remark = _first_line(remark_raw.strip())
|
|
91
|
+
print(code, title, remark)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
@api_typer.command("detail", rich_help_panel="API 查询", no_args_is_help=True)
|
|
95
|
+
def get_api_detail(
|
|
96
|
+
code: Annotated[str, typer.Argument(help="API 接口编码")],
|
|
97
|
+
simplify: Annotated[
|
|
98
|
+
bool,
|
|
99
|
+
typer.Option("-s", "--simplify", help="仅显示基本信息,不展示请求/响应参数"),
|
|
100
|
+
] = False,
|
|
101
|
+
) -> None:
|
|
102
|
+
"""获取 API 接口详情.
|
|
103
|
+
|
|
104
|
+
根据 API 接口编码获取详细信息,包括请求方法、路径、状态、请求参数和响应参数。
|
|
105
|
+
|
|
106
|
+
示例:
|
|
107
|
+
获取 API 接口完整信息
|
|
108
|
+
>>> data-ops-cli api detail user_login
|
|
109
|
+
|
|
110
|
+
仅显示基本信息
|
|
111
|
+
>>> data-ops-cli api detail user_login --simplify
|
|
112
|
+
>>> data-ops-cli api detail user_login -s
|
|
113
|
+
"""
|
|
114
|
+
try:
|
|
115
|
+
meta = service_get_api_by_code(code)
|
|
116
|
+
except DataOpsError as e:
|
|
117
|
+
typer.echo(f"错误: {e.message}")
|
|
118
|
+
raise typer.Exit(code=1) from None
|
|
119
|
+
|
|
120
|
+
d = meta.data
|
|
121
|
+
method = d.method
|
|
122
|
+
status_label = _STATUS_MAP.get(d.status, d.status)
|
|
123
|
+
scope_label = _SCOPE_MAP.get(d.scope, d.scope)
|
|
124
|
+
|
|
125
|
+
# 基本信息
|
|
126
|
+
print(f"方法: {method}")
|
|
127
|
+
print(f"路径: {d.endpoint}")
|
|
128
|
+
print(f"状态: {status_label}")
|
|
129
|
+
print(f"范围: {scope_label}")
|
|
130
|
+
if d.charger:
|
|
131
|
+
print(f"负责人: {d.charger}")
|
|
132
|
+
if d.env_code:
|
|
133
|
+
print(f"API 环境: {d.env_code}")
|
|
134
|
+
if d.description:
|
|
135
|
+
print(f"\n说明:\n{d.description}")
|
|
136
|
+
|
|
137
|
+
if simplify:
|
|
138
|
+
return
|
|
139
|
+
|
|
140
|
+
# 请求参数
|
|
141
|
+
rp = d.requestParam
|
|
142
|
+
print("\n--- 请求参数 ---")
|
|
143
|
+
|
|
144
|
+
# 认证
|
|
145
|
+
auth = rp.get("authParam", {})
|
|
146
|
+
if auth:
|
|
147
|
+
auth_type = auth.get("type", "none")
|
|
148
|
+
print(f" 认证: {auth_type}")
|
|
149
|
+
|
|
150
|
+
# Headers
|
|
151
|
+
headers = rp.get("headers", [])
|
|
152
|
+
if headers:
|
|
153
|
+
print(f" 请求头 ({len(headers)}):")
|
|
154
|
+
for h in headers:
|
|
155
|
+
required = " *" if h.get("required") else ""
|
|
156
|
+
print(f" - {h.get('name', '?')}: {h.get('title', '')}{required}")
|
|
157
|
+
|
|
158
|
+
# Path params
|
|
159
|
+
path_params = rp.get("pathParams", [])
|
|
160
|
+
if path_params:
|
|
161
|
+
print(f" 路径参数 ({len(path_params)}):")
|
|
162
|
+
for p in path_params:
|
|
163
|
+
required = " *" if p.get("required") else ""
|
|
164
|
+
print(
|
|
165
|
+
f" - {p.get('name', '?')}: {p.get('title', '')} ({p.get('type', '?')}){required}"
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
# Query params
|
|
169
|
+
query_params = rp.get("queryParams", [])
|
|
170
|
+
if query_params:
|
|
171
|
+
print(f" Query 参数 ({len(query_params)}):")
|
|
172
|
+
for q in query_params:
|
|
173
|
+
required = " *" if q.get("required") else ""
|
|
174
|
+
print(
|
|
175
|
+
f" - {q.get('name', '?')}: {q.get('title', '')} ({q.get('type', '?')}){required}"
|
|
176
|
+
)
|
|
177
|
+
|
|
178
|
+
# Body
|
|
179
|
+
body = rp.get("bodyParams", {})
|
|
180
|
+
if body:
|
|
181
|
+
mine_type = body.get("mineType", "none")
|
|
182
|
+
if mine_type != "none":
|
|
183
|
+
structure = body.get("structure", [])
|
|
184
|
+
print(f" 请求体: {mine_type}")
|
|
185
|
+
if structure:
|
|
186
|
+
_print_params_tree(structure, indent=4)
|
|
187
|
+
|
|
188
|
+
# Cookies
|
|
189
|
+
cookies = rp.get("cookies", [])
|
|
190
|
+
if cookies:
|
|
191
|
+
print(f" Cookie ({len(cookies)}):")
|
|
192
|
+
for c in cookies:
|
|
193
|
+
print(f" - {c.get('name', '?')}: {c.get('title', '')}")
|
|
194
|
+
|
|
195
|
+
# 响应参数
|
|
196
|
+
response_params = d.responseParams
|
|
197
|
+
if response_params:
|
|
198
|
+
print("\n--- 响应参数 ---")
|
|
199
|
+
for rp_item in response_params:
|
|
200
|
+
status_code = rp_item.get("status_code", "?")
|
|
201
|
+
title = rp_item.get("title", "")
|
|
202
|
+
mine_type = rp_item.get("mineType", "")
|
|
203
|
+
structure = rp_item.get("structure", [])
|
|
204
|
+
print(f" [{status_code}] {title} ({mine_type})")
|
|
205
|
+
if structure:
|
|
206
|
+
_print_params_tree(structure, indent=4)
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
def _print_params_tree(params: list[dict], indent: int = 0, prefix: str = "") -> None:
|
|
210
|
+
"""递归打印参数树结构."""
|
|
211
|
+
for p in params:
|
|
212
|
+
ptype = p.get("type", "?")
|
|
213
|
+
name = p.get("name", "?")
|
|
214
|
+
title = p.get("title", "")
|
|
215
|
+
required = " *" if p.get("required") else ""
|
|
216
|
+
desc = p.get("description", "")
|
|
217
|
+
line = f"{' ' * indent}- {prefix}{name}: {title} ({ptype}){required}"
|
|
218
|
+
if desc:
|
|
219
|
+
line += f" # {desc}"
|
|
220
|
+
print(line)
|
|
221
|
+
if ptype in ("object", "array"):
|
|
222
|
+
children = p.get("children", [])
|
|
223
|
+
if children:
|
|
224
|
+
if ptype == "array":
|
|
225
|
+
_print_params_tree(children, indent + 2)
|
|
226
|
+
else:
|
|
227
|
+
_print_params_tree(children, indent + 2)
|
|
@@ -12,6 +12,7 @@ import typer
|
|
|
12
12
|
from rich.console import Console
|
|
13
13
|
from rich.table import Table
|
|
14
14
|
|
|
15
|
+
from dataops_cli.cli.utils import print_list
|
|
15
16
|
from dataops_cli.constants import USER_INFO_FILE
|
|
16
17
|
from dataops_cli.exceptions import AuthenticationError
|
|
17
18
|
from dataops_cli.schems import UserInfo
|
|
@@ -135,11 +136,13 @@ def application_list(query: Annotated[str | None, typer.Argument(help="关键字
|
|
|
135
136
|
typer.echo(f"错误: {e}")
|
|
136
137
|
raise typer.Exit(code=1) from None
|
|
137
138
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
139
|
+
print_list(
|
|
140
|
+
["code", "title", "remark"],
|
|
141
|
+
[
|
|
142
|
+
[application.CODE, application.LABEL_CN, application.REMARK]
|
|
143
|
+
for application in applications
|
|
144
|
+
],
|
|
145
|
+
)
|
|
143
146
|
|
|
144
147
|
|
|
145
148
|
@application_typer.command("set")
|
|
@@ -11,7 +11,7 @@ import typer
|
|
|
11
11
|
from rich.console import Console
|
|
12
12
|
from rich.table import Table
|
|
13
13
|
|
|
14
|
-
from dataops_cli.cli.utils import render_table
|
|
14
|
+
from dataops_cli.cli.utils import print_list, render_table
|
|
15
15
|
from dataops_cli.exceptions import DataOpsError
|
|
16
16
|
from dataops_cli.schems import MetaType, PageParam, SqlQueryParam
|
|
17
17
|
from dataops_cli.sdk import (
|
|
@@ -63,11 +63,10 @@ def list_datatable(
|
|
|
63
63
|
if query:
|
|
64
64
|
group_nodes = filter_nodes_by_pattern(group_nodes, query, include_digest=True)
|
|
65
65
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
console.print(table)
|
|
66
|
+
print_list(
|
|
67
|
+
["code", "title", "remark"],
|
|
68
|
+
[[column.CODE, column.TITLE, column.REMARK] for column in group_nodes],
|
|
69
|
+
)
|
|
71
70
|
|
|
72
71
|
|
|
73
72
|
@data_table_typer.command("detail", no_args_is_help=True)
|
|
@@ -4,9 +4,9 @@ import typer
|
|
|
4
4
|
from rich.console import Console
|
|
5
5
|
from rich.table import Table
|
|
6
6
|
|
|
7
|
+
from dataops_cli.cli.utils import print_list
|
|
7
8
|
from dataops_cli.exceptions import DataOpsError
|
|
8
|
-
from dataops_cli.
|
|
9
|
-
from dataops_cli.sdk.meta import release_list_get_by_code, release_list_list
|
|
9
|
+
from dataops_cli.sdk import service_get_dataset_detail_by_code, service_list_datasets
|
|
10
10
|
from dataops_cli.utils import filter_nodes_by_pattern
|
|
11
11
|
|
|
12
12
|
dataset_typer = typer.Typer(name="dataset", help="Manage dataset.", no_args_is_help=True)
|
|
@@ -28,7 +28,7 @@ def list_dataset(
|
|
|
28
28
|
>>> data-ops-cli dataset list "HHI.*"
|
|
29
29
|
"""
|
|
30
30
|
try:
|
|
31
|
-
group_nodes =
|
|
31
|
+
group_nodes = service_list_datasets()
|
|
32
32
|
except DataOpsError as e:
|
|
33
33
|
typer.echo(f"错误: {e.message}")
|
|
34
34
|
raise typer.Exit(code=1) from None
|
|
@@ -36,11 +36,10 @@ def list_dataset(
|
|
|
36
36
|
if query:
|
|
37
37
|
group_nodes = filter_nodes_by_pattern(group_nodes, query, include_digest=True)
|
|
38
38
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
console.print(table)
|
|
39
|
+
print_list(
|
|
40
|
+
["code", "name", "alias", "remark"],
|
|
41
|
+
[[column.CODE, column.NAME, column.TITLE, column.REMARK] for column in group_nodes],
|
|
42
|
+
)
|
|
44
43
|
|
|
45
44
|
|
|
46
45
|
@dataset_typer.command("detail", no_args_is_help=True)
|
|
@@ -61,7 +60,7 @@ def get_dataset_detail_by_code(
|
|
|
61
60
|
>>> data-ops-cli dataset detail my_dataset_code --full
|
|
62
61
|
"""
|
|
63
62
|
try:
|
|
64
|
-
meta =
|
|
63
|
+
meta = service_get_dataset_detail_by_code(code)
|
|
65
64
|
except DataOpsError as e:
|
|
66
65
|
typer.echo(f"错误: {e.message}")
|
|
67
66
|
raise typer.Exit(code=1) from None
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
"""数据源管理模块.
|
|
2
|
+
|
|
3
|
+
提供数据源、表、数据集的查询和管理功能。
|
|
4
|
+
|
|
5
|
+
- 服务层函数 (service_*):纯 Python 接口,返回原始数据,可供 agent 自由组合
|
|
6
|
+
- CLI 命令:基于服务层的薄包装,负责格式化输出
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from __future__ import annotations
|
|
10
|
+
|
|
11
|
+
from typing import Annotated
|
|
12
|
+
|
|
13
|
+
import typer
|
|
14
|
+
from rich.console import Console
|
|
15
|
+
from rich.table import Table
|
|
16
|
+
|
|
17
|
+
from dataops_cli.exceptions import DataOpsError
|
|
18
|
+
from dataops_cli.schems import (
|
|
19
|
+
DataDataSource,
|
|
20
|
+
InnerMetaType,
|
|
21
|
+
MetaCreate,
|
|
22
|
+
)
|
|
23
|
+
from dataops_cli.schems.enums import DataSourceType
|
|
24
|
+
from dataops_cli.sdk.datasource import (
|
|
25
|
+
get_application_datasource_config,
|
|
26
|
+
service_get_datasource_by_name,
|
|
27
|
+
)
|
|
28
|
+
from dataops_cli.sdk.meta import (
|
|
29
|
+
release_list_create,
|
|
30
|
+
release_list_get_by_name,
|
|
31
|
+
release_list_list,
|
|
32
|
+
release_list_update,
|
|
33
|
+
)
|
|
34
|
+
from dataops_cli.session import get_application
|
|
35
|
+
from dataops_cli.utils import filter_nodes_by_pattern
|
|
36
|
+
|
|
37
|
+
# ---------------------------------------------------------------------------
|
|
38
|
+
# CLI 命令(薄包装,负责输出渲染)
|
|
39
|
+
# ---------------------------------------------------------------------------
|
|
40
|
+
|
|
41
|
+
datasource_typer = typer.Typer(name="datasource", help="Manage data sources.", no_args_is_help=True)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
@datasource_typer.command("config")
|
|
45
|
+
def get_datasource_config() -> None:
|
|
46
|
+
"""显示当前应用的数据库源配置信息.
|
|
47
|
+
|
|
48
|
+
展示应用关联的三个核心数据源:
|
|
49
|
+
- 主数据源: 默认读写数据源
|
|
50
|
+
- 隐患读数据源: 隐患业务只读数据源
|
|
51
|
+
- 隐患写数据源: 隐患业务只写数据源
|
|
52
|
+
|
|
53
|
+
示例:
|
|
54
|
+
# 显示当前应用的数据源配置
|
|
55
|
+
>>> data-ops-cli datasource config
|
|
56
|
+
"""
|
|
57
|
+
application = get_application()
|
|
58
|
+
datasource_config = get_application_datasource_config(application.CUID)
|
|
59
|
+
table = Table(
|
|
60
|
+
"name", "功能", title=f"应用数据源配置\n{application.LABEL_CN}({application.CODE})"
|
|
61
|
+
)
|
|
62
|
+
table.add_row(datasource_config.main.name, "主数据源")
|
|
63
|
+
table.add_row(datasource_config.hazard_read.name, "隐患读数据源")
|
|
64
|
+
table.add_row(datasource_config.hazard_write.name, "隐患写数据源")
|
|
65
|
+
console = Console(no_color=True)
|
|
66
|
+
console.print(table)
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
@datasource_typer.command("list")
|
|
70
|
+
def list_datasource(
|
|
71
|
+
query: Annotated[str | None, typer.Option("-q", "--query", help="正则表达式查询")] = None,
|
|
72
|
+
) -> None:
|
|
73
|
+
"""列出所有已注册的数据源.
|
|
74
|
+
|
|
75
|
+
从元数据服务获取所有数据源节点,支持通过正则表达式过滤数据源名称。
|
|
76
|
+
|
|
77
|
+
参数:
|
|
78
|
+
query: 可选的正则表达式,用于过滤返回的数据源列表
|
|
79
|
+
|
|
80
|
+
示例:
|
|
81
|
+
# 列出所有数据源
|
|
82
|
+
>>> data-ops-cli datasource list
|
|
83
|
+
|
|
84
|
+
# 通过正则过滤数据源
|
|
85
|
+
>>> data-ops-cli datasource list -q "doris.*"
|
|
86
|
+
|
|
87
|
+
# 完整参数名形式
|
|
88
|
+
>>> data-ops-cli datasource list --query zhwg
|
|
89
|
+
"""
|
|
90
|
+
try:
|
|
91
|
+
group_nodes = release_list_list(InnerMetaType.DATASOURCE.value)
|
|
92
|
+
except DataOpsError as e:
|
|
93
|
+
typer.echo(f"错误: {e.message}")
|
|
94
|
+
raise typer.Exit(code=1) from None
|
|
95
|
+
|
|
96
|
+
if query:
|
|
97
|
+
group_nodes = filter_nodes_by_pattern(group_nodes, query, include_digest=True)
|
|
98
|
+
|
|
99
|
+
table = Table("name", "alias", "remark")
|
|
100
|
+
console = Console(no_color=True)
|
|
101
|
+
for column in group_nodes:
|
|
102
|
+
table.add_row(column.NAME, column.TITLE, column.REMARK or "")
|
|
103
|
+
console.print(table)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
@datasource_typer.command("detail")
|
|
107
|
+
def get_datasource_detail(
|
|
108
|
+
name: Annotated[str, typer.Argument(help="数据源名称")],
|
|
109
|
+
) -> None:
|
|
110
|
+
"""获取指定数据源的详细信息.
|
|
111
|
+
|
|
112
|
+
Args:
|
|
113
|
+
name: 数据源名称
|
|
114
|
+
"""
|
|
115
|
+
meta = service_get_datasource_by_name(name)
|
|
116
|
+
table = Table("field", "value", show_header=False)
|
|
117
|
+
table.add_row("name", meta.name)
|
|
118
|
+
table.add_row("title", meta.title)
|
|
119
|
+
table.add_row("分组", meta.groupCode)
|
|
120
|
+
table.add_row("数据库类型", meta.data.type.value)
|
|
121
|
+
table.add_row("地址", meta.data.ip)
|
|
122
|
+
table.add_row("端口", str(meta.data.port))
|
|
123
|
+
table.add_row("数据库账户", meta.data.username)
|
|
124
|
+
table.add_row("说明", meta.remark or "")
|
|
125
|
+
console = Console(no_color=True)
|
|
126
|
+
console.print(table)
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
@datasource_typer.command("create", no_args_is_help=True)
|
|
130
|
+
def create_datasource(
|
|
131
|
+
name: Annotated[str, typer.Option(help="数据源名称")],
|
|
132
|
+
title: Annotated[str, typer.Option(help="数据源中文名称")],
|
|
133
|
+
type: Annotated[DataSourceType, typer.Option("-t", "--type", help="数据源类型")],
|
|
134
|
+
ip: Annotated[str, typer.Option(help="数据源 IP 地址")],
|
|
135
|
+
port: Annotated[int, typer.Option("-p", "--port", help="数据源端口号")],
|
|
136
|
+
username: Annotated[str, typer.Option("-u", "--username", help="数据源用户名")],
|
|
137
|
+
password: Annotated[str, typer.Option(help="数据源密码", hide_input=True)],
|
|
138
|
+
database: Annotated[str, typer.Option("-db", "--database", help="数据库名称")],
|
|
139
|
+
remark: Annotated[str | None, typer.Option(help="数据源备注")] = None,
|
|
140
|
+
) -> None:
|
|
141
|
+
"""创建新的数据源."""
|
|
142
|
+
meta_create = MetaCreate[DataDataSource](
|
|
143
|
+
type="datasource",
|
|
144
|
+
subType=f"database__{type.value}",
|
|
145
|
+
name=name,
|
|
146
|
+
title=title,
|
|
147
|
+
remark=remark,
|
|
148
|
+
groupCode="inner",
|
|
149
|
+
data=DataDataSource(
|
|
150
|
+
type=type, ip=ip, port=port, username=username, password=password, database=database
|
|
151
|
+
),
|
|
152
|
+
)
|
|
153
|
+
result = release_list_create(meta_create, _class=DataDataSource)
|
|
154
|
+
typer.echo(f"数据源 {result.name} 创建成功")
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
@datasource_typer.command("update", no_args_is_help=True)
|
|
158
|
+
def update_datasource(
|
|
159
|
+
name: Annotated[str, typer.Argument(help="数据源名称")],
|
|
160
|
+
title: Annotated[str | None, typer.Option(help="数据源中文名称")] = None,
|
|
161
|
+
type: Annotated[DataSourceType | None, typer.Option("-t", "--type", help="数据源类型")] = None,
|
|
162
|
+
ip: Annotated[str | None, typer.Option(help="数据源 IP 地址")] = None,
|
|
163
|
+
port: Annotated[int | None, typer.Option("-p", "--port", help="数据源端口号")] = None,
|
|
164
|
+
username: Annotated[str | None, typer.Option("-u", "--username", help="数据源用户名")] = None,
|
|
165
|
+
password: Annotated[str | None, typer.Option(help="数据源密码", hide_input=True)] = None,
|
|
166
|
+
database: Annotated[str | None, typer.Option("-db", "--database", help="数据库名称")] = None,
|
|
167
|
+
remark: Annotated[str | None, typer.Option(help="数据源备注")] = None,
|
|
168
|
+
) -> None:
|
|
169
|
+
"""更新已有的数据源."""
|
|
170
|
+
meta = release_list_get_by_name(InnerMetaType.DATASOURCE.value, name, _class=DataDataSource)
|
|
171
|
+
if type:
|
|
172
|
+
meta.data.type = type
|
|
173
|
+
meta.subType = f"database__{type.value}"
|
|
174
|
+
if title:
|
|
175
|
+
meta.title = title
|
|
176
|
+
if ip:
|
|
177
|
+
meta.data.ip = ip
|
|
178
|
+
if port:
|
|
179
|
+
meta.data.port = port
|
|
180
|
+
if username:
|
|
181
|
+
meta.data.username = username
|
|
182
|
+
if password:
|
|
183
|
+
meta.data.password = password
|
|
184
|
+
if database:
|
|
185
|
+
meta.data.database = database
|
|
186
|
+
if remark:
|
|
187
|
+
meta.remark = remark
|
|
188
|
+
|
|
189
|
+
result = release_list_update(meta, _class=DataDataSource)
|
|
190
|
+
typer.echo(f"数据源 {result.name} 更新成功")
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
if __name__ == "__main__":
|
|
194
|
+
print(DataDataSource.model_json_schema())
|
|
195
|
+
# list_datasource("doris")
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
from typing import Annotated, Optional
|
|
2
|
+
|
|
3
|
+
import typer
|
|
4
|
+
from rich.console import Console
|
|
5
|
+
from rich.table import Table
|
|
6
|
+
|
|
7
|
+
from dataops_cli.cli.utils import print_list
|
|
8
|
+
from dataops_cli.exceptions import DataOpsError
|
|
9
|
+
from dataops_cli.sdk.dict_ import (
|
|
10
|
+
service_get_dict_detail_by_code,
|
|
11
|
+
service_get_dict_detail_by_name,
|
|
12
|
+
service_list_dicts,
|
|
13
|
+
)
|
|
14
|
+
from dataops_cli.utils import filter_nodes_by_pattern
|
|
15
|
+
|
|
16
|
+
dict_typer = typer.Typer(name="dict", help="Manage dict.", no_args_is_help=True)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
@dict_typer.command("list")
|
|
20
|
+
def list_dict(
|
|
21
|
+
datasource: Annotated[str, typer.Argument(help="数据源")],
|
|
22
|
+
query: Annotated[str | None, typer.Argument(help="字典名称关键字")] = None,
|
|
23
|
+
) -> None:
|
|
24
|
+
"""列出数据源中的字典列表.
|
|
25
|
+
|
|
26
|
+
支持通过关键字过滤字典名称,并支持正则表达式匹配。
|
|
27
|
+
|
|
28
|
+
示例:
|
|
29
|
+
# 列出指定数据源的所有字典
|
|
30
|
+
>>> data-ops-cli dict list <datasource>
|
|
31
|
+
|
|
32
|
+
# 列出数据源中名称包含 "user" 的字典
|
|
33
|
+
>>> data-ops-cli dict list <datasource> user
|
|
34
|
+
|
|
35
|
+
# 使用正则过滤字典名
|
|
36
|
+
>>> data-ops-cli dict list <datasource> "^user_.*"
|
|
37
|
+
"""
|
|
38
|
+
try:
|
|
39
|
+
group_nodes = service_list_dicts(datasource)
|
|
40
|
+
except DataOpsError as e:
|
|
41
|
+
typer.echo(f"错误: {e.message}")
|
|
42
|
+
raise typer.Exit(code=1) from None
|
|
43
|
+
|
|
44
|
+
if not group_nodes:
|
|
45
|
+
print("未查询到匹配字典")
|
|
46
|
+
return
|
|
47
|
+
|
|
48
|
+
if query:
|
|
49
|
+
group_nodes = filter_nodes_by_pattern(group_nodes, query)
|
|
50
|
+
|
|
51
|
+
print_list(
|
|
52
|
+
["code", "name", "alias"],
|
|
53
|
+
[[column.CODE, column.NAME, column.TITLE] for column in group_nodes],
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
@dict_typer.command("detail", no_args_is_help=True)
|
|
58
|
+
def get_dict_detail(
|
|
59
|
+
arg1: Annotated[str, typer.Argument(help="编码或数据源")],
|
|
60
|
+
name: Annotated[Optional[str], typer.Argument(help="字典名称")] = None,
|
|
61
|
+
full: Annotated[bool, typer.Option("--full", help="是否显示完整信息")] = False,
|
|
62
|
+
) -> None:
|
|
63
|
+
"""获取字典详情信息.
|
|
64
|
+
|
|
65
|
+
支持两种查询方式:
|
|
66
|
+
1. 通过字典编码(CODE)直接查询
|
|
67
|
+
2. 通过数据源名称和字典名称组合查询
|
|
68
|
+
|
|
69
|
+
默认只显示字典选项的基本信息(label/value)。
|
|
70
|
+
使用 --full 选项可显示完整信息。
|
|
71
|
+
|
|
72
|
+
示例:
|
|
73
|
+
# 通过字典编码查询字典结构
|
|
74
|
+
>>> data-ops-cli dict detail dict_code_123
|
|
75
|
+
|
|
76
|
+
# 通过数据源和字典名查询
|
|
77
|
+
>>> data-ops-cli dict detail <datasource> my_dict
|
|
78
|
+
|
|
79
|
+
# 显示完整的字典信息
|
|
80
|
+
>>> data-ops-cli dict detail <datasource> my_dict --full
|
|
81
|
+
"""
|
|
82
|
+
try:
|
|
83
|
+
meta = (
|
|
84
|
+
service_get_dict_detail_by_name(arg1, name)
|
|
85
|
+
if name
|
|
86
|
+
else service_get_dict_detail_by_code(arg1)
|
|
87
|
+
)
|
|
88
|
+
except DataOpsError as e:
|
|
89
|
+
typer.echo(f"错误: {e.message}")
|
|
90
|
+
raise typer.Exit(code=1) from None
|
|
91
|
+
|
|
92
|
+
console = Console(no_color=True)
|
|
93
|
+
table = Table("value", "label", title=f"{arg1} {meta.name} dict")
|
|
94
|
+
for option in meta.data.options:
|
|
95
|
+
table.add_row(str(option.value), option.label)
|
|
96
|
+
console.print(table)
|