常用的配置文件类型

在做自动化测试中，配置文件常用的有2种。

第一种是*.ini文件，实际上*.ini文件是Initialization File的缩写，即为初始化文件，是Windows系统配置文件所采用的存储格式，统管Windows的各项配置，用户可以通过修改对应的*.ini文件来实现不同的初始化配置

第二种是yaml文件，YML文件格式是YAML (YAML Aint Markup Language)编写的文件格式，YAML是一种直观的能够被电脑识别的的数据数据序列化格式。

下面就主要介绍下ini文件以及yaml文件的使用。

ini文件

什么是ini

ini文件是Initialization File的缩写，即初始化文件，通常存放的是一个程序的初始化信息，是Windows的系统配置文件所采用的存储格式，统管Windows的各项配置。ini文件的后缀名不一定是.ini，也可以是.cfg、.conf或者是.tx*。

• 优点

• 通用格式，格式简单

• 缺点

• 不适合存储大量数据

ini文件格式&语法规范

ini文件由若干个节（section）组成，每个section由若干键（Key）组成，每个Key可以赋相应的值。读写ini文件实际上就是读写某个的section中相应的Key的值，而这只要借助几个函数即可完成。

• 参数（Parameter）

• ini文件包含的最基本元素是参数，参数包含参数名（name）和参数值（value），格式如下：

name=value

• 节（section）

• 所有的参数都是以节为单位结合在一起。节名称独占一行，在节声明后的所有的参数都属于该节。节没有结束标识符，一个section的开始就是上一个section的结束。格式如下：

[section]

• 注释（comments)

• 注释用分号;表示，放在注释之前，;号后直到行尾均为注释。示例如下：

;i wish nothing but the best for you		

文件实例

[owner]
name=WU yanzu
organization=The United Nations

[UserConfig]
OpenDownloadFileAtOnec=Y
WindowStyle=DevExpress Dark Style
 
[Language]
Language=CHS
 
[AutoUpdate]
Version=2.10  ;last version:2.08

注意点

• [section]不能重复
• 同一个[section]key不能重复
• 等号前后不要用空格
• 默认类型为字符串
• 添加、删除、修改只是对内存进行修改，并不会修改实际文件

ini文件操作

• 导入包

• from configparser import ConfigParser

• 实例化

• conf = ConfigParser()
• conf.read(‘test.ini’, encoding=“utf-8”)

• 掌握

• 获取所有section

• sections = conf.sections()

• 获取指定section下所有的key

• keys = conf.options('log1')

• 获取指定section下所有的key,value

• val_list = conf.items('your_section')

• 获取指定section指定key的值

• 默认读取str

• value = conf.get('your_section','key')

• 获取布尔值

• booleans = conf.getboolean('your_section','key1')

• 获取数字为int

• number = conf.getint('your_section','key1')

• 获取数字类型小数

• float = conf.getfloat('your_section','key1')

• 了解

• 添加sections(操作内存)

• conf.add_section('your_section')

• 添加key,val(操作内存)

• conf.set('your_section','key22','val22')

• 删除(操作内存)

• conf.remove_option('your_section', "key1")

• 写入文件

• 将你内存你的数据全部写入文件进行覆盖，conf初始化的时候读取的是所有对象
• conf.write(fp=open(file=file_path,mode='w'))

import configparser

"""读取ini文件中节点/选项/选项值"""
config = configparser.ConfigParser()
config.read("config.ini")

"""读取ini文件所有的节点"""
selections = config.sections()
print(f"文件中所有的节点:{selections}", type(selections))
print("--------------------------------------------------")

"""获取每个节点下的选线"""
for selection in selections:
    options = config.options(selection)
    print(f"{selection}节点所有的选项:{options}", type(options))
    """获取选项值"""
    for option in options:
        value = config.get(selection,option)
        print(f"{selection}节点{option}选项的值:{value}")
print("--------------------------------------------------")

"""获取指定节点下的所有options"""
options = config.options("server")
print(f"获取指定节点(server)下的选项:{options}", type(options))
print("--------------------------------------------------")

"""获取指定节点指定选项的值"""
value = config.get(section="server",option="ip")
print(f"获取指定节点(server)下的(ip)的值:{value}")
print("--------------------------------------------------")

"""判断是否有指定的selection"""
print(f"判断是否有指定的server节点:", config.has_section("server"))
print("--------------------------------------------------")

"""判断是否有指定的option"""
print(f"判断在在指定的节点server下是否有指定的ip选项:", config.has_option("server", "ip"))
print("--------------------------------------------------")

