fix: improved error messages in case of invalid storage queries

snakemake · Dec 6, 2023 · 9671fd0 · 9671fd0
1 parent b47d0df
commit 9671fd0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/snakemake/io.py b/snakemake/io.py
@@ -739,7 +739,7 @@ def apply_wildcards(self, wildcards):
             validation_res = storage_object.is_valid_query()
             if not validation_res:
                 raise WorkflowError(
-                    validation_res,
+                    str(validation_res),
                     rule=self.rule,
                 )
 

diff --git a/snakemake/path_modifier.py b/snakemake/path_modifier.py
@@ -97,8 +97,10 @@ def is_annotated_callable(value):
             if isinstance(value, AnnotatedString):
                 return bool(value.callable)
 
+        provider = self.workflow.storage_settings.default_storage_provider
+
         if (
-            self.workflow.storage_registry.default_storage_provider is None
+            provider is None
             or is_flagged(path, "storage_object")
             or is_flagged(path, "local")
             or is_annotated_callable(path)
@@ -117,7 +119,10 @@ def is_annotated_callable(value):
         validation_res = storage_object.is_valid_query()
         if not validation_res:
             raise WorkflowError(
-                validation_res,
+                f"Error applying default storage provider {provider}. "
+                "Make sure to provide a valid --default-storage-prefix "
+                "(see https://snakemake.github.io/snakemake-plugin-catalog/plugins/"
+                "storage/{provider}.html). {validation_res}",
             )
         return flag_with_storage_object(path, storage_object)
 

diff --git a/snakemake/storage.py b/snakemake/storage.py
@@ -161,7 +161,9 @@ def _storage_object(
         query_validity = provider.is_valid_query(query)
         if not query_validity:
             raise WorkflowError(
-                f"Error applying storage provider {provider_name}. {query_validity}"
+                f"Error applying storage provider {provider_name} "
+                "(see https://snakemake.github.io/snakemake-plugin-catalog/plugins/"
+                "storage/{provider}.html). {query_validity}"
             )
 
         storage_object = provider.object(