dataops-sdk 0.5.3__tar.gz → 0.5.4__tar.gz

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataops-sdk
-Version: 0.5.3
+Version: 0.5.4
 Summary: Python SDK for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/__init__.py

@@ -93,4 +93,4 @@ from .services import (  # noqa: F401
 )
 from .session import dataops_base_url_context, request_context
 
-__version__ = "0.5.3"
+__version__ = "0.5.4"

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/runner/utils/nacos.py

@@ -22,6 +22,14 @@ from dataops_sdk.runner.schemas.nacos.constants import Constants
 from dataops_sdk.session import get_headers
 
 
+def _has_explicit_credential(headers: Mapping[str, str] | None) -> bool:
+    """调用方已传入登录令牌或 API key 时，不再强制本地登录。"""
+    if not headers:
+        return False
+    names = {name.lower() for name in headers}
+    return "x-api-key" in names or "fmind-auth" in names
+
+
 def get_service_instance(
     service_name: str,
     group_name: str = Constants.DEFAULT_GROUP,
@@ -89,7 +97,7 @@ def get_service_instance(
 
     instance = random.choice(service.hosts)
 
-    auth_headers = get_headers()
+    auth_headers = dict(get_headers(strict=not _has_explicit_credential(headers)))
     if headers:
         auth_headers.update(headers)
 

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/schemas/__init__.py

@@ -47,7 +47,7 @@ from .ontology import (
 )
 from .query import PageParam, SqlCondition, SqlFilter, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
-from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult, SkillOntologyVO
+from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
 from .table import (
     ColumnItem,
     DataBaseColumnDictExternal,

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/schemas/skill.py

@@ -62,13 +62,6 @@ class MetaSkill(Meta[DataSkill]):
     """
 
 
-class SkillOntologyVO(BaseModel):
-    """技能归属本体（由 meta_release_ref 反查）."""
-
-    code: Annotated[str, Field(description="本体编码")]
-    title: Annotated[str, Field(description="本体标题", default="")]
-
-
 class SkillCallResult(BaseModel):
     """调用 skill 后的返回结果，对应 Java ``SkillResult``.
 

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/services/__init__.py

@@ -101,10 +101,10 @@ from .skill import (
     service_skill_update,
     service_skill_get_subfile_by_code,
     service_skill_get_subfile_by_name,
+    service_skill_files,
+    service_skill_file,
     service_skill_upload,
     service_skill_upload_sub_file,
-    service_skill_list_ontologies_by_codes,
-    service_skill_list_ontology_options,
     service_skill_list_skill_codes_by_ontology,
 )
 from .table import (
@@ -249,10 +249,10 @@ __all__ = [
     "service_skill_update",
     "service_skill_get_subfile_by_code",
     "service_skill_get_subfile_by_name",
+    "service_skill_files",
+    "service_skill_file",
     "service_skill_upload",
     "service_skill_upload_sub_file",
-    "service_skill_list_ontologies_by_codes",
-    "service_skill_list_ontology_options",
     "service_skill_list_skill_codes_by_ontology",
     "service_count_table_by_code",
     "service_count_table_by_name",

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/services/skill.py

@@ -21,13 +21,11 @@ from pydantic_core import to_json
 from dataops_sdk.exceptions import AuthenticationError, DataOpsError
 from dataops_sdk.schemas import (
     DataSkill,
-    DataSkillSubFile,
     Meta,
     MetaBase,
     MetaSkillSubType,
     MetaType,
     SkillCallResult,
-    SkillOntologyVO,
 )
 from dataops_sdk.services.meta import (
     release_list_get_by_code,
@@ -54,8 +52,8 @@ __all__ = [
     "service_skill_upload_sub_file",
     "service_skill_get_subfile_by_name",
     "service_skill_get_subfile_by_code",
-    "service_skill_list_ontologies_by_codes",
-    "service_skill_list_ontology_options",
+    "service_skill_files",
+    "service_skill_file",
     "service_skill_list_skill_codes_by_ontology",
 ]
 
@@ -227,26 +225,6 @@ def _post_skill_data_api(url: str, body: dict) -> object:
         raise AuthenticationError("认证失败，请先登录") from e
 
 
-def service_skill_list_ontology_options() -> list[SkillOntologyVO]:
-    """列出已绑定技能的本体选项（``POST /data/skill/ontology/options``）."""
-    data = _post_skill_data_api("/data/skill/ontology/options", {})
-    if not isinstance(data, list):
-        return []
-    return [SkillOntologyVO.model_validate(item) for item in data]
-
-
-def service_skill_list_ontologies_by_codes(codes: list[str]) -> dict[str, list[SkillOntologyVO]]:
-    """批量查询技能归属本体（``POST /data/skill/ontology/batch``）."""
-    data = _post_skill_data_api("/data/skill/ontology/batch", {"codes": codes})
-    if not isinstance(data, dict):
-        return {}
-    result: dict[str, list[SkillOntologyVO]] = {}
-    for key, value in data.items():
-        if isinstance(value, list):
-            result[str(key)] = [SkillOntologyVO.model_validate(item) for item in value]
-    return result
-
-
 def service_skill_list_skill_codes_by_ontology(ontology_code: str) -> list[str]:
     """按本体查询绑定的技能 code 列表（``POST /data/skill/ontology/skillCodes``）."""
     data = _post_skill_data_api(
@@ -280,12 +258,10 @@ def service_get_skill_by_name(name: str, path: None = None) -> Meta[DataSkill]:
 
 
 @overload
-def service_get_skill_by_name(name: str, path: str) -> Meta[DataSkillSubFile]: ...
+def service_get_skill_by_name(name: str, path: str) -> dict: ...
 
 
-def service_get_skill_by_name(
-    name: str, path: str | None = None
-) -> Meta[DataSkill | DataSkillSubFile]:
+def service_get_skill_by_name(name: str, path: str | None = None) -> Meta[DataSkill] | dict:
     """按业务名获取技能详情.
 
     Args:
@@ -360,7 +336,7 @@ def service_skill_upload(
     with (
         open(path, "rb") as f,
         post_multipart(
-            "/data/skill/import",
+            "/data/skill/create",
             files={"file": (path.name, f)},
             data=form_data,
         ) as resp,
@@ -410,7 +386,7 @@ def service_skill_update(
     with (
         open(path, "rb") as f,
         post_multipart(
-            f"/data/skill/{meta.code}/import",
+            f"/data/skill/{meta.code}/update",
             files={"file": (path.name, f)},
             data=form_data or None,
         ) as resp,
@@ -549,12 +525,10 @@ def service_skill_delete_sub_file(name: str, path: str) -> None:
         DataOpsError: API 返回错误时
         AuthenticationError: 未认证或认证失败时
     """
-    body = dict(path=path)
+    body = {"path": path}
     try:
         with get_session() as session:
-            resp = session.post(
-                f"/data/skill/{name}/subfile/delete", content=to_json(encrypt_body(body))
-            )
+            resp = session.post(f"/data/skill/{name}/subfile/delete", params=body)
             resp_body = resp.json()
             if resp.status_code == 401:
                 raise AuthenticationError("认证失败，请先登录")
@@ -639,7 +613,7 @@ def service_skill_call_by_name(name: str, inputs: Mapping) -> SkillCallResult:
         raise AuthenticationError("认证失败，请先登录") from e
 
 
-def service_skill_get_subfile_by_name(name: str, path: str) -> Meta[DataSkillSubFile]:
+def service_skill_get_subfile_by_name(name: str, path: str) -> dict:
     """获取技能下的指定子文件.
 
     Args:
@@ -653,11 +627,10 @@ def service_skill_get_subfile_by_name(name: str, path: str) -> Meta[DataSkillSub
         DataOpsError: API 返回错误时
         AuthenticationError: 未认证或认证失败时
     """
-    body = dict(path=path)
     try:
         with get_session() as session:
             resp = session.post(
-                f"/data/skill/{name}/subfile/getByName", content=to_json(encrypt_body(body))
+                "/data/skill/file", content=to_json(encrypt_body({"name": name, "path": path}))
             )
             resp_body = resp.json()
             if resp.status_code == 401:
@@ -669,12 +642,12 @@ def service_skill_get_subfile_by_name(name: str, path: str) -> Meta[DataSkillSub
         data = resp_body.get("data")
         if data is None:
             raise DataOpsError(f"文件 {path} 不存在")
-        return Meta[DataSkillSubFile].model_validate(data)
+        return data
     except SystemExit as e:
         raise AuthenticationError("认证失败，请先登录") from e
 
 
-def service_skill_get_subfile_by_code(code: str, path: str) -> Meta:
+def service_skill_get_subfile_by_code(code: str, path: str) -> dict:
     """获取技能下的指定子文件.
 
     Args:
@@ -688,11 +661,10 @@ def service_skill_get_subfile_by_code(code: str, path: str) -> Meta:
         DataOpsError: API 返回错误时
         AuthenticationError: 未认证或认证失败时
     """
-    body = dict(path=path)
     try:
         with get_session() as session:
             resp = session.post(
-                f"/data/skill/{code}/subfile/getByCode", content=to_json(encrypt_body(body))
+                "/data/skill/file", content=to_json(encrypt_body({"code": code, "path": path}))
             )
             resp_body = resp.json()
             if resp.status_code == 401:
@@ -704,6 +676,50 @@ def service_skill_get_subfile_by_code(code: str, path: str) -> Meta:
         data = resp_body.get("data")
         if data is None:
             raise DataOpsError(f"文件 {path} 不存在")
-        return Meta.model_validate(data)
+        return data
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+
+
+def service_skill_files(*, code: str | None = None, name: str | None = None) -> list[dict]:
+    """获取技能文件树，技能由 ``code`` 或 ``name`` 定位。"""
+    if not code and not name:
+        raise ValueError("code 或 name 至少提供一个")
+    try:
+        with get_session() as session:
+            resp = session.post(
+                "/data/skill/files",
+                content=to_json(encrypt_body({"code": code, "name": name})),
+            )
+            body = resp.json()
+            if resp.status_code == 401:
+                raise AuthenticationError("认证失败，请先登录")
+            if resp.status_code != 200:
+                raise DataOpsError(body.get("msg", f"HTTP {resp.status_code}"), resp.status_code)
+        data = body.get("data")
+        return data if isinstance(data, list) else []
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+
+
+def service_skill_file(path: str, *, code: str | None = None, name: str | None = None) -> dict:
+    """读取技能指定路径的可读内容；``SKILL.md`` 对应技能主文件。"""
+    if not code and not name:
+        raise ValueError("code 或 name 至少提供一个")
+    try:
+        with get_session() as session:
+            resp = session.post(
+                "/data/skill/file",
+                content=to_json(encrypt_body({"code": code, "name": name, "path": path})),
+            )
+            body = resp.json()
+            if resp.status_code == 401:
+                raise AuthenticationError("认证失败，请先登录")
+            if resp.status_code != 200:
+                raise DataOpsError(body.get("msg", f"HTTP {resp.status_code}"), resp.status_code)
+        data = body.get("data")
+        if not isinstance(data, dict):
+            raise DataOpsError(f"文件 {path} 不存在")
+        return data
     except SystemExit as e:
         raise AuthenticationError("认证失败，请先登录") from e

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk/session.py

@@ -198,18 +198,38 @@ def get_user_info(strict: bool = True) -> UserInfo | None:
     return user_info
 
 
+def _api_key_headers_from_env() -> dict[str, str] | None:
+    """从环境变量组装 API key 请求头。
+
+    ``DATAOPS_API_KEY`` 与 ``DATAOPS_CLIENT_ID`` 必须同时存在才视为 API key 认证。
+    ``DATAOPS_TENANT_ID`` 非空时写入 ``x-tenant-id``。
+    """
+    api_key = (os.getenv("DATAOPS_API_KEY") or "").strip()
+    client_id = (os.getenv("DATAOPS_CLIENT_ID") or "").strip()
+    tenant_id = (os.getenv("DATAOPS_TENANT_ID") or "").strip()
+    if not api_key or not client_id or not tenant_id:
+        return None
+    headers = {"x-api-key": api_key, "x-client-id": client_id, "x-tenant-id": tenant_id}
+    return headers
+
+
 def get_headers(strict: bool = True) -> dict[str, str]:
     """构造调用 DataOps API 所需的请求头。
 
     按以下优先级合并来源：
     1. 请求上下文中的认证头（web app 场景，由 ``set_request_auth`` 注入）。
-    2. 环境变量 ``FMIND_AUTH_HEADERS`` 中的 JSON 字符串。
-    3. 模块级配置 / 本地缓存：``Fmind-Auth`` 取自 ``user_info``，``X-App-Code``
-       与 ``X-App-Release`` 取自 ``application`` 或 ``_config``。
+    2. 环境变量 ``FMIND_AUTH_HEADERS`` 中的 JSON 字符串。可为登录令牌，也可仅为
+       ``x-api-key`` / ``x-client-id`` / ``x-tenant-id``。
+    3. 环境变量 ``DATAOPS_API_KEY`` 与 ``DATAOPS_CLIENT_ID``（可选 ``DATAOPS_TENANT_ID``）。
+       存在时不再要求 ``user_info.json``，也不写入 ``Fmind-Auth``。若本地有
+       ``application.json``，仍附加 ``X-App-Code`` / ``X-App-Release``。
+    4. 模块级配置 / 本地缓存：``Fmind-Auth`` 取自 ``user_info``，``X-App-Code``
+       与 ``X-App-Release`` 取自 ``application``。
 
     Args:
         strict: 是否要求凭据必须可用。为 ``True`` 时若缺失则会触发 ``SystemExit``；
             为 ``False`` 时允许仅返回 ``X-App-Code`` 等应用头而不包含 ``Fmind-Auth``。
+            API key 环境变量视为完整凭证，满足 ``strict=True``。
 
     Returns:
         Mapping[str, str]: 最终的请求头映射。
@@ -226,6 +246,14 @@ def get_headers(strict: bool = True) -> dict[str, str]:
         headers = from_json(fmind_auth_headers)
         assert isinstance(headers, dict), "FMIND_AUTH_HEADERS must be a JSON object string"
         return headers
+    api_key_headers = _api_key_headers_from_env()
+    if api_key_headers is not None:
+        headers = dict(api_key_headers)
+        application = get_application(strict=False)
+        if application is not None:
+            headers["X-App-Code"] = application.CODE
+            headers["X-App-Release"] = "1.0.0"
+        return headers
     # 其次从配置获取
     user_info = get_user_info(strict=strict)
     application = get_application(strict=strict)

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataops-sdk
-Version: 0.5.3
+Version: 0.5.4
 Summary: Python SDK for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{dataops_sdk-0.5.3 → dataops_sdk-0.5.4}/src/dataops_sdk.egg-info/SOURCES.txt

@@ -86,6 +86,7 @@ src/dataops_sdk/utils/__init__.py
 src/dataops_sdk/utils/common.py
 src/dataops_sdk/utils/log.py
 src/dataops_sdk/utils/utils.py
+tests/test_api_key_headers.py
 tests/test_constants.py
 tests/test_datasource_factory.py
 tests/test_db_conn_async.py

dataops_sdk-0.5.4/tests/test_api_key_headers.py

@@ -0,0 +1,74 @@
+"""API key 作为 dataops_sdk 完整凭证的请求头测试."""
+
+from __future__ import annotations
+
+import json
+
+import pytest
+from dataops_sdk.session import get_headers
+
+
+def test_fmind_auth_headers_api_key_is_returned_as_is(monkeypatch: pytest.MonkeyPatch) -> None:
+    """FMIND_AUTH_HEADERS 仅含 API key 三头时原样返回，不补 Fmind-Auth."""
+    payload = {
+        "x-api-key": "secret",
+        "x-client-id": "caller-client",
+        "x-tenant-id": "tenant-1",
+    }
+    monkeypatch.setenv("FMIND_AUTH_HEADERS", json.dumps(payload))
+    monkeypatch.setenv("DATAOPS_API_KEY", "other-key")
+    monkeypatch.setenv("DATAOPS_CLIENT_ID", "other-client")
+
+    headers = get_headers(strict=True)
+
+    assert headers == payload
+    assert "Fmind-Auth" not in headers
+
+
+def test_api_key_env_satisfies_strict_without_user_info(
+    monkeypatch: pytest.MonkeyPatch, tmp_user_dir
+) -> None:
+    """仅 DATAOPS_API_KEY 与 DATAOPS_CLIENT_ID 时 strict=True 成功，且不含 Fmind-Auth."""
+    monkeypatch.delenv("FMIND_AUTH_HEADERS", raising=False)
+    monkeypatch.setenv("DATAOPS_API_KEY", "secret")
+    monkeypatch.setenv("DATAOPS_CLIENT_ID", "caller-client")
+    monkeypatch.setenv("DATAOPS_TENANT_ID", "tenant-1")
+
+    headers = get_headers(strict=True)
+
+    assert headers["x-api-key"] == "secret"
+    assert headers["x-client-id"] == "caller-client"
+    assert headers["x-tenant-id"] == "tenant-1"
+    assert "Fmind-Auth" not in headers
+
+
+def test_api_key_env_appends_application_headers(
+    monkeypatch: pytest.MonkeyPatch, write_application
+) -> None:
+    """存在 application.json 时，API key 头仍附加应用编码与版本."""
+    monkeypatch.delenv("FMIND_AUTH_HEADERS", raising=False)
+    monkeypatch.setenv("DATAOPS_API_KEY", "secret")
+    monkeypatch.setenv("DATAOPS_CLIENT_ID", "caller-client")
+    monkeypatch.delenv("DATAOPS_TENANT_ID", raising=False)
+    write_application({"CODE": "file-app"})
+
+    headers = get_headers(strict=True)
+
+    assert headers["x-api-key"] == "secret"
+    assert headers["X-App-Code"] == "file-app"
+    assert headers["X-App-Release"] == "1.0.0"
+    assert "Fmind-Auth" not in headers
+    assert "x-tenant-id" not in headers
+
+
+def test_api_key_without_client_id_still_requires_login(
+    monkeypatch: pytest.MonkeyPatch, tmp_user_dir
+) -> None:
+    """只设置 API key、没有 client id 时，strict=True 仍要求登录."""
+    monkeypatch.delenv("FMIND_AUTH_HEADERS", raising=False)
+    monkeypatch.setenv("DATAOPS_API_KEY", "secret")
+    monkeypatch.delenv("DATAOPS_CLIENT_ID", raising=False)
+
+    with pytest.raises(SystemExit) as exc:
+        get_headers(strict=True)
+    assert exc.value.code == 401