ap-client 0.1.4.dev0__tar.gz → 0.1.5.post0__tar.gz

ap_client-0.1.5.post0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: ap-client
+Version: 0.1.5.post0
+Summary: Agent Platform API Client & CLI
+Requires-Python: >=3.10
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+A lightweight Python SDK and command line interface for Agent Platform. It provides helpers for configuring API access and managing templates, datasets, jobs, and groups.

ap_client-0.1.5.post0/ap_client/__init__.py

@@ -0,0 +1,21 @@
+"""Agent Platform API Client"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from .api import APIClient, APIError, get_client
+from .config import Config, ConfigurationError, get_config
+
+try:
+    __version__ = version("ap-client")
+except PackageNotFoundError:
+    __version__ = "0+unknown"
+
+__all__ = [
+    "APIClient",
+    "APIError",
+    "Config",
+    "ConfigurationError",
+    "__version__",
+    "get_client",
+    "get_config",
+]

{ap_client-0.1.4.dev0 → ap_client-0.1.5.post0}/ap_client/api.py

@@ -1,6 +1,6 @@
 """API client."""
 
-import json as _json
+import json
 import platform
 import sys
 import time
@@ -10,7 +10,7 @@ from urllib.parse import quote
 
 import requests
 
-from .config import Config, get_config
+from .config import Config, ConfigurationError, get_config, has_cluster_header
 
 _GROUP_ARTIFACTS_PAGE_SIZE = 500
 _VERBOSE_SAMPLE_KEYS = 5
@@ -18,6 +18,28 @@ _VERBOSE_SAMPLE_ITEMS = 3
 _VERBOSE_VALUE_PREVIEW = 120
 
 
+class APIError(Exception):
+    """Raised when an API request fails."""
+
+    def __init__(
+        self,
+        status_code: Optional[int],
+        detail: Any,
+        request_id: str,
+        response: Optional[requests.Response],
+    ):
+        self.status_code = status_code
+        self.detail = detail
+        self.request_id = request_id
+        self.response = response
+        super().__init__(self._build_message())
+
+    def _build_message(self) -> str:
+        if self.status_code is None:
+            return f"API Network Error: {self.detail} (request_id={self.request_id})"
+        return f"API Error {self.status_code}: {self.detail} (request_id={self.request_id})"
+
+
 class APIClient:
     """Agent Platform API client."""
 
@@ -27,6 +49,11 @@ class APIClient:
         headers = dict(config.headers)
         user_agent = _build_user_agent(headers.get("User-Agent"))
         headers["User-Agent"] = user_agent
+
+        # 认证 header: AP_TOKEN_KEY -> X-API-Key
+        if config.token_key:
+            headers["X-API-Key"] = config.token_key
+
         self.session.headers.update(
             {
                 "Content-Type": "application/json",
@@ -55,6 +82,7 @@ class APIClient:
         timeout: float = 30,
     ) -> Any:
         """Send an HTTP request with X-Request-ID and optional verbose logging."""
+        self._require_cluster_config()
         url = self._url(path)
         request_id = str(uuid.uuid4())
         headers = {"X-Request-ID": request_id}
@@ -71,27 +99,29 @@ class APIClient:
                 headers=headers,
                 timeout=timeout,
             )
-        except Exception as exc:
+        except requests.RequestException as exc:
             if verbose:
                 duration_ms = (time.perf_counter() - start) * 1000
                 self._log_exception(method, url, request_id, duration_ms, exc)
-            raise
+            raise APIError(None, str(exc), request_id, None) from exc
         duration_ms = (time.perf_counter() - start) * 1000
         if verbose:
             self._log_response(method, url, request_id, resp, duration_ms)
         if not resp.ok:
-            try:
-                err_data = resp.json()
-                detail = err_data.get("detail", resp.text)
-            except Exception:
-                detail = resp.text
-            raise Exception(
-                f"API Error {resp.status_code}: {detail} (request_id={request_id})"
-            )
+            detail = _response_error_detail(resp)
+            raise APIError(resp.status_code, detail, request_id, resp)
         if not resp.content:
             return None
         return resp.json()
 
+    def _require_cluster_config(self) -> None:
+        if has_cluster_header(self.config.headers):
+            return
+        raise ConfigurationError(
+            "Missing cluster configuration. Set AP_CLUSTER (e.g. export AP_CLUSTER=test) "
+            "or include a non-empty X-Cluster in AP_HEADERS (e.g. export AP_HEADERS='X-Cluster: test')."
+        )
+
     def _get(self, path: str, params: Optional[dict] = None) -> Any:
         """Send a GET request."""
         return self._request("GET", path, params=params)
@@ -354,16 +384,62 @@ class APIClient:
         return self._post(f"/groups/{quote(group_id)}/cancel", {})
 
     def get_job_logs(
-        self, job_id: str, container: Optional[str] = None, tail: Optional[int] = None
+        self,
+        job_id: str,
+        container: Optional[str] = None,
+        offset: Optional[int] = 0,
+        limit: Optional[int] = 1000,
     ) -> dict:
-        """Get job logs."""
+        """获取任务日志
+
+        Args:
+            job_id: 任务ID
+            container: 容器名称，如果为None则返回所有容器日志
+            offset: 分页偏移量，用于获取后续日志页
+            limit: 分页大小，默认为1000
+        """
         params = {}
         if container:
             params["container"] = container
-        if tail:
-            params["tail"] = tail
+        if offset is not None:
+            params["offset"] = offset
+        if limit is not None:
+            params["limit"] = limit
         return self._get(f"/jobs/{quote(job_id)}/logs", params=params or None)
 
+    def get_job_logs_complete(self, job_id: str, container: str) -> dict:
+        """获取完整日志（自动处理分页）
+
+        一直调用接口直到返回的next_offset为空，标识日志获取完成
+
+        Args:
+            job_id: 任务ID
+            container: 容器名称
+
+        Returns:
+            dict: 所有日志
+        """
+        all_logs = []
+        offset = 0
+
+        while True:
+            result = self.get_job_logs(
+                job_id=job_id, container=container, offset=offset, limit=1000
+            )
+
+            # 提取日志数据
+            if "logs" in result and isinstance(result["logs"], list):
+                all_logs.extend(result["logs"])
+
+            # 检查是否还有更多日志
+            next_offset = result.get("next_offset")
+            if next_offset is None:
+                break
+
+            offset = next_offset
+
+        return {"logs": all_logs, "container": container, "job_id": job_id}
+
     def get_job_events(self, job_id: str, container: Optional[str] = None) -> dict:
         """Get job events."""
         params = {}
@@ -371,6 +447,14 @@ class APIClient:
             params["container"] = container
         return self._get(f"/jobs/{quote(job_id)}/events", params=params or None)
 
+    def get_job_containers(self, job_id: str) -> dict:
+        """Get all container names for a job.
+
+        Args:
+            job_id: The job ID to get containers for
+        """
+        return self._get(f"/jobs/{quote(job_id)}/containers")
+
     def get_job_metrics(self, job_id: str) -> dict:
         """Get job metrics."""
         return self._get(f"/metrics/{quote(job_id)}")
@@ -471,11 +555,21 @@ def _write_stderr(lines: list[str]) -> None:
 
 def _safe_json(value: Any) -> str:
     try:
-        return _json.dumps(value, ensure_ascii=False, default=str)
+        return json.dumps(value, ensure_ascii=False, default=str)
     except Exception:
         return str(value)
 
 
+def _response_error_detail(resp: requests.Response) -> Any:
+    try:
+        err_data = resp.json()
+    except Exception:
+        return resp.text
+    if isinstance(err_data, dict):
+        return err_data.get("detail", resp.text)
+    return err_data
+
+
 def _safe_decode(raw: bytes) -> str:
     try:
         return raw.decode("utf-8", errors="replace")