Dynaconf无法替换config.yaml中${}占位符，寻求解决办法

现有配置与代码 #

config.yaml #

kafka:
  bootstrap_servers: "${BOOTSTRAP_SERVERS}"
  group: "${GROUP_NAME_1}"
  topics: 
    - name: "${TOPIC_1}"
      consumers: "${CONSUMER_NUMBER_FOR_TOPIC_1}"

Dynaconf初始化代码 #

from dynaconf import Dynaconf
from dynaconf.validator import Validator

settings = Dynaconf(
    envvar_prefix="service-a",
    settings_files=['config.yaml'],  
    load_dotenv=True,
    dotenv_path='.env',
    validators=[
        Validator(
            "server.port", must_exist=True
        )
    ]
)

业务代码片段 #

def start_kafka_consumers():
    topics = settings.kafka.topics
    threads = []
    for topic in topics:
        topic_name = topic['name']
        consumer_count = topic['consumers']
        logger.info(f"{consumer_count} consumers will be started for topic {topic_name}")

        for _ in range(consumer_count):
            thread = threading.Thread(target=start_consumer_for_topic, args=(topic_name,))
            thread.start()
            threads.append(thread)

解决建议 #

1. 启用环境变量插值功能 #

Dynaconf默认不会自动解析YAML中的${}占位符，需显式开启相关配置。修改Dynaconf初始化代码：

settings = Dynaconf(
    envvar_prefix="service-a",
    settings_files=['config.yaml'],  
    load_dotenv=True,
    dotenv_path='.env',
    # 开启环境变量插值解析
    environments=True,
    # 留空表示直接读取.env中的原始变量名，无需添加前缀
    auto_envvar_prefix="",
    validators=[
        Validator("server.port", must_exist=True),
        # 可选：添加kafka相关配置的存在性验证
        Validator("kafka.bootstrap_servers", must_exist=True),
        Validator("kafka.group", must_exist=True),
        Validator("kafka.topics", must_exist=True)
    ]
)

2. 处理变量类型转换 #

.env中的数值变量默认是字符串类型，直接用于range()会报错，可通过两种方式解决：

• YAML中指定类型：修改config.yaml的consumers字段

  consumers: !int "${CONSUMER_NUMBER_FOR_TOPIC_1}"
  

• 代码中转换：在业务代码里显式转成整数

  consumer_count = int(topic['consumers'])
  

3. 检查envvar_prefix的影响 #

envvar_prefix="service-a"会让Dynaconf只读取以SERVICE_A_开头的环境变量。如果.env中的变量没有前缀，二选一即可：

• 将.env中的变量名改为带前缀格式，比如SERVICE_A_BOOTSTRAP_SERVERS
• 保持.env变量名不变，设置auto_envvar_prefix=""（如建议1所示）

4. 验证配置加载结果 #

可在代码中打印配置值，确认替换是否生效：

print(settings.kafka.bootstrap_servers)
print(settings.kafka.topics[0].name)
print(settings.kafka.topics[0].consumers)

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