xmanager-slurm 0.4.6__py3-none-any.whl → 0.4.8__py3-none-any.whl

xm_slurm/api/web/client.py

@@ -33,7 +33,7 @@ class XManagerWebAPI(XManagerAPI):
         self.client = httpx.Client(headers={"Authorization": f"Bearer {token}"}, verify=False)
 
     def _make_url(self, path: str) -> str:
-        return f"{self.base_url}/api{path}"
+        return f"{self.base_url}{path}"
 
     @with_backoff
     def get_experiment(self, xid: int) -> models.Experiment:

xm_slurm/config.py

@@ -119,8 +119,9 @@ class SlurmSSHConfig:
             config=None,
             kbdint_auth=False,
             disable_trivial_auth=True,
+            known_hosts=self.known_hosts,
         )
-        options.prepare(last_config=self.config, known_hosts=self.known_hosts)
+        options.prepare(last_config=self.config)
         return options
 
     def serialize(self):

xm_slurm/execution.py

@@ -235,11 +235,10 @@ class SlurmHandle(_BatchedSlurmHandle, tp.Generic[SlurmJobT]):
         return await self._batched_get_state(self.ssh, self.slurm_job)
 
     async def logs(
-        self, *, num_lines: int, block_size: int, wait: bool, follow: bool
-    ) -> tp.AsyncGenerator[ConsoleRenderable, None]:
-        statedir = await get_client()._state_dir(self.ssh)
-        file = statedir / f"{self.experiment_id}/slurm-{self.slurm_job.job_id}.out"
-
+        self, *, num_lines: int, block_size: int, wait: bool, follow: bool, raw: bool = False
+    ) -> tp.AsyncGenerator[tp.Union[str, ConsoleRenderable], None]:
+        experiment_dir = await get_client().experiment_dir(self.ssh, self.experiment_id)
+        file = experiment_dir / f"slurm-{self.slurm_job.job_id}.out"
         fs = await get_client().fs(self.ssh)
 
         if wait:
@@ -249,7 +248,7 @@ class SlurmHandle(_BatchedSlurmHandle, tp.Generic[SlurmJobT]):
         file_size = await fs.size(file)
         assert file_size is not None
 
-        async with await fs.open(file, "rb") as remote_file:  # type: ignore
+        async with await fs.open(file, "rb") as remote_file:
             data = b""
             lines = []
             position = file_size
@@ -257,27 +256,40 @@ class SlurmHandle(_BatchedSlurmHandle, tp.Generic[SlurmJobT]):
             while len(lines) <= num_lines and position > 0:
                 read_size = min(block_size, position)
                 position -= read_size
-                await remote_file.seek(position)  # type: ignore
+                await remote_file.seek(position)
                 chunk = await remote_file.read(read_size)
                 data = chunk + data
                 lines = data.splitlines()
 
             if position <= 0:
-                yield Rule("[bold red]BEGINNING OF FILE[/bold red]")
+                if raw:
+                    yield "\033[31mBEGINNING OF FILE\033[0m\n"
+                else:
+                    yield Rule("[bold red]BEGINNING OF FILE[/bold red]")
             for line in lines[-num_lines:]:
-                yield Text.from_ansi(line.decode("utf-8", errors="replace"))
+                if raw:
+                    yield line.decode("utf-8", errors="replace") + "\n"
+                else:
+                    yield Text.from_ansi(line.decode("utf-8", errors="replace"))
 
             if (await self.get_state()) not in status.SlurmActiveJobStates:
-                yield Rule("[bold red]END OF FILE[/bold red]")
-                return
+                if raw:
+                    yield "\033[31mEND OF FILE\033[0m\n"
+                    return
+                else:
+                    yield Rule("[bold red]END OF FILE[/bold red]")
+                    return
 
             if not follow:
                 return
 
-            await remote_file.seek(file_size)  # type: ignore
+            await remote_file.seek(file_size)
             while True:
                 if new_data := (await remote_file.read(block_size)):
-                    yield Text.from_ansi(new_data.decode("utf-8", errors="replace"))
+                    if raw:
+                        yield new_data.decode("utf-8", errors="replace")
+                    else:
+                        yield Text.from_ansi(new_data.decode("utf-8", errors="replace"))
                 else:
                     await asyncio.sleep(0.25)
 
@@ -454,10 +466,28 @@ class SlurmExecutionClient:
         return False
 
     @functools.cache
+    @utils.reawaitable
     async def _state_dir(self, ssh_config: SlurmSSHConfig) -> pathlib.Path:
-        cmd = await self.run(ssh_config, "printenv HOME", check=True)
-        assert isinstance(cmd.stdout, str)
-        return pathlib.Path(cmd.stdout.strip()) / ".local" / "state" / "xm-slurm"
+        state_dirs = [
+            ("XM_SLURM_STATE_DIR", ""),
+            ("XDG_STATE_HOME", "xm-slurm"),
+            ("HOME", ".local/state/xm-slurm"),
+        ]
+
+        for env_var, subpath in state_dirs:
+            cmd = await self.run(ssh_config, f"printenv {env_var}", check=False)
+            assert isinstance(cmd.stdout, str)
+            if cmd.returncode == 0:
+                return pathlib.Path(cmd.stdout.strip()) / subpath
+
+        raise SlurmExecutionError(
+            "Failed to find a valid state directory for XManager. "
+            "We weren't able to resolve any of the following paths: "
+            f"{', '.join(env_var + ('/' + subpath if subpath else '') for env_var, subpath in state_dirs)}."
+        )
+
+    async def experiment_dir(self, ssh_config: SlurmSSHConfig, experiment_id: int) -> pathlib.Path:
+        return (await self._state_dir(ssh_config)) / f"{experiment_id:08d}"
 
     async def run(
         self,
@@ -646,7 +676,7 @@ class SlurmExecutionClient:
 
         fs = await self.fs(cluster.ssh)
 
-        template_dir = (await self._state_dir(cluster.ssh)) / f"{experiment_id}"
+        template_dir = await self.experiment_dir(cluster.ssh, experiment_id)
 
         await fs.makedirs(template_dir, exist_ok=True)
         await fs.write(template_dir / submission_script_path, submission_script.encode())

xm_slurm/templates/slurm/runtimes/podman.bash.j2

@@ -3,7 +3,6 @@ time podman pull \
 {% if job.executable.credentials %}
   --creds {{ job.executable.credentials.username }}:{{ job.executable.credentials.password }} \
 {% endif %}
-  --retry 3 \
   {{ job.executable.image }}
 
 cat << 'ENTRYPOINT_EOF' > "$SLURM_TMPDIR"/xm-slurm-entrypoint.sh

xm_slurm/utils.py

@@ -1,3 +1,4 @@
+import asyncio
 import functools
 import logging
 import os
@@ -13,10 +14,39 @@ import typing as tp
 from xmanager import xm
 
 T = tp.TypeVar("T")
+P = tp.ParamSpec("P")
 
 logger = logging.getLogger(__name__)
 
 
+class CachedAwaitable(tp.Awaitable[T]):
+    def __init__(self, awaitable: tp.Awaitable[T]):
+        self.awaitable = awaitable
+        self.result: asyncio.Future[T] | None = None
+
+    def __await__(self):
+        if not self.result:
+            future = asyncio.get_event_loop().create_future()
+            self.result = future
+            try:
+                result = yield from self.awaitable.__await__()
+                future.set_result(result)
+            except Exception as e:
+                future.set_exception(e)
+
+        if not self.result.done():
+            yield from self.result
+        return self.result.result()
+
+
+def reawaitable(f: tp.Callable[P, tp.Awaitable[T]]) -> tp.Callable[P, CachedAwaitable[T]]:
+    @functools.wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> CachedAwaitable[T]:
+        return CachedAwaitable(f(*args, **kwargs))
+
+    return wrapper
+
+
 @functools.cache
 def find_project_root() -> pathlib.Path:
     launch_script_path: pathlib.Path | None = None

{xmanager_slurm-0.4.6.dist-info → xmanager_slurm-0.4.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xmanager-slurm
-Version: 0.4.6
+Version: 0.4.8
 Summary: Slurm backend for XManager.
 Project-URL: GitHub, https://github.com/jessefarebro/xm-slurm
 Author-email: Jesse Farebrother <jfarebro@cs.mcgill.ca>

{xmanager_slurm-0.4.6.dist-info → xmanager_slurm-0.4.8.dist-info}/RECORD

@@ -1,11 +1,11 @@
 xm_slurm/__init__.py,sha256=WgRn9HDYa5H3sfIH-HZu33liBOh98jM4GqcR349RaSY,1086
 xm_slurm/batching.py,sha256=GbKBsNz9w8gIc2fHLZpslC0e4K9YUfLXFHmjduRRCfQ,4385
-xm_slurm/config.py,sha256=NxlObwlhpjCqafs2CZuw1P5WFwhqayfblGHo6NGFi3Y,7072
+xm_slurm/config.py,sha256=PvdLG6fSNfbABbtwELbnytx85vWLPtyVfEJtoQsLf94,7084
 xm_slurm/console.py,sha256=UpMqeJ0C8i0pkue1AHnnyyX0bFJ9zZeJ7HBR6yhuA8A,54
 xm_slurm/constants.py,sha256=zefVtlFdflgSolie5g_rVxWV-Zpydxapchm3y0a2FDc,999
 xm_slurm/dependencies.py,sha256=-5gN_tpfs3dOA7H5_MIHO2ratb7F5Pm_yjkR5rZcgI8,6421
 xm_slurm/executables.py,sha256=fGmrFBl-258bMn6ip5adYeM7xxUHAeIbDN9zD2FDGtY,6373
-xm_slurm/execution.py,sha256=MRv7MjFVDhGbUrq28kpW82kOYvKdb0tS7tV5jh8g_I0,30163
+xm_slurm/execution.py,sha256=c0aV1h2tKQFyAGM6JLd16MWFgpRLKAbcutZz17xPUSw,31400
 xm_slurm/executors.py,sha256=fMtxGUCi4vEKmb_p4JEpqPUTh7L_f1LcR_TamMLAWNg,4667
 xm_slurm/experiment.py,sha256=94r0mhtUPUzw4eaUEz0kpsufC25wEGqlDhV4Fcr1ukY,39883
 xm_slurm/filesystem.py,sha256=4rKtq3t-KDgxJbSGt6JVyRJT_3lCN_vIKTcwKHpTo3I,4389
@@ -15,12 +15,12 @@ xm_slurm/packageables.py,sha256=fPUvqF2IvJ2Hn6hodDdQwtx1Ze3sJ8U-BUbxDHauW-g,1239
 xm_slurm/resources.py,sha256=tET3TPOQ8nXYE_SxAs2fiHt9UKJsCLW1vFktJTH0xG4,5722
 xm_slurm/status.py,sha256=WTWiDHi-ZHtwHRnDP0cGa-27zTSm6LkA-GCKsN-zBgg,6916
 xm_slurm/types.py,sha256=TsVykDm-LazVkrjeJrTwCMs4Q8APKhy7BTk0yKIhFNg,805
-xm_slurm/utils.py,sha256=ftV7kyyr4EUcIjon0godTDhhSzdVjyDkF2sVHA8zyls,5024
+xm_slurm/utils.py,sha256=xtFvktaxr0z65sTdu6HhOVfyo0OAB9t-EYXWcYrQQEU,5958
 xm_slurm/api/__init__.py,sha256=cyao3LZ3uLftu1wIv1aN7Qvsl6gYzYpkxeehTHZ0fA8,1089
 xm_slurm/api/abc.py,sha256=-lS2OndnOuEiwNdr8ccQKkwMd1iDmKMmkBOSTvo5H5w,1816
 xm_slurm/api/models.py,sha256=_INVh0j-4-rRs0WASyg4fNB6NF1L1nUeGgQ6-XnbwsM,1610
 xm_slurm/api/sqlite/client.py,sha256=WykSIO7b14rRLy9qebbkiLKXy7EHU61jtoebLX17HMM,14124
-xm_slurm/api/web/client.py,sha256=GkQIaOAJc1MIz0mYVWUA97ZvhAgz_o4xXHvVdfs2ErA,6265
+xm_slurm/api/web/client.py,sha256=uO67Y7fnQ-w__Vm_A5BEuy7Qi8wQcWk3vIsBGEBkyfk,6261
 xm_slurm/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 xm_slurm/contrib/clusters/__init__.py,sha256=XFCVnkThiU3_8uA_tUgDByOBanXNHrxDvfmuptmQ2KE,2214
 xm_slurm/contrib/clusters/drac.py,sha256=ViLYerYBMSuZXnWVbz9RDIPPV7JA8BgBpgTfj1wPP28,5881
@@ -43,9 +43,9 @@ xm_slurm/templates/slurm/job.bash.j2,sha256=d35VYHdAKkgVK8s4XnUDJwQR0gLnDWRJu-Ld
 xm_slurm/templates/slurm/fragments/monitor.bash.j2,sha256=HYqYhXsTv8TCed5UaGCZVGIYsqxSKHcnPyNNTHWNvxc,1279
 xm_slurm/templates/slurm/fragments/proxy.bash.j2,sha256=VJLglZo-Nvx9R-qe3rHTxr07CylTQ6Z9NwBzvIpAZrA,814
 xm_slurm/templates/slurm/runtimes/apptainer.bash.j2,sha256=lE2EWVCK2O-n08RL4_MJYIikVTvODjcYKuv7Eh73Q2w,1932
-xm_slurm/templates/slurm/runtimes/podman.bash.j2,sha256=yUOUTzGNyVy1IQSgvY9wn9pE-reB1SYNJmuV2ji8l6w,1162
-xmanager_slurm-0.4.6.dist-info/METADATA,sha256=Zo382SdJ2QWrzEVwNYQX7DXRhhcv9HZA8SPRuWtT0W4,1042
-xmanager_slurm-0.4.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-xmanager_slurm-0.4.6.dist-info/entry_points.txt,sha256=_HLGmLgxuQLOPmF2gOFYDVq2HqtMVD_SzigHvUh8TCY,49
-xmanager_slurm-0.4.6.dist-info/licenses/LICENSE.md,sha256=IxstXr3MPHwTJ5jMrByHrQsR1ZAGQ2U_uz_4qzI_15Y,11756
-xmanager_slurm-0.4.6.dist-info/RECORD,,
+xm_slurm/templates/slurm/runtimes/podman.bash.j2,sha256=3j7K5eyXt_WhXK0EoMlxnhlmFVJ2JyxRKbsMRaDqzSs,1148
+xmanager_slurm-0.4.8.dist-info/METADATA,sha256=8QQ9xbptuObTCHB8WaYr0rSKOgxK5ojCaeD7mN9Qvl0,1042
+xmanager_slurm-0.4.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xmanager_slurm-0.4.8.dist-info/entry_points.txt,sha256=_HLGmLgxuQLOPmF2gOFYDVq2HqtMVD_SzigHvUh8TCY,49
+xmanager_slurm-0.4.8.dist-info/licenses/LICENSE.md,sha256=IxstXr3MPHwTJ5jMrByHrQsR1ZAGQ2U_uz_4qzI_15Y,11756
+xmanager_slurm-0.4.8.dist-info/RECORD,,