Python3使用telnetlib实现Telnet自动测试详解

桃夭

发布时间：2026-10-14 | 2人浏览过

原创

本文详细介绍如何利用Python3内置的telnetlib模块实现Telnet协议的自动测试。内容涵盖建立连接、发送字节命令、读取返回数据及关闭连接的核心方法，并通过完整代码示例演示如何结合Excel配置实现自动化命令执行与结果验证，适用于网络设备或服务器的远程交互测试场景。

1 telnetlib介绍

1.1 简介

官方文档链接：telnetlib – Telnet 客户端 — Python 3.9.6 文档

telnetlib 模块提供了一个实现 Telnet 协议的类 Telnet。

1.2 库常用函数及使用

1.2.1 建立连接

建立连接主要有两种方式：第一种是在实例化 Telnet 类时，通过构造函数传递可选参数 host 和 port，此时服务器连接会在构造函数返回前自动建立；第二种是先实例化对象，随后调用 Telnet 类的 open 函数来建立连接。

以下两种写法功能等同，其中 timeout 参数表示阻塞等待时间（单位为秒），若不指定则默认一直阻塞：


import telnetlib

HOST = "10.102.1.12"
#方式1
tn = telnetlib.Telnet(HOST, port=21, timeout=10)

#方式2
tn = telnetlib.Telnet()
tn.open(HOST, port=21)

1.2.2 发送命令

发送命令需使用 Telnet 类的 write 方法。需要注意的是，参数 buffer 必须是字节字符串（byte string）。由于网络数据传输基于字节流，因此在发送字符串前需添加前缀 b 以将其转换为字节流。


Telnet.write(buffer)

例如，向服务器发送“exit”命令以退出 Telnet 连接。


tn.write(b"exit\n")

1.2.3 读取返回数据

Telnet 类提供了多种读取返回结果的方法，此处列举三种： Telnet.read_until(expected, timeout=None)：读取直到遇到指定的字节串 expected 或 timeout 秒超时。默认情况下为阻塞式读取。

TelNet.read_all()：读取数据直到遇到文件结束符（EOF）；在连接关闭前会保持阻塞状态。

Telnet.read_very_eager()：在不阻塞 I/O 的情况下尽可能多地读取所有可用内容（eager 模式）。

1.2.4 关闭连接

关闭 Telnet 连接可直接调用 Telnet.close() 函数，或者发送“exit”命令，以下两种用法效果相同。


tn = telnetlib.Telnet()
#方式1
tn.close()
#方式2
tn.write(b"exit\n")

1.3 使用示例

首先，使用 IPOP 创建一个 FTP 服务，端口设置为 21，用户名为 admin，密码为 admin。

接着，编写一个简单的测试用例，连接 Telnet 服务器后直接退出。


import getpass
import telnetlib

HOST = "10.102.1.12"
user = input("Enter your remote account: ")
password = getpass.getpass()

tn = telnetlib.Telnet(HOST, port=21, timeout=10)

tn.write(user.encode('ascii') + b"\n")
if password:
    tn.write(password.encode('ascii') + b"\n")

print(tn.read_very_eager().decode('ascii'))

tn.write(b"exit\n")

print ("exit")

直接执行上述代码，结果如下：可以看出程序成功连接了一次 Telnet 服务器，随后正常退出。

2 自动测试

参考代码：Python3+telnetlib实现telnet客户端 - 诸子流 - 博客园 (cnblogs.com)

简要说明代码实现的功能：首先运行一个程序以创建 Telnet 服务；然后使用 Python 编写一个 Telnet 客户端，连接该服务并输入命令，获取命令返回结果，根据返回结果判断命令是否执行正确。

命令及期望结果：命令和期望结果存储在 Excel 文件中。期望结果用于从命令的返回数据中进行字符串查找，如果找到匹配字符串，则判定命令执行成功，否则判定为失败。格式如下：

执行失败结果保存：若命令执行失败，则将对应的命令和获取到的返回数据单独保存到一个文件中。

以下说明代码的目录结构：

1078885-20210817232240481-1025625638


C_parse_excel.py类用于解析excel，获取命令及返回结果：

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

import os
import sys
import re
import xlrd
import logging

logging.basicConfig(level=logging.NOTSET, format='[%(filename)s:%(lineno)d]-%(levelname)s %(message)s')


