docopt-ng 项目使用教程

最新推荐文章于 2024-11-06 07:09:58 发布

施京柱Belle

最新推荐文章于 2024-11-06 07:09:58 发布

阅读量576

点赞数 22

本文链接：https://blog.csdn.net/gitblog_00175/article/details/142192470

版权

docopt-ng 项目使用教程

docopt-ng Humane command line arguments parser. Now with maintenance, typehints, and complete test coverage. 项目地址: https://gitcode.com/gh_mirrors/do/docopt-ng

1. 项目介绍

docopt-ng 是一个开源的命令行参数解析库，由 jazzband 社区维护和更新。它是原 docopt 库的进化版，不仅继承了前任的精髓，还增添了类型提示、全面的测试覆盖率等现代开发所必需的支持。docopt-ng 通过解析文档字符串（docstring）来自动生成高效的命令解析器，使得开发者能够轻松构建优雅且功能强大的命令行界面。

2. 项目快速启动

安装

使用 pip 安装 docopt-ng：

python -m pip install docopt-ng

示例代码

以下是一个简单的 Python 脚本示例，展示了如何使用 docopt-ng 来解析命令行参数：

"""Naval Fate.

Usage:
  naval_fate.py ship new <name>
  naval_fate.py ship <name> move <x> <y> [--speed=<kn>]
  naval_fate.py ship shoot <x> <y>
  naval_fate.py mine (set|remove) <x> <y> [--moored | --drifting]
  naval_fate.py (-h | --help)
  naval_fate.py --version

Options:
  -h --help     Show this screen.
  --version     Show version.
  --speed=<kn>  Speed in knots [default: 10].
  --moored      Moored (anchored) mine.
  --drifting    Drifting mine.
"""

from docopt import docopt

if __name__ == "__main__":
    argv = ["ship", "Guardian", "move", "100", "150", "--speed=15"]
    arguments = docopt(__doc__, argv)
    print(arguments)

运行上述代码后，docopt-ng 会根据文档字符串自动解析命令行参数，并返回一个包含解析结果的字典。