快捷導(dǎo)航

python Pexpect模塊的使用

更新時間：2020年12月25日 09:36:37 作者：碼道仕

這篇文章主要介紹了python Pexpect模塊的使用，幫助大家更好的理解和使用python，感興趣的朋友可以了解下

Pexpect簡介

在講解Pexpect之前，我們需要先了解一下Expect這個腳本語言，它是由TCL語言實現(xiàn)的，主要用于人機(jī)交互式對話的自動化控制，可以用來完成ssh、ftp、telnet等命令行程序的自動化交互。Pexpect其實就是一個用Python語言實現(xiàn)的類Expect功能的模塊，通過它就可以在Python中完成Expect所完成的功能。

Pexpect的基本工作流程，基本可以分為以下三個步驟：

首先用spawn來執(zhí)行一個程序；
然后用expect方法來等待指定的關(guān)鍵字，這個關(guān)鍵字是被執(zhí)行的程序打印到標(biāo)準(zhǔn)輸出上面的；
最后當(dāng)發(fā)現(xiàn)這個關(guān)鍵字以后，使用send/sendline方法發(fā)送字符串給這個程序。

通常在程序中第一步只需要做一次，第二步和第三步會不停的循環(huán)來完成整個工作。當(dāng)然在Pexpect中還有很多其他方法，編寫程序時可以根據(jù)自己的需求選擇使用。

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()方法用來執(zhí)行一個程序，返回程序的操作句柄，后續(xù)就可以通過操作句柄來與這個程序進(jìn)行交互了。

# 子程序退出時會引發(fā)pexpect.EOF異常，即如果捕捉到pexpect.EOF則說明子程序已退出
process = pexpect.spawn('ls -l')
process.expect(pexpect.EOF)
result = process.before.decode()
print(result)

command參數(shù)并不支持字符的特殊含義（比如管道符、通配符、重定向符等），在Linux系統(tǒng)中如果想使用這些符號的特殊含義就必須加上shell來運(yùn)行。

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

# 示例二
# 第一個參數(shù)為主程序，而args列表里的元素是主程序的參數(shù)
process = pexpect.spawn('bash', ['-c', 'ls -l | wc -l'])
process.expect(pexpect.EOF)

expect()方法

當(dāng)使用spawn()方法啟動了一個程序并返回程序控制句柄后，就可以使用expect()方法來等待指定的關(guān)鍵字了。關(guān)鍵字可以是字符串、正則表達(dá)式、EOF、TIMEOUT或者以上類型組成的列表，用來匹配子程序返回的結(jié)果。如果只提供字符串等非列表，則匹配成功后返回0，如果提供列表，則返回匹配成功的列表元素的索引，匹配失敗會拋出異常。

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

before/after/match：當(dāng)expect()匹配到關(guān)鍵字之后，系統(tǒng)會自動給這三個變量賦值，通過這三個變量可以獲取子程序運(yùn)行輸出。

before：保存了到匹配到關(guān)鍵字為止，緩存里面已有的所有數(shù)據(jù)。也就是說如果緩存里緩存了100個字符的時候匹配到了關(guān)鍵字，那before就是除了匹配到的關(guān)鍵字之外的所有字符。
after：保存了匹配到了關(guān)鍵字。
match：保存的是匹配到的正則表達(dá)式的實例，和上面的after相比一個是匹配到的字符串，一個是匹配到的正則表達(dá)式實例。

process = pexpect.spawn('ls -l')
process.expect('expect')
print(process.before.decode())
print(process.after.decode())
print(process.match)

如果expect()過程中發(fā)生錯誤，那么before保存到目前為止緩存里的所有數(shù)據(jù)，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()的區(qū)別就是sendline()發(fā)送的是帶回車符的字符串。

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

Pexpect還提供了很多其他方法，這里不再詳細(xì)闡述，使用時可參考其官方文檔。

interact()方法

interact()表示將終端控制權(quán)交給用戶（或者說將標(biāo)準(zhǔn)輸入交給用戶）。通常情況下Pexpect會接管所有的輸入和輸出，如果需要用戶介入完成部分工作的時候，interact()就派上用場了。

# 讓出控制權(quán)給用戶
process.interact()
# 通過設(shè)置escape_character的值定義返回碼，當(dāng)用戶輸入此值后，會將控制權(quán)重新交給pexpect
process.interact(escape_character='\x1d', input_filter=None, output_filter=None)

應(yīng)用示例

接下來通過SSH連接遠(yuǎn)程服務(wù)器的示例來體驗下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模塊的使用的詳細(xì)內(nèi)容，更多關(guān)于python Pexpect模塊的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: