python接口自動化測試 - configparser配置文件解析器詳細使用

configparser簡介

• ConfigParser模塊已在Python 3中重命名為configparser
• 該模塊定義了ConfigParser類。 ConfigParser類實現一種基本的配置文件解析器語言，該語言提供的結構類似於 .ini 文件中的結構

 

ini文件相關知識

• 鍵值對可用 = 或者 : 進行分隔
•  section 的名字是區分大小寫的，而 option 的名字是不區分大小寫的
• 鍵值對中頭部和尾部的空白符會被去掉
• 值可以為多行
• 配置文件可以包含注釋，注釋以 # 或者 ; 為前綴

ini文件示例

[server]    
age = 45
username = yes

# server就是section
# age、username就是option

 

操作ini文件

認准三部曲

1. 實例化ConfigParser類
2. 讀取配置文件
3. 操作配置文件

 

基礎代碼

    import configparser

    filename = 'F:/Interface/config/server.ini'
    # 實例化configparser
    config = configparser.ConfigParser()

    # 讀取配置文件
    config.read(filename, encoding="utf-8-sig")

    # 獲取某個option的值(最常見的操作)
    config.get(section="server", option="username")

 

包含知識點

• 當你配置文件有中文時，在調用 read() 方法時，需要傳  encoding="utf-8-sig" 參數
• 最常見的操作就是 get(section,option,fallback="默認值") ，獲取某個option的值，當然也可以傳個 fallback ，當你的option不存在的時候，就會返回fallback的值

 

configparser封裝類

為了更好的復用configparser，我們將常用的方法寫成一個封裝類

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

"""
__title__  = 操作配置文件工具類
"""

import configparser


class ConfigUtil:
    # 實例化configparser
    config = configparser.ConfigParser()

    def read(self, filename):
        """
        讀取配置文件
        :param filename: 配置文件路徑
        """
        self.config.read(filename, encoding="utf-8-sig")

    def get(self, _options, _section='server'):
        """
        獲取某個options值
        :param _options: option
        :param _section: section
        """
        try:
            # 方式一：調用方法
            value = self.config.get(section=_section, option=_options, fallback="默認值,key不存在則返回此值")

            # 方式二：索引
            value = self.config[_section][_options]
        except Exception as e:
            print("沒有獲取到值")
            value = None
        return value

    def get_options_key_value(self, _section):
        """
        以列表(name,value)的形式返回section中的每個值
        :param _section: 某個section
        :return: list[tuple(key,value)]
        """
        return self.config.items(_section)

    def get_all_section(self):
        """
        獲取所有section
        """
        return self.config.sections()

    def get_options_by_section(self, _section):
        """
        獲取section下所有可用options
        """
        # 方式一
        keys = []
        for _options in self.config[_section]:
            keys.append(_options)

        # 方式二（推薦）
        keys = self.config.options(_section)
        return keys

    def assert_section_in_config(self, _section):
        """
        判斷section是否存在
        :param _section: 需要判斷的section
        """
        return _section in self.config

    def assert_options_in_section(self, _section, _options):
        """
        判斷options是否存在某個section中
        :param _section: 某個section
        :param _options: 需要判斷的options的key值
        """
        return _options in self.config[_section]


configUtil = ConfigUtil()

if __name__ == '__main__':
    filename = 'F:/imocInterface/config/server.ini'
    configUtil.read(filename)
    print(configUtil.get("username"))
    print(configUtil.get_all_section())
    print(configUtil.assert_section_in_config("server"))
    print(configUtil.get_options_by_section("server"))
    print(configUtil.assert_options_in_section("server", "usernsame"))
    print(configUtil.get_options_key_value("server"))