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使用urllib模块和pyquery实现阿里巴巴排名查询
Jan 16 Python
Python数据结构与算法之使用队列解决小猫钓鱼问题
Dec 14 Python
python+django+sql学生信息管理后台开发
Jan 11 Python
python之matplotlib学习绘制动态更新图实例代码
Jan 23 Python
django用户注册、登录、注销和用户扩展的示例
Mar 19 Python
python获取酷狗音乐top500的下载地址 MP3格式
Apr 17 Python
python中enumerate() 与zip()函数的使用比较实例分析
Sep 03 Python
Python常用编译器原理及特点解析
Mar 23 Python
python用Configobj模块读取配置文件
Sep 26 Python
Python fileinput模块如何逐行读取多个文件
Oct 05 Python
Pytorch - TORCH.NN.INIT 参数初始化的操作
Feb 27 Python
使用python绘制分组对比柱状图
Apr 21 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
《被神捡到的男人》动画化计划进行中!
2020/03/06 日漫
php 截取字符串并以零补齐str_pad() 函数
2011/05/07 PHP
PHP详解ASCII码对照表与字符转换
2011/12/05 PHP
php旋转图片90度的方法
2013/11/07 PHP
PHP两个n位的二进制整数相加问题的解决
2018/08/26 PHP
phpinfo的知识点总结
2019/10/10 PHP
NodeJS学习笔记之网络编程
2014/08/03 NodeJs
Javascript判断文件是否存在(客户端/服务器端)
2014/09/16 Javascript
JS+CSS模拟可以无刷新显示内容的留言板实例
2015/03/03 Javascript
Javascript URI 解析介绍
2015/03/15 Javascript
javascript表单控件实例讲解
2016/09/13 Javascript
ES6生成器用法实例分析
2017/04/10 Javascript
vue2中filter()的实现代码
2017/07/09 Javascript
javaScript实现滚动条事件详解
2020/03/24 Javascript
Javascript将图片的绝对路径转换为base64编码的方法
2018/01/11 Javascript
vue.js打包之后可能会遇到的坑!
2018/06/03 Javascript
vue.js input框之间赋值方法
2018/08/24 Javascript
JS/jQuery实现简单的开关灯效果【案例】
2019/02/19 jQuery
如何进行微信公众号开发的本地调试的方法
2019/06/16 Javascript
vuex存取值和映射函数使用说明
2020/07/24 Javascript
[01:22:28]DOTA2-DPC中国联赛 正赛 SAG vs RNG BO3 第一场 1月18日
2021/03/11 DOTA
在Django中编写模版节点及注册标签的方法
2015/07/20 Python
使用Python的Django框架结合jQuery实现AJAX购物车页面
2016/04/11 Python
python实现图片批量压缩程序
2018/07/23 Python
Pandas 缺失数据处理的实现
2019/11/04 Python
numpy矩阵数值太多不能全部显示的解决
2020/05/14 Python
Python文件名匹配与文件复制的实现
2020/12/11 Python
奥地利度假券的专家:we-are.travel
2019/04/10 全球购物
人口与计划生育目标管理责任书
2014/07/29 职场文书
职工擅自离岗检讨书
2014/09/23 职场文书
个人合伙协议书范本
2014/10/14 职场文书
2014年银行年终工作总结
2014/12/19 职场文书
求职信如何撰写?
2019/05/22 职场文书
python中__slots__节约内存的具体做法
2021/07/04 Python
JS前端轻量fabric.js系列之画布初始化
2022/08/05 Javascript
MySQL 原理优化之Group By的优化技巧
2022/08/14 MySQL