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实现简单QQ单用户机器人的方法
Jul 03 Python
跟老齐学Python之坑爹的字符编码
Sep 28 Python
python django 访问静态文件出现404或500错误
Jan 20 Python
python paramiko模块学习分享
Aug 23 Python
python thrift搭建服务端和客户端测试程序
Jan 17 Python
Django rest framework工具包简单用法示例
Jul 20 Python
使用CodeMirror实现Python3在线编辑器的示例代码
Jan 14 Python
anaconda中更改python版本的方法步骤
Jul 14 Python
Python单元测试及unittest框架用法实例解析
Jul 09 Python
Python实例方法、类方法、静态方法区别详解
Sep 05 Python
Python爬虫后获取重定向url的两种方法
Jan 19 Python
使用Python webdriver图书馆抢座自动预约的正确方法
Mar 04 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 和 XML: 使用expat函数(三)
2006/10/09 PHP
php中导出数据到excel时数字变为科学计数的解决方法
2013/02/03 PHP
Youku 视频绝对地址获取的方法详解
2013/06/26 PHP
PHP使用Pthread实现的多线程操作实例
2015/11/14 PHP
javascript 写类方式之十
2009/07/05 Javascript
HTML node相关的一些资料整理
2010/01/01 Javascript
JQuery UI DatePicker中z-index默认为1的解决办法
2010/09/28 Javascript
javascript中的关于类型转换的性能优化
2010/12/14 Javascript
JavaScript不使用prototype和new实现继承机制
2014/12/29 Javascript
JavaScript使用yield模拟多线程的方法
2015/03/19 Javascript
BooStrap对导航条的改造实践小结
2016/09/21 Javascript
js遍历json对象所有key及根据动态key获取值的方法(必看)
2017/03/09 Javascript
整理关于Bootstrap列表组的慕课笔记
2017/03/29 Javascript
jquery+ajax实现省市区三级联动 (封装和不封装两种方式)
2017/05/15 jQuery
微信小程序多张图片上传功能
2017/06/07 Javascript
详解Nuxt.js Vue服务端渲染摸索
2018/02/08 Javascript
vue的toast弹窗组件实例详解
2018/05/14 Javascript
Vue js 的生命周期(看了就懂)(推荐)
2019/03/29 Javascript
node实现爬虫的几种简易方式
2019/08/22 Javascript
Python模块学习 datetime介绍
2012/08/27 Python
零基础学Python(一)Python环境安装
2014/08/20 Python
基于python元祖与字典与集合的粗浅认识
2017/08/23 Python
python实现最大子序和(分治+动态规划)
2019/07/05 Python
Pandas数据离散化原理及实例解析
2019/11/16 Python
MATLAB数学建模之画图汇总
2020/07/16 Python
彻底解决Python包下载慢问题
2020/11/15 Python
python上下文管理器异常问题解决方法
2021/02/07 Python
css3实现针线缝合效果(图解步骤)
2013/02/04 HTML / CSS
CSS3 box-sizing属性详解
2016/11/15 HTML / CSS
纯CSS3实现移动端展开和收起效果的示例代码
2020/04/26 HTML / CSS
Nice Kicks网上商店:ShopNiceKicks.com
2018/12/25 全球购物
安全协议书
2014/04/23 职场文书
中专毕业生的自荐书
2014/07/01 职场文书
教师自我剖析材料范文
2014/09/30 职场文书
工人先锋号申报材料
2014/12/29 职场文书
opencv-python图像配准(匹配和叠加)的实现
2021/06/23 Python