Poetry Dotenv Plugin 使用教程
1. 项目的目录结构及介绍
poetry-dotenv-plugin/
├── poetry_dotenv_plugin/
│ ├── __init__.py
│ ├── plugin.py
├── tests/
│ ├── __init__.py
│ ├── test_plugin.py
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
poetry_dotenv_plugin/
: 包含插件的主要代码。__init__.py
: 初始化文件。plugin.py
: 插件的核心实现。
tests/
: 包含插件的测试代码。__init__.py
: 初始化文件。test_plugin.py
: 测试插件功能的测试文件。
.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证。README.md
: 项目说明文档。pyproject.toml
: 项目配置文件。
2. 项目的启动文件介绍
项目的启动文件是 poetry_dotenv_plugin/plugin.py
。这个文件定义了插件的主要功能,包括自动加载环境变量。
# poetry_dotenv_plugin/plugin.py
from poetry.plugins import ApplicationPlugin
from dotenv import load_dotenv
import os
class DotenvPlugin(ApplicationPlugin):
def activate(self, application):
load_dotenv()
# 其他初始化代码
3. 项目的配置文件介绍
项目的配置文件是 pyproject.toml
。这个文件包含了项目的元数据和依赖信息,以及插件的配置。
[tool.poetry]
name = "poetry-dotenv-plugin"
version = "0.2.0"
description = "A Poetry plugin to automatically load environment variables from env files"
authors = ["Michael Peteuil <mpeteuil@example.com>"]
license = "MIT"
[tool.poetry.dependencies]
python = "^3.7"
python-dotenv = "^0.15.0"
[tool.poetry.dev-dependencies]
pytest = "^6.2.2"
[tool.poetry.plugins."poetry.application.plugins"]
dotenv = "poetry_dotenv_plugin.plugin:DotenvPlugin"
[tool.poetry.plugins.dotenv]
ignore = false
location = "env"
[tool.poetry]
: 项目的基本信息。[tool.poetry.dependencies]
: 项目的依赖。[tool.poetry.dev-dependencies]
: 开发依赖。[tool.poetry.plugins."poetry.application.plugins"]
: 插件的注册信息。[tool.poetry.plugins.dotenv]
: 插件的配置选项。