脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → python → Python PyYAML

Python使用PyYAML库进行配置文件管理

 更新时间：2023年12月27日 11:18:05   作者：tester Jeffky  
在现代软件开发中,配置文件管理已经成为了一个不可或缺的环节,本文主要为大家详细介绍了如何使用Python中的PyYAML库来操作YAML文件,以及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文件的优点：

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

YAML文件的缺点：

性能较差：由于YAML文件使用了缩进和换行符来表示层级关系，因此在解析和生成文件时需要消耗一定的计算资源。

不支持复杂的数据类型：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值。其他配置信息也可以使用这种思想创建，如报告路径、测试用例路径等等。

到此这篇关于Python使用PyYAML库进行配置文件管理的文章就介绍到这了,更多相关Python PyYAML内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • tensorflow 保存模型和取出中间权重例子

    tensorflow 保存模型和取出中间权重例子

    今天小编就为大家分享一篇tensorflow 保存模型和取出中间权重例子，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-01-01
  • 详解基于python-django框架的支付宝支付案例

    详解基于python-django框架的支付宝支付案例

    这篇文章主要介绍了基于python-django框架的支付宝支付案例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • 对python捕获ctrl+c手工中断程序的两种方法详解

    对python捕获ctrl+c手工中断程序的两种方法详解

    今天小编就为大家分享一篇对python捕获ctrl+c手工中断程序的两种方法详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • python plt如何保存为emf图像

    python plt如何保存为emf图像

    这篇文章主要介绍了python plt如何保存为emf图像问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • Python标准库pathlib操作目录和文件

    Python标准库pathlib操作目录和文件

    这篇文章主要为大家介绍了Python标准库pathlib操作目录和文件的示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步
    2021-11-11
  • Python实现24点小游戏

    Python实现24点小游戏

    这篇文章主要为大家详细介绍了Python实现24点小游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2021-09-09
  • 详解如何使用python打印出多样字符

    详解如何使用python打印出多样字符

    当你第一次进入Python的世界里,学到的第一句代码是不是print("Hello World"),今天,让我们一起来开启探索print()的奇妙之旅,从最基础的打印字符用法到让它跳舞唱歌——动态显示,让我们一步步解锁print()的各种技能吧,需要的朋友可以参考下
    2024-03-03
  • 使用Python统计代码运行时间的两种方法

    使用Python统计代码运行时间的两种方法

    有时候我们需要记录一个程序运行的时间,下面这篇文章主要给大家介绍了关于使用Python统计代码运行时间的两种方法,文中通过图文以及示例代码介绍的非常详细,需要的朋友可以参考下
    2022-12-12
  • django 通过ajax完成邮箱用户注册、激活账号的方法

    django 通过ajax完成邮箱用户注册、激活账号的方法

    本篇文章主要介绍了django 通过ajax完成邮箱用户注册、激活账号的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04
  • python获取redis memory使用情况场景分析

    python获取redis memory使用情况场景分析

    这篇文章主要介绍了python获取redis memory使用情况,项目研发过程中，用到Python操作Redis场景，记录学习过程中的心得体会，需要的朋友可以参考下
    2022-12-12

最新评论