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

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: data-ops-cli
-Version: 0.3.0
+Version: 0.3.1
 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: dataops-sdk[runner]>=0.3.2
 Requires-Dist: typer
 Requires-Dist: rich
 Provides-Extra: dev

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/pyproject.toml

@@ -8,7 +8,7 @@ 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",
+    "dataops-sdk[runner]>=0.3.2",
     "typer",
     "rich",
 ]
@@ -34,4 +34,4 @@ where = ["src"]
 include = ["dataops_cli*"]
 
 [tool.setuptools.package-data]
-dataops_cli = ["py.typed"]
+dataops_cli = ["py.typed"]

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/src/data_ops_cli.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: data-ops-cli
-Version: 0.3.0
+Version: 0.3.1
 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: dataops-sdk[runner]>=0.3.2
 Requires-Dist: typer
 Requires-Dist: rich
 Provides-Extra: dev

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

@@ -0,0 +1,7 @@
+dataops-sdk[runner]>=0.3.2
+typer
+rich
+
+[dev]
+pytest
+ruff

data_ops_cli-0.3.1/src/dataops_cli/__init__.py

@@ -0,0 +1,17 @@
+"""CLI package for DataOps.
+
+This package hosts the Typer-based ``data-ops-cli`` command line interface. It
+groups command modules under :mod:`dataops_cli.cli` and re-exports the package
+``__version__``. Platform functionality lives in the companion
+``dataops_sdk`` package; the CLI itself only wires commands onto SDK services.
+
+.. deprecated::
+    Importing the legacy top-level shims
+    (``dataops_cli.sdk`` / ``dataops_cli.schems`` / ``dataops_cli.runner`` /
+    ``dataops_cli.exceptions`` / ``dataops_cli.session`` /
+    ``dataops_cli.utils``) is deprecated; use ``dataops_sdk`` instead. The CLI
+    itself (``dataops_cli.cli``) is unaffected. These deprecation shims will be
+    removed in ``dataops_cli`` 1.0.
+"""
+
+__version__ = "0.3.1"

data_ops_cli-0.3.1/src/dataops_cli/_compat.py

