脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → 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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 详解Python常用的魔法方法

    详解Python常用的魔法方法

    在Python中,所有以“__”双下划线包起来的方法,都统称为“Magic Method”,中文称『魔术方法』,例如类的初始化方法 __init__ ,Python中所有的魔术方法均在官方文档中有相应描述,今天给大家整理了本篇文章,需要的朋友可以参考下
    2021-06-06
  • Python爬取城市租房信息实战分享

    Python爬取城市租房信息实战分享

    这篇文章主要介绍了Python爬取城市房租房信息实战分享，先单线程爬虫，测试可以成功爬取之后再优化为多线程，最后存入数据库，需要的小伙伴可以参考一下的相关资料
    2022-04-04
  • 使用Python调用天地图接口

    使用Python调用天地图接口

    天地图是中国国家测绘地理信息局推出的一款权威、全面的在线地理信息系统,本文将详细介绍如何使用Python调用天地图接口,感兴趣的可以了解下
    2024-12-12
  • Python实现截取PDF文件中的几页代码实例

    Python实现截取PDF文件中的几页代码实例

    今天小编就为大家分享一篇关于Python实现截取PDF文件中的几页代码实例，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2019-03-03
  • python-序列解包(对可迭代元素的快速取值方法)

    python-序列解包(对可迭代元素的快速取值方法)

    今天小编就为大家分享一篇python-序列解包(对可迭代元素的快速取值方法)，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2019-08-08
  • Python的Django框架中从url中捕捉文本的方法

    Python的Django框架中从url中捕捉文本的方法

    这篇文章主要介绍了Python的Django框架中从url中捕捉文本的方法,以及URLconf搜索的一些相关情况,需要的朋友可以参考下
    2015-07-07
  • mac安装pytorch及系统的numpy更新方法

    mac安装pytorch及系统的numpy更新方法

    今天小编就为大家分享一篇mac安装pytorch及系统的numpy更新方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • 快速进修Python指南之面向对象基础

    快速进修Python指南之面向对象基础

    这篇文章主要为大家介绍了Java开发者快速进修Python指南之面向对象基础,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12
  • python如何将aac转为mp3,保持原有目录结构

    python如何将aac转为mp3,保持原有目录结构

    使用Python脚本实现AAC格式转MP3格式的方法介绍,需要用户输入AAC文件所在目录路径和MP3输出目录路径,通过调用FFmpeg工具实现格式转换,该脚本简单易懂,适合需要批量处理音频文件的用户,使用前需确保已安装FFmpeg环境
    2024-11-11
  • Python解决ModuleNotFoundError: No module named 'PIL'的问题

    Python解决ModuleNotFoundError: No module named&

    ModuleNotFoundError: No module named 'PIL'是一个常见的Python错误,通常出现在使用Pillow库时,Pillow是Python中用于图像处理的一个库,其前身是PIL,本文介绍了Python解决ModuleNotFoundError: No module named 'PIL'的问题,需要的朋友可以参考下
    2024-09-09

最新评论