如何从 .env 文件为 pytests 加载变量

Question

我正在 Flask 中编写 API，在某些时候我会向注册的用户发送电子邮件。 我将有关此电子邮件服务的变量存储在 .env 文件中。 现在想测试我使用这些变量的部分，但我不知道如何从 .env 文件加载它们。

我在这里尝试了基本上所有的答案https://rb.gy/0nro1a ，猴子修补 setenv 如这里所示https://rb.gy/kd07wa + 其他技巧在这里和那里。 每个都在某些方面失败了。 我也尝试使用 pytest-dotenv。 pytest-env, pytest.ini 等..但没有真正按预期工作，这让我很困惑。

我的 pytests 夹具看起来像这样

@pytest.fixture(autouse=True)
def test_client_db():

    # set up
    app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///"
    app.config["JWT_SECRET_KEY"] = "testing"

    with app.app_context():
        db.init_app(app)
        db.create_all()
    testing_client = app.test_client()
    ctx = app.app_context()
    ctx.push()

    # do testing
    yield testing_client

    # tear down
    with app.app_context():
        db.session.remove()
        db.drop_all()

    ctx.pop()

我想知道为什么我不能简单地在固定装置的设置中的某处加载像这样的行load_dotenv(path/to/.env)的 .env 文件并完成？

作为新手，有人可以向我解释如何以简单直接的方式读取 .env 变量以使用 pytest 吗？

真正对我有用的唯一方法是在运行测试时在命令行上传递环境变量。

FROM_EMAIL="some@email.com" MAILGUN_DOMAIN="sandbox6420919ab29b4228sdfda9d43ff37f7689072.mailgun.org" MAILGUN_API_KEY="245d6d0asldlasdkjfc380fba7fbskfsj1ad3125649esadbf2-7cd1ac2b-47fb3ac2" pytest tests

但这是一种糟糕的方式，我不想每次运行测试时都将所有这些 var 写入命令行。

我只想编写pytest test ，我相信 .env 文件应该自动加载到某个地方。 但是在哪里以及如何？

任何帮助表示赞赏。

Answer 1

如果安装python-dotenv ，则可以使用它从.env文件加载变量。 这是一个最小的例子：

.env

SQLALCHEMY_DATABASE_URI="sqlite:///"
JWT_SECRET_KEY="testing"

测试文件

import os

import pytest
from dotenv import load_dotenv


@pytest.fixture(scope='session', autouse=True)
def load_env():
    load_dotenv()


@pytest.fixture(autouse=True)
def test_client_db():
    print(f"\nSQLALCHEMY_DATABASE_URI"
          f"={os.environ.get('SQLALCHEMY_DATABASE_URI')}")
    print(f"JWT_SECRET_KEY={os.environ.get('JWT_SECRET_KEY')}")


def test():
    pass

python -m pytest -s test.py给出：

============================================ test session starts ============================================
...
collected 1 item

test.py
SQLALCHEMY_DATABASE_URI=sqlite:///
JWT_SECRET_KEY=testing
.

============================================= 1 passed in 0.27s =============================================

例如，环境变量在整个测试会话中设置，可用于配置您的应用程序。 请注意，我没有在load_dotenv()提供路径，因为我将.env文件放在与测试相同的目录中 - 在您的代码中，您可能必须添加路径（ load_dotenv(dotenv_path=your_path) ）。

Answer 2

你可以使用pytest提供的monkeypatch fixture来操作env变量：

@pytest.fixture(scope="function")
def configured_env(monkeypatch):
    monkeypatch.setenv("SQLALCHEMY_DATABASE_URI", "sqlite:///")
    monkeypatch.setenv("JWT_SECRET_KEY", testing)

def test_client(configured_env):
 #env variables are set here