python代码:x.py -h 或--help显示帮助文档
时间: 2024-10-20 12:05:49 浏览: 58
在Python中,如果你创建了一个名为`x.py`的脚本,并想要添加一个命令行选项 `-h` 或 `--help` 来显示帮助文档,你可以使用`argparse`模块来实现这个功能。`argparse`是一个内置的模块,用于处理命令行参数。下面是一个简单的例子:
```python
import argparse
def main():
parser = argparse.ArgumentParser(description='This is a sample script with help documentation.')
# 添加命令行选项
parser.add_argument('-h', '--help', action='help', help='Display this help message and exit.')
parser.add_argument('optional_arg', nargs='?', default='default_value', help='An optional argument')
args = parser.parse_args()
# 如果用户只传递了-h或--help,那么直接显示帮助并退出
if not args.optional_arg:
parser.print_help()
return
# 否则执行正常的业务逻辑
print(f"Optional arg: {args.optional_arg}")
if __name__ == "__main__":
main()
```
在这个示例中,当你运行 `python x.py -h` 或 `python x.py --help` 时,会打印出关于脚本的描述以及可用参数的帮助信息。
阅读全文