feat: add SDK client identifier override and deployment plan parameters

Author: luk384090-cloud

dashscope/cli/__init__.py

@@ -22,6 +22,7 @@
 import dashscope  # noqa: E402
 from dashscope.cli.common import err_console  # noqa: E402
 from dashscope.common.error import AuthenticationError  # noqa: E402
+from dashscope.common.utils import set_sdk_client  # noqa: E402
 from dashscope.cli import (  # noqa: E402
     application,
     auth,
@@ -43,6 +44,8 @@
     video_synthesis,
 )
 
+set_sdk_client("python-cli")
+
 
 # ---------------------------------------------------------------------------
 # Legacy command compatibility layer

dashscope/cli/deployments.py

@@ -129,10 +129,11 @@ def create(
         "--capacity",
         help="The target capacity",
     ),
-    plan: Optional[str] = typer.Option(
-        None,
+    plan: str = typer.Option(
+        ...,
         "--plan",
-        help="Deployment plan or template ID",
+        help="Required. Deployment plan: ptu (PTU reserved), "
+        "mu (model unit), or Lora (LoRA deployment).",
     ),
     template_id: Optional[str] = typer.Option(
         None,
@@ -145,9 +146,8 @@ def create(
         "model": model,
         "capacity": capacity,
         "suffix": suffix,
+        "plan": plan,
     }
-    if plan is not None:
-        kwargs["plan"] = plan
     if template_id is not None:
         kwargs["template_id"] = template_id
 
@@ -194,12 +194,19 @@ def call(
         "--capacity",
         help="The target capacity",
     ),
+    plan: str = typer.Option(
+        ...,
+        "--plan",
+        help="Required. Deployment plan: ptu (PTU reserved), "
+        "mu (model unit), or Lora (LoRA deployment).",
+    ),
 ):
     """(Deprecated: use 'create' instead) Create a model deployment."""
     create(
         model=model,
         suffix=suffix,
         capacity=capacity,
+        plan=plan,
     )
 
 

dashscope/common/utils.py

@@ -163,6 +163,20 @@ def get_user_agent():
     return ua
 
 
+_SDK_CLIENT = "python-sdk"
+
+
+def set_sdk_client(client: str) -> None:
+    """Override the client identifier in the x-dashscope-sdk-client header.
+
+    Process-wide, used by entry points that embed the SDK (e.g. the
+    ``dashscope`` CLI marks itself as ``python-cli``).
+    """
+    global _SDK_CLIENT  # pylint: disable=global-statement
+    if client:
+        _SDK_CLIENT = client
+
+
 def get_sdk_headers(module: str = "") -> Dict[str, str]:
     """Structured SDK identification headers for backend statistics.
 
@@ -173,7 +187,7 @@ def get_sdk_headers(module: str = "") -> Dict[str, str]:
     """
     if os.environ.get("DASHSCOPE_DISABLE_SDK_HEADERS"):
         return {}
-    parts = ["python-sdk", __version__]
+    parts = [_SDK_CLIENT, __version__]
     if module:
         parts.append(module)
     return {

dashscope/finetune/deployments.py

@@ -37,6 +37,8 @@ def call(  # pylint: disable=arguments-renamed  # type: ignore[override]
         capacity: int,
         version: str = None,
         suffix: Optional[str] = None,
+        plan: Optional[str] = None,
+        template_id: Optional[str] = None,
         api_key: str = None,
         workspace: str = None,
         **kwargs,
@@ -51,6 +53,11 @@ def call(  # pylint: disable=arguments-renamed  # type: ignore[override]
                 If specified, the final model name will be model_suffix.
                 Defaults to None.
             capacity (int, optional): The model service capacity.
+            plan (str, optional): The deployment plan required by the
+                service: "ptu" (PTU reserved), "mu" (model unit) or
+                "Lora" (LoRA deployment). Defaults to None.
+            template_id (str, optional): Template ID for deployment
+                configuration. Defaults to None.
             api_key (str, optional): The api-key. Defaults to None.
             workspace (str): The dashscope workspace id.
 
@@ -63,6 +70,10 @@ def call(  # pylint: disable=arguments-renamed  # type: ignore[override]
             req["model_version"] = version
         if suffix is not None:
             req["suffix"] = suffix
+        if plan is not None:
+            req["plan"] = plan
+        if template_id is not None:
+            req["template_id"] = template_id
         response = super().call(
             req,
             api_key=api_key,

tests/unit/handle_deployment_request.py

@@ -21,6 +21,8 @@ async def create_deployment_handler(request: aiohttp.request):
             "deployed_model": "deploy123456",
             "status": "PENDING",
             "model_name": "qwen-turbo-ft-202307121513-5dde",
+            "plan": body.get("plan"),
+            "template_id": body.get("template_id"),
         },
     }
 

tests/unit/test_cli_main.py

@@ -648,7 +648,7 @@ def mock_call(**kwargs):
 
         result = CliRunner().invoke(
             cli_app,
-            ["deployments", "create", "--model", "qwen"],
+            ["deployments", "create", "--model", "qwen", "--plan", "ptu"],
         )
 
         assert result.exit_code == 1

tests/unit/test_http_deployments_api.py

@@ -21,6 +21,21 @@ def test_create_deployment_tune_job(self, http_server):
         assert resp.output["deployed_model"] == "deploy123456"
         assert resp.output["status"] == "PENDING"
 
+    def test_create_deployment_with_plan(self, http_server):
+        # Regression: plan/template_id must reach the request body (verified
+        # via mock echo; previously dropped silently, causing "plan is blank")
+        resp = Deployments.call(
+            model="gpt",
+            suffix="1",
+            capacity=2,
+            plan="plan-standard",
+            template_id="tpl-001",
+        )
+        assert resp.status_code == HTTPStatus.OK
+        assert resp.output["deployed_model"] == "deploy123456"
+        assert resp.output["plan"] == "plan-standard"
+        assert resp.output["template_id"] == "tpl-001"
+
     def test_list_deployment_job(self, http_server):
         rsp = Deployments.list()
         assert rsp.status_code == HTTPStatus.OK

tests/unit/test_sdk_headers.py

@@ -13,6 +13,11 @@
 SESSION_HEADER = "x-dashscope-sdk-session-id"
 DISABLE_ENV = "DASHSCOPE_DISABLE_SDK_HEADERS"
 
+# client 取值来源：
+#   - "python-sdk": SDK 默认（common/utils.py 的 _SDK_CLIENT）
+#   - "python-cli": dashscope/cli/__init__.py 在 CLI 进程启动时调用
+#                   set_sdk_client("python-cli") 覆盖
+#   - "acli":       acli/providers/tongyi.py 自建 header
 # module 取值在代码库中的实际使用点：
 #   - "" (无 module): default_headers / base_request / api_request_factory
 #   - "agentstudio":  agentstudio/transport.py
@@ -21,6 +26,12 @@
 ACLI_MODULES = ["", "app"]
 
 
+@pytest.fixture(autouse=True)
+def _pin_sdk_client(monkeypatch):
+    # CLI 测试会在同进程内把 client 改成 python-cli，这里钉住默认值
+    monkeypatch.setattr("dashscope.common.utils._SDK_CLIENT", "python-sdk")
+
+
 def _check_client_header(value, client, version, module=""):
     parts = value.split("/")
     assert parts[0] == client
@@ -68,5 +79,46 @@ def test_sdk_headers_disabled(monkeypatch):
     assert SESSION_HEADER not in provider._get_headers()
 
 
+def test_python_cli_client_header():
+    from dashscope.common.utils import set_sdk_client
+
+    set_sdk_client("python-cli")
+    try:
+        headers = get_sdk_headers()
+        value = headers[CLIENT_HEADER]
+        print(f"\npython-cli -> {value}")
+        _check_client_header(value, "python-cli", sdk_version)
+        # module 段同样适用
+        value = get_sdk_headers(module="agentstudio")[CLIENT_HEADER]
+        print(f"python-cli -> {value}")
+        _check_client_header(value, "python-cli", sdk_version, "agentstudio")
+    finally:
+        set_sdk_client("python-sdk")
+
+
+def test_cli_import_marks_process():
+    # 子进程隔离验证：加载 dashscope.cli 后，进程内请求的
+    # client 标识应变为 python-cli（与同进程其他测试的执行顺序无关）
+    import subprocess
+    import sys
+
+    code = (
+        "import dashscope.cli; "
+        "from dashscope.common.utils import get_sdk_headers; "
+        "h = get_sdk_headers(); "
+        "c = h['x-dashscope-sdk-client']; "
+        "assert c.startswith('python-cli/'), c; "
+        "print(c)"
+    )
+    result = subprocess.run(
+        [sys.executable, "-c", code],
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    assert result.returncode == 0, result.stderr
+    print(f"\nCLI process -> {result.stdout.strip()}")
+
+
 if __name__ == "__main__":
     pytest.main([__file__, "-v", "-s"])