snk-cli 0.6.1__tar.gz → 0.7.0__tar.gz

{snk_cli-0.6.1 → snk_cli-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snk-cli
-Version: 0.6.1
+Version: 0.7.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.6.1 → snk_cli-0.7.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.6.1"
+__version__ = "0.7.0"

{snk_cli-0.6.1 → snk_cli-0.7.0}/src/snk_cli/config/config.py

@@ -37,6 +37,9 @@ class SnkConfig:
       skip_missing (bool): Whether to skip missing CLI options. Defaults to False.
       additional_snakemake_args (List[str]): List of additional Snakemake command-line arguments. Defaults to an empty list.
       commands (List[str]): List of subcommands to include in the CLI. Defaults to ["run", "script", "env", "profile", "info", "config"].
+      snakefile (Optional[Path]): Path to the Snakefile. Defaults to None.
+      configfile (Optional[Path]): Path to the config file. Defaults to None.
+      min_snk_cli_version (Optional[str]): Minimum version of the SNK CLI required to run the workflow. Defaults to None.
       cli (dict): Dictionary of CLI options and their values. Defaults to an empty dictionary.
       _snk_config_path (Path): The path to the SNK config file. Defaults to None.
 
@@ -73,6 +76,7 @@ class SnkConfig:
     commands: List[str] = field(default_factory=lambda: ["run", "script", "env", "profile", "info", "config"])
     snakefile: Optional[Path] = None
     configfile: Optional[Path] = None
+    min_snk_cli_version: Optional[str] = None
     cli: dict = field(default_factory=dict)
     _snk_config_path: Path = None
 
@@ -108,6 +112,14 @@ class SnkConfig:
             # TODO: remove conda_required in the future
             snk_config_dict["conda"] = snk_config_dict["conda_required"]
             del snk_config_dict["conda_required"]
+        # print warning about any invalid keys
+        fields = set(cls.__dict__["__dataclass_fields__"])
+        invalid_config_keys = set(snk_config_dict.keys()) - fields
+        if invalid_config_keys:
+            import warnings
+            warnings.warn(f"invalid keys in `snk.yaml` file: {invalid_config_keys}.")
+        # filer out any invalid keys
+        snk_config_dict = {k: v for k, v in snk_config_dict.items() if k in fields}
         snk_config = cls(**snk_config_dict)
         snk_config.resources = [
             snk_config_path.parent / resource for resource in snk_config.resources

{snk_cli-0.6.1 → snk_cli-0.7.0}/tests/data/workflow/snk.yaml

@@ -1,4 +1,5 @@
 art: null
+invalid: false
 cli:
   hidden:
     hidden: true