python Pexpect模块的使用


Posted in Python onDecember 25, 2020

Pexpect简介

在讲解Pexpect之前,我们需要先了解一下Expect这个脚本语言,它是由TCL语言实现的,主要用于人机交互式对话的自动化控制,可以用来完成ssh、ftp、telnet等命令行程序的自动化交互。Pexpect其实就是一个用Python语言实现的类Expect功能的模块,通过它就可以在Python中完成Expect所完成的功能。

Pexpect的基本工作流程,基本可以分为以下三个步骤:

  1. 首先用spawn来执行一个程序;
  2. 然后用expect方法来等待指定的关键字,这个关键字是被执行的程序打印到标准输出上面的;
  3. 最后当发现这个关键字以后,使用send/sendline方法发送字符串给这个程序。

通常在程序中第一步只需要做一次,第二步和第三步会不停的循环来完成整个工作。当然在Pexpect中还有很多其他方法,编写程序时可以根据自己的需求选择使用。

Pexpect API

spawn类

class spawn(SpawnBase):
  '''This is the main class interface for Pexpect. Use this class to start
  and control child applications. '''

  # This is purely informational now - changing it has no effect
  use_native_pty_fork = use_native_pty_fork
  
	def __init__(self, command, args=[], timeout=30, maxread=2000,
           searchwindowsize=None, logfile=None, cwd=None, env=None,
           ignore_sighup=False, echo=True, preexec_fn=None,
           encoding=None, codec_errors='strict', dimensions=None,
           use_poll=False):

通过spawn()方法用来执行一个程序,返回程序的操作句柄,后续就可以通过操作句柄来与这个程序进行交互了。

# 子程序退出时会引发pexpect.EOF异常,即如果捕捉到pexpect.EOF则说明子程序已退出
process = pexpect.spawn('ls -l')
process.expect(pexpect.EOF)
result = process.before.decode()
print(result)

command参数并不支持字符的特殊含义(比如管道符、通配符、重定向符等),在Linux系统中如果想使用这些符号的特殊含义就必须加上shell来运行。

# 示例一
process = pexpect.spawn('bash -c "ls -l | wc -l"')
process.expect(pexpect.EOF)

# 示例二
# 第一个参数为主程序,而args列表里的元素是主程序的参数
process = pexpect.spawn('bash', ['-c', 'ls -l | wc -l'])
process.expect(pexpect.EOF)

expect()方法

当使用spawn()方法启动了一个程序并返回程序控制句柄后,就可以使用expect()方法来等待指定的关键字了。关键字可以是字符串、正则表达式、EOF、TIMEOUT或者以上类型组成的列表,用来匹配子程序返回的结果。如果只提供字符串等非列表,则匹配成功后返回0,如果提供列表,则返回匹配成功的列表元素的索引,匹配失败会抛出异常。

process = pexpect.spawn('ls -l')
# 匹配expect字符
process.expect('expect')

before/after/match:当expect()匹配到关键字之后,系统会自动给这三个变量赋值,通过这三个变量可以获取子程序运行输出。

  • before:保存了到匹配到关键字为止,缓存里面已有的所有数据。也就是说如果缓存里缓存了100个字符的时候匹配到了关键字,那before就是除了匹配到的关键字之外的所有字符。
  • after:保存了匹配到了关键字。
  • match:保存的是匹配到的正则表达式的实例,和上面的after相比一个是匹配到的字符串,一个是匹配到的正则表达式实例。
process = pexpect.spawn('ls -l')
process.expect('expect')
print(process.before.decode())
print(process.after.decode())
print(process.match)

如果expect()过程中发生错误,那么before保存到目前为止缓存里的所有数据,after和match都是None。

如果没匹配成功则会抛出异常,可以通过匹配异常,让异常不在终端显示。

process = pexpect.spawn('ls -l')
# 返回0表示匹配成功,返回1和2表示匹配到了异常
index = process.expect(['expect', pexpect.EOF, pexpect.TIMEOUT])
print(index)

send()/sendline()方法

sendline()和send()的区别就是sendline()发送的是带回车符的字符串。

process = pexpect.spawn('nslookup')
process.expect('>')
process.sendline('www.baidu.com')
process.expect('>')
print(process.before.decode())
process.sendline('exit')

Pexpect还提供了很多其他方法,这里不再详细阐述,使用时可参考其官方文档。

interact()方法

interact()表示将终端控制权交给用户(或者说将标准输入交给用户)。通常情况下Pexpect会接管所有的输入和输出,如果需要用户介入完成部分工作的时候,interact()就派上用场了。

# 让出控制权给用户
process.interact()
# 通过设置escape_character的值定义返回码,当用户输入此值后,会将控制权重新交给pexpect
process.interact(escape_character='\x1d', input_filter=None, output_filter=None)

应用示例

接下来通过SSH连接远程服务器的示例来体验下Pexpect的使用方法。

#!/usr/bin/env python3.6
#-*- coding:utf-8 -*-

import pexpect

