如何在 __doc__ 中定义 CLI 程序的帮助？

Question

我想做这样的事情：

def main():
    """
    Display Information about a Google Calendar

     -u --user login     Google Login
     -p --pass password  Google Password
     -d --debug          Set DEBUG = True
     -h --help           Display this help
    """

    print(__doc__)

if __name__ == "__main__":
    main()

但答案是：None ... 为什么？

Answer 1

因为__doc__ 是函数的属性，而不是局部变量。您需要将其称为main.__doc__，如下所示：

def main():
    """Display Information about a Google Calendar

    ..."""
    print(main.__doc__)

if __name__ == "__main__":
    main()

Answer 2

如果您要打印的帮助是“全局的”，您可能会发现将其作为程序的主要文档更合乎逻辑：

#!/usr/bin/env python
"""
Display Information about a Google Calendar
...
"""

if __name__ == '__main__':
    print __doc__

__doc__ 是一个包含脚本文档字符串的全局变量。