如何在Snakemake的.smk文件中导入本地Python模块

原有写法抛出ModuleNotFoundError通常是三个细节没处理对：

• 代码中使用了sys和pathlib.Path但未提前导入对应模块
• 未将路径转为绝对路径，Snakemake运行时工作目录为执行命令的目录，而非smk文件所在目录，相对路径计算容易错位
• 被导入的dir1目录缺少包标识文件，部分Python版本无法将其识别为可导入模块

以下方法都可以正常导入本地py文件，按需选择即可：

• 方法1：修正路径逻辑+补全包标识
  1. 在dir1目录下新建空文件__init__.py，将目录标记为Python包，调整后目录结构如下：

     parent_dir
     ├── dir1
     │   ├── __init__.py
     │   └── a.py
     └── dir2
         └── b.smk
     

  2. 在b.smk文件最顶部添加如下导入代码：

     import sys
     from pathlib import Path
     
     # 计算parent_dir的绝对路径加入系统路径
     parent_dir = Path(__file__).resolve().parent.parent
     sys.path.insert(0, str(parent_dir))
     
     # 正常导入模块即可
     from dir1 import a
     

• 方法2：直接按文件路径加载，无需新建__init__.py
  如果不想额外创建包标识文件，可以用Python的importlib工具直接按文件绝对路径加载py模块，在b.smk顶部写如下代码：

  import importlib.util
  from pathlib import Path
  
  # 定位a.py的绝对路径
  a_file_path = Path(__file__).resolve().parent.parent / "dir1" / "a.py"
  # 加载模块
  spec = importlib.util.spec_from_file_location("a_mod", a_file_path)
  a = importlib.util.module_from_spec(spec)
  spec.loader.exec_module(a)
  
  # 后续直接通过a.xxx的形式调用a.py中的函数、变量即可
  

• 方法3：通过环境变量指定Python搜索路径
  如果不想在smk文件中写路径处理逻辑，可以在执行Snakemake命令前，将parent_dir的路径加入PYTHONPATH环境变量：

  # 进入parent_dir目录，也可以直接写parent_dir的绝对路径
  export PYTHONPATH=$PYTHONPATH:$(pwd)
  # 正常执行snakemake命令即可
  snakemake -s dir2/b.smk  # 追加你平时使用的其他snakemake运行参数
  

  这种方式需要保证dir1下存在__init__.py文件，smk中直接写from dir1 import a即可完成导入。

注意：所有路径计算尽量基于__file__生成绝对路径，不要直接写相对路径，否则切换执行命令的目录时很容易再次出现导入错误。

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