[python]从环境变量和配置文件中获取配置参数

前言

从环境变量和配置文件中获取配置参数，相关库：

• python-dotenv：第三方库，需要使用pip安装
• configparser：标准库

示例代码

• test.ini

[mysql]
host = "192.168.0.10"
port = 3306
user = "root"
password = "123456"

[postgresql]
host = "192.168.0.11"
port = 5432
user = "postgres"
password = "123456"

• demo.py

from configparser import ConfigParser, NoSectionError, NoOptionError
from dotenv import load_dotenv
import os

# 如果存在环境变量的文件，则加载配置到环境变量
if os.path.exists("settings.env"):
    load_dotenv("settings.env")

os_env = os.environ

def read_config(filename: str) -> ConfigParser:
    """
    从文件中读取配置信息

    Parameters
    ----------
    filename : str, 配置文件
    """
    # 实例化对象
    config = ConfigParser()
    if not os.path.exists(filename):
        raise FileNotFoundError(f"配置文件 {filename} 不存在")
    config.read(filename, encoding="utf-8")
    return config

def get_config(config: ConfigParser, section: str, key: str):
    """
    根据指定section和key获取value

    Parameters
    ----------
    config:  ConfigParser(), 配置实例对象
    section: str, 配置文件中的区域
    key:     str, 配置的参数名
    """
    # 优先从环境变量中获取配置参数, 没有的话再从配置文件中获取
    value = os_env.get(key, "")
    if not value:
        try:
            value = config.get(section, key)
        except (NoOptionError, NoSectionError):
            # 没有的话就返回None
            value = None
    return value

if __name__ == '__main__':
    config = read_config("test.ini")
    print(get_config(config, "mysql", "host"))