config1 = configparser.ConfigParser()
with open("config.ini", "a+") as file:
    """添加节点"""
    config1.add_section("data")
    """添加选项以及选项值"""
    config1.set(section="data", option="TestName", value="Test01")
    config1.set(section="data", option="TestPassWd", value="12345678")
    """移除选项"""
    config1.remove_option(section="data",option="TestPassWd")
    """移除节点"""
    config1.remove_section(section="data")
    config1.write(file)

from configparser import ConfigParser
import os
"""
继承ConfigParser类
然后初始化编码格式
"""
class ReadConf(ConfigParser):
    def __init__(self,file_path):
        super().__init__()
        self.read(filenames=file_path,encoding='utf-8')

file_path = os.path.join(os.path.dirname(__file__), 'test.ini')
conf=ReadConf(file_path=file_path)

#使用直接导入conf实例
from confFile.conffengzhuang import conf
values = conf.options('log1')
print(values)
输出：['key1', 'key2']

yaml文件

什么是yaml

YAML是一种广泛使用的语言，用于跨不同语言和框架的配置文件。专注于简化XML的XML人员名单帮助生成Common XML，这是一个功能强大的XML子集，为XML创建了数据序列化的替代方案，特别是与python ，Perl和Ruby。它的可读性和可编辑性感觉比json高，支持C++强类型。YAML文件可视为二维。有些库支持配置引用。有些库支持配置引用。

• 优点

• 配置有序，容易阅读。
• 支持数组，数组中的元素可以是基本数据类型或者对象。
• 简洁方便，容易与脚本语言交互。
• 以数据为核心，重数据轻格式。
• 支持所有编程语言以及支持跨平台

• 缺点

• 不支持 @PropertySource 注解导入自定义的 YAML 配置

yaml文件格式&语法格式

• yaml特点

• 大小写敏感
• 使用缩进表示层级关系
• 禁止使用tab键，只能使用空格键
• 缩进长度无限制，只要是对齐的就算是同一个层级
• 字符串可以不用引号标注
• 使用#进行注释
• 一个yaml文件对外只能有一个类型（读出来要么是dict，要么是list）
• 可一次性读取全部数据
• 读取出来的是python对象，可以直接使用

• 支持数据类型

• 字典

• 通过(:)来连接，冒号后面要带一个空格
  key: val

• 列表

• 使用连接字符(-)表示，- 后面要带一个空格
  – hello

• scalar、纯量

• 字符串、数字、布尔值、不可变数据类型文件实例

yaml文件操作

• 安装包

• pip install pyyaml

• 导入包

• import yaml

import yaml


def get_yaml_data(yaml_file):
    print("*****获取yaml数据*****")
    with open(yaml_file, encoding='utf-8') as file:
        content = file.read()
        print(content)
        print(type(content))

        print("*****转换yaml数据为字典或列表*****")
        # 设置Loader=yaml.FullLoader忽略YAMLLoadWarning警告
        data = yaml.load(content, Loader=yaml.FullLoader)
        print(data)
        print(type(data))
        print(data.get('my'))  # 类型为字典 <class 'dict'> # print(data[0]["model"]) # 若类型为列表 <class 'list'>


if __name__ == "__main__":
    get_yaml_data("config.yaml")

• yaml键值对：即python中的字典

user: my
pwd: 1111

*****获取yaml数据*****
# yaml键值对：即python中的字典
user: my
pwd: 1111
<class 'str'>

*****转换yaml数据为字典或列表*****
{'user': 'my', 'pwd': 1111}
<class 'dict'>
my

• yaml键值对嵌套：即python中的字典嵌套字典

user1:
  name: a
  pwd: 111222
user2:
  name: b
  pwd: 222333

*****获取yaml数据*****
user1:
  name: a
  pwd: 111222
user2:
  name: b
  pwd: 222333
<class 'str'>

*****转换yaml数据为字典或列表*****
{'user1': {'name': 'a', 'pwd': 111222}, 'user2': {'name': 'b', 'pwd': 222333}}
<class 'dict'>
{'name': 'a', 'pwd': 111222}

• yaml键值对中嵌套数组

user3:
  - a
  - b
user4:
  - d
  - e

*****获取yaml数据*****
user3:
  - a
  - b
user4:
  - d
  - e
<class 'str'>

*****转换yaml数据为字典或列表*****
{'user3': ['a', 'b'], 'user4': ['d', 'e']}
<class 'dict'>
['a', 'b']

• yaml中纯量

s_val: hello world
num_val: 15
bol_val: true
nul_val: null
data_val: 2020-08-17