class CCsrConfig(object):

    def __init__(self, excelName):
        self._registerDict = {}
        self._excelName = excelName

    def OpenExcel(self):
        if self._excelName == "":
            self._excelName = None
        else:
            self._excelfd = xlrd.open_workbook(self._excelName)
            for sheetName in self._excelfd.sheet_names():
                pass

    def ReadCSRCfg(self):
        return_dict = {}  #{sheetName: [cmdlist]}
        for sheetName in self._excelfd.sheet_names():
            tmp_list = []
            sheet = self._excelfd.sheet_by_name(sheetName)
            if None != sheet:
                if sheet.nrows == 0:  # no content
                    continue
            sheetName = str(sheetName.strip()).lower()
            logging.debug(sheetName)
            row_start = 0
            for row in range(sheet.nrows):
                if sheet.cell(row, 0).value.strip() == u"command":
                    row_start = row + 1
                    break
            for row in range(row_start, sheet.nrows, 1):
                cmd = str(sheet.cell(row, 0).value).strip()
                exp_ret = str(sheet.cell(row, 1).value).strip()
                tmp_list.append([cmd, exp_ret])
            return_dict[sheetName.lower()] = tmp_list
        return return_dict

C_telnet.py 类负责实现 Telnet 连接，以及发送命令和获取结果，并解析结果信息：


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

import logging
import telnetlib
import time

class TelnetClient():
    def __init__(self,):
        self.tn = telnetlib.Telnet()

    # 此函数实现telnet登录主机
    def login_host(self, host_ip, remote_port, username, password):
        try:
            self.tn.open(host_ip, port = remote_port)
        except:
            logging.warning('%s网络连接失败' % host_ip)
            return False
        # 等待login出现后输入用户名，最多等待10秒
        self.tn.read_until(b'login: ', timeout=2)
        self.tn.write(username.encode('ascii') + b'\n')
        # 等待Password出现后输入用户名，最多等待10秒
        self.tn.read_until(b'Password: ', timeout=2)
        self.tn.write(password.encode('ascii') + b'\n')
        # 延时两秒再收取返回结果，给服务端足够响应时间
        time.sleep(2)
        # 获取登录结果
        command_result = self.tn.read_very_eager().decode('ascii')
        if 'Login incorrect' not in command_result:
            logging.debug(u'%s登录成功' % host_ip)
            return True
        else:
            logging.warning(u'%s登录失败，用户名或密码错误' % host_ip)
            return False

    def start_test_cmd(self, cmd_dict):
        for sheet_item in cmd_dict:
            for sheet in sheet_item:
                cmd_list = sheet_item[sheet]
                tmp_err_list = []
                for cmd in cmd_list:
                    cmd_in = cmd[0]
                    exp_ret = cmd[1]
                    self.tn.write(cmd_in.encode('ascii')+b'\n')
                    time.sleep(1)
                    # 获取命令结果
                    command_result = self.tn.read_very_eager().decode('ascii')
                    if command_result.find(exp_ret) == -1:
                        tmp_err_list.append([cmd_in, command_result])
                    else:
                        print('%s' % command_result)

                if len(tmp_err_list) != 0:  # 将错误信息记录到文件中
                    with open("./out_file/%s_err_log.txt" % sheet, "w+", newline="") as f:
                        for err_item in tmp_err_list:
                            logging.debug(err_item[0])
                            f.write("%s" % err_item[0])
                            f.write("%s" % err_item[1])

    # 退出telnet
    def logout_host(self):
        self.tn.write(b"exit\n")

main_func.py 是主函数入口：


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

import logging
import os
import sys
from C_telnet import *
from C_parse_excel import *

Host_ip = '192.168.17.128'
Username = 'admin'
Password = 'admin'
Remote_port = 8000

def parse_cmd_excel(dir_name):
    objList = []
    list_f = os.listdir(dir_name)
    for item in list_f:
        item = dir_name + item
        if os.path.isfile(item) and (item[-5:] == '.xlsx' or item[-5:] == '.xlsm'):
            if item.find("$") != -1:
                continue            
            csrConfig = CCsrConfig(item)
            csrConfig.OpenExcel()
            tmp = csrConfig.ReadCSRCfg()
            objList.append(tmp)
        elif os.path.isdir(item):
            item = item + '/'
            new_obj_list = []
            new_obj_list = parse_cmd_excel(item)
            for each in new_obj_list:
                objList.append(each)
                
    return objList

if __name__ == '__main__':
    # 从表格中获取测试的命令
    all_cmd_dict = {}
    all_cmd_dict = parse_cmd_excel("./src_file/")

    #启动telnet客户端连接，并进行测试
    telnet_client = TelnetClient()
    if telnet_client.login_host(Host_ip, Remote_port, Username, Password) == False:
        print("Telnet disconnected!\n")
    else:
        telnet_client.start_test_cmd(all_cmd_dict)
        telnet_client.logout_host()

通过上述结构即可实现一个简单的自动测试命令流程。

到此这篇关于python3+telnetlib实现简单自动测试的文章就介绍到这了,更多相关python3 telnetlib自动测试内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站！