resubmit 0.0.3__tar.gz

resubmit-0.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

resubmit-0.0.3/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: resubmit
+Version: 0.0.3
+Summary: Small wrapper around submitit to simplify cluster submissions
+Author: Amir Mehrpanah
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: submitit>=0.8
+Provides-Extra: debug
+Requires-Dist: debugpy; extra == "debug"
+Dynamic: license-file
+
+# resubmit
+
+Small utility library to simplify job submission with Submitit on SLURM clusters.
+
+Quick usage:
+
+- Install locally for development:
+
+```bash
+pip install -e .[debug]
+```
+
+- Use in your project:
+
+```python
+from resubmit import submit_jobs, maybe_attach_debugger
+
+# attach remote debugger if requested
+maybe_attach_debugger(args.get("port", None))
+
+# submit jobs (list of dicts)
+submit_jobs(jobs_list, my_entrypoint, timeout_min=60, block=True)
+```
+
+## API
+
+### submit_jobs(...) 🔧
+
+Submit multiple jobs to a Slurm cluster using Submitit.
+
+Signature (short):
+
+`submit_jobs(jobs_args: Iterable[dict], func: Callable[[List[dict]], Any], *, timeout_min: int, cpus_per_task: int = 16, mem_gb: int = 64, num_gpus: int = 1, account: Optional[str] = None, folder: str = "logs/%j", block: bool = False, prompt: bool = True, local_run: bool = False, slurm_additional_parameters: Optional[Dict] = None, constraint: Optional[str] = None, reservation: Optional[str] = None)`
+
+- `jobs_args`: iterable of per-job kwargs (each item is passed to `func`).
+- `func`: entrypoint called for each job (should accept a list or single job dict depending on your usage).
+- `timeout_min`, `cpus_per_task`, `mem_gb`, `num_gpus`: common Slurm resources.
+- `account`: optional Slurm account name.
+- `folder`: logs folder for Submitit files (supports `%j` for job id).
+- `block`: if True, waits for all jobs and returns results.
+- `prompt`: if True, asks for confirmation interactively; set to `False` for CI or tests.
+- `local_run`: run the jobs locally without Submitit (useful for debugging).
+- `slurm_additional_parameters`: pass any extra Slurm key/value pairs to Submitit.
+- `constraint` / `reservation`: cluster-specific options kept out of defaults — provide them explicitly if you need them (they take precedence over values in `slurm_additional_parameters`).
+
+Example:
+
+```python
+submit_jobs(
+    jobs_list,
+    my_entrypoint,
+    timeout_min=60,
+    num_gpus=2,
+    prompt=False,
+    constraint="gpu",
+)
+```
+
+### maybe_attach_debugger(port: Optional[int]) 🐞
+
+Attach `debugpy` to the job when `port` is provided (> 0). Safe no-op if `port` is `None` or `<= 0`.
+
+- If `debugpy` (and `submitit`) are not available on the node, a `RuntimeError` is raised with an explanatory message.
+
+Example:
+
+```python
+# attach remote debugger only when a port is provided (e.g., from CLI args)
+maybe_attach_debugger(args.get("port"))
+```
+
+---
+
+Tips:
+- Use `prompt=False` when calling `submit_jobs` from scripts or CI to avoid interactive prompts.
+- Tests demonstrate non-interactive behavior (`prompt=False`) and optional `constraint`/`reservation` handling.

resubmit-0.0.3/README.md

