Python项目中六大常见的配置文件管理方式详解

 更新时间:2026年07月10日 09:13:33   作者:梦想不只是梦与想  
本指南对比了Python项目中配置文件管理方式的6种主流方法,从硬编码到云原生环境变量,帮你快速掌握.env、YAML、TOML等核心配置方式的优缺点,点击了解如何根据项目规模选择最佳策略,彻底告别敏感信息泄露风险

在 Python 项目中,配置文件是将代码与配置分离的重要手段。常见方式有以下几种,从简单到正式分别是:

一、配置方式

方式格式适用场景特点
硬编码Python 代码极简/临时脚本最不灵活
.env 文件KEY=VALUE环境变量、敏感信息轻量,适合敏感信息
config.py 模块Python 代码中小型项目灵活,可用Python逻辑
JSON / YAML.json / .yaml复杂配置结构结构清晰,通用
TOML.toml项目元数据Python 官方推荐(pyproject.toml
系统环境变量OS 级别容器/云原生标准化,适合云部署

二、各方式介绍

方式 1:硬编码(不推荐)

# config.py
DB_HOST = "localhost"
DB_PORT = 5432
API_KEY = "sk-123456"  # 敏感信息暴露在代码里

问题

  • 敏感信息暴露在代码里
  • 不同环境(开发/测试/生产)需要改代码
  • 配置文件跟代码绑定,难以复用

适用场景:仅限简单脚本,任何正式项目都不应该用这种方式

方式 2:.env文件(最常用的轻量方案)

# .env 文件
DB_HOST=localhost
DB_PORT=5432
API_KEY=sk-123456
DEBUG=true
# 加载配置
from dotenv import load_dotenv
import os

load_dotenv()
db_host = os.getenv("DB_HOST", "localhost")
api_key = os.getenv("API_KEY")

优点

  • 敏感信息不进代码(.env 加入 .gitignore
  • 环境切换只需改一个文件
  • 配合 python-dotenv 使用,标准轻量

缺点

  • 只能处理字符串(需要手动转换类型)
  • 不支持复杂嵌套结构(如对象、列表)

方式 3:config.py模块(Python 代码配置)

# config.py
import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'dev-secret'
    DEBUG = False
    TESTING = False

class DevelopmentConfig(Config):
    DEBUG = True
    DB_URL = 'sqlite:///dev.db'

class ProductionConfig(Config):
    DB_URL = os.environ.get('DATABASE_URL')

# 根据环境选择配置
config = {
    'development': DevelopmentConfig,
    'production': ProductionConfig,
    'default': DevelopmentConfig
}
# 使用
from config import config
cfg = config[os.getenv('ENV', 'default')]()
print(cfg.DB_URL)

优点

  • 灵活,可以使用 Python 逻辑
  • 支持继承、条件判断
  • 适合中小型项目

缺点

配置和代码在一起

修改配置需要改 Python 文件

方式 4:JSON / YAML(结构化配置)

# config.yaml
database:
  host: localhost
  port: 5432
  name: mydb
api:
  key: sk-123456
  timeout: 30
logging:
  level: INFO
  format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
import yaml
import json

# 读取 YAML
with open('config.yaml', 'r') as f:
    config = yaml.safe_load(f)

print(config['database']['host'])  # localhost

优点

  • 结构清晰,支持嵌套
  • 跨语言通用
  • 适合复杂配置

缺点

  • 需要额外库(pyyaml
  • 不支持注释(JSON)或支持有限(YAML)

方式 5:TOML(Python 项目官方推荐)

# pyproject.toml
[project]
name = "myapp"
version = "0.1.0"
description = "My Python application"
[tool.myaapp.database]
host = "localhost"
port = 5432
[tool.myaapp.api]
key = "sk-123456"
timeout = 30
import tomllib  # Python 3.11+ 内置

with open('pyproject.toml', 'rb') as f:
    config = tomllib.load(f)

db_host = config['tool']['myapp']['database']['host']

优点

  • Python 官方推荐(PEP 518/621)
  • 支持注释,结构清晰
  • 3.11+ 内置支持

缺点

  •  旧版本需要 tomli 库
  • 不如 YAML 表达能力强

方式 6:系统环境变量(云原生/容器)

# 在 shell 中设置
export DB_HOST=localhost
export DB_PORT=5432
export API_KEY=sk-123456

# Docker 中设置
docker run -e DB_HOST=localhost -e API_KEY=sk-123456 myapp
import os

db_host = os.environ.get('DB_HOST')

优点

  • 标准化,12-Factor App 推荐
  • 适合容器、云部署
  • 敏感信息不暴露在文件里

缺点

  • 只能处理字符串
  • 大量配置时不方便管理

小项目 .env 就够了;项目大了用 config.yaml;正式 Python 项用 pyproject.toml;上云用环境变量。不要把敏感信息写在代码里!

到此这篇关于Python项目中六大常见的配置文件管理方式详解的文章就介绍到这了,更多相关Python配置文件管理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • python 读取视频,处理后,实时计算帧数fps的方法

    python 读取视频,处理后,实时计算帧数fps的方法

    今天小编就为大家分享一篇python 读取视频,处理后,实时计算帧数fps的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • flask框架蓝图和子域名配置详解

    flask框架蓝图和子域名配置详解

    这篇文章主要介绍了flask框架蓝图和子域名配置,结合实例形式详细分析了flask框架蓝图和子域名配置相关原理、操作技巧与注意事项,需要的朋友可以参考下
    2020-01-01
  • Python标准库shutil模块使用方法解析

    Python标准库shutil模块使用方法解析

    这篇文章主要介绍了Python标准库shutil模块使用方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • 在pandas中遍历DataFrame行的实现方法

    在pandas中遍历DataFrame行的实现方法

    这篇文章主要介绍了在pandas中遍历DataFrame行的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Ubuntu+python将nii图像保存成png格式

    Ubuntu+python将nii图像保存成png格式

    这篇文章主要介绍了Ubuntu+python将nii图像保存成png格式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • pycharm 实现显示project 选项卡的方法

    pycharm 实现显示project 选项卡的方法

    今天小编就为大家分享一篇pycharm 实现显示project 选项卡的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-01-01
  • Python图像锐化与边缘检测之Sobel与Laplacian算子详解

    Python图像锐化与边缘检测之Sobel与Laplacian算子详解

    图像锐化和边缘检测主要包括一阶微分锐化和二阶微分锐化,本文主要讲解常见的图像锐化和边缘检测方法,即Sobel算子和Laplacian算子,感兴趣的可以了解一下
    2022-12-12
  • Python之PyUnit单元测试实例

    Python之PyUnit单元测试实例

    这篇文章主要介绍了Python之PyUnit单元测试实例,是非常实用的技巧,需要的朋友可以参考下
    2014-10-10
  • python PyQt5对象类型的判定及对象删除操作详细解读

    python PyQt5对象类型的判定及对象删除操作详细解读

    PyQt5主要是用来判定一个对象的类型,或者说是否继承自某个类,本文给大家介绍python PyQt5对象类型的判定,对象删除操作详细解读,感兴趣的朋友一起看看吧
    2024-07-07
  • Python Numpy库的超详细教程

    Python Numpy库的超详细教程

    Numpy库是Python中的一个科学计算库,本文主要介绍了ndarray的基本操作、 ndarray运算等各种Numpy库的超详细教程,需要的朋友可以参考下
    2022-04-04

最新评论