Python 自動化測試的設定層實現方式對標與落地
2023-06-16 18:01:10
Python中什麼是組態檔，組態檔如何使用，有哪些支援的組態檔等內容，話不多說，讓我們一起看看吧~
1 什麼是組態檔？
組態檔是用於設定計算機程式的引數和初始化設定的檔案，如果沒有這些設定程式可能無法執行或是影響執行（執行速度、便捷性等），使用組態檔的好處在於，部分內容以及環境執行時只需要修改組態檔的引數內容，而無需去程式碼裡查詢並修改，提高便捷性、提高可維護性。
2 組態檔有哪幾種？
設定主要有四種形式：
- 第一種是YAML、JSON、XML、TOML、INI、Linux系統中的.bashrc一類，主要應用於軟體測試領域，在軟體測試的領域行業中，大多數公司採用最新的YAML形式來作為組態檔，例如資料庫地址、用例資料等內容的存放，而少部分公司仍然採用舊的INI設定形式
- 第二種是excel表格的形式，在excel表格中會有固定的title代表每個欄位列的含義，有多列，以此來進行設定，多用於遊戲領域中，在遊戲行業大量使用excel表格的形式，已經是一個常態了。
- 第三種是py檔案，py檔案對於一個純Python專案而言是非常方便的，它不需要做資料的讀取操作，只需要進行匯入即可，不好的點在於，沒有YAML這一類靈活，YAML組態檔無論是Python、Java等語言，都是支援的，且資料型別支援很多，而py的組態檔，就只能用作於python，有一定的侷限性。
- 第四種是txt文字格式，通過讀取的方式來識別到txt文字內容，通常而言是測開或者測試工程師製作的簡便工具，供給業務層面的測試人員進行使用，降低了YAML這種設定的理解難度，也避免了開啟excel的緩慢，用輕量級txt來代替是一個不錯的選擇。
2.1 ini
python3自帶的ini
.ini 檔案是Initialization File的縮寫，即初始化檔案，是windows的系統組態檔所採用的儲存格式，統管windows的各項設定
2.1.1 ini檔案的定義
.ini 檔案通常由節（Section）、鍵（key）和值（value）組成。具體形式如下：
db.ini
[mysql]
host = 127.0.0.1
port = 3306
user = root
password = 123456
database = test
2.1.2 python讀取ini檔案
使用python內建的 configparser 標準庫進行解析ini檔案。
read() 讀取檔案內容 items() 獲取指定節的所有鍵值對
# -*- coding: utf-8 -*-
'''
* @Author : wxy
* @Date : 2022-08-24 11:11:06
* @Description : 讀取ini檔案
* @LastEditTime : 2022-08-24 11:11:06
'''
from configparser import ConfigParser
from pprint import pprint
import pymysql
# ini檔案路徑
ini_file = './db.ini'
# 讀取ini的節（Section）
db_name = 'mysql'
# configparser範例化
text = ConfigParser()
# 讀取ini檔案內容
text.read(ini_file)
# text.items()返回list，元素為tuple,元組格式為 key,value
db_tuple = text.items(db_name)
print(db_tuple)
# 將元組轉換成dict
db_dict = dict(text.items(db_name))
print(db_dict)
2.2 json
JSON(JavaScript Object Notation,) 是一種輕量級的資料交換格式。
2.2.1 json檔案的定義
簡單的json範例
{
"mysql": {
"host": "127.0.0.1",
"port": 3306,
"user": "root",
"password": "123456",
"database": "test"
}
}
2.2.2 python讀取json檔案
load() 從json檔案中讀取json格式資料
loads() 將字串型別資料轉化為json格式資料
dump() 將json格式資料儲存到檔案
dumps() 將json格式資料儲存為字串型別
# -*- coding: utf-8 -*-
'''
* @Author : wxy
* @Date : 2022-8-24 11:39:44
* @Description : 讀取json檔案
* @LastEditTime : 2022-8-24 11:39:44
'''
import json
from pprint import pprint
import pymysql
json_file = "./db.json"
db_name = "mysql"
web = "web"
with open(json_file) as f:
cfg = json.load(f)[db_name]
print(cfg)
with open(json_file) as f:
cfg = json.load(f)[web]
print(cfg['user'])
2.3 toml
TOML 是 Github 聯合創始人 Tom Preston-Werner 所提出的一種組態檔格式，是一種旨在成為一個小規模、易於使用的語意化的組態檔格式，它被設計為可以無二義性的轉換為一個雜湊表。
2.3.1 定義toml檔案
語法：
TOML的語法廣泛地由key = 「value」、[節名]、#註釋構成。
支援以下資料型別：字串、整形、浮點型、布林型、日期時間、陣列和圖表。
# db.toml
[mysql]
[mysql.config]
host = "127.0.0.1"
user = "root"
port = 3306
password = "123456"
database = "test"
[mysql.parameters]
pool_size = 5
charset = "utf8"
[mysql.fields]
course_cols = ["cno", "cname", "ccredit", "cdept"]
2.3.2 python讀取toml檔案
使用外部庫 toml 解析toml檔案
# -*- coding: utf-8 -*-
'''
* @Description : 讀取toml檔案
* @LastEditTime : 2022-08-14 11:31:07
'''
import toml
from pprint import pprint
import pymysql
toml_file = "./db.toml"
cfg = toml.load(toml_file)['mysql']
pprint(cfg)
2.4 yaml
YAML(YAML Ain’t a Markup Language」, YAML不是一種標示語言) 格式是目前較為流行的一種組態檔，它早在 2001 由一個名為 Clark Evans 的人提出；同時它也是目前被廣泛使用的組態檔型別。
2.4.1 定義yaml檔案
# db.yaml
mysql:
config:
host: "127.0.0.1"
port: 3306
user: "root"
password: ""
database: "stu_sys"
parameters:
pool_size: 5
charset: "utf8"
fileds:
course_cols:
- cno
- cname
- ccredit
- cdept
2.4.2 python讀取yaml檔案
使用外部庫 pyyaml 解析toml檔案。
# -*- coding: utf-8 -*-
'''
* @Author : wxy
* @Date : 2022-8-24 11:34:37
* @Description : 讀取yaml檔案
* @LastEditTime : 2022-8-24 11:34:37
'''
import yaml
from pprint import pprint
import pymysql
yaml_file = "./db.yaml"
with open(yaml_file, 'r') as f:
cfg = yaml.safe_load(f)
print(cfg)
2.5 Python xlrd 讀取 操作Excel
python Excel庫對比
本次主要關注python xlrd讀取 操作excel
2.5.1 xlrd模組介紹
1.什麼是xlrd模組？
python操作excel主要用到xlrd和xlwt這兩個庫，即xlrd是讀excel，xlwt是寫excel的庫。
2.為什麼使用xlrd模組？
在UI自動化或者介面自動化中資料維護是一個核心，所以此模組非常實用。
xlrd模組可以用於讀取Excel的資料，速度非常快，推薦使用！
官方檔案：https://xlrd.readthedocs.io/en/latest/
2.5.2 安裝xlrd模組
到python官網下載http://pypi.python.org/pypi/xlrd 模組安裝，前提是已經安裝了python 環境。
或者在cmd視窗 pip install xlrd
最新的xlrd不支援Excel xlsx檔案的讀取。所以需要安裝舊版本 pip install xlrd==1.2.0
2.5.3 使用介紹
1.常用單元格的資料型別
- empty（空的）
- string（text）
- number
- date
- boolean
- error
- blank（空白表格）
2.匯入模組
import xlrd
3.開啟Excel檔案讀取資料
data = xlrd.open_workbook(filename)#檔名以及路徑，如果路徑或者檔名有中文給前面加一個 r
4.常用的函數
excel中最重要的方法就是book和sheet的操作
- 獲取book（excel檔案）中一個工作表
table = data.sheets()[0] #通過索引順序獲取
table = data.sheet_by_index(sheet_indx) #通過索引順序獲取
table = data.sheet_by_name(sheet_name) #通過名稱獲取
# 以上三個函數都會返回一個xlrd.sheet.Sheet()物件
names = data.sheet_names() #返回book中所有工作表的名字
data.sheet_loaded(sheet_name or indx) # 檢查某個sheet是否匯入完畢
- 行的操作
nrows = table.nrows
# 獲取該sheet中的行數，注，這裡table.nrows後面不帶().
table.row(rowx)
# 返回由該行中所有的單元格物件組成的列表,這與tabel.raw()方法並沒有區別。
table.row_slice(rowx)
# 返回由該行中所有的單元格物件組成的列表
table.row_types(rowx, start_colx=0, end_colx=None)
# 返回由該行中所有單元格的資料型別組成的列表；
# 返回值為邏輯值列表，若型別為empy則為0，否則為1
table.row_values(rowx, start_colx=0, end_colx=None)
# 返回由該行中所有單元格的資料組成的列表
table.row_len(rowx)
# 返回該行的有效單元格長度，即這一行有多少個資料
- 列（colnum）的操作
ncols = table.ncols
# 獲取列表的有效列數
table.col(colx, start_rowx=0, end_rowx=None)
# 返回由該列中所有的單元格物件組成的列表
table.col_slice(colx, start_rowx=0, end_rowx=None)
# 返回由該列中所有的單元格物件組成的列表
table.col_types(colx, start_rowx=0, end_rowx=None)
# 返回由該列中所有單元格的資料型別組成的列表
table.col_values(colx, start_rowx=0, end_rowx=None)
# 返回由該列中所有單元格的資料組成的列表
- 單元格的操作
table.cell(rowx,colx)
# 返回單元格物件
table.cell_type(rowx,colx)
# 返回對應位置單元格中的資料型別
table.cell_value(rowx,colx)
# 返回對應位置單元格中的資料
2.5.4 實戰訓練
使用xlrd模組進行讀取：
import xlrd
xlsx = xlrd.open_workbook('./3_1 xlrd 讀取 操作練習.xlsx')
# 通過sheet名查詢：xlsx.sheet_by_name("sheet1")
# 通過索引查詢：xlsx.sheet_by_index(3)
table = xlsx.sheet_by_index(0)
# 獲取單個表格值 (2,1)表示獲取第3行第2列單元格的值
value = table.cell_value(2, 1)
print("第3行2列值為",value)
# 獲取表格行數
nrows = table.nrows
print("表格一共有",nrows,"行")
# 獲取第4列所有值（列表生成式）
name_list = [str(table.cell_value(i, 3)) for i in range(1, nrows)]
print("第4列所有的值：",name_list)
2.6 Python xlwt 寫入 操作Excel（僅限xls格式！）
xlwt可以用於寫入新的Excel表格或者在原表格基礎上進行修改，速度也很快，推薦使用！
官方檔案：https://xlwt.readthedocs.io/en/latest/
2.6.1 pip安裝xlwt
pip install xlwt
2.6.2 使用xlwt建立新表格並寫入
編寫xlwt新表格寫入程式:
# 3.2.2 使用xlwt建立新表格並寫入
def fun3_2_2():
# 建立新的workbook（其實就是建立新的excel）
workbook = xlwt.Workbook(encoding= 'ascii')
# 建立新的sheet表
worksheet = workbook.add_sheet("My new Sheet")
# 往表格寫入內容
worksheet.write(0,0, "內容1")
worksheet.write(2,1, "內容2")
# 儲存
workbook.save("新建立的表格.xls")
2.6.3 xlwt 設定字型格式
程式範例：
# 3.2.3 xlwt設定字型格式
def fun3_2_3():
# 建立新的workbook（其實就是建立新的excel）
workbook = xlwt.Workbook(encoding= 'ascii')
# 建立新的sheet表
worksheet = workbook.add_sheet("My new Sheet")
# 初始化樣式
style = xlwt.XFStyle()
# 建立字型樣式
font = xlwt.Font()
font.name = 'Times New Roman' #字型
font.bold = True #加粗
font.underline = True #下劃線
font.italic = True #斜體
# 設定樣式
style.font = font
# 往表格寫入內容
worksheet.write(0,0, "內容1")
worksheet.write(2,1, "內容2",style)
# 儲存
workbook.save("新建立的表格.xls")
# 設定列寬
worksheet.col(0).width = 256*20
# 設定行高
style = xlwt.easyxf('font:height 360;') # 18pt,型別小初的字號
row = worksheet.row(0)
row.set_style(style)
# 合併 第1行到第2行 的 第0列到第3列
worksheet.write_merge(1, 2, 0, 3, 'Merge Test')
# 設定邊框樣式
borders = xlwt.Borders() # Create Borders
borders.left = xlwt.Borders.DASHED
borders.right = xlwt.Borders.DASHED
borders.top = xlwt.Borders.DASHED
borders.bottom = xlwt.Borders.DASHED
borders.left_colour = 0x40
borders.right_colour = 0x40
borders.top_colour = 0x40
borders.bottom_colour = 0x40
2.7 Python xlutils 修改 操作Excel
xlutils可用於拷貝原excel或者在原excel基礎上進行修改，並儲存；
官方檔案：https://xlutils.readthedocs.io/en/latest/
2.7.1 pip安裝xlutils
pip install xlutils
2.7.2 xlutils拷貝原始檔（需配合xlrd使用）
程式範例：
# 3.3.2 拷貝原始檔
def fun3_3_2():
workbook = xlrd.open_workbook('3_3 xlutils 修改操作練習.xlsx') # 開啟工作簿
new_workbook = copy(workbook) # 將xlrd物件拷貝轉化為xlwt物件
new_workbook.save("new_test.xls") # 儲存工作簿
2.7.3 xlutils 讀取 寫入 （也就是修改）Excel 表格資訊
程式範例：
# 3.3.3 xlutils讀取 寫入 Excel 表格資訊
def fun3_3_3():
# file_path：檔案路徑，包含檔案的全名稱
# formatting_info=True：保留Excel的原格式（使用與xlsx檔案）
workbook = xlrd.open_workbook('3_3 xlutils 修改操作練習.xlsx')
new_workbook = copy(workbook) # 將xlrd物件拷貝轉化為xlwt物件
# 讀取表格資訊
sheet = workbook.sheet_by_index(0)
col2 = sheet.col_values(1) # 取出第二列
cel_value = sheet.cell_value(1, 1)
print(col2)
print(cel_value)
# 寫入表格資訊
write_save = new_workbook.get_sheet(0)
write_save.write(0, 0, "xlutils寫入！")
new_workbook.save("new_test.xls") # 儲存工作簿
2.8 Python xlwings 讀取 寫入 修改 操作Excel
2.8.1 pip安裝xlwings
pip install xlwings
2.8.2 基本操作
引入庫
import xlwings as xw
（1）開啟已存在的Excel檔案
# 匯入xlwings模組
import xlwings as xw
# 開啟Excel程式，預設設定：程式可見，只開啟不新建工作薄，螢幕更新關閉
app=xw.App(visible=True,add_book=False)
app.display_alerts=False
app.screen_updating=False
# 檔案位置：filepath，開啟test檔案，然後儲存，關閉，結束程式
filepath=r'g:\Python Scripts\test.xlsx'
wb=app.books.open(filepath)
wb.save()
wb.close()
app.quit()
（2）新建Excel檔案，命名為test.xlsx，並儲存在D槽
import xlwings as xw
app=xw.App(visible=True,add_book=False)
wb=app.books.add()
wb.save(r'd:\test.xlsx')
wb.close()
app.quit()
（3） xlwings 讀寫 Excel
新建test.xlsx，在sheet1的第一個單元格輸入 「人生」 ，然後儲存關閉，退出Excel程式。
def fun3_4_4():
# 新建Excle 預設設定：程式可見，只開啟不新建工作薄，螢幕更新關閉
app = xw.App(visible=True, add_book=False)
app.display_alerts = False
app.screen_updating = False
# 開啟已存在的Excel檔案
wb=app.books.open('./3_4 xlwings 修改操作練習.xlsx')
# 獲取sheet物件
print(wb.sheets)
sheet = wb.sheets[0]
# sheet = wb.sheets["sheet1"]
# 讀取Excel資訊
cellB1_value = sheet.range('B1').value
print("單元格B1內容為：",cellB1_value)
# 清除單元格內容和格式
sheet.range('A1').clear()
# 寫入單元格
sheet.range('A1').value = "xlwings寫入"
# 儲存工作簿
wb.save('example_3.xlsx')
# 退出工作簿
wb.close()
# 退出Excel
app.quit()l
2.9 Python openpyxl 讀取 寫入 修改 操作Excel
在openpyxl中，主要用到三個概念：Workbooks，Sheets，Cells。
Workbook就是一個excel工作表；
Sheet是工作表中的一張表頁；
Cell就是簡單的一個格。
openpyxl就是圍繞著這三個概念進行的，不管讀寫都是「三板斧」：開啟Workbook，定位Sheet，操作Cell。
官方檔案：https://openpyxl.readthedocs.io/en/stable/
1.安裝
pip install openpyxl
2.開啟檔案
（1）新建
from openpyxl import Workbook
# 範例化
wb = Workbook()
# 啟用 worksheet
ws = wb.active
（2）開啟已有
from openpyxl import load_workbook
wb = load_workbook('檔名稱.xlsx')
3.寫入資料
# 方式一：資料可以直接分配到單元格中(可以輸入公式)
ws['A1'] = 42
# 方式二：可以附加行，從第一列開始附加(從最下方空白處，最左開始)(可以輸入多行)
ws.append([1, 2, 3])
# 方式三：Python 型別會被自動轉換
ws['A3'] = datetime.datetime.now().strftime("%Y-%m-%d")
4.建立表（sheet）
# 方式一：插入到最後(default)
ws1 = wb.create_sheet("Mysheet")
# 方式二：插入到最開始的位置
ws2 = wb.create_sheet("Mysheet", 0)
5.選擇表（sheet）
# sheet 名稱可以作為 key 進行索引
>>> ws3 = wb["New Title"]
>>> ws4 = wb.get_sheet_by_name("New Title")
>>> ws is ws3 is ws4
True
6.檢視表名（sheet）
# 顯示所有表名
>>> print(wb.sheetnames)
['Sheet2', 'New Title', 'Sheet1']
# 遍歷所有表
>>> for sheet in wb:
... print(sheet.title)
7.儲存資料
wb.save('檔名稱.xlsx')
8.其它
（1）改變sheet標籤按鈕顏色
ws.sheet_properties.tabColor = "1072BA" # 色值為RGB16進位制值
（2）獲取最大行，最大列
# 獲得最大列和最大行
print(sheet.max_row)
print(sheet.max_column)
（3）獲取每一行每一列
sheet.rows為生成器, 裡面是每一行的資料，每一行又由一個tuple包裹。
sheet.columns類似，不過裡面是每個tuple是每一列的單元格。
# 因為按行，所以返回A1, B1, C1這樣的順序
for row in sheet.rows:
for cell in row:
print(cell.value)
# A1, A2, A3這樣的順序
for column in sheet.columns:
for cell in column:
print(cell.value)
（4）根據數位得到字母，根據字母得到數位
from openpyxl.utils import get_column_letter, column_index_from_string
# 根據列的數位返回字母
print(get_column_letter(2)) # B
# 根據字母返回列的數位
print(column_index_from_string('D')) # 4
（5）刪除工作表
# 方式一
wb.remove(sheet)
# 方式二
del wb[sheet]
專案實操—-UI自動化中實踐專案
需求：業務寫入揀貨容器，使用一次不可使用第二次，且指令碼中固定讀取固定位置
import openpyxl
from openpyxl.cell.cell import ILLEGAL_CHARACTERS_RE
from openpyxl.utils import get_column_letter, column_index_from_string
# 向sheetobj中的columnname列從start_row開始寫入listdata
def insert_listdata_to_column(sheetobj,listdata,column_name,start_row=3):
# 根據列名獲取列索引
colindex = column_index_from_string(column_name)
print('colindex為{}'.format(colindex))
# 迴圈從開始行數到資料寫入後最後一行
for rowindex in range(start_row, start_row + len(listdata)):
# 寫入list數值根據索引取值，從0開始
val = listdata[rowindex - start_row]
print('val{}'.format(val))
print('rowindex{}'.format(rowindex))
try:
sheetobj.cell(row = rowindex,column = colindex,value = val)
except:
# 出現非法字元時，可以將字串的非法字元替換掉
val = ILLEGAL_CHARACTERS_RE.sub(r'',val)
sheetobj.cell(row = rowindex,column = colindex,value = val)
delrow = start_row + len(listdata)
print('*********{}'.format(delrow))
sheetobj.delete_rows(delrow)
def del_excel():
xlsx = xlrd.open_workbook(r'D:\pytest\inbound_data.xlsx')
table =xlsx.sheet_by_index(2)
# 獲取第2列所有值
cel_value =table.col_values(1)
cel_value=cel_value[3::]
wb = openpyxl.load_workbook(r'D:\pytest\inbound_data.xlsx')
sheet = wb["B2B出庫"]
print(sheet)
insert_listdata_to_column(sheet,cel_value,'B',3)
wb.save(r'D:\pytest\inbound_data.xlsx')
del_excel()
3 總結
在本文中，簡單介紹了幾種組態檔和使用。根據不同的用例，複雜的工具/框架並不總是比簡單的軟體包更好。但無論選擇哪一種，都應始終考慮可讀性，可維護性以及如何儘早地發現錯誤。事實上，可以說組態檔只是另一種型別的程式碼。可以根據自己的專案框架來靈活運用啦~
作者：京東物流 王小云
來源：京東雲開發者社群