Merge pull request #2 from znamlab/dev

Dev

CHANGELOG.md

@@ -1,6 +1,10 @@
 
 ## Changelog
 
+### [v0.3] - 2023-12-05
+
+- Bugfix: `slurm_options` was required but can now be ommited in the decorator
+
 ### [v0.2] - 2023-12-05
 
 - Add option to change slurm options when calling the decorated function

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="znamutils",
-    version="v0.2",
+    version="v0.3-dev",
     packages=find_packages(exclude=["tests"]),
     url="https://github.com/znamlab/znamutils",
     license="MIT",

tests/test-results/pytest_in_tests.xml

@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><testsuites><testsuite name="pytest" errors="0" failures="0" skipped="0" tests="3" time="3.478" timestamp="2023-12-05T17:31:48.510906" hostname="int000"><testcase classname="tests.test_decorators" name="test_slurm_my_func" time="0.223" /><testcase classname="tests.test_decorators" name="test_update_slurm_options" time="0.052" /><testcase classname="tests.test_slurm_helpers" name="test_create_slurm_sbatch" time="0.000" /></testsuite></testsuites>
+<?xml version="1.0" encoding="utf-8"?><testsuites><testsuite name="pytest" errors="0" failures="0" skipped="0" tests="3" time="6.868" timestamp="2023-12-06T12:02:22.125240" hostname="int002"><testcase classname="tests.test_decorators" name="test_slurm_my_func" time="0.529" /><testcase classname="tests.test_decorators" name="test_update_slurm_options" time="0.057" /><testcase classname="tests.test_slurm_helpers" name="test_create_slurm_sbatch" time="0.000" /></testsuite></testsuites>

tests/test_decorators.py

@@ -13,6 +13,13 @@ def test_slurm_my_func():
     )
     slurm_folder.mkdir(exist_ok=True)
 
+    @slurm_it(conda_env="cottage_analysis")
+    def test_func(a, b):
+        return a + b
+
+    assert test_func(1, 2, use_slurm=False) == 3
+    assert isinstance(test_func(1, 2, use_slurm=True, slurm_folder=slurm_folder), str)
+
     @slurm_it(conda_env="cottage_analysis", slurm_options={"time": "00:01:00"})
     def test_func(a, b):
         from datetime import datetime

znamutils/decorators.py

@@ -56,6 +56,8 @@ def slurm_it(
         function: decorated function
     """
     # make a copy of default slurm options to avoid modifying the original
+    if slurm_options is None:
+        slurm_options = {}
     default_slurm_options = slurm_options.copy()
 
     # add parameters to the wrapped function signature