vscode_pytest missing after launching VScode from the OSGeo4W console

[axelande]

Type: Bug

To develop QGIS Python plugin vscode does a good job, however when I would like to add some pytest and run them I get this error from the testing console:

Behaviour

Fails to detect any tests.

Steps to reproduce:

1. Start vscode from the osgeo4w shell and open the test adapter

Diagnostic data

Output for Python in the Output

panel 2024-04-06 09:05:26.530 [info] > C:/OSGeo4W/bin/python-qgis.bat -m pytest -p vscode_pytest --collect-only tests
2024-04-06 09:05:26.531 [info] cwd: .
2024-04-06 09:05:27.374 [error] Traceback (most recent call last):
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 856, in import_plugin
    __import__(importspec)
ModuleNotFoundError: No module named 'vscode_pytest'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "C:\OSGeo4W\apps\Python39\lib\runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\OSGeo4W\apps\Python39\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pytest\__main__.py", line 7, in <module>
    raise SystemExit(pytest.console_main())
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 197, in console_main
    code = main()
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 155, in main
    config = _prepareconfig(args, plugins)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 337, in _prepareconfig
    config = pluginmanager.hook.pytest_cmdline_parse(
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pluggy\_hooks.py", line 501, in __call__
    return self._hookexec(self.name, self._hookimpls.copy(), kwargs, firstresult)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pluggy\_manager.py", line 119, in _hookexec
    return self._inner_hookexec(hook_name, methods, kwargs, firstresult)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pluggy\_callers.py", line 138, in _multicall
    raise exception.with_traceback(exception.__traceback__)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pluggy\_callers.py", line 121, in _multicall
    teardown.throw(exception)  # type: ignore[union-attr]
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\helpconfig.py", line 105, in pytest_cmdline_parse
    config = yield
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\pluggy\_callers.py", line 102, in _multicall
    res = hook_impl.function(*args)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 1143, in pytest_cmdline_parse
    self.parse(args)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 1492, in parse
    self._preparse(args, addopts=addopts)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 1375, in _preparse
    self.pluginmanager.consider_preparse(args, exclude_only=False)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 785, in consider_preparse
    self.consider_pluginarg(parg)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 808, in consider_pluginarg
    self.import_plugin(arg, consider_entry_points=True)
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 858, in import_plugin
    raise ImportError(
  File "C:\OSGeo4W\apps\Python39\lib\site-packages\_pytest\config\__init__.py", line 856, in import_plugin
    __import__(importspec)
ImportError: Error importing plugin "vscode_pytest": No module named 'vscode_pytest'</summary>

Extension version: 2024.4.0
VS Code version: Code 1.88.0 (5c3e652f63e798a5ac2f31ffd0d863669328dc4c, 2024-04-03T13:26:18.741Z)
OS version: Windows_NT x64 10.0.22631
Modes:

• Python version (& distribution if applicable, e.g. Anaconda): 3.9.18
• Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): Global
• Value of the python.languageServer setting: Default

User Settings

languageServer: "Pylance"

testing
• pytestArgs: "<placeholder>"
• pytestEnabled: true

Installed Extensions

Extension Name	Extension Id	Version
JavaScript Debugger	ms-vscode.js-debug	1.88.0
JavaScript Debugger Companion Extension	ms-vscode.js-debug-companion	1.1.2
Pylance	ms-python.vscode-pylance	2024.4.1
Python	ms-python.python	2024.4.0
Python Debugger	ms-python.debugpy	2024.4.0
Python Test Explorer for Visual Studio Code	littlefoxteam.vscode-python-test-adapter	0.8.2
Table Visualizer for JavaScript Profiles	ms-vscode.vscode-js-profile-table	1.0.8
Test Adapter Converter	ms-vscode.test-adapter-converter	0.1.9
Test Explorer UI	hbenl.vscode-test-explorer	2.21.1

System Info

Item	Value
CPUs	13th Gen Intel(R) Core(TM) i7-1355U (12 x 2611)
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: enabled vulkan: disabled_off webgl: enabled webgl2: enabled webgpu: enabled
Load (avg)	undefined
Memory (System)	31.64GB (21.18GB free)
Process Argv	--crash-reporter-id c8aa341d-064e-42a2-ba59-692c4ab6f3e1
Screen Reader	no
VM	0%

[axelande]

To fix it temporary I added these lines to the import_plugin function in _pytest/config/__init__.py

if "C:\\Users\\[user]\\.vscode\\extensions\\ms-python.python-2024.4.1\\python_files" not in sys.path:
    sys.path.append("C:\\Users\\[user]\\.vscode\\extensions\\ms-python.python-2024.4.1\\python_files")

Now it works, but it does not seem like a sustainable fix ;)

