Dynaconf 开源项目教程

33 0 0

Dynaconf 开源项目教程

dynaconfdynaconf/dynaconf: 是一个 Python 配置管理库，可以方便地实现配置的统一管理和发布。该项目提供了一个简单易用的配置管理库，可以方便地实现配置的统一管理和发布，同时支持多种配置格式和部署方式。项目地址:https://gitcode.com/gh_mirrors/dy/dynaconf

1. 项目的目录结构及介绍

Dynaconf 是一个用于 Python 应用的配置管理工具，其项目目录结构清晰，便于理解和使用。以下是 Dynaconf 项目的主要目录结构及其介绍：

dynaconf/ ├── dynaconf/ │ ├── __init__.py │ ├── base.py │ ├── constants.py │ ├── default_settings.py │ ├── loaders/ │ │ ├── __init__.py │ │ ├── redis_loader.py │ │ ├── vault_loader.py │ │ └── ... │ ├── utils.py │ └── ... ├── tests/ │ ├── __init__.py │ ├── test_core.py │ ├── test_loaders.py │ └── ... ├── .gitignore ├── LICENSE ├── README.md ├── setup.py └── ...

dynaconf/: 核心代码目录，包含了 Dynaconf 的主要功能实现。
- __init__.py: 模块初始化文件。
- base.py: 定义了配置对象的基础类。
- constants.py: 包含了一些常量定义。
- default_settings.py: 默认配置文件。
- loaders/: 配置加载器目录，支持多种配置源的加载。
- utils.py: 工具函数集合。
tests/: 测试代码目录，包含了各种测试用例。
.gitignore: Git 忽略文件配置。
LICENSE: 项目许可证文件。
README.md: 项目说明文档。
setup.py: 项目安装脚本。

2. 项目的启动文件介绍

Dynaconf 项目的启动文件主要是 setup.py，它负责项目的安装和分发。以下是 setup.py 的主要内容：


from setuptools import setup, find_packages
 
setup(
    name='dynaconf',
    version='2.2.3',
    description='Configuration Management for Python.',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Bruno Rocha',
    author_email='rochacbruno@gmail.com',
    url='https://github.com/dynaconf/dynaconf',
    packages=find_packages(),
    install_requires=[
        # 依赖列表
    ],
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

name: 项目名称。
version: 项目版本。
description: 项目简短描述。
long_description: 项目详细描述，通常从 README.md 文件读取。
author: 项目作者。
url: 项目仓库地址。
packages: 需要包含的包。
install_requires: 项目依赖列表。
classifiers: 项目分类信息。

3. 项目的配置文件介绍

Dynaconf 支持多种配置文件格式，包括 toml, yaml, ini, json, py 等。以下是一个典型的 settings.toml 配置文件示例：


[default]
username = "admin"
port = 5555
database = {name='mydb', schema='main'}
 
[development]
username = "dev_user"
port = 8000
 
[production]
username = "prod_user"
port = 8080

[default]: 默认配置节，包含所有环境通用的配置。
[development]: 开发环境配置节，覆盖默认配置。
[production]: 生产环境配置节，覆盖默认配置。

此外，Dynaconf 还支持敏感信息的配置，通常存储在 secrets.toml 文件中

# 随笔