cmdi 1.1.3

CMDI-命令界面

说明

一种修饰程序，它将一个称为命令接口的特殊接口应用于其修饰函数。最初是为构建库编写的

命令界面允许您通过命令界面控制函数的执行。：

• 它允许您保存/重定向/禁用输出流（stdout/stderr）以实现其修饰功能。这在文件描述符级别工作，因此可以重定向子进程和C代码的输出。
• 它允许您捕捉其修饰函数的异常，并使用cmdresult（）返回它们，包括返回代码、错误消息和有色的状态消息
• 它允许您在运行时打印命令的状态消息和摘要。
• 还有更多…

用@command修饰的函数可以接收一组特殊的关键字参数（\u verbose=…，\u stdout=…，\u stderr=…，catch\u err=…等），并返回一个cmdresult（）对象。

要求

python>；=3.7

安装

pip install cmdi

用法

@命令装饰器

使用@命令装饰符将命令接口应用于函数。

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

现在您可以使用foo_cmd作为命令

result=foo_cmd(10)

它将打印以下输出（彩色）：

Cmd: foo_cmd
------------
10
foo_cmd: Ok

并返回一个cmdresult对象：

CmdResult(val=20,code=0,name='foo_cmd',status='Ok',color=0,stdout=None,stderr=None)

命令函数参数

您可以使用一组应用于修饰函数的特殊关键字argumnets来定义命令函数的行为。

在本例中，我们将foo-cmd的输出重定向到自定义编写器并捕获异常，然后使用cmdresult（）对象返回异常的输出和信息：

fromcmdiimportCmdResult,Piperesult=foo_cmd(10,_stdout=Pipe(),_catch_err=True)isinstance(result,CmdResult)# Trueprint(result.stdout)# prints caught output.

有关特殊关键字参数的详细信息，请参阅下面的API文档。

自定义命令函数的结果

命令总是返回一个cmdresult对象，对于该对象，@command包装函数会自动猜测值，这在许多情况下都足够了。但有时需要对输出进行细粒度控制，例如创建特定于函数的返回代码：

@commanddeffoo_cmd(x:str,**cmdargs)->CmdResult:print(x)somestr="foo"+xifx=="bar":code=0else:code=42# Return a customized Command Result:returnCmdResult(val=somestr,code=code,)

注意：在上面的示例中，我们返回一个自定义的cmdresult，我们只为其自定义字段val和code。您可以自定义cmdresult对象的每个字段（可选）。您漏掉的字段将自动设置。

命令接口包装器

有时，您希望对现有函数使用命令接口，而不接触函数定义。您可以通过创建命令接口包装器来完成此操作：

fromcmdiimportcommand,strip_cmdargs,CmdResult# This function wraps the Command Interface around an existing function:@commanddeffoo_cmd(x,**cmdargs)->CmdResult:returnfoo(**strip_cmdargs(loclas()))# The original function that is being wrapped:deffoo(x)->int:print(x)returnx*2

命令接口包装器和子进程返回代码。

如果需要为运行子流程的现有函数创建命令接口包装器，并且您的命令依赖于该函数的返回代码，则可以使用子流程.calledprocesserror异常来编写某些内容。例如：

importsubprocessasspfromcmdiimportcommand,CmdResult,Status@commanddeffoo_cmd(x,**cmdargs)->CmdResult:try:returnfoo(**strip_cmdargs(locals()))exceptsp.CalledProcessErrorase:ife.returncode==13:returnCmdResult(code=e.returncode,status=Status.ok,)elife.returncode==42:returnCmdResult(code=e.returncode,status=Status.skip,)else:raisesp.CalledProcessError(e.returncode,e.args)deffoo(x)->int:returnsp.run(["my_arg"],check=True,...)

API

装饰器@command

此装饰器允许您将命令界面应用于函数。

用@command修饰的函数可以采用以下关键字参数：

详细：bool=true

在运行时启用/禁用打印标题/状态消息。

示例：

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

pip install cmdi

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2

fromcmdiimportcommand@commanddeffoo_cmd(x,**cmdargs)->CmdResult:print(x)returnx*2