如何在 PyCharm 中实际设置环境变量？

Question

我正在尝试为 PyCharm 中的 python 项目运行一系列测试，并且最近几天几乎不停地遇到 os.environ[] KeyErrors。 设备是 MacBook Pro M2。

我可以从内置的“终端”访问环境变量，但启动 python 并使用 os.environ 进行测试，但当我实际上是 go 并运行测试或调试时却不能。 那是 KeyErrors 出现的时候。

这是我到目前为止所做的：

1. 去运行>编辑配置并在那里添加我的环境变量
2. 转到设置>构建、执行、部署>控制台>Python控制台并将它们也添加到那里
3. 转到工具>终端并完成相同的操作。

当前的解决方法是为每个单独的测试添加一个 EnvFile 配置。 除非我指定确切的 file_name/python_function，否则 Run>Edit Configurations 似乎什么都不做。 为整个测试文件夹创建运行配置似乎没有任何作用。

这是我的 config.xml 文件的内容：

<component name="ProjectRunConfigurationManager">
  <configuration default="false" name="Unittests in tests/unit" type="tests" factoryName="Unittests">
    <module name="smde_refactor" />
    <option name="INTERPRETER_OPTIONS" value="" />
    <option name="PARENT_ENVS" value="true" />
    <option name="SDK_HOME" value="$PROJECT_DIR$/venv/bin/python" />
    <option name="SDK_NAME" value="Python 3.10 (smde_refactor)" />
    <option name="WORKING_DIRECTORY" value="" />
    <option name="IS_MODULE_SDK" value="false" />
    <option name="ADD_CONTENT_ROOTS" value="true" />
    <option name="ADD_SOURCE_ROOTS" value="true" />
    <EXTENSION ID="net.ashald.envfile">
      <option name="IS_ENABLED" value="true" />
      <option name="IS_SUBST" value="false" />
      <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
      <option name="IS_IGNORE_MISSING_FILES" value="false" />
      <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" />
      <ENTRIES>
        <ENTRY IS_ENABLED="true" PARSER="runconfig" IS_EXECUTABLE="false" />
        <ENTRY IS_ENABLED="true" PARSER="env" IS_EXECUTABLE="false" PATH="tests/unit/environment.env" />
      </ENTRIES>
    </EXTENSION>
    <option name="_new_pattern" value="&quot;&quot;" />
    <option name="_new_additionalArguments" value="&quot;&quot;" />
    <option name="_new_target" value="&quot;$PROJECT_DIR$/tests/unit&quot;" />
    <option name="_new_targetType" value="&quot;PATH&quot;" />
    <method v="2" />
  </configuration>
</component>

^我知道这是一个文件夹而不是脚本——但即使选择了一个特定的脚本，仍然没有运气使用该脚本中的任何函数来获取环境变量。

如果我将 a.py 脚本作为一个整体运行（在将环境变量添加到运行配置之后），它会成功（os.environ 被选中。）。 但是，如果我单独运行其中的任何测试，py 脚本。 他们都失败了（无法获取 os.environ）。

谢谢你！

Answer 1

以下是在tests/文件夹上调用 Pytest 的示例配置：

<component name="ProjectRunConfigurationManager">
  <configuration default="false" name="All tests" type="tests" factoryName="py.test">
    <module name="$PROJECT_NAME" />
    <option name="INTERPRETER_OPTIONS" value="" />
    <option name="PARENT_ENVS" value="true" />
    <envs>
      <env name="ABC" value="XXX" />
    </envs>
    <option name="SDK_HOME" value="" />
    <option name="WORKING_DIRECTORY" value="" />
    <option name="IS_MODULE_SDK" value="true" />
    <option name="ADD_CONTENT_ROOTS" value="true" />
    <option name="ADD_SOURCE_ROOTS" value="true" />
    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
    <option name="_new_keywords" value="&quot;&quot;" />
    <option name="_new_parameters" value="&quot;&quot;" />
    <option name="_new_additionalArguments" value="&quot;--tb\u003dshort&quot;"/>
    <option name="_new_target" value="&quot;$PROJECT_DIR$/tests&quot;" />
    <option name="_new_targetType" value="&quot;PATH&quot;" />
    <method v="2" />
  </configuration>
</component>

如您所见，有一个<envs>部分，其中ABC变量被设置为XXX 。 还要注意factoryName是py.test而不是你的Unittests ，这是一种不同类型的运行配置。

当您在编辑器中单击测试 function 旁边的绿色箭头时，要为每个自动创建的运行配置自动设置环境变量，您需要做两件事：

1. 确保Preferences -> Tools -> Python Integrated Tools -> Testing -> Default test runner设置为pytest 。
2. 在Edit configurations... -> Edit configuration templates... -> Python tests -> pytest -> Environment variables设置你想要的所有环境变量。

但是，我意识到您正在使用EnvFile插件，这可能会使我上面所写的内容完全无效，这些内容演示了内置的 PyCharm 功能。 如果您想测试我的示例，我建议您暂时禁用该插件。

Answer 2

出色地...

tmt 是正确的——我真正需要做的就是在“运行”>“编辑配置”中乱搞几分钟。

关键是然后输入 go 和“编辑配置模板”。 为了确保，我将所需的环境变量添加到 Python、Python 测试/pytest 和 Python 测试/单元测试的模板中。

^THIS 没有立即起作用。 我必须拨打 go 并删除我第一次打开“运行”>“编辑配置”时出现的所有现有配置。

然后瞧——文件夹中的所有 pytests 脚本+模块开始获取所需的环境变量。

*附带说明，我认为 EnvFile 插件添加了

<ENTRY IS_ENABLED="true" PARSER="env" IS_EXECUTABLE="false" PATH="tests/unit/environment.env" />

ENTRIES 下的行，而不是直接在 .xml 中指定键/值（无论如何它都不起作用）