Activity

1. ghost added

   triage-neededNeeds assignment to the proper sub-teamNeeds assignment to the proper sub-team

   on Jul 19, 2020
2. jamilraichouni commented on Jul 19, 2020

   

   Jamil RAICHOUNI (jamilraichouni)

   on Jul 19, 2020

   Last edited by jamilraichouni

   More actions

   Thanks!

   Title of issue

   Maybe I should have worded it like that and you may want to change the title of the current issue:

   „Provide the conda prefix in getExecutionDetails API when the execCommand belongs to a conda environment.“

   Example

   Something like

   getExecutionDetails()["execCommand"] = [
       "/path/to/conda/env/A/bin/python",
       "/path/to/conda/env/B/bin/python",
       "/path/to/system/python"
   ]
   getExecutionDetails()["condaPrefix"] = [
       "/path/to/conda/env/A",
       "/path/to/conda/env/B",
       null
   ]

   Use case

   There is a Code extension that maintains website favorites (many of them pointing
   to API references/ documentations for Python packages).

   Projects often work with different Python environments and Python package versions.
   Hence, depending on the selected

   • resource (document)
   • folder
   • workspace

   the URL to these Python package documentation websites must be adapted according to the currently selected Python
   interpreter.

   To do so all website favorites are maintained in a template JSON file.

   Cut-out example:

   [
       {
           "fallback_url": "https://numpy.org/doc/stable/user",
           "url": "https://numpy.org/doc/${MAJOR}.${MINOR}/user/",
           "pkg_name": "numpy",
           "title": "NumPy ${MAJOR}.${MINOR} (Documentation)"
       },
       {
           "fallback_url": "https://pandas.pydata.org/pandas-docs/stable/",
           "url": "https://pandas.pydata.org/pandas-docs/version/${MAJOR}.${MINOR}.${PATCH}/",
           "pkg_name": "pandas",
           "title": "pandas ${MAJOR}.${MINOR}.${PATCH} (Documentation)"
       }
   ]

   The extension knows some open website command offering all favorites in a
   quick pick UI in Code. When the open website command is run, the extension requests the current
   interpreter selection via the API of ms-python.python and calls some external
   Python tool.

   For that call the interpreter from execCommand cannot be used since this tool depends on several packages that are not always given in the selected environment. The interpreter selection in VS Code (execCommand) is passed as argument to that external tool and the tool needs to know the conda prefix but is itself not being run in the conda environment of interest.

   Here, the conda environment is not properly activated (env var CONDA_PREFIX is not set).

   The external Python tool needs to know the conda prefix of interest but is being run by some default conda interpreter.

   During runtime the tool can NOT check for sys.prefix or sys.executable to identify the conda prefix for the selected interpreter.

   The prefix is needed to request versions for all Python packages installed in that
   conda environment to populate the ${MAJOR}, ${MINOR}, and ${PATCH} placeholders
   in the URLs (see example listing above).

   When the processing/ filling of placeholders is completed, the quick pick UI is being shown.

   That way, the developer can always and very quick choose to open an API reference for any Python
   package version corresponding to the resource/ folder/ workspace he/ she is working on.

   I can imagine that this is just one out of multiple imaginable use cases.

   This is why I request that this additional information will be exposed by the API of the
   Python extension.
3. jamilraichouni commented on Jul 19, 2020

   

   Jamil RAICHOUNI (jamilraichouni)

   on Jul 19, 2020

   More actions

   I had to rephrase (detail) the use case (see paragraph with bold text above).
4. Karthik Nadig (karthiknadig)

   added

   feature-requestRequest for new features or functionalityRequest for new features or functionality

   needs decision

   on Jul 20, 2020
5. ghost removed

   triage-neededNeeds assignment to the proper sub-teamNeeds assignment to the proper sub-team

   on Jul 20, 2020
6. luabud commented on Sep 9, 2020

   

   Luciana Abud (luabud)

   on Sep 9, 2020

   Member

   More actions

   Thanks for the suggestion! We talked about it with the team and we have unfortunately decided we will not be moving forward with this idea. We think there isn't an enough widespread need for this to warrant the maintenance cost for the feature.
7. Luciana Abud (luabud)

   closed this as completedon Sep 9, 2020
8. ghost removed

   needs decision

   on Sep 9, 2020
9. jamilraichouni commented on Sep 9, 2020

   

   Jamil RAICHOUNI (jamilraichouni)

   on Sep 9, 2020

   More actions

   Alright, thanks that this has been considered in discussions!
10. github-actions

    locked as resolved and limited conversation to collaborators on Oct 8, 2021