本文基于我和GPT-4的讨论记录，由GPT-4生成，由我本人对结果进行审查。
编写Python库是一项让人兴奋的任务，它不仅可以提高你的编码效率，还可以与全球的Python社区共享你的工作。本文将指导你如何创建一个Python库，特别是一个可以调用Snakefile（常用于Snakemake工作流管理系统）的库。我们将覆盖库的结构设计、如何组织文件，以及如何在Python代码中读取和使用Snakefile。
项目结构
首先，让我们确定一个合理的项目结构，比如说下面这种：
mypackage/
├── src/
│ ├── mypackage/
│ │ ├── __init__.py
│ │ └── ...
│ └── workflow/
│ ├── __init__.py
│ └── Snakefile
├── tests/
│ └── ...
├── docs/
│ └── ...
├── setup.py
├── README.md
├── LICENSE
└── requirements.txt
在这个结构中，mypackage是我们的库名，所有源代码放在src目录下。workflow目录包含Snakemake的Snakefile，我们希望在库中调用它。
setup.py配置
setup.py是Python项目的核心，它告诉Python如何安装和分发你的库。以下是一个setup.py的例子，特别针对于包含非Python文件（如Snakefile）的情况：
from setuptools import setup, find_packages
setup(
name="mypackage",
version="0.1.0",
description="my package",
package_dir={"": "src"},
packages=find_packages(where="src"),
include_package_data=True,
package_data={
"": ["*.md", "envs/*", "workflow/*"],
"wgap": ["*.py"],
},
entry_points={
'console_scripts': ['wgap = wgap.main:cli']
},
install_requires=[
# 依赖列表
],
python_requires=">=3.7",
)
在配置文件中，需要注意如下两类参数：
第一类是：包目录和包查找
package_dir={"": "src"}: 这个参数指定了包的源代码在哪个目录下。这里，空字符串""表示包的根导入路径，而"src"表示源代码实际位于src目录。这意味着在导入包时，Python会到src目录下查找模块。packages=find_packages(where="src"): 使用find_packages函数自动查找src目录下的所有Python包。这样做的好处是自动识别包和子包，无需手动列出。
包内资源文件
package_data: 这个参数指定了除了Python模块文件外，还需要包含在包内的其他文件。这对于包含数据文件、文档或其他资源很有用。"": ["*.md", "envs/*", "workflow/*"]: 这里的空字符串""代表包的根目录（由package_dir指定）。"*.md"表示包含所有Markdown文件，"envs/*"表示包含envs目录下的所有文件，"workflow/*"表示包含workflow目录下的所有文件。"wgap": ["*.py"]: 这表示在wgap包内，包含所有Python(*.py)文件。虽然Python文件默认被包含，这里显式声明有助于清晰地说明意图。
include_package_data=True: 确保包含在package_data和MANIFEST.in中声明的数据文件。这个设置确保了你的包在安装时会包含这些额外的非代码文件。
基于我们的配置文件，python在安装的时候，会做如下事情
- 从根目录，也就是src中查找python库，也就是workflow和wgap
- 从根目录，也就是src中，包含额外数据，例如 env, workflow
- 从wgap包中，包含py文件
在Python代码中读取Snakefile
要在Python代码中读取和使用Snakefile，我们推荐使用importlib.resources模块，这是一个现代的解决方案，用于在包内部访问资源文件。以下是如何实现的一个示例：
import importlib.resources as pkg_resources
def get_snakefile_path():
print('loading snakefile')
with pkg_resources.path('workflow', 'Snakefile') as snakefile_path:
print(snakefile_path)
这个代码段首先使用resources.path获取Snakefile的路径，然后以读取模式打开并读取其内容。
总结
编写一个可以调用Snakefile的Python库涉及到精心设计库的结构、合理配置setup.py，以及在代码中正确读取非Python文件。通过遵循本文的指南，你可以创建一个功能强大、易于维护和分享的Python库，它可以无缝地与Snakemake工作流集成，为科学研究或数据处理提供强大的支持。
