基于REST API的Python库可配置化：Pythonic实践探讨

我开发了一个供其他Python库或项目调用的REST API库，库内需要URL等配置变量，不想硬编码，也不愿在函数入参里重复传递URL、USER这类信息，希望实现可配置化。目前用os.getenv("MY_URL")的方案可行，想了解替代方案以及符合Python风格的最佳实践，以下是三种方案的详细分析：

1. 直接使用环境变量（os.environ）的方案 #

通过环境变量存储库的配置，库依赖已设置好的环境变量，由应用或脚本负责配置变量。

库代码实现 #

my_package/__init__.py

from .my_module import my_func

my_package/my_module.py

import os

def my_func():
    print(os.getenv("MY_URL"))

使用示例 #

main.py

import os
import my_package

os.environ["MY_URL"] = "http://example.com"
my_package.my_func()

优点 #

• 无需在库内或导入前定义变量
• Docker环境中可直接将配置放入容器环境，十分便捷
• 运行时可通过修改环境变量变更配置值

潜在缺点 #

• 仅支持字符串类型，虽可转换但存在局限
• 库中直接使用os.getenv()的做法是否为最佳实践存疑，略显不规范

2. 库内全局变量+猴子补丁的方案 #

将所需变量初始化为None，在应用或脚本中通过猴子补丁修改，可用字典优化配置便捷性。

库代码实现 #

my_package/__init__.py

from .my_module import my_func

config = None

my_package/my_module.py

# 其他代码
def my_func():
    print(my_package.config["MY_URL"])

使用示例 #

main.py

import my_package

my_package.config = {"MY_URL": "http://example.com"}
my_package.my_func()

优点 #

• 无需在库内或导入前定义变量
• 运行时可再次通过猴子补丁修改配置值
• 库不依赖环境变量，但仍可从环境变量中读取值并加入字典

潜在缺点 #

• 相比方案1，显得更不规范

3. 库内全局变量+配置方法的方案 #

将配置字典初始化为None，在应用或脚本中调用配置方法传入字典，可记录配置调用日志，更规范但实现稍复杂。

库代码实现 #

my_package/__init__.py

from .my_module import my_func
from .config import config_loader

my_package/config.py

from logging import getLogger

config = None
logger = getLogger(__name__)

def config_loader(config_dict):
    global config
    logger.info(f"config loaded: {config_dict}")
    config = config_dict

my_package/my_module.py

import my_package.config as cfg
# 其他代码
def my_func():
    print(cfg.config["MY_URL"])

使用示例 #

main.py

import my_package

my_package.config_loader({"MY_URL": "http://example.com"})
my_package.my_func()

优点 #

• 无需在库内或导入前定义变量
• 运行时可再次调用方法修改配置值
• 库不依赖环境变量，但仍可从环境变量中读取值并加入字典
• 有明确的配置设置方式

潜在缺点 #

• 整体实现更复杂，相对小众

内容的提问来源于stack exchange，提问作者FordPrefect