[eleanorjboyd]

@karthiknadig, thoughts given the use of an external shell?

[karthiknadig]

@eleanorjboyd We are running with the libraries path added to the environment variables when we run this right? It seems odd that it does not get picked up.

[eleanorjboyd]

yes- we append it ourselves in the code below. We should print out the env vars, @axelande do you see that anywhere in your logs if you set them to trace (set to trace by using command palette "developer: set log level" command) and look in the python output channel?

        const relativePathToPytest = 'python_files';
        const fullPluginPath = path.join(EXTENSION_ROOT_DIR, relativePathToPytest);

        const mutableEnv = {
            ...(await this.envVarsService?.getEnvironmentVariables(uri)),
        };
        // get python path from mutable env, it contains process.env as well
        const pythonPathParts: string[] = mutableEnv.PYTHONPATH?.split(path.delimiter) ?? [];
        const pythonPathCommand = [fullPluginPath, ...pythonPathParts].join(path.delimiter);
        mutableEnv.PYTHONPATH = pythonPathCommand;
        traceInfo(`All environment variables set for pytest execution: ${JSON.stringify(mutableEnv)}`);

[axelande]

I changed the log level to traced and this is the output:

2024-04-18 19:59:36.983 [info] Experiment 'pythonRecommendTensorboardExt' is active
2024-04-18 19:59:36.983 [info] Experiment 'pythonREPLSmartSend' is active
2024-04-18 19:59:36.983 [info] Experiment 'pythonTerminalEnvVarActivation' is active
2024-04-18 19:59:36.983 [info] Experiment 'pythonTestAdapter' is active
2024-04-18 19:59:36.983 [info] Default formatter is set to null for workspace c:\dev\my_project
2024-04-18 19:59:36.983 [info] Test server listening.
2024-04-18 19:59:36.983 [info] Python interpreter path: C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 19:59:36.999 [info] > pyenv which python
2024-04-18 19:59:36.999 [info] cwd: .
2024-04-18 19:59:38.693 [info] Starting Pylance language server.
2024-04-18 20:00:13.665 [debug] Testing: Refreshing all test data
2024-04-18 20:00:13.666 [debug] Found cached env for C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 20:00:13.667 [info] Discover tests for workspace name: my_project - uri: c:\dev\my_project
2024-04-18 20:00:13.667 [info] Running discovery for pytest using the new test adapter.
2024-04-18 20:00:13.667 [info] All environment variables set for pytest discovery for workspace c:\dev\my_project: {"ALLUSERSPROFILE":"C:\\ProgramData","APPDATA":"C:\\Users\\User\\AppData\\Roaming","CHROME_CRASHPAD_PIPE_NAME":"\\\\.\\pipe\\crashpad_4680_IWTQUYBHKTZQZELC","COMPUTERNAME":"CompPC-UYYTNTD9","EFC_4732":"1","ELECTRON_RUN_AS_NODE":"1","FPS_BROWSER_APP_PROFILE_STRING":"Internet Explorer","FPS_BROWSER_USER_PROFILE_STRING":"Default","GDAL_DATA":"C:\\OSGeo4W\\apps\\gdal\\share\\gdal","GDAL_DRIVER_PATH":"C:\\OSGeo4W\\apps\\gdal\\lib\\gdalplugins","HOMEDRIVE":"C:","HOMEPATH":"\\Users\\User","LOCALAPPDATA":"C:\\Users\\User\\AppData\\Local","LOGONSERVER":"\\\\SRV-DC-1","NUMBER_OF_PROCESSORS":"12","O4W_QT_BINARIES":"C:/OSGeo4W/apps/Qt5/bin","O4W_QT_DOC":"C:/OSGeo4W/apps/Qt5/doc","O4W_QT_HEADERS":"C:/OSGeo4W/apps/Qt5/include","O4W_QT_LIBRARIES":"C:/OSGeo4W/apps/Qt5/lib","O4W_QT_PLUGINS":"C:/OSGeo4W/apps/Qt5/plugins","O4W_QT_PREFIX":"C:/OSGeo4W/apps/Qt5","O4W_QT_TRANSLATIONS":"C:/OSGeo4W/apps/Qt5/translations","OPENSSL_ENGINES":"C:\\OSGeo4W\\lib\\engines-3","ORIGINAL_XDG_CURRENT_DESKTOP":"undefined","OS":"Windows_NT","OSGEO4W_ROOT":"C:\\OSGeo4W","PATHEXT":".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC","PDAL_DRIVER_PATH":"C:\\OSGeo4W\\apps\\pdal\\plugins","PROCESSOR_ARCHITECTURE":"AMD64","PROCESSOR_IDENTIFIER":"Intel64 Family 6 Model 186 Stepping 3, GenuineIntel","PROCESSOR_LEVEL":"6","PROCESSOR_REVISION":"ba03","PROJ_LIB":"C:\\OSGeo4W\\share\\proj","PROMPT":"$P$G","PUBLIC":"C:\\Users\\Public","PYTHONHOME":"C:\\OSGeo4W\\apps\\Python312","PYTHONUTF8":"1","QT_PLUGIN_PATH":"C:\\OSGeo4W\\apps\\Qt5\\plugins","SESSIONNAME":"Console","SSL_CERT_DIR":"C:\\OSGeo4W\\apps\\openssl\\certs","SSL_CERT_FILE":"C:\\OSGeo4W\\bin\\curl-ca-bundle.crt","TEMP":"C:\\Users\\User\\AppData\\Local\\Temp","TMP":"C:\\Users\\User\\AppData\\Local\\Temp","UATDATA":"C:\\Windows\\CCM\\UATData\\D9F8C395-CAB8-491d-B8AC-179A1FE1BE77","USERDNSDOMAIN":"sp.se","USERDOMAIN":"SP","USERDOMAIN_ROAMINGPROFILE":"SP","USERNAME":"User","USERPROFILE":"C:\\Users\\User","VSCODE_AMD_ENTRYPOINT":"vs/workbench/api/node/extensionHostProcess","VSCODE_CODE_CACHE_PATH":"C:\\Users\\User\\AppData\\Roaming\\Code\\CachedData\\e170252f762678dec6ca2cc69aba1570769a5d39","VSCODE_CRASH_REPORTER_PROCESS_TYPE":"extensionHost","VSCODE_CWD":"C:\\OSGeo4W","VSCODE_HANDLES_UNCAUGHT_ERRORS":"true","VSCODE_IPC_HOOK":"\\\\.\\pipe\\498dadfd-1.88.1-main-sock","VSCODE_NLS_CONFIG":"{\"locale\":\"en-us\",\"osLocale\":\"en-se\",\"availableLanguages\":{},\"_languagePackSupport\":true}","VSCODE_PID":"4680","ChocolateyLastPathUpdate":"133520437829948508","ComSpec":"C:\\Windows\\system32\\cmd.exe","CommonProgramFiles":"C:\\Program Files\\Common Files","CommonProgramFiles(x86)":"C:\\Program Files (x86)\\Common Files","CommonProgramW6432":"C:\\Program Files\\Common Files","DriverData":"C:\\Windows\\System32\\Drivers\\DriverData","OneDrive":"C:\\Users\\User\\OneDrive - Comp","OneDriveCommercial":"C:\\Users\\User\\OneDrive - Comp","PSModulePath":"C:\\Program Files\\WindowsPowerShell\\Modules;C:\\Windows\\system32\\WindowsPowerShell\\v1.0\\Modules;C:\\Program Files\\MicrosoftManagedDesktop\\Powershell","ProgramData":"C:\\ProgramData","ProgramFiles":"C:\\Program Files","ProgramFiles(x86)":"C:\\Program Files (x86)","ProgramW6432":"C:\\Program Files","SystemDrive":"C:","SystemRoot":"C:\\Windows","__PSLockDownPolicy":"0","windir":"C:\\Windows","Path":"C:\\OSGeo4W\\apps\\qt5\\bin;C:\\OSGeo4W\\apps\\Python312\\Scripts;C:\\OSGeo4W\\bin;C:\\Windows\\system32;C:\\Windows;C:\\Windows\\system32\\WBem;C:\\Users\\User\\AppData\\Local\\Programs\\Microsoft VS Code;C:\\OSGeo4W\\apps\\Python312\\include;C:\\Users\\User\\.vscode\\extensions\\ms-python.python-2024.4.1\\python_files;C:\\OSGeo4W\\Scripts","PYTHONPATH":"c:\\Users\\User\\.vscode\\extensions\\ms-python.python-2024.4.1\\python_files;C:\\OSGeo4W\\apps\\qgis\\python;C:\\OSGeo4W\\apps\\qgis\\python\\plugins","TEST_UUID":"f8aa3c54-82dc-4153-847c-83343fa0e0a3","TEST_PORT":"64845"} 

