Python中使用YAML文件进行配置文件管理

在现代软件开发中，配置文件管理已经成为了一个不可或缺的环节。它们包含了程序运行所需的各种参数，如数据库连接信息、服务器地址等。然而，传统的配置文件通常以文本形式存在，这种方式既容易出错，又不利于代码的维护和扩展。因此，使用YAML文件进行配置文件管理成为了一种趋势。本文将介绍如何使用Python中的PyYAML库来操作YAML文件，以及YAML文件的一些优缺点。

首先，我们需要安装PyYAML库。可以使用pip命令进行安装：

pip install pyyaml

接下来，我们来看一下YAML文件的基本结构。YAML文件是一种简洁的非标记语言，它使用缩进来表示层级关系。例如，以下是一个包含字典和列表的YAML文件：

person:
  name: John Doe
  age: 30
  hobbies:
    - reading
    - swimming

我们可以使用Python中的PyYAML库来读取和操作YAML文件。以下是一些基本的使用方法：

1. 读取YAML文件：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

print(data['person']['name'])  # 输出：John Doe

2. 修改YAML文件中的数据：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

data['person']['age'] = 31

with open('config.yml', 'w') as f:
    yaml.safe_dump(data, f)

3. 添加新的键值对：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

data['person']['job'] = 'engineer'

with open('config.yml', 'w') as f:
    yaml.safe_dump(data, f)

4. 删除键值对：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

del data['person']['age']

with open('config.yml', 'w') as f:
    yaml.safe_dump(data, f)

5. 操作嵌套的字典和列表：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

# 访问嵌套的字典
print(data['person']['hobbies'][0])  # 输出：reading

# 修改嵌套的字典
data['person']['hobbies'][0] = 'cycling'

# 添加新的键值对到嵌套的字典
data['person']['address'] = {'city': 'New York', 'street': '5th Avenue'}

# 删除嵌套的字典中的键值对
del data['person']['address']['city']

with open('config.yml', 'w') as f:
    yaml.safe_dump(data, f)

6. 操作嵌套的列表：

import yaml

with open('config.yml', 'r') as f:
    data = yaml.safe_load(f)

# 访问嵌套的列表
print(data['person']['hobbies'])  # 输出：['reading', 'swimming']

# 修改嵌套的列表
data['person']['hobbies'].append('hiking')

# 添加新的元素到嵌套的列表
data['person']['friends'].append('Alice')

# 删除嵌套的列表中的元素
data['person']['hobbies'].remove('reading')

with open('config.yml', 'w') as f:
    yaml.safe_dump(data, f)

YAML文件的优点：

1. 简洁易懂：YAML文件使用缩进来表示层级关系，使得文件结构清晰易读。
2. 易于维护：YAML文件可以方便地添加、修改和删除键值对，而无需修改整个文件。
3. 跨平台：YAML文件可以在多种操作系统和编程语言中使用，具有良好的兼容性。
4. 可读性高：YAML文件的格式与纯文本非常相似，便于人类阅读和理解。

YAML文件的缺点：

1. 性能较差：由于YAML文件使用了缩进和换行符来表示层级关系，因此在解析和生成文件时需要消耗一定的计算资源。
2. 不支持复杂的数据类型：YAML文件只支持字符串、数字、布尔值、列表和字典这五种基本数据类型，对于其他复杂的数据类型（如日期、时间、正则表达式等）的支持有限。

示例：
本专栏中使用yaml作为配置文件，如下方代码

BASE:
  test:
    url: "http://119.3.246.198:64644"

创建Conf.py操作类，用于读取和解析一个名为conf.yml的配置文件。

import os
from utils.YamlUtil import YamlReader

current = os.path.abspath(__file__)

BASE_DIR = os.path.dirname(os.path.dirname(current))

_config_path = BASE_DIR + os.sep + "config"
_config_file = _config_path + os.sep + 'conf.yml'


def get_config_path():
    return _config_path


def get_config_file():
    return _config_file


class ConfigYaml:
    def __init__(self):
        self.config = YamlReader(get_config_file()).data()

    def get_conf_url(self):
        return self.config['BASE']['test']['url']

• 这段代码中导入了os模块和YamlReader类，用于处理文件路径和读取YAML文件。然后定义了两个函数get_config_path()和get_config_file()，分别返回配置文件所在的路径和文件名。
• 接下来定义了一个名为ConfigYaml的类，该类在初始化时会调用YamlReader类来读取配置文件，并将读取到的数据存储在self.config属性中。类中还定义了一个方法get_conf_url()，用于获取配置文件中的BASE.test.url的值。
• 最后，代码中创建了一个ConfigYaml类的实例，并调用get_conf_url()方法来获取配置文件中的URL值。其他配置信息也可以使用这种思想创建，如报告路径、测试用例路径等等。