@@ -0,0 +1,76 @@
+# resubmit
+
+Small utility library to simplify job submission with Submitit on SLURM clusters.
+
+Quick usage:
+
+- Install locally for development:
+
+```bash
+pip install -e .[debug]
+```
+
+- Use in your project:
+
+```python
+from resubmit import submit_jobs, maybe_attach_debugger
+
+# attach remote debugger if requested
+maybe_attach_debugger(args.get("port", None))
+
+# submit jobs (list of dicts)
+submit_jobs(jobs_list, my_entrypoint, timeout_min=60, block=True)
+```
+
+## API
+
+### submit_jobs(...) 🔧
+
+Submit multiple jobs to a Slurm cluster using Submitit.
+
+Signature (short):
+
+`submit_jobs(jobs_args: Iterable[dict], func: Callable[[List[dict]], Any], *, timeout_min: int, cpus_per_task: int = 16, mem_gb: int = 64, num_gpus: int = 1, account: Optional[str] = None, folder: str = "logs/%j", block: bool = False, prompt: bool = True, local_run: bool = False, slurm_additional_parameters: Optional[Dict] = None, constraint: Optional[str] = None, reservation: Optional[str] = None)`
+
+- `jobs_args`: iterable of per-job kwargs (each item is passed to `func`).
+- `func`: entrypoint called for each job (should accept a list or single job dict depending on your usage).
+- `timeout_min`, `cpus_per_task`, `mem_gb`, `num_gpus`: common Slurm resources.
+- `account`: optional Slurm account name.
+- `folder`: logs folder for Submitit files (supports `%j` for job id).
+- `block`: if True, waits for all jobs and returns results.
+- `prompt`: if True, asks for confirmation interactively; set to `False` for CI or tests.
+- `local_run`: run the jobs locally without Submitit (useful for debugging).
+- `slurm_additional_parameters`: pass any extra Slurm key/value pairs to Submitit.
+- `constraint` / `reservation`: cluster-specific options kept out of defaults — provide them explicitly if you need them (they take precedence over values in `slurm_additional_parameters`).
+
+Example:
+
+```python
+submit_jobs(
+    jobs_list,
+    my_entrypoint,
+    timeout_min=60,
+    num_gpus=2,
+    prompt=False,
+    constraint="gpu",
+)
+```
+
+### maybe_attach_debugger(port: Optional[int]) 🐞
+
+Attach `debugpy` to the job when `port` is provided (> 0). Safe no-op if `port` is `None` or `<= 0`.
+
+- If `debugpy` (and `submitit`) are not available on the node, a `RuntimeError` is raised with an explanatory message.
+
+Example:
+
+```python
+# attach remote debugger only when a port is provided (e.g., from CLI args)
+maybe_attach_debugger(args.get("port"))
+```
+
+---
+
+Tips:
+- Use `prompt=False` when calling `submit_jobs` from scripts or CI to avoid interactive prompts.
+- Tests demonstrate non-interactive behavior (`prompt=False`) and optional `constraint`/`reservation` handling.

