Python动态配置管理Dynaconf的实现示例详解

作者:编程学习网 时间:2021-01-24 19:35:06 

Dynaconf 是一个 Python 的第三方模块,旨在成为在 Python 中管理配置的最佳选择。

它可以从各种来源读取设置,包括环境变量、文件、服务器配置等

它适用于任何类型的 Python 程序,包括 Flask 和 Django 扩展

1.准备

开始之前,你要确保 Python 和 pip 已经成功安装在电脑上

然后,请选择以下任一种方式输入命令安装依赖:

  • Windows 环境 打开 Cmd ( 开始-运行-CMD )

  • MacOS 环境 打开 Terminal ( command + 空格输入 Terminal )

  • 如果你用的是 VSCode 编辑器 或 Pycharm,可以直接使用界面下方的 Terminal

pip install dynaconf

2.初步使用DynaConf

在你的项目的根目录中运行 dynaconf init 命令。

cd path/to/your/project/
dynaconf init -f toml

会有类似如下的输出,说明初始化完成:

⚙️ Configuring your Dynaconf environment
------------------------------------------
🐍 The file `config.py` was generated.
🎛️ settings.toml created to hold your settings.
🔑 .secrets.toml created to hold your secrets.
🙈 the .secrets.* is also included in `.gitignore`
beware to not push your secrets to a public repo.
🎉 Dynaconf is configured! read more on https://dynaconf.com

刚刚初始化的时候我们选择了 toml 格式。实际上你还可以选择 toml|yaml|json|ini|py ,不过 toml 是默认的,也是最推荐的配置格式。

初始化完成后会创建以下文件:

.
├── config.py # 需要被导入的配置脚本
├── .secrets.toml # 像密码等敏感信息配置
└── settings.toml # 应用配置

初始化完成后你就可以编写你的配置,编辑settings.toml:

key = "value"
a_boolean = false
number = 1234
a_float = 56.8
a_list = [1, 2, 3, 4]
a_dict = {hello="world"}
[a_dict.nested]
other_level = "nested value"

然后就可以在你的代码中导入并使用这些配置:

from config import settings
assert settings.key == "value"
assert settings.number == 789
assert settings.a_dict.nested.other_level == "nested value"
assert settings['a_boolean'] is False
assert settings.get("DONTEXIST", default=1) == 1

如果是密码等敏感信息,你可以配置在 .secrets.toml 中:

password = "xxxxxxxxxxxxxx"
token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
message = "This file doesn't go to your pub repo"

.secrets.toml 文件会被自动加入到 .gitignore 文件中,这些信息不会被上传到Git仓库上。

同时,DYNACONF还支持带前缀的环境变量:

export DYNACONF_NUMBER=789
export DYNACONF_FOO=false
export DYNACONF_DATA__CAN__BE__NESTED=value
export DYNACONF_FORMATTED_KEY="@format {this.FOO}/BAR"
export DYNACONF_TEMPLATED_KEY="@jinja {{ env['HOME'] | abspath }}"

3.高级使用

你还可以在Flask或Django中使用DynaConf,以Django为例,第一步要先确保已经设置 DJANGO_SETTINGS_MODULE 环境变量:

export DJANGO_SETTINGS_MODULE=yourproject.settings

然后在 manage.py 相同文件夹下运行初始化命令:

dynaconf init -f yaml

然后按照终端上的说明进行操作:

Django app detected
⚙️ Configuring your Dynaconf environment
------------------------------------------
🎛️ settings.yaml created to hold your settings.
🔑 .secrets.yaml created to hold your secrets.
🙈 the .secrets.yaml is also included in `.gitignore`
beware to not push your secrets to a public repo
or use dynaconf builtin support for Vault Servers.
⁉ path/to/yourproject/settings.py is found do you want to add dynaconf? [y/N]:

回答 y:

🎠 Now your Django settings are managed by Dynaconf
🎉 Dynaconf is configured! read more on https://dynaconf.com

在 Django 上,推荐的文件格式是yaml,因为它可以更轻松地保存复杂的数据结构,但是你依然可以选择使用 toml、json、ini 甚至将你的配置保存为 .py 格式。

初始化 dynaconf 后,在现有的settings.py底部包含以下内容:

# HERE STARTS DYNACONF EXTENSION LOAD
import dynaconf # noqa
settings = dynaconf.DjangoDynaconf(__name__) # noqa
# HERE ENDS DYNACONF EXTENSION LOAD (No more code below this line)

现在,在你的 Django 视图、模型和所有其他地方,你现在可以正常使用 django.conf.settings,因为它已被 Dynaconf 设置对象替换。

from django.conf import settings
def index(request):
   assert settings.DEBUG is True
   assert settings.NAME == "Bruno"
   assert settings.DATABASES.default.name == "db"
   assert settings.get("NONEXISTENT", 2) == 2

现在,通过修改 manage.py 相同文件夹下的配置文件,就能让配置全局生效了

来源:https://juejin.cn/post/7124198542079442957

标签:Python,动态配置,Dynaconf
0
投稿

猜你喜欢

  • 基于Django静态资源部署404的解决方法

    2021-09-06 11:59:41
  • Python 实现王者荣耀中的敏感词过滤示例

    2023-08-14 01:21:04
  • 你知道mysql哪些查询情况不走索引吗

    2024-01-15 06:32:00
  • 浅谈python类属性的访问、设置和删除方法

    2022-01-12 00:14:48
  • mysql数据库乱码之保存越南文乱码解决方法

    2024-01-14 12:12:24
  • Python中二维列表如何获取子区域元素的组成

    2021-02-16 02:41:01
  • 解决PHP mysql_query执行超时(Fatal error: Maximum execution time …)

    2023-11-17 08:13:30
  • 使用Python完成SAP客户端的打开和系统登陆功能

    2021-02-28 17:12:29
  • 如何做网页设计的10个小窍门

    2010-04-11 22:30:00
  • Python3.6使用tesseract-ocr的正确方法

    2023-10-24 20:46:28
  • SQLServer 连接 EXCEL

    2009-07-09 19:00:00
  • js+html5通过canvas指定开始和结束点绘制线条的方法

    2024-05-02 17:20:44
  • MySQL表设计优化与索引 (八)

    2010-10-25 19:46:00
  • Python中常见的加密解密算法总结

    2021-10-18 12:13:17
  • 从源码解析Python的Flask框架中request对象的用法

    2021-02-20 02:15:57
  • GO语言常用的文件读取方式

    2024-05-21 10:21:30
  • Python Requests 基础入门

    2022-01-19 10:58:36
  • 详解Python绘图Turtle库

    2021-11-29 05:42:06
  • 如何用Cookie进行登录验证?

    2010-06-12 12:34:00
  • 关于Javascript的内存泄漏问题

    2008-04-15 07:46:00
  • asp之家 网络编程 m.aspxhome.com