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使用urllib2获取网络资源实例讲解
Dec 02 Python
一篇文章快速了解Python的GIL
Jan 12 Python
关于python写入文件自动换行的问题
Jun 23 Python
在IPython中进行Python程序执行时间的测量方法
Nov 01 Python
Python自动发送邮件的方法实例总结
Dec 08 Python
pycharm远程开发项目的实现步骤
Jan 20 Python
Pycharm运行加载文本出现错误的解决方法
Jun 27 Python
浅谈python的elementtree模块处理中文注意事项
Mar 06 Python
windows10在visual studio2019下配置使用openCV4.3.0
Jul 14 Python
Python 使用xlwt模块将多行多列数据循环写入excel文档的操作
Nov 10 Python
浅析python连接数据库的重要事项
Feb 22 Python
健身房被搭讪?用python写了个小米计时器助人为乐
Jun 08 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
老机欣赏|中国60年代精品收音机
2021/03/02 无线电
php外部执行命令函数用法小结
2016/10/11 PHP
PHP基于phpqrcode类生成二维码的方法示例详解
2020/08/07 PHP
js编码之encodeURIComponent使用介绍(asp,php)
2012/03/01 Javascript
jquery获得keycode的示例代码
2013/12/30 Javascript
js的Boolean对象初始值示例
2014/03/04 Javascript
jQuery中的Deferred和promise 的区别
2016/04/03 Javascript
JS模拟的Map类实现方法
2016/06/17 Javascript
使用jquery如何获取时间
2016/10/13 Javascript
ionic开发中点击input时键盘自动弹出
2016/12/23 Javascript
JS求解三元一次方程组值的方法
2017/01/03 Javascript
Angular2.0实现modal对话框的方法示例
2018/02/18 Javascript
vue弹窗组件使用方法
2018/04/28 Javascript
Bootstrap Table实现定时刷新数据的方法
2018/08/13 Javascript
JavaScript变量提升和严格模式实例分析
2019/01/27 Javascript
jQuery HTML获取内容和属性操作实例分析
2020/05/20 jQuery
如何封装Vue Element的table表格组件
2021/02/06 Vue.js
详解Python中的__getitem__方法与slice对象的切片操作
2016/06/27 Python
python批量下载网站马拉松照片的完整步骤
2018/12/05 Python
Python利用heapq实现一个优先级队列的方法
2019/02/03 Python
linux环境下Django的安装配置详解
2019/07/22 Python
记一次pyinstaller打包pygame项目为exe的过程(带图片)
2020/03/02 Python
HTML5 Canvas实现烟花绽放特效
2016/03/02 HTML / CSS
html5 移动端视频video的android兼容(去除播放控件、全屏)
2020/03/26 HTML / CSS
英国领先的票务代理商之一:The Ticket Factory
2019/02/09 全球购物
介绍一下linux的文件系统
2012/03/20 面试题
文秘专业大学生求职信
2013/11/10 职场文书
教你打造完美的创业计划书
2014/01/06 职场文书
分层教学实施方案
2014/03/19 职场文书
竞聘书怎么写,如何写?
2014/03/31 职场文书
《和田的维吾尔》教学反思
2014/04/14 职场文书
2014年科室工作总结范文
2014/12/19 职场文书
2019年大学推荐信
2019/06/24 职场文书
Springboot/Springcloud项目集成redis进行存取的过程解析
2021/12/04 Redis
Vue+TypeScript中处理computed方式
2022/04/02 Vue.js
python高温预警数据获取实例
2022/07/23 Python