揭秘python-dotenv：那些鲜为人知的实用窍门-CSDN博客

本文链接：https://blog.csdn.net/JingYu_365/article/details/140566072

Python-dotenv 的场景及应用

Python-dotenv是一个流行的库，用于在Python项目中管理环境变量。它允许开发者将敏感信息（如数据库密码、API密钥等）存储在.env文件中，而不是硬编码在代码里。这样做的好处是可以在不修改代码的情况下轻松更改应用程序的配置信息，并且由于.env文件通常不会被版本控制系统跟踪，可以防止敏感信息泄露。

Python-dotenv的使用场景广泛，包括但不限于：

本地开发：为本地开发环境提供方便的配置，同时避免将敏感数据提交到版本控制系统。
多环境部署：在不同环境中（如测试、生产）使用不同的.env文件来管理环境变量。
灵活配置：通过组合多个.env文件或与系统环境变量结合，实现更复杂的配置逻辑。

如何使用Python-dotenv

python-dotenv 能够用于在 POSIX 系统中调整环境变量。环境变量的赋值遵循以下优先级顺序：

首先检查系统环境变量；
其次采用 .env 文件中指定的值；
如果未指定，则使用提供的默认值；
若以上均未提供，则结果为空字符串。

加载依赖

首先，确保你已经安装了 python-dotenv。如果你还没有安装，可以通过以下命令安装：

pip install python-dotenv

项目结构

假设你的项目结构如下：

project/
│
├── .env
├── app.py
└── settings.py

其中：

.env 文件将包含你的环境变量
app.py 是你的主应用文件
settings.py 可以用来配置应用设置。

.env 文件内容如下：

USERNAME=JingYu
DATABASE_URL=postgres://user:password@localhost/dbname
SECRET_KEY=your_secret_key

项目中使用

在你的 Python 代码中，你可以使用以下方式来加载 .env 文件：
在 app.py 或 settings.py 的顶部，添加以下代码：

from dotenv import load_dotenv

load_dotenv()  # 这会加载项目根目录中的.env文件

# 现在你可以使用os模块来访问环境变量
import os

database_url = os.getenv('DATABASE_URL')
secret_key = os.getenv('SECRET_KEY')

print(database_url, secret_key)

输出：postgres://user:password@localhost/dbname your_secret_key

注意事项

如果需要覆盖环境变量中的某些值需要使用参数：override=True

from dotenv import load_dotenv
import os

load_dotenv(override=True)
username = os.getenv('USERNAME')
print(username)

环境变量中引用其他变量：确保引用其他变量时用大括号 {}包围，就像 ${HOME}。

VERSION=v0.1.1
SSERVICE_NAME= Python-samples ${VERSION}

加载制定名称的环境配置：更改 .env 文件名为 dev.env

load_dotenv(dotenv_path="dev.env", override=True)

其他加载方式

from dotenv import load_dotenv, find_dotenv
from pathlib import Path

# 1.自动搜索 .env 文件
load_dotenv(verbose=True)

# 2.与上面方式等价
load_dotenv(find_dotenv(), verbose=True)

# 3. 或者指定 .env 文件位置
# 使用 pathlib 创建一个指向当前目录下 .env 文件的路径
env_path = Path('.') / '.env'
if env_path.exists():
    load_dotenv(dotenv_path=env_path, verbose=True)
else:
    print(f".env file not found at {env_path}")

源码分析

def load_dotenv(
    dotenv_path: Union[str, os.PathLike, None] = None,
    stream: Optional[IO[str]] = None,
    verbose: bool = False,
    override: bool = False,
    interpolate: bool = True,
    encoding: Optional[str] = "utf-8",
) -> bool:
    """Parse a .env file and then load all the variables found as environment variables.

    Parameters:
        dotenv_path: Absolute or relative path to .env file.
        stream: Text stream (such as `io.StringIO`) with .env content, used if
            `dotenv_path` is `None`.
        verbose: Whether to output a warning the .env file is missing.
        override: Whether to override the system environment variables with the variables
            from the `.env` file.
        encoding: Encoding to be used to read the file.
    Returns:
        Bool: True if atleast one environment variable is set elese False

    If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the
    .env file.
    """