def main(server):
  command = 'ssh -p %s %s@%s' % (server['port'], server['username'], server['hostname'])
  process = pexpect.spawn(command, timeout=30)
  print(f'命令: {command}')
  expect_list = [
    'yes/no',
    'password:',
    pexpect.EOF,
    pexpect.TIMEOUT,
  ]
  index = process.expect(expect_list)
  print(f'匹配到: {index} => {expect_list[index]}')
  if index == 0: 
    process.sendline("yes")
    expect_list = [
      'password:',
      pexpect.EOF,
      pexpect.TIMEOUT,
    ]
    index = process.expect(expect_list)
    print(f'匹配到: {index} => {expect_list[index]}')
    if index == 0:
      process.sendline(server['password'])
      process.interact()
    else:
      print('EOF or TIMEOUT')
  elif index == 1:
    process.sendline(server['password'])
    process.interact()
  else:
    print('EOF or TIMEOUT')
  
if __name__ == '__main__':
  server = {
    'hostname': '192.168.1.100',
    'port': '22',
    'username': 'admin',
    'password': 'ABuklhsfnVyxI',
  }
  main(server)

以上就是python Pexpect模块的使用的详细内容,更多关于python Pexpect模块的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
python 生成目录树及显示文件大小的代码
Jul 23 Python
Python编程语言的35个与众不同之处(语言特征和使用技巧)
Jul 07 Python
Python3实现从文件中读取指定行的方法
May 22 Python
Python中asyncio与aiohttp入门教程
Oct 16 Python
浅谈Python的条件判断语句if/else语句
Mar 21 Python
Python字符串内置函数功能与用法总结
Apr 16 Python
python爬虫selenium和phantomJs使用方法解析
Aug 08 Python
python 多进程并行编程 ProcessPoolExecutor的实现
Oct 11 Python
python 计算概率密度、累计分布、逆函数的例子
Feb 25 Python
Python3.x+pyqtgraph实现数据可视化教程
Mar 14 Python
Python将字典转换为XML的方法
Aug 01 Python
Python多线程实用方法以及共享变量资源竞争问题
Apr 12 Python
Python中读取文件名中的数字的实例详解
Dec 25 #Python
Python的logging模块基本用法
Dec 24 #Python
python 通过exifread读取照片信息
Dec 24 #Python
python 如何上传包到pypi
Dec 24 #Python
python 基于PYMYSQL使用MYSQL数据库
Dec 24 #Python
python xlsxwriter模块的使用
Dec 24 #Python
想学画画?python满足你!
Dec 24 #Python
You might like
php字符串截取函数用法分析
2014/11/25 PHP
获取客户端网卡MAC地址和IP地址实现JS代码
2013/03/17 Javascript
node.js中的console.trace方法使用说明
2014/12/09 Javascript
JavaScript获取伪元素(Pseudo-Element)属性的方法技巧
2015/03/13 Javascript
javascript中对变量类型的判断方法
2015/08/09 Javascript
jQuery插件开发精品教程让你的jQuery提升一个台阶
2016/01/27 Javascript
全面理解闭包机制
2016/07/11 Javascript
js实现图片淡入淡出切换简易效果
2016/08/22 Javascript
分分钟玩转Vue.js组件
2016/10/25 Javascript
jquery Easyui Datagrid实现批量操作(编辑,删除,添加)
2017/02/20 Javascript
jQuery is not defined 错误原因与解决方法小结
2017/03/19 Javascript
vue自定义一个v-model的实现代码
2018/06/21 Javascript
vue.js实现带日期星期的数字时钟功能示例
2018/08/28 Javascript
总结javascript三元运算符知识点
2018/09/28 Javascript
实例讲解JavaScript预编译流程
2019/01/24 Javascript
原生js代码能实现call和bind吗
2019/07/31 Javascript
JS中this的4种绑定规则详解
2020/02/04 Javascript
vue中echarts引入中国地图的案例
2020/07/28 Javascript
[07:48]DOTA2上海特级锦标赛主赛事首日RECAP
2016/03/04 DOTA
Python 拷贝对象(深拷贝deepcopy与浅拷贝copy)
2008/09/06 Python
对Python使用mfcc的两种方式详解
2019/01/09 Python
Python二叉搜索树与双向链表转换算法示例
2019/03/02 Python
如何用python 操作zookeeper
2020/12/28 Python
html2 canvas生成清晰的图片实现打印功能
2019/09/23 HTML / CSS
ALDI奥乐齐官方海外旗舰店:德国百年超市
2017/12/27 全球购物
生产班组长岗位职责
2014/01/05 职场文书
行政人事经理职位说明书
2014/03/05 职场文书
自行车广告词大全
2014/03/21 职场文书
公司领导班子四风对照检查材料
2014/09/27 职场文书
个人债务授权委托书
2014/10/17 职场文书
2015年学生会工作总结范文
2015/03/31 职场文书
预备党员考察表党小组意见
2015/06/01 职场文书
2019奶茶店创业计划书范本,值得你借鉴
2019/08/14 职场文书
前端学习——JavaScript原生实现购物车案例
2021/03/31 Javascript
k-means & DBSCAN 总结
2021/04/27 Python
Redis安装使用RedisJSON模块的方法
2022/03/23 Redis