2024-04-18 20:00:13.667 [debug] Found cached env for C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 20:00:13.756 [debug] Activation Commands received undefined for shell cmd, resource c:\dev\my_project and interpreter C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 20:00:13.770 [debug] Running pytest discovery with command: -m pytest -p vscode_pytest --collect-only tests for workspace c:\dev\my_project.
2024-04-18 20:00:13.770 [info] > C:/OSGeo4W/bin/python-qgis.bat -m pytest -p vscode_pytest --collect-only tests
2024-04-18 20:00:13.770 [info] cwd: .
2024-04-18 20:00:14.026 [error] Traceback (most recent call last):
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 856, in import_plugin
    __import__(importspec)
ModuleNotFoundError: No module named 'vscode_pytest'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pytest\__main__.py", line 7, in <module>
    raise SystemExit(pytest.console_main())
                     ^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 197, in console_main

2024-04-18 20:00:14.026 [error]     code = main()
           ^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 155, in main
    config = _prepareconfig(args, plugins)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 337, in _prepareconfig
    config = pluginmanager.hook.pytest_cmdline_parse(
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pluggy\_hooks.py", line 501, in __call__
    return self._hookexec(self.name, self._hookimpls.copy(), kwargs, firstresult)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pluggy\_manager.py", line 119, in _hookexec
    return self._inner_hookexec(hook_name, methods, kwargs, firstresult)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pluggy\_callers.py", line 138, in _multicall
    raise exception.with_traceback(exception.__traceback__)

2024-04-18 20:00:14.027 [error]   File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pluggy\_callers.py", line 121, in _multicall
    teardown.throw(exception)  # type: ignore[union-attr]
    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\helpconfig.py", line 105, in pytest_cmdline_parse

2024-04-18 20:00:14.027 [error]     config = yield
             ^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\pluggy\_callers.py", line 102, in _multicall
    res = hook_impl.function(*args)
 
2024-04-18 20:00:14.027 [error]          ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 1143, in pytest_cmdline_parse

2024-04-18 20:00:14.028 [error]     self.parse(args)
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 1492, in parse

2024-04-18 20:00:14.028 [error]     self._preparse(args, addopts=addopts)

2024-04-18 20:00:14.028 [error]   File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 1375, in _preparse

2024-04-18 20:00:14.029 [error]     self.pluginmanager.consider_preparse(args, exclude_only=False)

2024-04-18 20:00:14.029 [error]-   File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 785, in consider_preparse

2024-04-18 20:00:14.029 [error]     self.consider_pluginarg(parg)
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 808, in consider_pluginarg

2024-04-18 20:00:14.031 [error]     self.import_plugin(arg, consider_entry_points=True)
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 858, in import_plugin
    raise ImportError(
  File "C:\OSGeo4W\apps\Python312\Lib\site-packages\_pytest\config\__init__.py", line 856, in import_plugin
    __import__(importspec)
ImportError: Error importing plugin "vscode_pytest": No module named 'vscode_pytest'

2024-04-18 20:00:14.071 [error] Subprocess exited unsuccessfully with exit code 1 and signal null on workspace c:\dev\my_project.
2024-04-18 20:00:14.071 [error] Subprocess exited unsuccessfully with exit code 1 and signal null on workspace c:\dev\my_project. Creating and sending error discovery payload
2024-04-18 20:00:14.071 [error] pytest test discovery error for workspace:  c:\dev\my_project 
  
 The python test process was terminated before it could exit on its own, the process errored with: Code: 1, Signal: null for workspace c:\dev\my_project
2024-04-18 20:00:14.071 [info] ResultResolver EOT received for discovery.
2024-04-18 20:00:14.071 [debug] deferredTill EOT resolved for c:\dev\my_project
2024-04-18 20:00:14.071 [info] Disposing data receiver for c:\dev\my_project and deleting UUID; pytest discovery.
2024-04-18 20:00:17.226 [debug] Found cached env for C:\OSGeo4W\bin\python-qgis.bat

Is the "correct paths" overwritten between they are set and the pytest is called with:

2024-04-18 20:00:13.667 [debug] Found cached env for C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 20:00:13.756 [debug] Activation Commands received undefined for shell cmd, resource c:\dev\my_project and interpreter C:\OSGeo4W\bin\python-qgis.bat
2024-04-18 20:00:13.770 [debug] Running pytest discovery with command: -m pytest -p vscode_pytest --collect-only tests for workspace c:\dev\my_project.
2024-04-18 20:00:13.770 [info] > C:/OSGeo4W/bin/python-qgis.bat -m pytest -p vscode_pytest --collect-only tests

[axelande]

Problem solved!! For some reason I managed to set the interpreter to C:\OSGeo4W\bin\python-qgis.bat instead of interpreter C:\OSGeo4W\bin\python.exe.
C:\OSGeo4W\bin\python-qgis.bat <- ran Python but also sets paths so therefor the vscode_pytest failed.