[ PyQt入門教程 ] PyQt+socket實現遠程操作服務器

  來需求了。。干活啦。。

需求內容

  部分時候由於緩存刷新、驗證碼顯示不出來或者瀏覽器打不開或者打開速度很慢等原因，導致部分測試同事不想使用瀏覽器登錄服務器執行命令。期望有小工具可以替代登錄瀏覽器的操作，直接發送指令到服務器執行並將執行結果返回。

需求設計

  1、開發界面，方便用戶輸入IP、用戶名、密碼以及執行的命令。

  2、IP、用戶名、密碼和命令輸入提供默認值。特別是用戶名和密碼，對於測試服務器來說，通常都是固定的。

  3、IP、命令行輸入框可以自動補全用戶輸入。自動補全常用IP、命令行可以提高操作效率。

  4、可以自動保存用戶執行成功的IP、命令行。用於完善自動補全命令（本文代碼未實現）。

  5、其他異常場景考慮：包括輸入參數的合法性檢查、socket發送連接服務器失敗提示（連接建立、用戶名/密碼登錄失敗等）

需求設計

  1、使用Qt Designer實現界面開發。開發后界面參考如下：

  2、使用socket程序登錄服務器並執行命令，並將結果顯示在界面文本框中。

開發工具

Python3.7.4 + Qt Designer + PyQt5

代碼實現（程序可以直接復制運行）

 1、使用Qt Designer實現界面開發。主窗口模板類型選擇Widget，拖動4個label+4個輸入框+1個按鈕+1個textBrowser到主界面。修改控件顯示名稱、對象名稱以及設置初始值。完成的設計界面如下所示：

 2、使用pyuic5 -o commandTools.py commandTools.ui指令將.ui文件轉換成.py文件。

生成的commandTools.py文件內容如下：

# -*- coding: utf-8 -*-

# Form implementation generated from reading ui file 'commandTools.ui'
#
# Created by: PyQt5 UI code generator 5.11.3
#
# WARNING! All changes made in this file will be lost!

from PyQt5 import QtCore, QtGui, QtWidgets

class Ui_Form(object):
    def setupUi(self, Form):
        Form.setObjectName("Form")
        Form.resize(483, 347)
        self.ip_label = QtWidgets.QLabel(Form)
        self.ip_label.setGeometry(QtCore.QRect(30, 20, 16, 16))
        font = QtGui.QFont()
        font.setBold(True)
        font.setWeight(75)
        self.ip_label.setFont(font)
        self.ip_label.setObjectName("ip_label")
        self.ip_lineEdit = QtWidgets.QLineEdit(Form)
        self.ip_lineEdit.setGeometry(QtCore.QRect(50, 20, 101, 20))
        self.ip_lineEdit.setObjectName("ip_lineEdit")
        self.username_label = QtWidgets.QLabel(Form)
        self.username_label.setGeometry(QtCore.QRect(160, 20, 61, 16))
        font = QtGui.QFont()
        font.setBold(True)
        font.setWeight(75)
        self.username_label.setFont(font)
        self.username_label.setObjectName("username_label")
        self.username_lineEdit = QtWidgets.QLineEdit(Form)
        self.username_lineEdit.setGeometry(QtCore.QRect(220, 20, 71, 20))
        self.username_lineEdit.setObjectName("username_lineEdit")
        self.password_label = QtWidgets.QLabel(Form)
        self.password_label.setGeometry(QtCore.QRect(300, 20, 61, 16))
        font = QtGui.QFont()
        font.setBold(True)
        font.setWeight(75)
        self.password_label.setFont(font)
        self.password_label.setObjectName("password_label")
        self.password_lineEdit = QtWidgets.QLineEdit(Form)
        self.password_lineEdit.setGeometry(QtCore.QRect(360, 20, 80, 20))
        self.password_lineEdit.setObjectName("password_lineEdit")
        self.command_label = QtWidgets.QLabel(Form)
        self.command_label.setGeometry(QtCore.QRect(30, 70, 51, 16))
        font = QtGui.QFont()
        font.setBold(True)
        font.setWeight(75)
        self.command_label.setFont(font)
        self.command_label.setObjectName("command_label")
        self.command_lineEdit = QtWidgets.QLineEdit(Form)
        self.command_lineEdit.setGeometry(QtCore.QRect(90, 70, 251, 20))
        self.command_lineEdit.setObjectName("command_lineEdit")
        self.result_textBrowser = QtWidgets.QTextBrowser(Form)
        self.result_textBrowser.setGeometry(QtCore.QRect(30, 120, 410, 201))
        self.result_textBrowser.setObjectName("result_textBrowser")
        self.run_Button = QtWidgets.QPushButton(Form)
        self.run_Button.setGeometry(QtCore.QRect(360, 70, 80, 23))
        self.run_Button.setObjectName("run_Button")

        self.retranslateUi(Form)
        QtCore.QMetaObject.connectSlotsByName(Form)

    def retranslateUi(self, Form):
        _translate = QtCore.QCoreApplication.translate
        Form.setWindowTitle(_translate("Form", "cmdTool"))
        self.ip_label.setText(_translate("Form", "IP"))
        self.ip_lineEdit.setText(_translate("Form", "127.0.0.1"))
        self.username_label.setText(_translate("Form", "username"))
        self.username_lineEdit.setText(_translate("Form", "admin"))
        self.password_label.setText(_translate("Form", "password"))
        self.password_lineEdit.setText(_translate("Form", "Winovs12!"))
        self.command_label.setText(_translate("Form", "Command"))
        self.command_lineEdit.setText(_translate("Form", "LST LOG"))
        self.run_Button.setText(_translate("Form", "Run"))

