功能的“命令界面”。
cmdinter的Python项目详细描述
#cmdinter
description
这是一个库,可用于将*命令接口*应用于函数。
其主要目的是将*returncode*约定应用于python函数
,并为您提供一些如何运行这些函数的控制。例如,如果需要
无提示运行函数(无标准输出)如果需要返回
函数生成的stdout,或者需要防止函数抛出错误,
`cmdinter'是为[buildlib]创建的(https://pypi.python.org/pypi/buildlib)
包。
`对象。
`` python
类CmdFuncResult(NamedTuple):
returncode:int
returnvalue:Any
摘要:str
````
`returncode`Unix returncode约定…
`returnvalue`函数返回的值这就是通常通过“return”关键字返回的内容。
“summary”包含带有状态标志的cmd摘要(请参见下面的状态)例如:
````
[ok]运行apt get install。
[error]pip install package x.
[skip]安装硬盘驱动器。已安装好驱动器。
`````
\\\\\\\\\\\\\\\\\\\\
<
``python
``python
class status(object):
ok:str='[ok]'
error:str='[error]'
`````
``````
`````=='[error]'
````````````````;run_cmd()
如果要运行子级,可以使用此函数作为命令运行。
,
)
````
这是来自源代码:
``python
def run\u cmd(
silent:bool=false,
return\u stdout:bool=false,
catch\u err:bool=false,
)->;可调用:
“
此函数与返回
‘cmdfuncresult’对象的函数结合使用。使用“run-cmd()”可以更好地控制
这些函数。
@return_stdout:返回子函数的stdout。
@catch_err:捕获子函数引发的错误,并返回带有“cmdresult”对象的错误
“
”
“…
````
`
对象。
``python
class cmdresult(namedtuple):
returnvalue:any
returncode:int
摘要:str
stdout:optional[str]
stderr:optional[str]
traceback:optional[str]
``
`cmdresult`对象是“cmdfuncresult”的扩展版本。
`stdout`以防返回来自子函数的stdout,它存储在此处。
`stderr`如果使用“catch_err”选项捕获子函数的错误,则它存储在此处。
`traceback`错误回溯存储在此处。
description
这是一个库,可用于将*命令接口*应用于函数。
其主要目的是将*returncode*约定应用于python函数
,并为您提供一些如何运行这些函数的控制。例如,如果需要
无提示运行函数(无标准输出)如果需要返回
函数生成的stdout,或者需要防止函数抛出错误,
`cmdinter'是为[buildlib]创建的(https://pypi.python.org/pypi/buildlib)
包。
`对象。
`` python
类CmdFuncResult(NamedTuple):
returncode:int
returnvalue:Any
摘要:str
````
`returncode`Unix returncode约定…
`returnvalue`函数返回的值这就是通常通过“return”关键字返回的内容。
“summary”包含带有状态标志的cmd摘要(请参见下面的状态)例如:
````
[ok]运行apt get install。
[error]pip install package x.
[skip]安装硬盘驱动器。已安装好驱动器。
`````
\\\\\\\\\\\\\\\\\\\\
<
``python
``python
class status(object):
ok:str='[ok]'
error:str='[error]'
`````
``````
`````=='[error]'
````````````````;run_cmd()
如果要运行子级,可以使用此函数作为命令运行。
,
)
````
这是来自源代码:
``python
def run\u cmd(
silent:bool=false,
return\u stdout:bool=false,
catch\u err:bool=false,
)->;可调用:
“
此函数与返回
‘cmdfuncresult’对象的函数结合使用。使用“run-cmd()”可以更好地控制
这些函数。
@return_stdout:返回子函数的stdout。
@catch_err:捕获子函数引发的错误,并返回带有“cmdresult”对象的错误
“
”
“…
````
`
对象。
``python
class cmdresult(namedtuple):
returnvalue:any
returncode:int
摘要:str
stdout:optional[str]
stderr:optional[str]
traceback:optional[str]
``
`cmdresult`对象是“cmdfuncresult”的扩展版本。
`stdout`以防返回来自子函数的stdout,它存储在此处。
`stderr`如果使用“catch_err”选项捕获子函数的错误,则它存储在此处。
`traceback`错误回溯存储在此处。