codeapi-client 0.4.1__py3-none-any.whl

codeapi/client/_sync/_cli.py

@@ -0,0 +1,332 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List
+
+import httpx
+
+if TYPE_CHECKING:
+    from . import Client
+from codeapi.types import (
+    CodeInfo,
+    CodeType,
+    CodeZip,
+    DataZip,
+    EnvVars,
+    Job,
+    JobStage,
+    JobStatus,
+    JobType,
+    JsonData,
+)
+
+
+class StoredCliClient:
+    def __init__(self, client: Client):
+        self._client = client
+
+    def run(
+        self,
+        code_id: str,
+        command: str,
+        env_vars: EnvVars | dict | None = None,
+        data_zip: DataZip | None = None,
+        timeout: float | None = None,
+    ) -> Job:
+        """Runs stored code.
+
+        Args:
+            code_id (str): The code ID.
+            command (str): The command to run.
+            env_vars (EnvVars | dict | None): Optional environment variables.
+            data_zip (DataZip | None): Optional data zip.
+            timeout (float | None): The timeout for the job.
+
+        Returns:
+            Job: The created job.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/jobs/code/{code_id}/run/cli"
+
+        files = self._client._prepare_files(data_zip=data_zip)
+        data = {"command": command}
+        if env_vars:
+            data["env_vars"] = EnvVars(env_vars).json_str
+        params = {"timeout": timeout} if timeout else {}
+
+        try:
+            response = httpx.post(
+                url,
+                headers=self._client.api_key_header,
+                files=files or None,
+                data=data,
+                params=params,
+            )
+            response.raise_for_status()
+            return Job(**response.json())
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def list_info(self) -> list[CodeInfo]:
+        """List all stored CLI code.
+
+        Returns:
+            list[CodeInfo]: List of CLI code info.
+        """
+        return self._client.code.list_info(code_type=CodeType.CLI)
+
+    def delete(self, code_id: str) -> str:
+        """Delete stored CLI code.
+
+        Args:
+            code_id (str): The code ID to delete.
+
+        Returns:
+            str: Deletion confirmation message.
+
+        Raises:
+            ValueError: If the code_id is not CLI code.
+        """
+        # Verify this is actually CLI code
+        code_info = self._client.code.get_info(code_id)
+        if code_info.code_type != CodeType.CLI:
+            raise ValueError(
+                f"Code '{code_id}' is {code_info.code_type}, not CLI code. "
+                "Cannot delete non-CLI code from CLI client."
+            )
+
+        return self._client.code.delete(code_id)
+
+
+class CliJobsClient:
+    def __init__(self, client):
+        self._client = client
+
+    def list(
+        self,
+        job_status: JobStatus | None = None,
+        job_stage: JobStage | None = None,
+    ) -> List[Job]:
+        """List CLI jobs.
+
+        Args:
+            job_status (JobStatus | None): Filter by job status.
+            job_stage (JobStage | None): Filter by job stage.
+
+        Returns:
+            list[Job]: List of CLI jobs.
+        """
+        return self._client.jobs.list(
+            job_type=JobType.RUN_CLI,
+            job_status=job_status,
+            job_stage=job_stage,
+        )
+
+    def get_latest(self) -> Job | None:
+        """Get the most recent CLI job.
+
+        Returns:
+            Job | None: The most recent CLI job, or None if no jobs exist.
+        """
+        jobs = self.list()
+        return jobs[0] if jobs else None
+
+    def list_queued(self) -> List[Job]:
+        """Get all queued CLI jobs.
+
+        Returns:
+            List[Job]: List of queued CLI jobs.
+        """
+        return self.list(job_status=JobStatus.QUEUED)
+
+    def list_scheduled(self) -> List[Job]:
+        """Get all scheduled CLI jobs.
+
+        Returns:
+            List[Job]: List of scheduled CLI jobs.
+        """
+        return self.list(job_status=JobStatus.SCHEDULED)
+
+    def list_started(self) -> List[Job]:
+        """Get all started CLI jobs.
+
+        Returns:
+            list[Job]: List of started CLI jobs.
+        """
+        return self.list(job_status=JobStatus.STARTED)
+
+    def list_deferred(self) -> List[Job]:
+        """Get all deferred CLI jobs.
+
+        Returns:
+            List[Job]: List of deferred CLI jobs.
+        """
+        return self.list(job_status=JobStatus.DEFERRED)
+
+    def list_canceled(self) -> List[Job]:
+        """Get all canceled CLI jobs.
+
+        Returns:
+            List[Job]: List of canceled CLI jobs.
+        """
+        return self.list(job_status=JobStatus.CANCELED)
+
+    def list_stopped(self) -> List[Job]:
+        """Get all stopped CLI jobs.
+
+        Returns:
+            List[Job]: List of stopped CLI jobs.
+        """
+        return self.list(job_status=JobStatus.STOPPED)
+
+    def list_failed(self) -> List[Job]:
+        """Get all failed CLI jobs.
+
+        Returns:
+            list[Job]: List of failed CLI jobs.
+        """
+        return self.list(job_status=JobStatus.FAILED)
+
+    def list_finished(self) -> List[Job]:
+        """Get all finished CLI jobs.
+
+        Returns:
+            list[Job]: List of finished CLI jobs.
+        """
+        return self.list(job_status=JobStatus.FINISHED)
+
+    def list_timed_out(self) -> List[Job]:
+        """Get all timed out CLI jobs.
+
+        Returns:
+            List[Job]: List of timed out CLI jobs.
+        """
+        return self.list(job_status=JobStatus.TIMEOUT)
+
+    def list_pre_running(self) -> List[Job]:
+        """Get all pre-running CLI jobs.
+
+        Returns:
+            List[Job]: List of pre-running CLI jobs.
+        """
+        return self.list(job_stage=JobStage.PRE_RUNNING)
+
+    def list_running(self) -> List[Job]:
+        """Get all running CLI jobs.
+
+        Returns:
+            List[Job]: List of running CLI jobs.
+        """
+        return self.list(job_stage=JobStage.RUNNING)
+
+    def list_post_running(self) -> List[Job]:
+        """Get all post-running CLI jobs.
+
+        Returns:
+            List[Job]: List of post-running CLI jobs.
+        """
+        return self.list(job_stage=JobStage.POST_RUNNING)
+
+
+class CliClient:
+    def __init__(self, client: Client):
+        self._client = client
+        self.stored = StoredCliClient(client)
+        self.jobs = CliJobsClient(client)
+
+    def run(
+        self,
+        code_zip: CodeZip,
+        command: str,
+        env_vars: EnvVars | dict | None = None,
+        data_zip: DataZip | None = None,
+        timeout: float | None = None,
+    ) -> Job:
+        """Starts a CLI job from code zip.
+
+        Args:
+            code_zip (CodeZip): The code zip.
+            command (str): The command to run.
+            env_vars (EnvVars | dict | None): Optional environment variables.
+            data_zip (DataZip | None): Optional data zip.
+            timeout (float | None): The timeout for the job.
+
+        Returns:
+            Job: The created job.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/jobs/code/run/cli"
+
+        files = self._client._prepare_files(code_zip=code_zip, data_zip=data_zip)
+        data = {"command": command}
+        if env_vars:
+            data["env_vars"] = EnvVars(env_vars).json_str
+        params = {"timeout": timeout} if timeout else {}
+
+        try:
+            response = httpx.post(
+                url,
+                headers=self._client.api_key_header,
+                files=files or None,
+                data=data,
+                params=params,
+            )
+            response.raise_for_status()
+            return Job(**response.json())
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def upload(
+        self,
+        code_zip: CodeZip,
+        code_name: str,
+        metadata: JsonData | dict | None = None,
+    ) -> str:
+        """Upload CLI code.
+
+        Args:
+            code_zip (CodeZip): The code zip.
+            code_name (str): The name of the code.
+            metadata (JsonData | dict | None): The JSON metadata of the code.
+
+        Returns:
+            str: The code ID.
+        """
+        return self._client.code.upload(
+            code_zip=code_zip,
+            code_name=code_name,
+            code_type=CodeType.CLI,
+            metadata=metadata,
+        )
+
+    def ingest(
+        self,
+        code_zip: CodeZip,
+        code_name: str,
+        metadata: JsonData | dict | None = None,
+        build_pexenv: bool = False,
+        pexenv_python: str | None = None,
+    ) -> Job:
+        """Ingest CLI code.
+
+        Args:
+            code_zip (CodeZip): The code zip.
+            code_name (str): The name of the code.
+            metadata (JsonData | dict | None): The JSON metadata of the code.
+            build_pexenv (bool): Whether to build the pex venv.
+            pexenv_python: (str | None): Python interpreter for the pex venv.
+
+        Returns:
+            Job: The code ingestion job.
+        """
+        return self._client.code.ingest(
+            code_zip=code_zip,
+            code_name=code_name,
+            code_type=CodeType.CLI,
+            metadata=metadata,
+            build_pexenv=build_pexenv,
+            pexenv_python=pexenv_python,
+        )

codeapi/client/_sync/_code.py

@@ -0,0 +1,203 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import httpx
+
+from codeapi.types import CodeInfo, CodeType, CodeZip, Job, JsonData
+
+if TYPE_CHECKING:
+    from . import Client
+
+
+class CodeClient:
+    def __init__(self, client: Client):
+        self._client = client
+
+    def upload(
+        self,
+        code_zip: CodeZip,
+        code_name: str,
+        code_type: CodeType,
+        metadata: JsonData | dict | None = None,
+    ) -> str:
+        """Upload code.
+
+        Args:
+            code_zip (CodeZip): The code zip.
+            code_name (str): The name of the code.
+            code_type (CodeType): The type of the code.
+            metadata (JsonData | dict | None): The JSON metadata of the code.
+
+        Returns:
+            str: The code ID.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/upload"
+
+        files = self._client._prepare_files(code_zip=code_zip, metadata=metadata)
+        data = {"code_name": code_name, "code_type": code_type}
+
+        try:
+            response = httpx.post(
+                url, headers=self._client.api_key_header, files=files, data=data
+            )
+            response.raise_for_status()
+            return str(response.json()).strip()
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def download(self, code_id: str, zip_path: Path | str | None = None) -> CodeZip:
+        """Download code and optionally saves it to a file.
+
+        Args:
+            code_id (str): The code ID.
+            zip_path (Path | str | None): The path to save the code zip file to.
+
+        Returns:
+            CodeZip: The downloaded code zip.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/{code_id}/download"
+
+        try:
+            with httpx.stream(
+                "GET", url, headers=self._client.api_key_header
+            ) as response:
+                zip_bytes = self._client._handle_stream_download(response, zip_path)
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+        return CodeZip(zip_bytes=zip_bytes)
+
+    def delete(self, code_id: str) -> str:
+        """Deletes code by code_id.
+
+        Args:
+            code_id (str): The code ID.
+
+        Returns:
+            str: Confirmation message.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/{code_id}"
+        try:
+            response = httpx.delete(url, headers=self._client.api_key_header)
+            response.raise_for_status()
+            return f"Code with id={code_id} deleted"
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def get_info(self, code_id: str) -> CodeInfo:
+        """Gets the code info.
+
+        Args:
+            code_id (str): The code ID.
+
+        Returns:
+            CodeInfo: The code info.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/{code_id}/info"
+        try:
+            response = httpx.get(url, headers=self._client.api_key_header)
+            response.raise_for_status()
+            return CodeInfo(**response.json())
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def list_info(self, code_type: CodeType | None = None) -> list[CodeInfo]:
+        """Gets list of code infos.
+
+        Args:
+            code_type (CodeType | None): The type of code to list.
+
+        Returns:
+            list[CodeInfo]: The list of code infos.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/info"
+        try:
+            params = {"code_type": code_type} if code_type else None
+            response = httpx.get(
+                url, headers=self._client.api_key_header, params=params
+            )
+            response.raise_for_status()
+            return [CodeInfo(**item) for item in response.json()]
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def get_metadata(self, code_id: str) -> JsonData:
+        """Gets code metadata.
+
+        Args:
+            code_id (str): The ID of the code.
+
+        Returns:
+            JsonData: The metadata.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/code/{code_id}/metadata"
+        try:
+            response = httpx.get(url, headers=self._client.api_key_header)
+            response.raise_for_status()
+            return JsonData(response.json())
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)
+
+    def ingest(
+        self,
+        code_zip: CodeZip,
+        code_name: str,
+        code_type: CodeType,
+        metadata: JsonData | dict | None = None,
+        build_pexenv: bool = False,
+        pexenv_python: str | None = None,
+    ) -> Job:
+        """Starts a code ingestion job.
+
+        Args:
+            code_zip (CodeZip): The code zip.
+            code_name (str): The name of the code.
+            code_type (CodeType): The type of the code.
+            metadata (JsonData | dict | None): The JSON metadata of the code.
+            build_pexenv (bool): Whether to build the pex venv.
+            pexenv_python: (str | None): Python interpreter for the pex venv.
+
+        Returns:
+            Job: The code ingestion job.
+
+        Raises:
+            HTTPException: If the request fails.
+        """
+        url = f"{self._client.base_url}/jobs/code/ingest"
+
+        files = self._client._prepare_files(code_zip=code_zip, metadata=metadata)
+        data = {
+            "code_name": code_name,
+            "code_type": code_type,
+            "build_pexenv": build_pexenv,
+            "pexenv_python": pexenv_python,
+        }
+
+        try:
+            response = httpx.post(
+                url, headers=self._client.api_key_header, files=files, data=data
+            )
+            response.raise_for_status()
+            return Job(**response.json())
+        except httpx.HTTPStatusError as e:
+            raise self._client._get_http_exception(httpx_error=e)