clasp 0.2.10

关于

clap（命令行和子进程）扩展了click（https://palletsprojects.com/p/click/） 并提供一个函数库，帮助开发命令行 需要频繁调用系统可执行文件的工具。特殊结构 程序[选项]命令参数[选项]已实现 设置读取和写入配置文件和组命令的简单方法 允许有组织地开发命令行工具套件的程序。

https://clasp.readthedocs.io/

安装

pip install clasp

用法

命令行程序具有以下结构：

"""template file."""

from __future__ import print_function

import clasp.click as click
import clasp.click_ext as clk



@click.group()
@clk.shared_decs(clk.main_decs)
def main(ctx, config, outconfig, configalias, inputalias):
    """template file for script development."""
    clk.get_config(ctx, config, outconfig, configalias, inputalias)


@main.command('XXX')
@click.argument('arg1')
@click.option('--opts','-opts', is_flag=True,
              help="check parsed options")
@click.option('--debug', is_flag=True,
              help="show traceback on exceptions")
@click.pass_context
def XXX(ctx, arg1, **kwargs):
    """
    docstring with full help text for command
    """
    if kwargs['opts']:
        kwargs['opts'] = False
        clk.echo_args(arg1,**kwargs)
    else:
        try:
            ##########
            #code body
            ##########
        except click.Abort:
            raise
        except Exception as ex:
            clk.print_except(ex, kwargs['debug'])
    return 'XXX', kwargs, ctx


@main.resultcallback()
@click.pass_context
def printconfig(ctx, opts, **kwargs):
    """callback to save config file"""
    try:
        clk.tmp_clean(opts[2])
    except Exception:
        pass
    if kwargs['outconfig']:
        clk.print_config(ctx, opts, kwargs['outconfig'], kwargs['config'],
                         kwargs['configalias'])

在设置中设置入口点：

entry_points={"console_scripts":'program=package.program:main'}

然后执行：

program XXX arg1 [options]

启用选项的自动完成功能：

_PROGRAM_COMPLETE=source program > bash_complete.sh
# put this in .bash_profile (with path)
source bash_complete.sh

回调

除了click提供的强大的选项解析之外 回调是clap的一部分，它有助于分析常用的参数

文档

单击和sphinx_单击使帮助和文档变得超级简单，但是 为–help和sphinx格式化docstring时有一些冲突。 clap.sphinx_click_ext尝试解决这些冲突并对选项进行排序 并根据上面显示的脚本模板显示帮助。与狮身人面像一起使用 在conf.py中的扩展名中添加“clap.sphinx_click_ext”

源代码

• 扣环：https://bitbucket.org/stephenwasilewski/clasp

许可证