jsh 0.3.6

文档

完整文档可以在 RTD 上找到。

安装

使用 pip install jsh 从 PyPI 安装。

基本用法

该库接受 CLI “布局”，这是一个基于字典的树状结构，描述您的 CLI 命令。例如，一个完全无用的 CLI，只有一个 exit 命令，您会这样定义它

import jsh

layout = {
    'exit': jsh.exit,
}

jsh.run(layout)

jsh.run 是以下内容的快捷方式

cli = jsh.JSH(layout)

while True:
    try:
        cli.read_and_execute()
    except jsh.JSHError as err:
        print err
    except EOFError:
        break

这创建了一个基本的布局，包含一个可用的命令（退出），并将其传递给一个实例 jsh.JSH，然后启动一个无限循环，使用 JSH CLI 对象的 read_and_execute 方法与用户进行交互。为了更好地控制这个循环，你应该自己编写而不是使用 jsh.run。

这提供了一个看起来如下所示的 CLI

> ?
Possible completions:
  exit
> ex?
Possible completions:
  exit
> exit ?
Possible completions:
  <[Enter]>   Execute this command
> exit