首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何在执行Python文件时打印其文档字符串?

如何在执行Python文件时打印其文档字符串?
EN

Stack Overflow用户
提问于 2011-10-17 17:09:03
回答 2查看 33.9K关注 0票数 87

我有一个带有文档字符串的Python脚本。当命令行参数的解析不成功时,我想打印用户信息的文档字符串。

有没有办法做到这一点?

最小示例

代码语言:javascript
复制
#!/usr/bin/env python
"""
Usage: script.py

This describes the script.
"""

import sys


if len(sys.argv) < 2:
    print("<here comes the docstring>")
EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2011-10-17 17:10:12

文档字符串存储在模块的全局__doc__中。

代码语言:javascript
复制
print(__doc__)

顺便说一句,这适用于任何模块:import sys; print(sys.__doc__)。函数和类的文档字符串也在它们的__doc__属性中。

票数 100
EN

Stack Overflow用户

发布于 2013-02-25 17:50:44

这里有一个替代方案,它不对脚本的文件名进行硬编码,而是使用sys.argv来打印它。使用%(scriptName)s而不是%s可以提高代码的可读性。

代码语言:javascript
复制
#!/usr/bin/env python
"""
Usage: %(scriptName)s

This describes the script.
"""

import sys
if len(sys.argv) < 2:
   print __doc__ % {'scriptName' : sys.argv[0].split("/")[-1]}
   sys.exit(0)
票数 13
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/7791574

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档