argparse模块的降价导出
argdown的Python项目详细描述
argdown
argdown是python的argparse模块的扩展,它添加了markdown和rst 文档导出。
argparse模块非常擅长生成命令行用法和帮助文本, 但是,将预先格式化和缩进的终端输出粘贴到a readme.md 是 相当丑陋。argdown是一个python模块,它提供一个函数 argdown.md_help(parser) 它接受一个 ArgumentParser对象 返回一串可爱的帮助文本。
毕竟,argdown需要一个完全格式的argumentparser对象 已执行add_argument() s。唯一能确保 ArgumentParser对象的创建方式与在正常情况下相同 脚本执行是在分析参数之前执行脚本。做 这样,argdown将读取输入文件,直到它读取包含 。解析参数( 。文件的其余部分,与命令行无关 调用被截断,并将对 argdown.md_help() 的调用插入到 从解析器生成标记。需要注意的是,这意味着 整个脚本直到在 全部,包括可能引起的任何副作用-Argdown没有 尝试以任何方式清除代码。
有两种方法可以使用argdown—从命令行,详细信息请参见 参数和用法部分,对于更持久的行为,来自 .argdown 文件,详见 .argdown 部分。