configparser是python标准库中读取ini配置文件的轻量方案,支持节、键值对、注释,但大小写敏感、值默认为字符串、需手动类型转换,且不加密敏感信息。

Python标准库中的configparser模块是读取INI风格配置文件最常用、最轻量的方式,适合管理数据库连接、API密钥、环境开关等结构化配置项。它不依赖第三方包,语法简单,但有几个关键细节容易踩坑——比如大小写敏感、节(section)必须存在、值默认为字符串等。
配置文件格式要规范
configparser只认标准INI格式:以[section]开头,键值对用=或:分隔,支持注释(# 或 ;),但不支持json或YAML语法。
示例config.ini:
[database]
host = localhost
port = 5432
user = admin
password = secret123
[feature]
enable_cache = true
log_level = INFO
立即学习“Python免费学习笔记(深入)”;
注意:
• 节名区分大小写,[Database] 和 [database] 是不同节
• 值一律读作字符串,True、123、3.14 都需要手动转换类型
• 空行和缩进不影响解析,但键前后空格会被保留(建议避免)
基础读取与类型转换
用ConfigParser加载后,先检查节是否存在,再读取键;推荐用.get()方法配合fallback参数防错,而不是直接索引。
- 用
config.read("config.ini")加载文件,返回成功读取的文件列表(可传多个路径) - 用
config.has_section("database")判断节是否存在 - 用
config.get("database", "host")获取字符串值 - 用
config.getint("database", "port")、getboolean("feature", "enable_cache")自动转类型(失败抛ValueError) - 用
config.get("database", "password", fallback="default_pass")提供默认值
处理常见问题
实际项目中常遇到路径错误、编码异常、缺失字段等问题:
- 中文路径或含中文注释时,显式指定
encoding="utf-8"(Python 3.7+ 默认是utf-8,但旧版本需声明) - 配置项可能被覆盖:同一节中重复键名,后出现的会覆盖前面的;不同节同名键互不影响
- 想让键名不区分大小写?可继承
ConfigParser并重写_optionxform方法,例如返回option.lower() - 若需合并多份配置(如base.ini + dev.ini),调用多次
.read()即可,后读的优先级更高
安全提示:别把敏感信息硬编码在配置里
configparser本身不加密、不校验,密码、密钥等应通过环境变量或密钥管理服务注入。配置文件建议加入.gitignore,开发时用config.example.ini模板替代真实配置。
一个最小可用实践片段:
from configparser import ConfigParser
config = ConfigParser()
config.read(“config.ini”, encoding=”utf-8″)
db_host = config.get(“database”, “host”, fallback=”127.0.0.1″)
db_port = config.getint(“database”, “port”, fallback=5432)
cache_on = config.getboolean(“feature”, “enable_cache”, fallback=False)
不复杂但容易忽略细节,用对了能省掉不少调试时间。