kids.sh 0.0.8

wrap

如果命令没有失败，则返回标准输出

>>> from __future__ import print_function

>>> from kids.sh import wrap
>>> print(wrap('test "$HELLO" && echo "foo" || echo "bar"'))
bar

但如果命令失败，则抛出一个特殊的 ShellError 异常

>>> wrap('test "$HELLO" && echo "foo" || { echo "bar" ; false ; }')
Traceback (most recent call last):
...
ShellError: Wrapped command returned with unexpected errorlevel.
  command: 'test "$HELLO" && echo "foo" || { echo "bar" ; false ; }'
  errlvl: 1
  stdout:
  | bar

如果您提供的是字符串列表而不是字符串，则不会使用 shell 来解释您的命令：进程和参数将直接发送到系统

>>> wrap(["/bin/cat", "/tmp/should-not-exist-file-xxxx"])
Traceback (most recent call last):
...
ShellError: Wrapped command returned with unexpected errorlevel.
  command: ['/bin/cat', '/should-not-exist-file-xxxx']
  errlvl: 1
  stderr:
  | /bin/cat: /tmp/should-not-exist-file-xxxx: No such file or directory

注意：

• 命令 wrap(..) 会移除输出（从输出的开始和结束处移除空白符和换行符）。如果您不希望这样，可以提供 strip=False。

  >>> from kids.sh import wrap
  >>> print("[%s]" % wrap('echo "  foo   "'))
  [foo]
  >>> print("[%s]" % wrap('echo "  foo   "', strip=False))
  [  foo   ]
  

• wrap(..) 在处理多行内容时也支持良好的异常信息（通常用于 shell 脚本）

  >>> from kids.sh import wrap
  >>> print(wrap('''
  ...    if [ "bar" ]; then
  ...       echo "foo"
  ...       exit 3
  ...    else
  ...       exit 4
  ...    fi
  ... '''))
  Traceback (most recent call last):
  ...
  ShellError: Wrapped command returned with unexpected errorlevel.
    command:
    |
    |    if [ "bar" ]; then
    |       echo "foo"
    |       exit 3
    |    else
    |       exit 4
    |    fi
    |
    errlvl: 3
    stdout:
    | foo

cmd

如果您想要从命令中获取所有信息，可以使用 cmd

>>> from kids.sh import cmd

>>> cmd('test "$HELLO" && echo "foo" || { echo "bar" ; false ; }')
ShellOutput(out=...'bar\n', err=...'', errlvl=1)

因此，请注意它不会抛出任何异常，而是输出一个命名元组。

cmd(..) 也支持处理参数列表而不是命令字符串，如果您想绕过 shell 解释

>>> cmd(['/bin/cat', '/file-does-not-exist-xxxx'])
ShellOutput(out=...'', err=...'...', errlvl=1)

推送请求指南

您可以发送任何代码。我会查看它，并自己将其集成到代码库中，并将您作为作者。这个过程可能需要时间，如果您遵循以下指南，则会更快：

• 使用 PEP8 或 pylint 检查您的代码。尽量保持 80 列宽。

• 按照最小的关注点分离您的提交。

• 每次提交都应该通过测试（以便进行简单的二分查找）

• 每次功能/错误修复提交都应该包含代码、测试和文档。

• 欢迎对排版或代码外观进行小的修改的提交。这些应该在其提交摘要中标上 !minor。

• 提交信息应遵循 gitchangelog 规则（检查 git 日志以获取示例）

• 如果提交修复了问题或完成了功能的实现，请将其在摘要中提及。

如果您对指南有疑问，这里没有回答，请查看当前的 git log，您可能会找到以前提交的示例，说明如何处理您的问题。

0.0.8 (2018-04-09)

更改

• 移除 swrap(..)，改为使用 wrap(..) 的 strip=True 关键字参数。[Valentin Lab]

0.0.7 (2018-04-09)

0.0.6 (2015-03-12)

0.0.5 (2015-02-06)

修复

• 重构以避免使用包 .tests。[Valentin Lab]

0.0.2 (2015-02-06)

新增

• 添加了 cmd 命令的文档。[Valentin Lab]

• 提供测试设施。[Valentin Lab]

  • 引入 set_env

  • unittest 基类 BaseShTest

  • 使用 namedtuple 从 cmd 中获取元组

0.0.1 (2014-05-13)

• 第一次导入。[Valentin Lab]