Python项目配置信息yaml文件使用示例

在Python项目中，使用.yaml文件来存储配置信息是一种常见且推荐的做法，因为YAML格式具有良好的可读性和易于编辑的特点。下面是一个详细的示例，包括创建一个YAML配置文件，以及在Python代码中读取和使用这些配置。

步骤1：创建YAML配置文件

创建一个名为config.yaml的文件，存放项目配置信息。以下是一个示例配置文件内容：

# config.yaml
database:
  host: localhost
  port: 5432
  name: my_project_db
  user: app_user
  password: secretpassword

logging:
  level: info
  filename: logs/app.log
  max_bytes: 10485760  # 10 MB
  backup_count: 5

api:
  base_url: https://api.example.com/v1
  timeout: 10  # seconds
  retries: 3

app:
  debug: true
  secret_key: aVeryLongAndSecureSecretKeyHere

在这个例子中，配置文件包含了以下几个部分：

• database: 存储数据库连接相关的配置，如主机名、端口、数据库名、用户名和密码。
• logging: 定义日志记录的相关设置，如日志级别、日志文件路径、最大文件大小和备份文件数量。
• api: 用于API交互的配置，包括基础URL、请求超时时间和重试次数。
• app: 应用级别的配置，如调试模式开关和应用程序密钥。

步骤2：在Python中读取YAML配置

为了在Python代码中读取和使用上述YAML配置，你需要安装PyYAML库（如果尚未安装）。使用pip进行安装：

pip install PyYAML

然后，编写Python代码来加载和解析config.yaml文件：

import yaml

def load_config(file_path='config.yaml'):
    with open(file_path, 'r', encoding='utf-8') as f:
        return yaml.safe_load(f)

config = load_config()

这里定义了一个load_config()函数，它打开指定路径（默认为config.yaml）的文件，使用yaml.safe_load()方法解析其内容，并返回解析后的Python对象（通常是字典）。将返回值赋给全局变量config，以便在项目中全局访问配置信息。

步骤3：使用配置信息

现在可以在Python代码中像访问字典一样使用配置数据。例如：

import logging

def setup_logging():
    log_level = config['logging']['level'].upper()
    log_filename = config['logging']['filename']
    max_bytes = config['logging']['max_bytes']
    backup_count = config['logging']['backup_count']

    logging.basicConfig(
        level=log_level,
        filename=log_filename,
        filemode='a',
        format='%(asctime)s %(levelname)s:%(message)s',
        datefmt='%d/%m/%Y %H:%M:%S',
        handlers=[
            logging.handlers.RotatingFileHandler(
                log_filename,
                maxBytes=max_bytes,
                backupCount=backup_count,
            )
        ],
    )

setup_logging()

# 示例：使用数据库配置
import psycopg2

def connect_to_database():
    db_params = config['database']
    conn = psycopg2.connect(
        host=db_params['host'],
        port=db_params['port'],
        dbname=db_params['name'],
        user=db_params['user'],
        password=db_params['password'],
    )
    return conn

connection = connect_to_database()

以上代码展示了如何使用配置中的logging部分设置日志记录器，以及如何使用database部分的配置连接到PostgreSQL数据库。类似的，你可以根据需要访问和使用api和app部分的配置。

通过这种方式，你可以将项目的各种配置集中在一个易于维护的YAML文件中，同时保持Python代码的清晰和简洁。当需要更改配置时，只需编辑config.yaml文件，无需修改任何Python源代码。