python 如何写好main函数（转）

最新推荐文章于 2025-05-16 22:10:04 发布

OPMR

最新推荐文章于 2025-05-16 22:10:04 发布

阅读量1k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： python 文章标签： python

原文链接：http://www.artima.com/weblogs/viewpost.jsp?thread=4829

python 专栏收录该内容

12 篇文章

订阅专栏

Python之父Guido van Rossum分享了优化main()函数的方法，通过增加argv参数的灵活性、定义Usage异常来简化错误处理流程，提高代码的可读性和可维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

转载自：http://codingpy.com/article/guido-shows-how-to-write-main-function/

每个程序员在学习编程的过程中，肯定没少写过main()函数，Python程序员也不例外。本文为大家分享Python之父Guido van Rossum推荐的函数写法，可以大大提高这个函数的灵活性。

一般来说，Python程序员可能是这样写main()函数的：

"""Module docstring.

This serves as a long usage message.
"""
import sys
import getopt

def main():
    # parse command line options
    try:
        opts, args = getopt.getopt(sys.argv[1:], "h", ["help"])
    except getopt.error, msg:
        print msg
        print "for help use --help"
        sys.exit(2)
    # process options
    for o, a in opts:
        if o in ("-h", "--help"):
            print __doc__
            sys.exit(0)
    # process arguments
    for arg in args:
        process(arg) # process() is defined elsewhere

if __name__ == "__main__":
    main()

Guido也承认之前自己写的main()函数也是类似的结构，但是这样写的灵活性还不够高，尤其是需要解析复杂的命令行选项时。为此，他向大家提出了几点建议。

添加可选的 argv 参数

首先，修改main()函数，使其接受一个可选参数 argv，支持在交互式shell中调用该函数：

def main(argv=None):
    if argv is None:
        argv = sys.argv
    # etc., replacing sys.argv with argv in the getopt() call.

这样做，我们就可以动态地提供 argv 的值，这比下面这样写更加的灵活：

def main(argv=sys.argv):
    # etc.

这是因为在调用函数时，sys.argv 的值可能会发生变化；可选参数的默认值都是在定义main()函数时，就已经计算好的。

但是现在sys.exit()函数调用会产生问题：当main()函数调用sys.exit()时，交互式解释器就会推出！解决办法是让main()函数的返回值指示退出状态（exit status）。因此，最后面的那行代码就变成了这样：

if __name__ == "__main__":
    sys.exit(main())

并且，main()函数中的sys.exit(n)调用全部变成return n。

定义一个Usage()异常

另一个改进之处，就是定义一个Usage()异常，可以在main()函数最后的except子句捕捉该异常：

import sys
import getopt

class Usage(Exception):
    def __init__(self, msg):
        self.msg = msg

def main(argv=None):
    if argv is None:
        argv = sys.argv
    try:
        try:
            opts, args = getopt.getopt(argv[1:], "h", ["help"])
        except getopt.error, msg:
            raise Usage(msg)
        # more code, unchanged
    except Usage, err:
        print >>sys.stderr, err.msg
        print >>sys.stderr, "for help use --help"
        return 2

if __name__ == "__main__":
    sys.exit(main())

这样main()函数就只有一个退出点（exit）了，这比之前两个退出点的做法要好。而且，参数解析重构起来也更容易：在辅助函数中引发Usage的问题不大，但是使用return 2却要求仔细处理返回值传递的问题。