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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snk-cli
-Version: 0.4.0
+Version: 0.5.0
 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.4.0 → snk_cli-0.5.0}/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.4.0"
+__version__ = "0.5.0"

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

@@ -2,6 +2,7 @@ import typer
 from typing import List, Callable
 from inspect import signature, Parameter
 from makefun import with_signature
+from enum import Enum
 
 from .options import Option
 import sys
@@ -146,17 +147,25 @@ class DynamicTyper:
           >>> create_cli_parameter(option)
           Parameter('foo', kind=Parameter.POSITIONAL_OR_KEYWORD, default=typer.Option(..., help='[CONFIG] A number'), annotation=int)
         """
+        annotation_type = option.type
+        default = option.default
+        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})
+            if default:
+              default = annotation_type(default)
         return Parameter(
             option.name,
             kind=Parameter.POSITIONAL_OR_KEYWORD,
             default=typer.Option(
-                ... if option.required else option.default,
+                ... if option.required else default,
                 *[option.flag, option.short_flag] if option.short else [],
                 help=f"{option.help}",
                 rich_help_panel="Workflow Configuration",
                 hidden=option.hidden,
             ),
-            annotation=option.type,
+            annotation=annotation_type,
         )
 
     def check_if_option_passed_via_command_line(self, option: Option):

{snk_cli-0.4.0 → snk_cli-0.5.0}/src/snk_cli/options/option.py

@@ -16,3 +16,4 @@ class Option:
     short_flag: Optional[str]
     hidden: bool = False
     from_annotation: bool = False
+    choices: Optional[list] = None

{snk_cli-0.4.0 → snk_cli-0.5.0}/src/snk_cli/options/utils.py

@@ -1,8 +1,9 @@
-from typing import List, Any
+from typing import List
 from ..config.config import SnkConfig
 from ..utils import get_default_type, flatten
 from .option import Option
 from pathlib import Path
+from enum import Enum
 
 types = {
     "int": int,
@@ -17,6 +18,7 @@ types = {
     "list[str]": List[str],
     "list[path]": List[Path],
     "list[int]": List[int],
+    "enum": Enum,
 }
 
 def get_keys_from_annotation(annotations):
@@ -78,6 +80,7 @@ def create_option_from_annotation(
         short_flag=f"-{short}" if short else None,
         hidden=hidden,
         from_annotation=from_annotation,
+        choices=annotation_values.get(f"{annotation_key}:choices", None),
     )
 
 

{snk_cli-0.4.0 → snk_cli-0.5.0}/tests/data/workflow/snk.yaml

@@ -9,6 +9,8 @@ cli:
     type: bool
   null_annotation:
     default: null
+  enum:
+    choices: [a, b, c]
   test:
     another:
       test:

{snk_cli-0.4.0 → snk_cli-0.5.0}/tests/test_cli/test_dynamic_options.py

@@ -35,9 +35,42 @@ def test_create_option_from_annotation(
     assert option.default == "default_value"
     assert option.updated is False
     assert option.help == "Test help"
-    assert option.type == str
+    assert option.type is str
     assert option.required is True
 
+def test_create_option_from_annotation_with_short(
+    default_annotation_values, default_default_values
+):
+    default_annotation_values["test:short"] = "t"
+
+    option = create_option_from_annotation(
+        "test", default_annotation_values, default_default_values
+    )
+
+    assert option.short == "t"
+
+def test_create_option_from_annotation_with_hidden(
+    default_annotation_values, default_default_values
+):
+    default_annotation_values["test:hidden"] = True
+
+    option = create_option_from_annotation(
+        "test", default_annotation_values, default_default_values
+    )
+
+    assert option.hidden is True
+
+def test_create_option_from_annotation_with_enums(
+    default_annotation_values, default_default_values
+):
+    default_annotation_values["test:choices"] = ["a", "b", "c"]
+
+    option = create_option_from_annotation(
+        "test", default_annotation_values, default_default_values
+    )
+
+    assert option.choices == ["a", "b", "c"]
+
 
 @pytest.fixture
 def default_snakemake_config():

{snk_cli-0.4.0 → snk_cli-0.5.0}/tests/test_cli/test_snk_config.py

@@ -41,4 +41,11 @@ def test_non_standard_configfile(tmp_path):
     runner = dynamic_runner({}, SnkConfig(configfile=tmp_path / "config2.yaml"), tmp_path=tmp_path)
     res = runner.invoke(["run"])
     assert res.exit_code == 0, res.stderr
-    assert "config2" in res.stdout, res.stderr
+    assert "config2" in res.stdout, res.stderr
+
+def test_snk_config_with_enums(tmp_path):
+    runner = dynamic_runner({}, SnkConfig(cli={"test": {"choices": ["enum1", "enum2"], "type": "enum"}}), tmp_path=tmp_path)
+    res = runner.invoke(["run", "--help"])
+    assert res.exit_code == 0, res.stderr
+    assert "enum1" in res.stdout, res.stderr
+    assert "enum2" in res.stdout, res.stderr