Python读取YAML配置文件方法

IT行业相对于一般传统行业，发展更新速度更快，一旦停止了学习，很快就会被行业所淘汰。所以我们需要踏踏实实的不断学习，精进自己的技术，尤其是初学者。今天golang学习网给大家整理了《Python读取YAML配置文件教程》，聊聊，我们一起来看看吧！

YAML配置文件的优势在于可读性强、结构清晰、语法简洁，适合复杂配置场景。它能直观表示嵌套数据和列表，如多数据库连接信息；相比INI或JSON，编写更高效。通过PyYAML库可轻松读取为字典或列表，便于Python操作。

Python读取YAML配置文件，核心在于使用 PyYAML 库，将YAML文件内容转换为Python可操作的数据结构，比如字典或列表。

import yaml

def read_yaml_config(file_path):
    try:
        with open(file_path, 'r') as f:
            config = yaml.safe_load(f)
        return config
    except FileNotFoundError:
        print(f"错误：配置文件 {file_path} 未找到")
        return None
    except yaml.YAMLError as e:
        print(f"错误：解析 YAML 文件时发生错误：{e}")
        return None

# 示例用法
config_data = read_yaml_config('config.yaml')
if config_data:
    print(config_data)

YAML文件读取后，就可以像操作普通字典或列表一样使用其中的数据了。

YAML配置文件的优势是什么？

YAML相比于传统的INI或JSON，可读性更强，结构更清晰，更适合用于复杂的配置场景。例如，可以方便地表示嵌套的配置项，或者包含列表的配置。而且，YAML的语法也相对简洁，减少了不必要的字符，提升了编写效率。想象一下，你要配置一个包含多个数据库连接信息，每个连接信息又包含host、port、username、password等字段的场景，用YAML来描述就会非常直观。

如何处理YAML文件中的环境变量？

有时候，我们希望在YAML配置文件中使用环境变量，比如数据库密码，避免硬编码。PyYAML 本身不直接支持环境变量的解析，但我们可以通过一些技巧来实现。一种方法是在读取YAML文件后，手动替换其中的环境变量。

import os
import yaml

def resolve_env_variables(config):
    if isinstance(config, dict):
        for key, value in config.items():
            if isinstance(value, str) and value.startswith("${") and value.endswith("}"):
                env_var = value[2:-1]
                config[key] = os.environ.get(env_var, value) # 如果环境变量不存在，则使用原始值
            elif isinstance(value, (dict, list)):
                resolve_env_variables(value)
    elif isinstance(config, list):
        for item in config:
            if isinstance(item, str) and item.startswith("${") and item.endswith("}"):
                env_var = item[2:-1]
                item = os.environ.get(env_var, item)
            elif isinstance(item, (dict, list)):
                resolve_env_variables(item)
    return config

def read_yaml_config_with_env(file_path):
    config = read_yaml_config(file_path)
    if config:
        config = resolve_env_variables(config)
    return config

# 示例
config_data = read_yaml_config_with_env('config.yaml')
if config_data:
    print(config_data)

这个方法会递归地遍历整个配置，如果发现字符串以 ${ 开头，以 } 结尾，就尝试从环境变量中获取对应的值。

读取YAML时遇到yaml.constructor.ConstructorError怎么办？

这个错误通常发生在YAML文件中包含Python对象，而 PyYAML 默认情况下不会加载这些对象，为了安全考虑。如果你确定YAML文件是可信的，并且需要加载其中的Python对象，可以使用 yaml.unsafe_load 代替 yaml.safe_load。但是，请注意，这可能会带来安全风险，因为它可以执行YAML文件中包含的任意Python代码。

import yaml

def read_yaml_config_unsafe(file_path):
    try:
        with open(file_path, 'r') as f:
            config = yaml.unsafe_load(f)
        return config
    except FileNotFoundError:
        print(f"错误：配置文件 {file_path} 未找到")
        return None
    except yaml.YAMLError as e:
        print(f"错误：解析 YAML 文件时发生错误：{e}")
        return None

更安全的方法是避免在YAML文件中存储Python对象，而是使用基本的数据类型，比如字符串、数字、布尔值等。

今天关于《Python读取YAML配置文件方法》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于Python,环境变量,读取,YAML,PyYAML的内容请关注golang学习网公众号！