美文网首页
快速介绍Python Invoke以及简单例子

快速介绍Python Invoke以及简单例子

作者: 糖醋沼跃鱼 | 来源:发表于2022-03-01 14:00 被阅读0次

快速介绍Python Invoke, Fabric附赠

Fabric 套娃之一 Invoke

Fabric 文档介绍了,Fabric是基于Invoke,和Paramiko的高级封装,为了更好的理解Fabric的行为,还是不想漏掉Invoke这个包,所以本文做一个快速介绍及演示,并用实例来展示他的强大之处。

什么是Invoke?

Invoke是支持python2.7和python3.4以上版本的功能强大的任务执行库。

Invoke的前身竟然就是Fabric 1.x, 同样也提供了干净,高级的API,我觉得这里的干净指的就是更加高级的封装,可能帮用户完成了一些内容解析,编解码功能,用户也不必再写大面积的CLI解析判断。当然Invoke做的远远不止这么多。Invoke封装出的高级API可以用于运行shell命令,类似于shell脚本的替换选项。

由于我的工作环境也有限,自动化可能各公司的方案都百花齐放吧。

实例

from invoke import task

@task
def clean(c, docs=False, bytecode=False, extra=''):
    patterns = ['build']
    if docs:
        patterns.append('docs/_build')
    if bytecode:
        patterns.append('**/*.pyc')
    if extra:
        patterns.append(extra)
    for pattern in patterns:
        c.run("rm -rf {}".format(pattern))

@task
def build(c, docs=False):
    c.run("python setup.py build")
    if docs:
        c.run("sphinx-build docs docs/_build")
       

执行方法

invoke clean build

从其中就能看出invoke的强大和简洁了

  1. 单次调用可以执行多个task(就好像 make && make install)
  2. 同时简化了命令行解析的参数处理

Invoke的前身Fabric 1.x当时的考虑是作为命令行工具作为默认的工作模式,或者说是常用的使用方式。

并且,满足了和shell脚本兼容性不好的同学可以通过,Invoke来完成一些自动化的项目打包,部署工作。

用例

>>> from invoke import run
>>> cmd = "pip install -r requirements.txt"
>>> result = run(cmd, hide=True, warn=True)
>>> print(result.ok)
True
>>> print(result.stdout.splitlines()[-1])
Successfully installed invocations-0.13.0 pep8-1.5.7 spec-1.3.1

可以看到,invoke仍可以直接下command到本地去

但从这个用例看不出来,run这个接口是否可以获取持续的终端输出,是否会阻塞,能不能有像subprocess.popen那样,拥有communicate方法可以持续通信。

最后一个用例展现了invoke对命令行参数的高级封装(是根据第一个脚本来的)

$ invoke clean --docs --bytecode build --docs --extra='**/*.pyo'
$ invoke clean -d -b build --docs -e '**/*.pyo'
$ invoke clean -db build -de '**/*.pyo'

包含了,可选参数,参数简写默认支持,这三行命令的效果是一样的

Invoke像他的很多前身一样,它也提供一些高级功能,比如命名空间,任务别名,before/after 钩子,并行执行等等。

安装

$ pip install invoke

Reference

https://www.pyinvoke.org/

相关文章

网友评论

      本文标题:快速介绍Python Invoke以及简单例子

      本文链接:https://www.haomeiwen.com/subject/lcnsrrtx.html