fix: ensure that exceptions print storage queries instead of local copies of remote files

johanneskoester · johanneskoester · commit 8c130143bb4b · 2025-01-21T16:39:15.000+01:00
diff --git a/snakemake/exceptions.py b/snakemake/exceptions.py
@@ -354,6 +354,9 @@ def __init__(self, rule, lineno=None, snakefile=None):
 class AmbiguousRuleException(RuleException):
     def __init__(self, filename, job_a, job_b, lineno=None, snakefile=None):
         from snakemake import utils
+        from snakemake.io import pretty_print_iofile
+
+        filename = pretty_print_iofile(filename)
 
         wildcards_a = utils.format("{}", job_a._format_wildcards)
         wildcards_b = utils.format("{}", job_b._format_wildcards)
@@ -390,10 +393,11 @@ def __init__(self, repeatedrule, file, rule=None):
 
 class MissingRuleException(RuleException):
     def __init__(self, file, lineno=None, snakefile=None):
+        from snakemake.io import pretty_print_iofile
+
         super().__init__(
-            "No rule to produce {} (if you use input functions make sure that they don't raise unexpected exceptions).".format(
-                file
-            ),
+            f"No rule to produce {pretty_print_iofile(file)} (if you use input "
+            "functions make sure that they don't raise unexpected exceptions).",
             lineno=lineno,
             snakefile=snakefile,
         )
@@ -416,13 +420,17 @@ def __init__(self, lineno=None, snakefile=None):
 
 class IncompleteFilesException(RuleException):
     def __init__(self, files):
+        from snakemake.io import pretty_print_iofile
+
         super().__init__(
             "The files below seem to be incomplete. "
             "If you are sure that certain files are not incomplete, "
             "mark them as complete with\n\n"
             "    snakemake --cleanup-metadata <filenames>\n\n"
             "To re-generate the files rerun your command with the "
-            "--rerun-incomplete flag.\nIncomplete files:\n{}".format("\n".join(files))
+            "--rerun-incomplete flag.\nIncomplete files:\n{}".format(
+                "\n".join(map(pretty_print_iofile, files))
+            )
         )
 
 
diff --git a/snakemake/io.py b/snakemake/io.py
@@ -878,11 +878,11 @@ def __hash__(self):
         return self._file.__hash__()
 
 
-def pretty_print_iofile(iofile: _IOFile):
-    if iofile.is_storage:
+def pretty_print_iofile(iofile: Union[_IOFile, str]) -> str:
+    if isinstance(iofile, _IOFile) and iofile.is_storage:
         return f"{iofile.storage_object.query} (storage)"
     else:
-        return iofile._file
+        return iofile
 
 
 class AnnotatedString(str, AnnotatedStringInterface):
