Python extension loads the env var incorrectly

[burakcank]

Type: Bug

Behaviour

When I launch a new terminal in vscode, my .env variables are incorrectly read.

Steps to reproduce:

1. Use the following env variable ORACLE_DB_CONN_STR=oracle+oracledb://user:password@(DESCRIPTION=(LOAD_BALANCE=on)(FAILOVER=ON)...)
2. When you launch a terminal you can see that it was read as ORACLE_DB_CONN_STR=oracle+oracledb://user:password@(DESCRIPTION
3. I tried to load the same env var with django-environ, python-dotenv and they are working fine if there is no auto-load from the python extension.
4. I tried escaping.
5. My app works totally fine when I disable auto-loading of env variables with "python.envFile": "", in my settings.json file.
6. When the env variable is exported incorrectly during the terminal launch, it's also causing my application to fail. Basically django-environ is reading the already incorrectly exported value.

launch.json configuration

{
  "editor.rulers": [
    100
  ],
  "editor.linkedEditing": true,
  "editor.codeActionsOnSave": {
    "source.organizeImports": "explicit"
  },
  "editor.unicodeHighlight.allowedLocales": {
    "tr": true
  },
  "files.insertFinalNewline": true,
  "explorer.confirmDragAndDrop": false,
  "explorer.confirmDelete": false,
  "terminal.integrated.defaultProfile.linux": "fish",
  "[oraclesql]": {
    "editor.suggest.showSnippets": true,
    "editor.quickSuggestions": {
      "comments": "on",
      "strings": "on",
      "other": "on"
    }
  },
  "github.copilot.editor.enableAutoCompletions": true,
  "mypy.runUsingActiveInterpreter": true,
  "debugpy.debugJustMyCode": false,
  "editor.formatOnSave": true,
  "[html]": {
    "editor.defaultFormatter": "monosans.djlint"
  },
  "[javascript]": {
    "editor.defaultFormatter": "biomejs.biome"
  },
  "python.envFile": "",
}

Extension version: 2024.10.0
VS Code version: Code 1.93.1 (38c31bc77e0dd6ae88a4e9cc93428cc27a56ba40, 2024-09-11T17:20:05.685Z)
OS version: Linux x64 6.10.10-arch1-1
Modes:

• Python version (& distribution if applicable, e.g. Anaconda): 3.12.6
• Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): VirtualEnvironment

System Info

Item	Value
CPUs	AMD Ryzen 7 5700X 8-Core Processor (16 x 3718)
GPU Status	2d_canvas: enabled canvas_oop_rasterization: enabled_on direct_rendering_display_compositor: disabled_off_ok gpu_compositing: enabled multiple_raster_threads: enabled_on opengl: enabled_on rasterization: enabled raw_draw: disabled_off_ok skia_graphite: disabled_off video_decode: enabled video_encode: disabled_software vulkan: disabled_off webgl: enabled webgl2: enabled webgpu: disabled_off webnn: disabled_off
Load (avg)	3, 2, 1
Memory (System)	15.54GB (3.96GB free)
Process Argv	Documents/global/global-middleware/ --crash-reporter-id 75bdb8ad-a1f1-4222-99ed-6b14720fe7f7
Screen Reader	no
VM	0%
DESKTOP_SESSION	plasma
XDG_CURRENT_DESKTOP	KDE
XDG_SESSION_DESKTOP	KDE
XDG_SESSION_TYPE	wayland

A/B Experiments

vsliv368:30146709
vspor879:30202332
vspor708:30202333
vspor363:30204092
vscod805:30301674
binariesv615:30325510
vsaa593:30376534
py29gd2263:31024239
c4g48928:30535728
azure-dev_surveyone:30548225
962ge761:30959799
pythongtdpath:30769146
welcomedialogc:30910334
pythonnoceb:30805159
asynctok:30898717
pythonmypyd1:30879173
2e7ec940:31000449
pythontbext0:30879054
accentitlementst:30995554
dsvsc016:30899300
dsvsc017:30899301
dsvsc018:30899302
cppperfnew:31000557
dsvsc020:30976470
pythonait:31006305
dsvsc021:30996838
da93g388:31013173
a69g1124:31058053
dvdeprecation:31068756
dwnewjupytercf:31046870
2f103344:31071589
impr_priority:31102340
nativerepl1:31139838
refactort:31108082
pythonrstrctxt:31112756
flighttreat:31134774
wkspc-onlycs-t:31132770
wkspc-ranged-c:31125598
cf971741:31144450
autoexpandse:31146404
iacca2:31144504
cc771715:31146322

[burakcank]

Oh wait, this might belong to the python extension repo instead of the debugger? Please let me know if that's the case.

[karthiknadig]

This issue is with this regex:

vscode-python/src/client/common/variables/environment.ts

Line 146 in 01e745d

const match = line.match(/^\s*(_*[a-zA-Z]\w*)\s*=\s*(.*?)?\s*$/);

This is also poor at handing comments.

[cipri-tom]

yes, this loads in-line comments as the variable, as reported here: theskumar/python-dotenv#515 (comment)

Can VSCode just use a well-established library for this rather than running your own? such as python-dotenv linked above

[karthiknadig]

@cipri-tom The extension in written in TypeScript, we need to read the .env file to launch the python process so we can't really use python-dotenv. In my comment above I have linked the exact location where the fault occurs. We are open to taking a PR for the fix. It might just be updating the regex there, that could address this, along with updating tests.

[cpinamtz]

At least using the env variable provided by @burakcank in the initial message, it is correctly parsed by the parseEnvFile function's regex:

Am I doing something wrong or maybe the issue is outdated? Most probably will be the first one cause last time the regex was modified was in this commit 3 years ago

[burakcank]

I've tried to reproduce the issue but looks like it's fixed. Removing the related setting from my settings.json and closing this issue as resolved for now. If anything else comes up, I'll open a new issue.