@@ -0,0 +1,81 @@
+"""Build a deprecation-shim module via PEP 562 ``__getattr__``.
+
+This helper is used by the legacy top-level shims
+(``dataops_cli.sdk`` / ``dataops_cli.schems`` / ``dataops_cli.runner`` /
+``dataops_cli.exceptions`` / ``dataops_cli.session`` /
+``dataops_cli.utils``). Each shim file's 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).
+
+.. deprecated::
+    The shim modules themselves are deprecated; new code should import from
+    ``dataops_sdk`` directly. This helper module will be removed in
+    ``dataops_cli`` 1.0.
+"""
+
+from __future__ import annotations
+
+import importlib
+import sys
+import warnings
+from types import ModuleType
+from typing import Any
+
+# Mapping from legacy ``dataops_cli.*`` module paths to their ``dataops_sdk``
+# replacements. Used by :func:`make_shim` to resolve the target module.
+_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``.
+
+    The new module is wired with PEP 562 ``__getattr__`` so that attribute
+    access is lazily forwarded to ``dataops_sdk`` and emits a single
+    ``DeprecationWarning`` per attribute name on first access. ``__all__`` and
+    ``__dir__`` are forwarded from the target module so ``import *`` and
+    introspection behave naturally.
+
+    Args:
+        old_path: The legacy module path (e.g. ``"dataops_cli.sdk"``). Must be
+            a key in :data:`_OLD_TO_NEW`.
+
+    Returns:
+        The freshly created proxy module, also registered in :data:`sys.modules`
+        under ``old_path``.
+
+    .. deprecated::
+        Only used to construct the legacy ``dataops_cli.*`` shims. Will be
+        removed in ``dataops_cli`` 1.0 alongside the shims themselves.
+    """
+    new_path = _OLD_TO_NEW[old_path]
+    target = importlib.import_module(new_path)
+    warned: set[str] = set()
+
+    def __getattr__(name: str) -> Any:
+        """PEP 562 attribute lookup that warns once per attribute name."""
+        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.1/src/dataops_cli/cli/__init__.py

@@ -0,0 +1,9 @@
+"""data-ops-cli 的 Typer 命令组集合.
+
+本包聚合所有 CLI 子命令模块（alarm、api、auth 等），由 ``factory.create_app``
+统一注册为 Typer 应用并通过 ``dataops_cli.cli.app`` 暴露。
+"""
+
+from dataops_cli.cli.factory import create_app
+
+app = create_app()

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/src/dataops_cli/cli/alarm.py

@@ -10,10 +10,6 @@ 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
@@ -32,12 +28,15 @@ from dataops_sdk.services.alarm import (
     service_list_alarm_rules,
     service_list_alarm_specs,
 )
+from pydantic_core import to_json
+from rich.console import Console
+from rich.table import Table
 
 # ---------------------------------------------------------------------------
 # CLI 命令（薄包装，负责输出渲染）
 # ---------------------------------------------------------------------------
 
-alarm_typer = typer.Typer(name="alarm", help="告警相关命令", no_args_is_help=True)
+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)
@@ -93,6 +92,18 @@ def count_alarm_rules_match(
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警匹配规则数量。
+
+    按专业、关键字与启用状态进行过滤，返回匹配规则的总数。
+
+    Args:
+        spec: 专业值列表，多个值会同时参与匹配。
+        query: 可选关键字，用于模糊搜索。
+        enabled: 可选启用状态过滤；为 ``True`` / ``False`` 时严格匹配。
+
+    Examples:
+        >>> data-ops-cli alarm rule match count --spec MY_SPEC
+    """
     try:
         total = service_count_alarm_rule_matches(query, enabled, spec)
     except DataOpsError as e:
@@ -104,13 +115,27 @@ def count_alarm_rules_match(
 @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,
+    page_num: Annotated[int, typer.Option("-n", "--page-num", help="页码")] = 0,
+    page_size: Annotated[int, typer.Option("-s", "--page-size", help="每页大小")] = 20,
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警匹配规则列表。
+
+    按专业、关键字与启用状态过滤告警匹配规则，并以平面表格形式输出。
+
+    Args:
+        spec: 专业值列表，多个值同时参与匹配。
+        page: 页码（从 0 开始）。
+        size: 每页条数。
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm rule match list --spec MY_SPEC --page 0 --size 20
+    """
     try:
-        group_nodes = service_list_alarm_rule_matches(page, size, query, enabled, spec)
+        group_nodes = service_list_alarm_rule_matches(page_num, page_size, query, enabled, spec)
     except DataOpsError as e:
         typer.echo(f"错误: {e.message}")
         raise typer.Exit(code=1) from None
@@ -145,17 +170,30 @@ def list_alarm_rules_match(
 
 @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,
+    page_num: Annotated[int, typer.Option("-n", "--page-num", help="页码")] = 0,
+    page_size: Annotated[int, typer.Option("-s", "--page-size", help="每页大小")] = 20,
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     active: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警专业列表。
+
+    按关键字与启用状态过滤告警专业（spec），输出标题、值、行业等基础字段。
+
+    Args:
+        page: 页码（从 0 开始）。
+        size: 每页条数。
+        query: 可选关键字。
+        active: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm spec list -q "网元"
+    """
     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)