3、實現主程序callcommand.py調用（業務與邏輯分離）。代碼如下：

# -*- coding: utf-8 -*-

import sys
import time
import socket
import re
from PyQt5.QtWidgets import QApplication, QMainWindow,QCompleter,QMessageBox
from PyQt5.QtCore import Qt,QThread,pyqtSignal
from commandTools import Ui_Form


class MyMainForm(QMainWindow, Ui_Form):
    def __init__(self, parent=None):
        """
        構造函數
        """
        super(MyMainForm, self).__init__(parent)
        self.setupUi(self)
        self.ip = ""
        self.username = ""
        self.password = ""
        self.command = ""
        self.port = 6000
        self.continue_flag = True
        self.ip_init_lst = ['121.1.1.1', '192.168.1.1', '172.16.1.1']
        self.init_lineedit(self.ip_lineEdit,self.ip_init_lst)
        self.cmd_init_lst = ['LST LOG', 'LST PARA','MOD PARA']
        self.init_lineedit(self.command_lineEdit,self.cmd_init_lst)
        self.run_Button.clicked.connect(self.check_para)
        self.run_Button.clicked.connect(self.execte_command)

    def init_lineedit(self, lineedit, item_list):
        """
        用戶初始化控件自動補全功能
        """
        # 增加自動補全
        self.completer = QCompleter(item_list)
        # 設置匹配模式  有三種： Qt.MatchStartsWith 開頭匹配（默認）  Qt.MatchContains 內容匹配  Qt.MatchEndsWith 結尾匹配
        self.completer.setFilterMode(Qt.MatchContains)
        # 設置補全模式  有三種： QCompleter.PopupCompletion（默認）  QCompleter.InlineCompletion   QCompleter.UnfilteredPopupCompletion
        self.completer.setCompletionMode(QCompleter.PopupCompletion)
        # 給lineedit設置補全器
        lineedit.setCompleter(self.completer)

    def execte_command(self):
        """
        登錄服務器，並執行命令
        """
        if self.continue_flag:
            sockethandle = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
            rec_code = sockethandle.connect_ex((self.ip, self.port))
            #connect_ex函數執行成功返回0，失敗返回非0
            if rec_code == 0:
                send_cmd = "username: %s, admin: %s, command: %s" % (self.username, self.password, self.command)
                sockethandle.sendall(send_cmd.encode('utf-8'))
                time.sleep(0.5)
                recdata = sockethandle.recv(65535)
                tran_recdata = recdata.decode('utf-8')
                self.result_textBrowser.setText(tran_recdata)
            else:
                QMessageBox.information(self, '提示','連接失敗，請檢查IP和端口是否正確')


    def check_para(self):
        """
        獲取用戶界面輸入及判斷參數有效性
        """
        self.ip = self.ip_lineEdit.text()
        self.username = self.username_lineEdit.text()
        self.password = self.password_lineEdit.text()
        self.command = self.command_lineEdit.text()

        #判斷IP合法性
        if  len(self.ip) == 0 or self.ip.count('.') != 3 or len(self.ip) > 15:
            self.continue_flag = False
            QMessageBox.information(self, '提示','輸入的IP不合法，請重新輸入')

        #判斷用戶名或密碼是否為空
        if self.continue_flag and len(self.username) == 0 or len(self.password) == 0:
            self.continue_flag = False
            QMessageBox.information(self, '提示','用戶名或密碼未輸入，請重新輸入')

        #判斷命令行是否為空
        if self.continue_flag and len(self.command) == 0:
            self.continue_flag = False
            QMessageBox.information(self, '提示','命令未輸入，請重新輸入')


