Python-dotenv 使用指南

Python-dotenv 使用指南

python-dotenvReads key-value pairs from a .env file and can set them as environment variables. It helps in developing applications following the 12-factor principles.项目地址:https://gitcode.com/gh_mirrors/py/python-dotenv

项目介绍

Python-dotenv 是一个用于管理环境变量的轻量级库，它允许开发者从 .env 文件中加载环境变量到操作系统环境中，简化了开发过程中的配置管理和敏感信息的隔离。这个项目特别适用于多环境设置（如开发、测试、生产），避免在源代码中硬编码敏感信息，增强项目的可移植性和安全性。

项目快速启动

要快速开始使用 python-dotenv，首先确保你的环境中安装了 Python。接下来，通过以下步骤来集成它：

安装

使用 pip 安装 python-dotenv：

pip install python-dotenv

创建 .env 文件

在你的项目根目录下创建一个名为 .env 的文件，并添加一些环境变量：

SECRET_KEY=your-secret-key
DB_HOST=localhost
DB_NAME=mydatabase

加载环境变量

在 Python 脚本中导入并使用 dotenv 来加载这些变量：

from dotenv import load_dotenv

# 加载默认的.env文件，也可指定路径
load_dotenv()

# 访问环境变量
import os
print(os.environ.get('SECRET_KEY'))  # 输出：your-secret-key
print(os.environ.get('DB_HOST'))     # 输出：localhost
print(os.environ.get('DB_NAME'))     # 输出：mydatabase

应用案例和最佳实践

环境区分

为了在不同的环境（比如开发、生产和测试）使用不同的配置，可以通过条件判断或环境变量来选择加载不同的 .env 文件：

import os
from dotenv import load_dotenv

if os.getenv("FLASK_ENV") == "production":
    env_file = ".env.production"
else:
    env_file = ".env"

load_dotenv(env_file)

避免提交 .env 文件

由于 .env 文件可能包含敏感信息，务必将其加入到版本控制系统的忽略列表中，例如 .gitignore：

#.gitignore
.env

典型生态项目

虽然 python-dotenv 本身是基础且专一的，但它与许多现代web框架相结合，如 Flask 和 Django，成为处理环境配置的标准方式之一。以 Flask 为例，结合 python-dotenv 可轻松实现环境配置管理：

在 Flask 应用中，可以在初始化应用程序之前调用 load_dotenv()，然后通过环境变量配置 Flask 的各种设置：

from flask import Flask
from dotenv import load_dotenv

load_dotenv()  # 加载环境变量

app = Flask(__name__)
app.config['SECRET_KEY'] = os.environ.get('SECRET_KEY')
# 根据需要配置其他 Flask 设置...

这样，你就可以利用统一的环境变量管理系统，使得 Flask 应用在不同环境间切换变得简单而安全。

以上就是关于 python-dotenv 的基本使用教程，希望对您的项目有所帮助。

python-dotenvReads key-value pairs from a .env file and can set them as environment variables. It helps in developing applications following the 12-factor principles.项目地址:https://gitcode.com/gh_mirrors/py/python-dotenv