Invalid python interpreter path: `/usr/local/bin/python`

[weikanglim]

When using ghcr.io/devcontainers/features/python:1, the devcontainer opens up with an invalid python interpreter path /usr/local/bin/python.

When attempting to debug you get this error:

After clicking "Select Python interpreter", it shows the invalid path and a detected path:

Ctrl + P -> Open Remote Settings (JSON) shows the following settings under ~/.vscode-server/data/Machine:

{
	"python.defaultInterpreterPath": "/usr/local/bin/python",
	"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
	"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
	"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
	"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
	"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
	"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
	"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
	"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
	"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
}

I was able to create a minimal repro in https://github.com/weikanglim/devcontainer-python. I have full devcontainer build logs if needed.

Originally from Azure/azure-dev#922

[jkeech]

joshspicer it looks like this is coming from https://github.com/devcontainers/features/blob/main/src/python/devcontainer-feature.json#L62-L73. The issue is that based on the options the user specifies (such as "version": "os-provided" or tweaking installPath), the Python install path can be different. But the devcontainer.json contributions, including the customizations.vscode block, are static.

I think we need something for features to be able to dynamically alter the devcontainer.json metadata that they contribute. Or at least for this feature, we need to make sure it always installs to the same path no matter which options are selected.

[weikanglim]

John Keech (@jkeech) FWIW the docs seem to suggest that "version": "os-provided" is the default setting when unspecified. I tried removing "version": "os-provided" explicitly, and saw the same behavior.

[Chuxel]

joshspicer it looks like this is coming from https://github.com/devcontainers/features/blob/main/src/python/devcontainer-feature.json#L62-L73. The issue is that based on the options the user specifies (such as "version": "os-provided" or tweaking installPath), the Python install path can be different. But the devcontainer.json contributions, including the customizations.vscode block, are static.

I think we need something for features to be able to dynamically alter the devcontainer.json metadata that they contribute. Or at least for this feature, we need to make sure it always installs to the same path no matter which options are selected.

When os-provided specified the feature could potentially create a symlink from /usr/local/bin/<foo> to /bin/<foo> for the known python commands to try to resolve this.

An even easier path would be to update the default install location to /usr/local/python, with /usr/local/python/bin added to the path. That way /usr/local/python could be symlinked to / for os-provided and customizations setting updated.

[Chuxel]

In fact - the current path is just plain wrong in many cases. The default path is /usr/local/python. The path is then updated to soemthing else that looks like got broken somewhere along the way. This is a bug.

[Chuxel]

Self-assigning... I see what is wrong and know how to fix it. I also see a test bug I'll fix at the same time.

[Chuxel]

This should be fixed in the latest released feature (1.0.11)