Snakemake传递目录输入时自动去除末尾斜杠的问题排查

问题背景 #

我有一个针对目录内容执行多项QC任务的工作流，唯一输入是目标目录，调用命令如下：

snakemake --snakefile Snakefile \
  --use-conda \
  --config run_dir=/path/to/my/data/ \
  --slurm

我编写了sanitise_run_dir函数确保路径末尾带斜杠，但在gather_metrics规则中将其传给自定义脚本parse_key_metrics.py时，Snakemake自动去除了末尾斜杠，导致脚本用str.split('/')解析目录名失败。错误信息如下：

Error in rule gather_metrics:
    message: SLURM-job '422068' failed, SLURM status is: 'FAILED'
    jobid: 3
    input: myInstrument, /path/to/my/data
    output: <omitted_for_SO_post>, <omitted_for_SO_post>
    log: .snakemake/slurm_logs/rule_gather_metrics/422068.log (check log file(s) for error details)

Exiting because a job execution failed. Look above for error message

这是在将Snakemake从5.26.1升级到7.32.4适配Slurm后出现的问题，以下是针对三个疑问的解答：

1. Snakemake为何会去除末尾斜杠？ #

Snakemake内部会对所有路径进行标准化处理，这是为了保证路径解析的一致性——在文件系统中，/path/to/data和/path/to/data/指向的是同一个目录，标准化后会统一为无末尾斜杠的形式，避免因路径写法差异导致依赖判断错误、重复处理等问题。
从5.x到7.x的版本升级中，Snakemake强化了路径标准化逻辑，这就是你之前版本正常、升级后出现问题的原因。

2. 能否抑制该行为？ #

没有直接的配置或参数能强制Snakemake保留路径末尾的斜杠，因为路径标准化是其核心路径处理逻辑的一部分。
如果你的脚本依赖末尾斜杠，最稳妥的解决方式是在脚本层面处理：

• 用专业的路径处理工具（比如Python的pathlib）替代str.split('/')：比如from pathlib import Path; dir_name = Path(run_dir).name，不管输入路径有没有斜杠，都能正确提取目录名
• 手动给传入的路径添加斜杠：比如run_dir = run_dir.rstrip('/') + '/'，确保末尾始终有斜杠

3. 传递目录作为输入是否违反Snakemake设计理念？ #

Snakemake的核心设计是基于具体文件的依赖管理，它更擅长跟踪单个文件的变化（修改时间、内容哈希），而目录本身无法提供精确的更新信号——目录存在不代表内部文件没变化，目录修改时间变化也可能只是内部文件的增删。
但这并不意味着不能传递目录作为输入：

• 如果工作流需要处理目录下所有文件，更规范的做法是明确列出目录下的具体文件作为输入（比如用glob匹配），让Snakemake能精确跟踪依赖变化，避免不必要的重跑
• 如果必须以目录为输入，可以用directory()函数标记输入，比如：

  rule gather_metrics:
      input:
          instrument="myInstrument",
          run_dir=directory(config["run_dir"])
      # 其他规则内容
  

  这样Snakemake会将其识别为目录并检查存在性，但仍然会进行路径标准化（去掉末尾斜杠）。

内容的提问来源于stack exchange，提问作者Sam