*****获取yaml数据*****
s_val: hello world
num_val: 15
bol_val: true
nul_val: null
data_val: 2020-08-17
<class 'str'>

*****转换yaml数据为字典或列表*****
{'s_val': 'hello world', 'num_val': 15, 'bol_val': True, 'nul_val': None, 'data_val': datetime.date(2020, 8, 17)}
<class 'dict'>
hello world

• yaml写入一组数据

current_path = os.getcwd()
path = os.path.join(current_path, 'config.yaml')

aproject = {'name': 'Silenthand Olleander',
            'race': '哈哈哈黑',
            'traits': ['ONE_HAND', 'ONE_EYE']
            }

# 写
with open(path, 'w', encoding='utf-8')as f1:
    # 字符串写入yaml中
    yaml.dump(aproject, f1, default_flow_style=False, encoding='utf-8', allow_unicode=True)

# 读
with open(path, 'r', encoding='utf-8')as f2:
    # 读取，此时读取出来的是字符串
    data = f2.read()
    # 将读取的内容转化成字典
    # 添加Loader=yaml.FullLoader，不然会有warning
    result = yaml.load(data, Loader=yaml.FullLoader)
    print(result)

• yaml写入多组数据

import yaml
import os

current_path = os.getcwd()
path = os.path.join(current_path, 'config.yaml')

user1 = {
    'name': '张三',
    'age': 18,
    'like': {'kecheng': '语文','yundong': '跑步'}
}

user2 = {
    'name': '李四',
    'age': 17,
    'like': {'kecheng': '数学','yundong': '跳高'}
}

# 写
with open(path, 'w', encoding='utf-8')as f1:
    # 字符串写入yaml中
    yaml.dump_all([user1, user2], f1, default_flow_style=False, encoding='utf-8', allow_unicode=True)

# 读
with open(path, 'r', encoding='utf-8')as f2:
    data = f2.read()
    # 添加Loader=yaml.FullLoader，不然会有warning
    result = yaml.load_all(data, Loader=yaml.FullLoader)
    for i in result:
        print(i)

import yaml, os

class YamlUtil():

    def __init__(self, yaml_path):
        self.yaml_path = yaml_path

    def get_yml_data(self, is_modify=False, *key_names):
        """
        读取yaml配置文件并根据对应层级的key获取对应的value
        适用于两层数据
        :param: key_names: 需要查询的yaml文件的key关键字，从左向右依次
        :return: result: 根据key值返回对应value，不传key则直接返回所有， 没有对应key则返回None
        """
        with open(self.yaml_path, "r", encoding="utf-8") as f:
            content = f.read()
        yaml_content = yaml.safe_load(content)
        if is_modify:
            return yaml_content
        try:
            for key_name in key_names:
                yaml_content = yaml_content.get(key_name, None)
            return yaml_content
        except Exception as e:
            print(f"get_yml_data error:{e}")
            return None

    def set_yaml_data(self, value, *key_names):
        """
        设置yaml文件中的相关属性
        :param: value:修改后的值
        :param: key_names: 需要修改的yaml文件的key关键字，从左向右依次
        """
        yaml_content = self.get_yml_data(True, key_names)
        print(f'yaml_content:before:{yaml_content}')
        key_name = ''
        for item in list([[item] for item in key_names]):
            key_name += str(item)
        print(f'key_name:{key_name}')
        command = "yaml_content" + key_name + '=' + str(value)
        print(f'command:{command}')
        # exec:将字符串转换成python代码执行
        exec(command)
        print(f'yaml_content:after:{yaml_content}')
        with open(self.yaml_path, mode='w', encoding='utf-8') as f:
            f.write(yaml.safe_dump(yaml_content))


if __name__ == '__main__':
    YAML_PATH = os.path.join(os.path.dirname(__file__), 'config.yaml')
    yamlUtil = YamlUtil(YAML_PATH)
    print(yamlUtil.get_yml_data("test1", "test2-1"))
    print(yamlUtil.get_yml_data("test1", "test2-3", "test3-1"))
    yamlUtil.set_yaml_data(1234, "test1", "test2-1")
    yamlUtil.set_yaml_data(111, "test1", "test2-3", "test3-1")

总结

在我平时日常使用中，ini文件和yaml文件是最常用来配置文件或者测试数据的文件类型了。一般在使用配置文件的时候，会采用ini文件，在测试数据上会采用yaml文件。同时在大部分的情况下，对于ini文件和yaml文件主要是以读取数据的操作为主，很少会对文件进行增删改操作。