resubmit-0.0.3/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "build"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "resubmit"
+version = "0.0.3"
+description = "Small wrapper around submitit to simplify cluster submissions"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [ { name = "Amir Mehrpanah" } ]
+dependencies = ["submitit>=0.8"]
+
+[project.optional-dependencies]
+debug = ["debugpy"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["resubmit*"]
+
+[tool.setuptools]
+package-dir = { "" = "src" }

resubmit-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

resubmit-0.0.3/src/resubmit/__init__.py

@@ -0,0 +1,6 @@
+"""resubmit: small helpers around submitit for reproducible cluster submissions."""
+
+from .submit import submit_jobs
+from .debug import maybe_attach_debugger
+
+__all__ = ["submit_jobs", "maybe_attach_debugger"]

resubmit-0.0.3/src/resubmit/debug.py

@@ -0,0 +1,26 @@
+"""Debug helpers (attach remote debugger when running via Submitit)."""
+
+
+from typing import Optional
+
+def maybe_attach_debugger(port: Optional[int]) -> None:
+    """Attach debugpy to the current job when `port` is provided (> 0).
+
+    Safe no-op if `port` is None or <= 0. Raises informative errors if debugpy is missing.
+    """
+    if port is None or port <= 0:
+        return
+
+    try:
+        import submitit
+        import debugpy
+    except Exception as exc:  # pragma: no cover - environmental dependency
+        raise RuntimeError(
+            "debugging requires 'submitit' and 'debugpy' packages installed on the compute node"
+        ) from exc
+
+    job_env = submitit.JobEnvironment()
+    print(f"Debugger is running on node {job_env.hostname} port {port}")
+    debugpy.listen((job_env.hostname, port))
+    print("Waiting for debugger attach")
+    debugpy.wait_for_client()

resubmit-0.0.3/src/resubmit/submit.py

@@ -0,0 +1,85 @@
+"""Core submission utilities wrapping submitit."""
+from typing import Any, Callable, Iterable, List, Optional, Dict
+
+
+def submit_jobs(
+    jobs_args: Iterable[dict],
+    func: Callable[[List[dict]], Any],
+    *,
+    timeout_min: int,
+    cpus_per_task: int = 16,
+    mem_gb: int = 64,
+    num_gpus: int = 1,
+    account: Optional[str] = None,
+    folder: str = "logs/%j",
+    block: bool = False,
+    prompt: bool = True,
+    local_run: bool = False,
+    slurm_additional_parameters: Optional[Dict] = None,
+    constraint: Optional[str] = None,
+    reservation: Optional[str] = None,
+):
+    """Submit jobs described by `jobs_args` where each entry is a dict of kwargs for `func`.
+
+    - If `local_run` is True, the function is called directly: `func(jobs_args)`.
+    - Otherwise, submits via submitit.AutoExecutor and returns job objects or, if `block` is True, waits and returns results.
+
+    Optional Slurm settings `constraint` and `reservation` can be provided via explicit
+    parameters (they take precedence) or by passing `slurm_additional_parameters`.
+    If not provided, they are omitted so the code is not tied to cluster-specific
+    defaults.
+    """
+    jobs_list = list(jobs_args) if not isinstance(jobs_args, list) else jobs_args
+
+    if len(jobs_list) == 0:
+        print("No jobs to run exiting")
+        return
+
+    if local_run:
+        print("Running locally (local_run=True)")
+        return func(jobs_list)
+
+    if prompt:
+        print("Do you want to continue? [y/n]", flush=True)
+        if input() != "y":
+            print("Aborted")
+            return
+
+    import submitit
+    print("submitting jobs")
+    executor = submitit.AutoExecutor(folder=folder)
+
+    # default slurm params (keep cluster-specific options out unless explicitly set)
+    if slurm_additional_parameters is None:
+        slurm_additional_parameters = {"gpus": num_gpus}
+    else:
+        slurm_additional_parameters = dict(slurm_additional_parameters)
+        slurm_additional_parameters.setdefault("gpus", num_gpus)
+
+    # Allow explicit overrides similar to `account`.
+    if account is not None:
+        slurm_additional_parameters["account"] = account
+    if reservation is not None:
+        slurm_additional_parameters["reservation"] = reservation
+    if constraint is not None:
+        slurm_additional_parameters["constraint"] = constraint
+
+    print("Slurm additional parameters:", slurm_additional_parameters)
+
+    executor.update_parameters(
+        timeout_min=timeout_min,
+        cpus_per_task=cpus_per_task,
+        mem_gb=mem_gb,
+        slurm_additional_parameters=slurm_additional_parameters,
+    )
+
+    jobs = executor.map_array(func, jobs_list)
+    print("Job submitted")
+
+    if block:
+        print("Waiting for job to finish")
+        results = [job.result() for job in jobs]
+        print("All jobs finished")
+        return results
+
+    return jobs

resubmit-0.0.3/src/resubmit.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: resubmit
+Version: 0.0.3
+Summary: Small wrapper around submitit to simplify cluster submissions
+Author: Amir Mehrpanah
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: submitit>=0.8
+Provides-Extra: debug
+Requires-Dist: debugpy; extra == "debug"
+Dynamic: license-file
+
+# resubmit
+
+Small utility library to simplify job submission with Submitit on SLURM clusters.
+
+Quick usage:
+
+- Install locally for development:
+
+```bash
+pip install -e .[debug]
+```
+
+- Use in your project:
+
+```python
+from resubmit import submit_jobs, maybe_attach_debugger
+
+# attach remote debugger if requested
+maybe_attach_debugger(args.get("port", None))
+
+# submit jobs (list of dicts)
+submit_jobs(jobs_list, my_entrypoint, timeout_min=60, block=True)
+```
+
+## API
+
+### submit_jobs(...) 🔧
+
+Submit multiple jobs to a Slurm cluster using Submitit.
+
+Signature (short):
+
+`submit_jobs(jobs_args: Iterable[dict], func: Callable[[List[dict]], Any], *, timeout_min: int, cpus_per_task: int = 16, mem_gb: int = 64, num_gpus: int = 1, account: Optional[str] = None, folder: str = "logs/%j", block: bool = False, prompt: bool = True, local_run: bool = False, slurm_additional_parameters: Optional[Dict] = None, constraint: Optional[str] = None, reservation: Optional[str] = None)`
+
+- `jobs_args`: iterable of per-job kwargs (each item is passed to `func`).
+- `func`: entrypoint called for each job (should accept a list or single job dict depending on your usage).
+- `timeout_min`, `cpus_per_task`, `mem_gb`, `num_gpus`: common Slurm resources.
+- `account`: optional Slurm account name.
+- `folder`: logs folder for Submitit files (supports `%j` for job id).
+- `block`: if True, waits for all jobs and returns results.
+- `prompt`: if True, asks for confirmation interactively; set to `False` for CI or tests.
+- `local_run`: run the jobs locally without Submitit (useful for debugging).
+- `slurm_additional_parameters`: pass any extra Slurm key/value pairs to Submitit.
+- `constraint` / `reservation`: cluster-specific options kept out of defaults — provide them explicitly if you need them (they take precedence over values in `slurm_additional_parameters`).
+
+Example:
+
+```python
+submit_jobs(
+    jobs_list,
+    my_entrypoint,
+    timeout_min=60,
+    num_gpus=2,
+    prompt=False,
+    constraint="gpu",
+)
+```
+
+### maybe_attach_debugger(port: Optional[int]) 🐞
+
+Attach `debugpy` to the job when `port` is provided (> 0). Safe no-op if `port` is `None` or `<= 0`.
+
+- If `debugpy` (and `submitit`) are not available on the node, a `RuntimeError` is raised with an explanatory message.
+
+Example:
+
+```python
+# attach remote debugger only when a port is provided (e.g., from CLI args)
+maybe_attach_debugger(args.get("port"))
+```
+
+---
+
+Tips:
+- Use `prompt=False` when calling `submit_jobs` from scripts or CI to avoid interactive prompts.
+- Tests demonstrate non-interactive behavior (`prompt=False`) and optional `constraint`/`reservation` handling.

resubmit-0.0.3/src/resubmit.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/resubmit/__init__.py
+src/resubmit/debug.py
+src/resubmit/submit.py
+src/resubmit.egg-info/PKG-INFO
+src/resubmit.egg-info/SOURCES.txt
+src/resubmit.egg-info/dependency_links.txt
+src/resubmit.egg-info/requires.txt
+src/resubmit.egg-info/top_level.txt
+tests/test_resubmit.py

resubmit-0.0.3/src/resubmit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

resubmit-0.0.3/src/resubmit.egg-info/requires.txt

@@ -0,0 +1,4 @@
+submitit>=0.8
+
+[debug]
+debugpy

resubmit-0.0.3/src/resubmit.egg-info/top_level.txt

@@ -0,0 +1 @@
+resubmit

resubmit-0.0.3/tests/test_resubmit.py

@@ -0,0 +1,116 @@
+import pytest
+from resubmit import submit_jobs, maybe_attach_debugger
+
+
+def dummy_func(jobs):
+    # return a list of strings to show behavior
+    return [f"ok-{j['id']}" for j in jobs]
+
+
+def test_submit_local_run():
+    jobs = [{"id": 1}, {"id": 2}]
+    res = submit_jobs(jobs, dummy_func, timeout_min=1, local_run=True)
+    assert res == ["ok-1", "ok-2"]
+
+
+def test_maybe_attach_debugger_noop():
+    # should not raise when port is None or 0
+    maybe_attach_debugger(None)
+    maybe_attach_debugger(0)
+
+
+def test_slurm_parameters_optional(monkeypatch):
+    events = {}
+
+    class DummyExecutor:
+        def __init__(self, folder):
+            events['folder'] = folder
+
+        def update_parameters(self, **kwargs):
+            # capture the parameters passed to the executor
+            events['update'] = kwargs
+
+        def map_array(self, func, jobs_list):
+            return []
+
+    class DummyModule:
+        AutoExecutor = DummyExecutor
+
+    import sys
+    monkeypatch.setitem(sys.modules, 'submitit', DummyModule)
+
+    jobs = [{"id": 1}]
+    # default: no constraint/reservation keys
+    submit_jobs(jobs, dummy_func, timeout_min=1, local_run=False, num_gpus=2, prompt=False)
+    slurm = events['update']['slurm_additional_parameters']
+    assert slurm['gpus'] == 2
+    assert 'constraint' not in slurm
+    assert 'reservation' not in slurm
+
+
+def test_slurm_parameters_settable(monkeypatch):
+    events = {}
+
+    class DummyExecutor:
+        def __init__(self, folder):
+            events['folder'] = folder
+
+        def update_parameters(self, **kwargs):
+            events['update'] = kwargs
+
+        def map_array(self, func, jobs_list):
+            return []
+
+    class DummyModule:
+        AutoExecutor = DummyExecutor
+
+    import sys
+    monkeypatch.setitem(sys.modules, 'submitit', DummyModule)
+
+    jobs = [{"id": 1}]
+    submit_jobs(
+        jobs,
+        dummy_func,
+        timeout_min=1,
+        local_run=False,
+        constraint='thin',
+        reservation='safe',
+        prompt=False,
+    )
+    slurm = events['update']['slurm_additional_parameters']
+    assert slurm['constraint'] == 'thin'
+    assert slurm['reservation'] == 'safe'
+
+
+def test_slurm_parameters_arg_precedence(monkeypatch):
+    events = {}
+
+    class DummyExecutor:
+        def __init__(self, folder):
+            events['folder'] = folder
+
+        def update_parameters(self, **kwargs):
+            events['update'] = kwargs
+
+        def map_array(self, func, jobs_list):
+            return []
+
+    class DummyModule:
+        AutoExecutor = DummyExecutor
+
+    import sys
+    monkeypatch.setitem(sys.modules, 'submitit', DummyModule)
+
+    jobs = [{"id": 1}]
+    # slurm_additional_parameters has constraint='foo' but explicit arg should override
+    submit_jobs(
+        jobs,
+        dummy_func,
+        timeout_min=1,
+        local_run=False,
+        slurm_additional_parameters={'constraint': 'foo'},
+        constraint='bar',
+        prompt=False,
+    )
+    slurm = events['update']['slurm_additional_parameters']
+    assert slurm['constraint'] == 'bar'