+    group_nodes = service_list_alarm_specs(page_num, page_size, query_param)
 
     print_list(
         ["专业名称", "值", "行业", "启用状态", "创建人", "更新时间"],
@@ -178,18 +216,40 @@ def count_alarm_specs(
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警专业的总数。
+
+    Args:
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm spec count
+    """
     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,
+    page_num: Annotated[int, typer.Option("-n", "--page-num", help="页码")] = 0,
+    page_size: Annotated[int, typer.Option("-s", "--page-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)
+    """查询告警规则列表。
+
+    按关键字与启用状态过滤告警规则，并以平面表格输出名称、值与启用状态。
+
+    Args:
+        page: 页码（从 0 开始）。
+        size: 每页条数。
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm rule list -q "电压"
+    """
+    group_nodes = service_list_alarm_rules(page_num, page_size, query, enabled)
 
     print_list(
         ["规则名称", "值", "启用状态", "创建人", "更新时间"],
@@ -211,6 +271,15 @@ def count_alarm_specs(
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警规则的总数。
+
+    Args:
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm rule count
+    """
     total = service_count_alarm_rules(query, enabled)
     print(total)
 
@@ -218,13 +287,27 @@ def count_alarm_specs(
 @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,
+    page_num: Annotated[int, typer.Option("-n", "--page-num", help="页码")] = 0,
+    page_size: Annotated[int, typer.Option("-s", "--page-size", help="每页大小")] = 20,
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警动作列表。
+
+    按所属规则、关键字与启用状态过滤告警动作，并以平面表格输出。
+
+    Args:
+        rule: 所属规则编码列表。
+        page: 页码（从 0 开始）。
+        size: 每页条数。
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm action list --rule MY_RULE
+    """
     try:
-        group_nodes = service_list_alarm_action(page, size, query, enabled, rule)
+        group_nodes = service_list_alarm_action(page_num, page_size, query, enabled, rule)
     except DataOpsError as e:
         typer.echo(f"错误: {e.message}")
         raise typer.Exit(code=1) from None
@@ -261,6 +344,16 @@ def count_alarm_actions(
     query: Annotated[Optional[str], typer.Option("-q", "--query", help="搜索关键字")] = None,
     enabled: Annotated[Optional[bool], typer.Option(help="启用状态")] = None,
 ):
+    """查询告警动作的总数。
+
+    Args:
+        rule: 所属规则编码列表。
+        query: 可选关键字。
+        enabled: 可选启用状态过滤。
+
+    Examples:
+        >>> data-ops-cli alarm action count --rule MY_RULE
+    """
     try:
         total = service_count_alarm_action(query, enabled, rule)
     except DataOpsError as e:
@@ -271,9 +364,11 @@ def count_alarm_actions(
 
 @alarm_rule_typer.command("enums")
 def get_alarm_rule_enums() -> None:
-    """获取告警规则枚举配置.
+    """获取告警规则枚举配置。
 
-    示例:
+    后端返回 ``dict`` 时以两列 ``key/value`` 表渲染；其他结构以 JSON 形式输出。
+
+    Examples:
         >>> data-ops-cli alarm rule enums
     """
     try:
@@ -300,9 +395,14 @@ def get_alarm_rule_enums() -> None:
 def find_meta_by_codes(
     codes: Annotated[list[str], typer.Argument(help="告警规则编码列表")],
 ) -> None:
-    """根据告警规则编码批量查询关联元数据.
+    """根据告警规则编码批量查询关联元数据。
+
+    以 JSON 格式输出查询结果，便于人工检视或管道后续处理。
+
+    Args:
+        codes: 告警规则编码列表。
 
-    示例:
+    Examples:
         >>> data-ops-cli alarm rule find-meta-by-codes code1 code2
     """
     try:
@@ -318,9 +418,12 @@ def find_meta_by_codes(
 def get_alarm_table_columns(
     spec_type: Annotated[str, typer.Argument(help="告警规格类型")],
 ) -> None:
-    """获取指定 specType 对应的告警表列定义.
+    """获取指定 specType 对应的告警表列定义。
 
-    示例:
+    Args:
+        spec_type: 告警规格类型编码。
+
+    Examples:
         >>> data-ops-cli alarm rule alarm-columns MY_SPEC_TYPE
     """
     try:
@@ -336,9 +439,12 @@ def get_alarm_table_columns(
 def get_rel_table_columns(
     code: Annotated[str, typer.Argument(help="告警规则编码")],
 ) -> None:
-    """获取指定告警规则关联表列.
+    """获取指定告警规则关联表的列定义。
+
+    Args:
+        code: 告警规则编码。
 
-    示例:
+    Examples:
         >>> data-ops-cli alarm rule rel-columns rule_code_001
     """
     try:
@@ -358,12 +464,16 @@ def find_alarm_table_data(
         typer.Option(help="查询条件 JSON 字符串"),
     ] = None,
 ) -> None:
-    """查询告警表数据.
+    """查询指定数据源中告警表的实际数据（由告警规则写入的记录，非实时告警）。
 
-    示例:
-        >>> data-ops-cli alarm rule data --code rule_code_001
+    ``--query`` 接收 JSON 字符串并解析为 dict 后透传给 SDK。
 
-        带查询条件
+    Args:
+        code: 告警规则编码。
+        query: 可选 JSON 字符串，表示查询条件。
+
+    Examples:
+        >>> 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:

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/src/dataops_cli/cli/api.py

@@ -6,11 +6,10 @@
 - CLI 命令：基于服务层的薄包装，负责格式化输出
 """
 
-import shutil
 from typing import Annotated
 
 import typer
-
+from dataops_cli.cli.utils import print_list
 from dataops_sdk.exceptions import DataOpsError
 from dataops_sdk.schemas import MetaType
 from dataops_sdk.services.api import service_get_api_by_code
@@ -46,7 +45,11 @@ api_typer = typer.Typer(
 
 
 def _first_line(text: str) -> str:
-    """取文本的第一行."""
+    """取文本的第一行。
+
+    Args:
+        text: 多行字符串。
+    """
     return text.split("\n")[0]
 
 
@@ -56,11 +59,14 @@ def list_apis(
         str | None, typer.Option("-q", "--query", help="按名称/标题/备注正则过滤")
     ] = None,
 ) -> None:
-    """列出所有 API 接口.
+    """列出所有 API 接口。
 
     从元数据服务获取 API 接口列表，支持通过正则表达式按名称、标题或备注进行过滤。
 
-    示例:
+    Args:
+        query: 可选正则表达式，按名称/标题/备注过滤。
+
+    Examples:
         列出所有 API 接口
         >>> data-ops-cli api list
 
@@ -81,14 +87,14 @@ def list_apis(
         print("(无结果)")
         return
 
-    print("code title remark")
+    print_list(
+        ["code", "title", "remark"],
+        [
+            [node.CODE, node.TITLE, _first_line(node.REMARK or "")]
+            for node in group_nodes
+        ]
+    )
 
-    for node in group_nodes:
-        code = node.CODE
-        title = node.TITLE
-        remark_raw = node.REMARK or ""
-        remark = _first_line(remark_raw.strip())
-        print(code, title, remark)
 
 
 @api_typer.command("detail", rich_help_panel="API 查询", no_args_is_help=True)
@@ -99,11 +105,15 @@ def get_api_detail(
         typer.Option("-s", "--simplify", help="仅显示基本信息，不展示请求/响应参数"),
     ] = False,
 ) -> None:
-    """获取 API 接口详情.
+    """获取 API 接口详情。
 
     根据 API 接口编码获取详细信息，包括请求方法、路径、状态、请求参数和响应参数。
 
-    示例:
+    Args:
+        code: API 接口编码。
+        simplify: 是否仅显示基本信息（不展示请求/响应参数）。
+
+    Examples:
         获取 API 接口完整信息
         >>> data-ops-cli api detail user_login
 
@@ -207,7 +217,13 @@ def get_api_detail(
 
 
 def _print_params_tree(params: list[dict], indent: int = 0, prefix: str = "") -> None:
-    """递归打印参数树结构."""
+    """递归打印参数树结构。
+
+    Args:
+        params: 参数节点列表。
+        indent: 当前缩进空格数。
+        prefix: 每行前缀。
+    """
     for p in params:
         ptype = p.get("type", "?")
         name = p.get("name", "?")

{data_ops_cli-0.3.0 → data_ops_cli-0.3.1}/src/dataops_cli/cli/auth.py

@@ -34,11 +34,13 @@ auth_typer.add_typer(application_typer)
 
 @auth_typer.command("status")
 def auth_status() -> None:
-    """显示当前认证状态.
+    """显示当前认证状态。
 
     查询当前用户的登录状态及已设置的应用信息。
-    如果未登录，提示用户先进行登录。
-    如果已登录但未设置应用，提示用户设置应用。
+
+    如果未登录，提示用户先进行登录；
+    如果已登录但未设置应用，提示用户设置应用；
+    否则同时输出应用关联的主/隐患数据源信息。
     """
     target_path = get_work_dir(USER_INFO_FILE)
     if not target_path.exists():
@@ -82,12 +84,16 @@ def auth(
         envvar="DATA_OPS_PASSWORD",
     ),
 ) -> None:
-    """登录 DataOps 平台.
+    """登录 DataOps 平台。
 
     使用用户名和密码进行登录，登录成功后会将 Token 保存到本地。
-    支持通过环境变量 DATA_OPS_USERNAME 和 DATA_OPS_PASSWORD 传入凭据。
+    支持通过环境变量 ``DATA_OPS_USERNAME`` 和 ``DATA_OPS_PASSWORD`` 传入凭据。
+
+    Args:
+        username: 用户名。
+        password: 密码。
 
-    示例:
+    Examples:
         交互式登录
         >>> data-ops-cli auth login myuser mypassword
 
@@ -106,9 +112,12 @@ def auth(
 
 @auth_typer.command("logout")
 def logout() -> None:
-    """登出 DataOps 平台.
+    """登出 DataOps 平台。
 
     清除本地保存的登录凭证，退出当前登录状态。
+
+    Examples:
+        >>> data-ops-cli auth logout
     """
     ret = service_logout()
     if ret:
@@ -119,12 +128,15 @@ def logout() -> None:
 
 @application_typer.command("list")
 def application_list(query: Annotated[str | None, typer.Argument(help="关键字")] = None) -> None:
-    """列出所有可用应用.
+    """列出所有可用应用。
 
     显示当前用户可访问的所有应用列表，支持通过关键字过滤。
     表格显示应用的编码(code)、标题(title)和备注(remark)。
 
-    示例:
+    Args:
+        query: 可选关键字。
+
+    Examples:
         查看所有应用
         >>> data-ops-cli auth application list
 
@@ -148,12 +160,15 @@ def application_list(query: Annotated[str | None, typer.Argument(help="关键字
 
 @application_typer.command("set")
 def application_set(code: Annotated[str, typer.Argument(help="应用编码")]) -> None:
-    """设置当前应用.
+    """设置当前应用。
 
     将指定应用设置为当前会话的默认应用，后续操作将在该应用上下文中执行。
     设置完成后显示应用的详细信息。
 
-    示例:
+    Args:
+        code: 应用编码。
+
+    Examples:
         设置当前应用
         >>> data-ops-cli auth application set myapp_code
     """
@@ -174,10 +189,10 @@ def application_set(code: Annotated[str, typer.Argument(help="应用编码")]) -
 
 @application_typer.command("info")
 def application_info() -> None:
-    """显示当前应用信息.
+    """显示当前应用信息。
 
     查看当前已设置应用的详细信息，包括编码、标题和备注。
-    如果尚未设置应用，提示用户使用 auth application set 命令进行设置。
+    如果尚未设置应用，提示用户使用 ``auth application set`` 命令进行设置。
     """
     application = service_get_current_application()
     if application is None: