在 Python 的 main() 中调用参数是不好的做法吗

Question

函数名称 main() 是否应该始终为空并在函数本身内调用参数，或者将它们作为函数的输入是否可以接受，例如 main(arg1, arg2, arg3)？

我知道它有效，但我想知道这是否是糟糕的编程习惯。抱歉，如果这是重复的，但我看不到专门针对 Python 回答的问题。

Answer 1

在大多数其他编程语言中，您要么有零个参数，要么有两个参数：

int main(char *argv[], int argc)

表示传递给参数的参数。但是，在 Python 中，这些是通过 sys 模块访问的：

import sys

def main():
    print(sys.argv, len(sys.argv))

但是你可以扩展它，以便将 argv 和 argc 传递到你的 python 函数中，类似于其他语言是的：

import sys

def main(argv, arc):
    print(argv, arc)

if __name__ == '__main__':
    main(sys.argv, len(sys.argv))

但是现在让我们忘记 argv/argc - 为什么你想将一些东西传递给 main。您在 main 之外创建了一些东西，并希望将其传递给 main。这可能在两种情况下发生：

1. 您从其他函数多次调用 main。
2. 您在 main 之外创建了要传递的变量。

第 1 点绝对是不好的做法。 main 应该是唯一的，并且只在程序开始时调用一次。如果你需要多次调用它，那么main里面的代码就不属于main里面。分开吧。

第 2 点可能看起来很有意义，但你可以在实践中这样做：

def main(a, b):
    print(a, b)

if __name__ == '__main__':
    x = 4
    y = 5
    main(x, y)

但是x 和y 不是全局变量吗？良好的做法是假设这些位于文件的顶部（以及多个其他属性 - 它们是常量等），并且您不需要将它们作为参数传递。

Answer 2

按照模式：

def main():
    ...stuff...

if __name__ == '__main__':
    main()

它允许您的脚本直接运行，如果使用安装工具打包，则在安装包时通过指定 main 作为入口点自动生成可执行脚本。

见：https://setuptools.readthedocs.io/en/latest/setuptools.html#automatic-script-creation

您可以在setup.py 中添加类似：

entry_points={
    'console_scripts': [
        'my_script = my_module:main'
    ]
}

然后当你构建一个包时，人们可以在他们的虚拟环境中安装它，并立即在他们的路径上获得一个名为 my_script 的脚本。

像这样的自动脚本创建需要一个不带必需参数的函数。

允许您导入脚本并公开其功能以供代码重用和测试是一个好主意。我会推荐一些符合这种模式的东西：

import argparse

def parse_args():
    parser = argparse.ArgumentParser()
    #
    # ... configure command line arguments ...
    #
    return parser.parse_args()

def do_stuff(args):
    #
    # ... main functionality goes in here ...
    #

def main():
    args = parse_args()
    do_stuff(args)

if __name__ == '__main__':
    main()

这使您可以直接运行脚本，自动生成行为相同的脚本，还可以导入脚本并调用do_stuff 以重用或测试实际功能。

cmets 中提到了这篇博文：https://www.artima.com/weblogs/viewpost.jsp?thread=4829，它在 main 上使用默认参数来允许依赖注入进行测试，但是，这是一篇非常古老的博文（getopt 库从那时起已经被取代了两次) 我认为这种模式更胜一筹。

Answer 3

我肯定更愿意看到main 接受参数，而不是直接访问sys.argv。

这使得其他 Python 模块对 main 函数的重用变得更加容易。

import sys

def main(arg):
    ...

if __name__ == "__main__":
    main(sys.argv[1])

现在，如果我想将此模块作为脚本从另一个模块执行，我可以编写（在我的另一个模块中）。

from main_script import main

main("use this argument")

如果main 使用sys.argv，这就更难了。