文章目录

  • python库-dotenv包 | .env配置文件
  • 背景
  • python-dotenv 如何使用


python库-dotenv包 | .env配置文件

背景

我们开发的每个系统都离不开配置信息,这些信息都非常敏感,一旦泄露出去后果非常严重,被泄露的原因一般是程序员将配置信息和代码混在一起导致的。

一般业务代码中,通过环境变量来加载敏感信息。

将敏感信息设置成环境变量,但是这样的信息非常多,挨个设置也太麻烦了。你一定希望可以将这些敏感信息单独放在一个文件中,始终与代码分开管理。

在python项目中,敏感信息(如数据库密码)比较推荐使用 .env文件来单独管理,且不纳入git管理中。而目前比较流行的解析.env则是python-dotenv。

python-dotenv 能将配置文件的配置信息自动加入到环境变量。 python-dotenv解决了代码与敏感信息的分离

flask官方推荐使用python-dotenv包来管理特殊的配置。

python-dotenv 如何使用

使用思路:最简单和最常见的用法是在应用程序启动时调用load_dotenv,从当前目录或其父目录中的.env文件或指定的路径加载环境变量,然后你可以调用os.getenv提供的与环境相关的方法。

load_dotenv默认不会更新已经存在的配置项。推荐使用override参数,如下:

from dotenv import load_dotenv, find_dotenv
load_dotenv(find_dotenv(), override=True)
  • dotenv_path: 指定.env文件路径,当然如果不传该参数的话(默认为None)也会自定调用dotenv.find_dotenv()去查找文件位置的,但是你的文件名如果不是.env那就必须传递该参数
  • override: 当.env 文件中有变量与系统中原来的环境变量有冲突时,按照上面的取值顺序,默认使用系统变量,如果要用.env中的变量覆盖系统变量,可以给load_dotenv() 传递参数override=True。此时只是临时使用了.env 中的变量值
import os
from dotenv import find_dotenv, load_dotenv

# 加载.env文件到环境变量
load_dotenv(find_dotenv('.env'))
print(os.environ.get("URL"))

加载文件后,就可以通过os.environ从环境变量中读取内容。