Python接口自動化之yaml配置文件


VOL 119

04

2020-05

今天距2021年241天

這是ITester軟件測試小棧第119次推文

點擊上方藍字“ITester軟件測試小棧“關注我,每周一五早上 07:30准時推送。

微信公眾號后台回復“資源測試工具包“簡歷模板”領取測試資源

本文3435字,閱讀約需9分鍾

在上一篇Python接口自動化測試系列文章:Python接口自動化之數據驅動主要介紹openpyxl操作excel,結合ddt實現數據驅動。

在自動化過程中,需要使用配置文件儲存數據,比如數據庫信息、賬號信息、域名等。

其中,yaml文件是一種配置文件類型,相比較iniconf配置文件來說,更加的簡潔,操作也更加簡單,同時可以存放不同類型的數據。

以下主要介紹yaml語法、yaml儲數據,封裝類讀寫yaml配置文件。

yaml介紹及使用

01 yaml簡介

YAML 語言( /ˈjæməl/ )的設計目標,就是方便人類讀寫。它實質上是一種通用的數據串行化格式。

YAML 是一種非常靈活的格式,幾乎是 JSON 的超集。除了支持注釋、換行符分隔、多行字符串、裸字符串和更靈活的類型系統之外,YAML 也支持引用文件,以避免重復代碼。

02 yaml語法規則

基本語法規則:

  • 大小寫敏感;

  • 使用縮進表示層級關系;

  • 縮進時不允許使用Tab鍵,只允許使用空格;

  • 縮進的空格數目不重要,只要相同層級的元素左側對齊即可;

  • # 表示注釋,從這個字符一直到行尾,都會被解析器忽略;

03 yaml數據結構

  • 對象:鍵值對的集合,又稱為映射(mapping)哈希(hashes) 字典(dictionary);

  • 數組:一組按次序排列的值,又稱為序列(sequence) 列表(list);

  • 純量(scalars):單個的、不可再分的值;

▌對象

Map(屬性和值)(鍵值對)的形式:

key:(空格)value :表示一對鍵值對,空格不可省略。

person:
    name: vivi
    age: 18


一行寫法:

person:{name: vivi,age: 18}

相當於JSON格式:

{"name":"vivi","age":18}

數組

一組連詞線開頭的行,構成一個數組。數組前加有 “-” 符號,符號與值之間需用空格分隔。

color:
   - red
   - blue
   - green

一行寫法:

color: [red,blue,green]

相當於JSON

["red","blue","green"]

純量

單個的、不可再分的值。(如:字符串、bool值、整數、浮點數、時間、日期、null等)

n1: 8
n2: 8.8
n3: true
n4: false
n5: 'vivi'

yaml配置文件的使用

01  yaml配置文件准備

在項目下新建一個目錄config,在目錄下新建一個文件config.yaml。

在config.yaml配置文件中寫入數據庫配置。

mysql:
  host: "127.0.0.1"
  port: 3306
  user: "vivi"
  password: "123456"
  db: "ITester"
  charset: "utf8"

02  yaml配置文件格式校驗

剛了解yaml的同學,可能對yaml格式掌握不熟練,出現格式錯誤,這里推薦一個在線網站,用於校驗我們寫的yaml文件格式是否正確。

在線地址:

http://www.bejson.com/validators/yaml/ 

yaml配置文件讀寫


python中讀取yaml文件前需要安裝pyyaml和導入yaml模塊。

01  安裝pyYaml

在python中讀取yaml文件,需要用到第三方模塊PyYaml。

安裝命令:

pip install pyYaml

02  yaml模塊源碼解析

從yaml模塊中提取出loaddump函數

def load(stream, Loader=None):
    """
    Parse the first YAML document in a stream
    and produce the corresponding Python object.
    """
    if Loader is None:
        load_warning('load')
        Loader = FullLoader
    loader = Loader(stream)
    try:
        return loader.get_single_data()
    finally:
        loader.dispose()
        
def dump(data, stream=None, Dumper=Dumper, **kwds):
    """
    Serialize a Python object into a YAML stream.
    If stream is None, return the produced string instead.
    """
    return dump_all([data], stream, Dumper=Dumper, **kwds)

load:

將yaml流轉化為python字典;

dump:

將python對象轉化為yaml流;

03  讀寫yaml配置文件

將讀寫yaml配置文件的類進行封裝。

在common目錄下新建一個文件,config_handler.py用於讀寫yaml。

config_handler.py

import yaml

class YamlHandler:
    def __init__(self,file):
        self.file = file

    def read_yaml(self,encoding='utf-8'):
        """讀取yaml數據"""
        with open(self.file, encoding=encoding) as f:
            return yaml.load(f.read(), Loader=yaml.FullLoader)
            
    def write_yaml(self, data, encoding='utf-8'):
        """向yaml文件寫入數據"""
        with open(self.file, encoding=encoding, mode='w') as f:
            return yaml.dump(data, stream=f, allow_unicode=True)

if __name__ == '__main__':
    data = {
        "user":{
            "username": "vivi",
            "password": "123456"
        }
    }
    # 讀取config.yaml配置文件數據
    read_data = YamlHandler('../config/config.yaml').read_yaml()
    # 將data數據寫入config1.yaml配置文件
    write_data = YamlHandler('../config/config1.yaml').write_yaml(data)
    print(read_data)

運行結果為:

{'mysql': {'host': '127.0.0.1', 'port': 3306, 'user': 'vivi', 'password': '123456', 'db': 'ITester', 'charset': 'utf8'}}

寫入到config1.yaml的數據。

config1.yaml

user:
  password: '123456'
  username: vivi

總結:本文主要介紹yaml語法、yaml儲存數據,封裝類讀取yaml配置文件。

下一篇:Python接口自動化之數據庫操作

以上


That‘s all

更多系列文章

敬請期待

ITester軟件測試小棧

往期內容寵幸

1.Python接口自動化-接口基礎(一)


2.Python接口自動化-接口基礎(二)


3.Python接口自動化-requests模塊之get請求


4.Python接口自動化-requests模塊之post請求


5.Python接口自動化之cookie、session應用


6.Python接口自動化之Token詳解及應用


7.Python接口自動化之requests請求封裝


8.Python接口自動化之unittest單元測試


9.Python接口自動化之登錄接口測試


10.Python接口自動化之數據驅動

快來星標 置頂 關注

<<  滑動查看下一張圖片  >>

今日問題

在接口自動化測試項目中,你通常使用什么格式的配置文件? 

(歡迎在下方留言區發表你的看法)


 后台 回復"資源"取干貨

回復"簡歷模板"領取簡歷

測試交流Q群:727998947

點亮一下在看,你更好看


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM