snk-cli 0.5.0__tar.gz → 0.5.2__tar.gz

{snk_cli-0.5.0 → snk_cli-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snk-cli
-Version: 0.5.0
+Version: 0.5.2
 Project-URL: Documentation, https://github.com/wytamma/snk-cli#readme
 Project-URL: Issues, https://github.com/wytamma/snk-cli/issues
 Project-URL: Source, https://github.com/wytamma/snk-cli

{snk_cli-0.5.0 → snk_cli-0.5.2}/src/snk_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Wytamma Wirth <wytamma.wirth@me.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.5.0"
+__version__ = "0.5.2"

{snk_cli-0.5.0 → snk_cli-0.5.2}/src/snk_cli/config/config.py

@@ -205,6 +205,17 @@ class SnkConfig:
           >>> snk_config.to_yaml(Path("snk.yaml"))
         """
         config_dict = {k: v for k, v in vars(self).items() if not k.startswith("_")}
+        def convert_paths(data):
+            if isinstance(data, dict):
+                return {key: convert_paths(value) for key, value in data.items()}
+            elif isinstance(data, list):
+                return [convert_paths(item) for item in data]
+            elif isinstance(data, Path):
+                return str(data)
+            return data
+        
+        config_dict = convert_paths(config_dict)
+
         with open(path, "w") as f:
             yaml.dump(config_dict, f)
 

{snk_cli-0.5.0 → snk_cli-0.5.2}/src/snk_cli/dynamic_typer.py

@@ -152,9 +152,12 @@ class DynamicTyper:
         if option.type is Enum or option.choices:
             if not option.choices:
                 raise ValueError(f"Enum type {option.name} requires choices to be defined.")
-            annotation_type = Enum('DynamicEnum', {e: e for e in option.choices})
+            annotation_type = Enum(f'{option.name}', {str(e): str(e) for e in option.choices})
             if default:
-              default = annotation_type(default)
+              try:
+                default = annotation_type(default)
+              except ValueError:
+                raise ValueError(f"Default value {default} for option {option.name} is not a valid choice.")
         return Parameter(
             option.name,
             kind=Parameter.POSITIONAL_OR_KEYWORD,

snk_cli-0.5.2/tests/test_SnkConfig.py

@@ -0,0 +1,125 @@
+import pytest
+from snk_cli.config.config import SnkConfig
+
+
+def test_snk_config_creation():
+    snk_config = SnkConfig()
+    assert snk_config.tagline == "A Snakemake workflow CLI generated with Snk"
+    assert snk_config.font == "small"
+    assert snk_config.resources == []
+    assert snk_config.cli == {}
+    assert snk_config.symlink_resources is False
+    assert snk_config.version is None
+    assert snk_config.skip_missing is False
+
+
+def test_validate_resources_with_existing_files(tmp_path):
+    resources = [tmp_path / "file1", tmp_path / "file2"]
+    for resource in resources:
+        resource.touch()
+    snk_config = SnkConfig()
+    # Should not raise an exception
+    snk_config.validate_resources(resources)
+
+
+def test_validate_resources_with_missing_files(tmp_path):
+    resources = [tmp_path / "file1", tmp_path / "missing_file"]
+    resources[0].touch()
+    snk_config = SnkConfig()
+    with pytest.raises(FileNotFoundError):
+        snk_config.validate_resources(resources)
+
+
+def test_add_resources(tmp_path):
+    resources = [tmp_path / "file1", tmp_path / "file2"]
+    for resource in resources:
+        resource.touch()
+    snk_config = SnkConfig()
+    snk_config.add_resources(resources)
+    assert len(snk_config.resources) == 2
+
+
+def test_from_path_with_existing_file(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    config_file.touch()
+    config_file.write_text("logo: test_logo")
+    snk_config = SnkConfig.from_path(config_file)
+    assert snk_config._snk_config_path == config_file
+
+def test_missing_file(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    with pytest.raises(FileNotFoundError):
+        SnkConfig.from_path(config_file)
+
+def test_empty_file(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    config_file.touch()
+    with pytest.raises(ValueError):
+        SnkConfig.from_path(config_file)
+
+def test_invalid_yaml(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    config_file.touch()
+    config_file.write_text("logo: test_logo\ninvalid_yaml")
+    with pytest.raises(Exception):
+        SnkConfig.from_path(config_file)
+
+def test_from_dir_with_existing_file(tmp_path):
+    config_file = tmp_path / ".snk"
+    config_file.touch()
+    config_file.write_text("logo: test_logo")
+    # catch warning 
+    with pytest.warns(DeprecationWarning):
+        snk_config = SnkConfig.from_workflow_dir(tmp_path)
+    assert snk_config._snk_config_path == config_file
+
+
+def test_from_path_with_missing_file(tmp_path):
+    config_file = tmp_path / "missing_file.yaml"
+    # assert it raises FileNotFoundError
+    with pytest.raises(FileNotFoundError):
+        SnkConfig.from_path(config_file)
+
+
+def test_to_yaml(tmp_path):
+    snk_config = SnkConfig(art="test_art", logo="test_logo")
+    yaml_file = tmp_path / "snk.yaml"
+    snk_config.to_yaml(yaml_file)
+    assert yaml_file.exists()
+
+
+def test_save(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    snk_config = SnkConfig(_snk_config_path=config_file)
+    snk_config.art = "new_art"
+    snk_config.save()
+    saved_snk_config = SnkConfig.from_path(config_file)
+    assert saved_snk_config.art == "new_art"
+
+
+def test_version_from_about_file(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    about_file = tmp_path / "__about__.py"
+    about_file.touch()
+    about_file.write_text("__version__ = '0.0.1'")
+    config_file.write_text("version: __about__.py")
+    snk_config = SnkConfig.from_path(config_file)
+    assert snk_config.version == "0.0.1"
+
+def test_version_from_about_file_with_missing_file(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    about_file = tmp_path / "__about__.py"
+    config_file.write_text("version: __about__.py")
+    with pytest.raises(FileNotFoundError):
+        SnkConfig.from_path(config_file)
+
+def test_paths_are_written_as_strings(tmp_path):
+    config_file = tmp_path / "snk.yaml"
+    snk_config = SnkConfig(snakefile=tmp_path / "snakefile", resources=[tmp_path / "file1", tmp_path / "file2"])
+    snk_config.to_yaml(config_file)
+    with open(config_file) as f:
+        config = f.read()
+    print(config)
+    assert f"snakefile: {tmp_path / 'snakefile'}" in config
+    assert f"- {tmp_path / 'file1'}" in config
+    assert f"- {tmp_path / 'file2'}" in config

{snk_cli-0.5.0 → snk_cli-0.5.2}/tests/test_cli/test_validate.py

@@ -24,6 +24,12 @@ import pytest
         {"example": {"type": "bool"}},
         {"example": True}
     ),
+    # timestamp
+    (
+        {"example": "2021-01-01T00:00:00"},
+        {"example": {"type": "str"}},
+        {"example": "2021-01-01T00:00:00"}
+    ),
     # None
     (
         {"example": None},