在 vscode 中为 jupyter notebook 创建环境变量

Question

In vscode settings.json file I can use the following option to define environment variables:

"terminal.integrated.env.osx" : {
    "MY_ENV": "test"
    "MY_ENVTYPE": "qa"
}

Now whenever, I start a new shell in the workspace, the shell loads with the above environment variables, and I can access them typically with os.environ["MY_ENV"] is my python scripts.

But with the same settings.json , if I try to access the environment variables in a jupyter notebook I get None . So my question is, is there a way to define environment variables in vscode's settings.json file, so whenever I start a new notebook, the environment variables are loaded by default.

Currently the workaround I have found is to add the following code snippet in a top code cell.

import os
os.environ["MY_ENV"] = "test"
os.environ["MY_ENVTYPE"] = "qa"

I am hoping there is a better way to do the same.

Answer 1

We could use python-dotenv to solve this problem. Using "pip install python-dotenv" to install the package. To configure the development environment Please add.env file in the root directory of the project:

.
├── . env
└── test. py

Then we can use the following code to load environment:

%load_ext dotenv
%dotenv

Answer 2

I am using the following command in settings.json to setup environment variables which are specific to just jupyter notebook. Feels a bit hackish though.

Using jupyter.runStartupCommands , I am executing bunch of python commands to define environment variables and load jupyter extension. Note each command is separated by a newline character.

"jupyter.runStartupCommands": [
        "import os\nos.environ['MY_ENV']='mltest'\nos.environ['MY_ENVTYPE']='qa'\n%load_ext autoreload\n%autoreload 2"
    ]