如何在项目中正确使用助手模块？

Question

我有一个大的C/C++项目，有大量的设置。为了简化不同变体和配置的构建过程，我以模块的形式编写了Python脚本

所以在项目根目录下，我有一个helpers文件夹。我唯一需要设置工作环境的是将我的PYTHONPATH变量设置为我的Git根文件夹：

export PYTHONPATH=$(git rev-parse --show-toplevel)

这使我可以访问我的助手模块，但我怀疑这是最好的选择

有什么好的替代方法呢

Answer 1

另一种方法是将模块组织为命令

您可以创建一个主脚本，比如main.py，并在bin中创建指向它的链接：

user@host:home/user/bin$ ln ~/my_module/main.py buildhelper

然后使main.py可执行：更改其权限，并添加#!/usr/bin/env python作为其第一行

user@host:~/$ chmod 755 ~/my_module/main.py

现在您可能需要脚本来解析控制台参数，以便调用不同的特性。你的main.py可能看起来像：

import my_module
import sys

def setup(*args):
    pass

def build(*args):
    pass

if __name__ == '__main__':
    if len(sys.argv) == 1:
        print("No function requested")

    elif sys.argv[1] == 'setup':
        setup(*argv[1:])

    elif sys.argv[1] == 'build':
        build(*argv[1:])

    else:
        print("Invalid function")

然后，您可以通过以下命令调用模块的函数：

user@host:/anywhere$ buildhelper setup
user@host:/anywhere$ buildhelper build

优点

• 在任何地方工作
• 可以重新用于其他项目
• 清洁

缺点

• 适用于任何地方：如果脚本过于特定于项目，则可能是过度杀伤力
• 可能需要额外的工作才能将模块组织为命令