Python项目配置信息yaml完整使用示例

以下是一个完整的Python项目配置管理示例，包含创建config.yaml文件、编写config.py模块（使用单例模式）来加载和管理配置，以及在主程序中使用配置的全过程：

步骤1：创建config.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

步骤2：编写config.py模块

创建一个名为config.py的模块，实现配置加载和管理：

import yaml

class Config:
    _instance = None

    @classmethod
    def get_instance(cls, file_path='config.yaml'):
        if not cls._instance:
            with open(file_path, 'r', encoding='utf-8') as f:
                cls._instance = yaml.safe_load(f)
        return cls._instance

    @classmethod
    def reload(cls, file_path='config.yaml'):
        """Reload configuration from the specified file."""
        with open(file_path, 'r', encoding='utf-8') as f:
            cls._instance = yaml.safe_load(f)

这个模块定义了一个Config类，使用单例模式确保配置在整个程序生命周期内只加载一次。提供了get_instance()方法获取配置实例，以及reload()方法在需要时重新加载配置。

步骤3：在主程序中使用配置

假设有一个简单的主程序main.py，其中使用了配置中的database和app部分：

from config import Config

def connect_to_database():
    config = Config.get_instance()
    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

def main():
    config = Config.get_instance()
    is_debug = config['app']['debug']
    secret_key = config['app']['secret_key']

    connection = connect_to_database()
    # ... 其他使用配置的逻辑 ...
    # 当需要重新加载配置时，调用 Config.reload()
    Config.reload()

if __name__ == '__main__':
    main()

在这个示例中，主程序首先通过Config.get_instance()获取配置实例，然后在main()函数中使用配置信息连接数据库和设置调试模式。如果需要重新加载配置，可以调用Config.reload()方法。

这就是一个完整的Python项目使用YAML文件进行配置管理的示例。通过这种方式，你可以将配置集中管理，同时确保配置在整个项目中的全局可用性和一致性。