if __name__ == "__main__":
    app = QApplication(sys.argv)
    myWin = MyMainForm()
    myWin.show()
    sys.exit(app.exec_())

4、使用pyinstaller轉換成可執行的.exe文件。命令：pyinstaller -F callcommand.py -w

執行成功，生成的文件在d:\temp\dist\dist\callcommand.exe

5、運行callcommand.exe,點擊run運行

關鍵代碼

  1、輸入框自動補全功能函數。同樣適用於下拉框控件。

    def init_lineedit(self, lineedit, item_list):
        """
        用戶初始化控件自動補全功能
        """
        # 增加自動補全
        self.completer = QCompleter(item_list)
        # 設置匹配模式  有三種： Qt.MatchStartsWith 開頭匹配（默認）  Qt.MatchContains 內容匹配  Qt.MatchEndsWith 結尾匹配
        self.completer.setFilterMode(Qt.MatchContains)
        # 設置補全模式  有三種： QCompleter.PopupCompletion（默認）  QCompleter.InlineCompletion   QCompleter.UnfilteredPopupCompletion
        self.completer.setCompletionMode(QCompleter.PopupCompletion)
        # 給lineedit設置補全器
        lineedit.setCompleter(self.completer)

  實現效果如下所示：

  2、socket中sendall函數要將命令使用utf-8編碼，否則會導致界面卡住：

sockethandle.sendall(send_cmd.encode('utf-8'))

  3、需要將服務端返回的內容解碼再寫入textBrowser文本框，否則會導致界面卡住。

 recdata = sockethandle.recv(65535)
 tran_recdata = recdata.decode('utf-8')
 self.result_textBrowser.setText(tran_recdata)

附錄

1、PyQt5中textbrowser控件使用介紹

   a、textbrowser常用設置文本方法主要為增量添加 append()、重新設置 setText()以及清除內容 clear()方法。

   b、如何設置顯示中文。在Python3.X程序中，經常會遇到調用中文輸出導致程序卡住的問題。正確設置方法參考如下：

     output_str = u'設置textBrowser輸出'

     self.result_textBrowser.setText(output_str)

2、簡易調試程序服務器搭建

  由於本地沒有服務器用於調試程序。所以使用socket搭建1個簡易服務器以便調試。服務器功能實現將接收的命令原樣返回。就是接收什么命令就給客戶端返回什么內容。服務器IP為本地IP127.0.0.1，綁定端口為6000。代碼如下：

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

import socket
import sys

s = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
print("socket create success!")
try:
    s.bind(('127.0.0.1',6000))
except socket.error as msg:
    print(msg)
    sys.exit(1)
s.listen(10)

while True:
    conn, addr = s.accept()
    print("success")
    data = conn.recv(65535)
    conn.sendall(data.decode('utf-8'))
conn.close()
s.close()

啟動服務器：

簡陋的有點過分，但是滿足調試需求了。。。

小結

  這個python+scoket需求實現的遠程登錄服務器執行命令只是把基本功能實現了。中間遇到的界面無響應甚至退出的問題（就是socket發送和接收內容編解碼導致的）。。但是還有很多地方需要優化，比如對入參判斷的優化、對連接服務器結果的判斷，還有界面的美化等內容。。正是這些小需求及實踐過程中遇到問題、解決問題的過程逐步提升編碼能力。。fighting