sfapi-client 0.6.0__tar.gz → 0.7.0__tar.gz

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/.github/workflows/pytest.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
 
     steps:
       - uses: actions/checkout@v4

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: sfapi_client
-Version: 0.6.0
+Version: 0.7.0
 Summary: Python client for NERSC SF API
 Author-email: Chris Harris <cjh@lbl.gov>, Nicholas Tyler <tylern@lbl.gov>
 License-File: LICENSE
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: authlib
 Requires-Dist: httpx
 Requires-Dist: pydantic-settings
@@ -76,6 +76,8 @@ The sfapi_client project relies on these libraries:
 
 ## Installation
 
+Requires Python 3.10 or newer.
+
 Install with pip:
 
 ```shell

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/README.md

@@ -47,6 +47,8 @@ The sfapi_client project relies on these libraries:
 
 ## Installation
 
+Requires Python 3.10 or newer.
+
 Install with pip:
 
 ```shell

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/mkdocs.yml

@@ -37,8 +37,6 @@ plugins:
         - https://docs.python.org/3/objects.inv
         options:
           docstring_style: sphinx
-          docstring_options:
-            ignore_init_summary: yes
           merge_init_into_class: yes
           show_submodules: no
 

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/pyproject.toml

@@ -14,7 +14,7 @@ authors = [
 ]
 description = "Python client for NERSC SF API"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
   "authlib",
   "httpx",
@@ -43,6 +43,9 @@ exclude = [
   "src/sfapi_client/_async/_models.py"
 ]
 
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F"]
+
 [project.optional-dependencies]
 docs = [
   "mkdocs-material",

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/src/sfapi_client/_async/compute.py

@@ -224,7 +224,17 @@ class AsyncCompute(ComputeBase):
         task = await self._run_task(args)
         await task._wait()
 
-        if task.result.error:
+        # A non-empty `error` (stderr) alone doesn't mean the command failed - many commands
+        # write non-fatal warnings to stderr while still exiting zero. `exit_code` is the
+        # authoritative success/failure signal when the API provides it; only fall back to
+        # treating a non-empty `error` as fatal if `exit_code` is unavailable.
+        if task.result.exit_code is not None:
+            if task.result.exit_code != 0:
+                raise SfApiError(
+                    task.result.error
+                    or f"Command exited with code {task.result.exit_code}"
+                )
+        elif task.result.error:
             raise SfApiError(task.result.error)
 
         return task.result.output

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/src/sfapi_client/_sync/compute.py

@@ -1,5 +1,4 @@
 from typing import Dict, List, Optional, Union
-import json
 from pydantic import PrivateAttr, ConfigDict, BaseModel
 from ..exceptions import SfApiError
 from .._utils import _SLEEP
@@ -127,7 +126,9 @@ class Compute(ComputeBase):
             return task.result
 
     @check_auth
-    def submit_job(self, script: Union[str, RemotePath], args: Optional[List[str]] = None) -> JobSqueue:
+    def submit_job(
+        self, script: Union[str, RemotePath], args: Optional[List[str]] = None
+    ) -> JobSqueue:
         """Submit a job to the compute resource
 
         :param script: Path to file on the compute system, or script to run beginning with `#!`.
@@ -154,7 +155,9 @@ class Compute(ComputeBase):
         data = {"job": script, "isPath": is_path}
         if args is not None:
             if not is_path:
-                raise ValueError("Command line arguments cannot be passed when the script is not a file.")
+                raise ValueError(
+                    "Command line arguments cannot be passed when the script is not a file."
+                )
             data["args"] = args
 
         r = self.client.post(f"compute/jobs/{self.name}", data)
@@ -221,7 +224,17 @@ class Compute(ComputeBase):
         task = self._run_task(args)
         task._wait()
 
-        if task.result.error:
+        # A non-empty `error` (stderr) alone doesn't mean the command failed - many commands
+        # write non-fatal warnings to stderr while still exiting zero. `exit_code` is the
+        # authoritative success/failure signal when the API provides it; only fall back to
+        # treating a non-empty `error` as fatal if `exit_code` is unavailable.
+        if task.result.exit_code is not None:
+            if task.result.exit_code != 0:
+                raise SfApiError(
+                    task.result.error
+                    or f"Command exited with code {task.result.exit_code}"
+                )
+        elif task.result.error:
             raise SfApiError(task.result.error)
 
         return task.result.output

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/src/sfapi_client/_sync/paths.py

@@ -162,7 +162,7 @@ class RemotePath(PathBase):
 
         r = self.compute.client.get(
             f"utilities/download/{self.compute.name}/{self._path}",
-            params={"binary": binary}
+            params={"binary": binary},
         )
         json_response = r.json()
         download_response = FileDownloadResponse.model_validate(json_response)

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/tests/test_compute.py

@@ -1,6 +1,9 @@
 import time
 from pathlib import Path
 
+import pytest
+
+from sfapi_client import SfApiError
 from sfapi_client.jobs import JobState
 from sfapi_client.compute import CommandTask, TaskStatus
 
@@ -125,6 +128,30 @@ def test_run_arg_path(authenticated_client, test_machine):
         assert output
 
 
+def test_run_success_with_stderr(authenticated_client, test_machine):
+    with authenticated_client as client:
+        machine = client.compute(test_machine)
+        output = machine.run("bash -lc 'echo hello; echo warning >&2; exit 0'")
+
+        assert output == "hello\n"
+
+
+def test_run_failure_with_stderr(authenticated_client, test_machine):
+    with authenticated_client as client:
+        machine = client.compute(test_machine)
+
+        with pytest.raises(SfApiError, match="failing"):
+            machine.run(_failing_command())
+
+
+def test_run_failure_without_stderr(authenticated_client, test_machine):
+    with authenticated_client as client:
+        machine = client.compute(test_machine)
+
+        with pytest.raises(SfApiError, match="Command exited with code 7"):
+            machine.run("bash -lc 'exit 7'")
+
+
 def test_run_task(authenticated_client, test_machine):
     with authenticated_client as client:
         machine = client.compute(test_machine)

{sfapi_client-0.6.0 → sfapi_client-0.7.0}/tests/test_compute_async.py

@@ -3,6 +3,7 @@ import asyncio
 import pytest
 from pathlib import Path
 
+from sfapi_client import SfApiError
 from sfapi_client.compute import AsyncCommandTask, TaskStatus
 from sfapi_client.jobs import JobState
 
@@ -140,6 +141,33 @@ async def test_run_arg_path(async_authenticated_client, test_machine):
         assert output
 
 
+@pytest.mark.asyncio
+async def test_run_success_with_stderr(async_authenticated_client, test_machine):
+    async with async_authenticated_client as client:
+        machine = await client.compute(test_machine)
+        output = await machine.run("bash -lc 'echo hello; echo warning >&2; exit 0'")
+
+        assert output == "hello\n"
+
+
+@pytest.mark.asyncio
+async def test_run_failure_with_stderr(async_authenticated_client, test_machine):
+    async with async_authenticated_client as client:
+        machine = await client.compute(test_machine)
+
+        with pytest.raises(SfApiError, match="failing"):
+            await machine.run(_failing_command())
+
+
+@pytest.mark.asyncio
+async def test_run_failure_without_stderr(async_authenticated_client, test_machine):
+    async with async_authenticated_client as client:
+        machine = await client.compute(test_machine)
+
+        with pytest.raises(SfApiError, match="Command exited with code 7"):
+            await machine.run("bash -lc 'exit 7'")
+
+
 @pytest.mark.asyncio
 async def test_run_task(async_authenticated_client, test_machine):
     async with async_authenticated_client as client: