Create environment using venv or conda

package.json

@@ -271,6 +271,11 @@
                 "command": "python.createTerminal",
                 "title": "%python.command.python.createTerminal.title%"
             },
+            {
+                "category": "Python",
+                "command": "python.createEnvironment",
+                "title": "%python.command.python.createEnvironment.title%"
+            },
             {
                 "category": "Python",
                 "command": "python.enableLinting",
@@ -1540,6 +1545,12 @@
                     "title": "%python.command.python.configureTests.title%",
                     "when": "!virtualWorkspace && shellExecutionSupported"
                 },
+                {
+                    "category": "Python",
+                    "command": "python.createEnvironment",
+                    "title": "%python.command.python.createEnvironment.title%",
+                    "when": "!virtualWorkspace && shellExecutionSupported"
+                },
                 {
                     "category": "Python",
                     "command": "python.createTerminal",

package.nls.json

@@ -1,6 +1,7 @@
 {
     "python.command.python.sortImports.title": "Sort Imports",
     "python.command.python.startREPL.title": "Start REPL",
+    "python.command.python.createEnvironment.title": "Create Environment",
     "python.command.python.createTerminal.title": "Create Terminal",
     "python.command.python.execInTerminal.title": "Run Python File in Terminal",
     "python.command.python.debugInTerminal.title": "Debug Python File",
@@ -24,15 +25,15 @@
     "python.command.python.launchTensorBoard.title": "Launch TensorBoard",
     "python.command.python.refreshTensorBoard.title": "Refresh TensorBoard",
     "python.menu.createNewFile.title": "Python File",
-    "python.autoComplete.extraPaths.description":"List of paths to libraries and the like that need to be imported by auto complete engine. E.g. when using Google App SDK, the paths are not in system path, hence need to be added into this list.",
+    "python.autoComplete.extraPaths.description": "List of paths to libraries and the like that need to be imported by auto complete engine. E.g. when using Google App SDK, the paths are not in system path, hence need to be added into this list.",
     "python.condaPath.description": "Path to the conda executable to use for activation (version 4.4+).",
     "python.defaultInterpreterPath.description": "Path to default Python to use when extension loads up for the first time, no longer used once an interpreter is selected for the workspace. See https://aka.ms/AAfekmf to understand when this is used",
     "python.diagnostics.sourceMapsEnabled.description": "Enable source map support for meaningful stack traces in error logs.",
     "python.envFile.description": "Absolute path to a file containing environment variable definitions.",
     "python.experiments.enabled.description": "Enables A/B tests experiments in the Python extension. If enabled, you may get included in proposed enhancements and/or features.",
     "python.experiments.optInto.description": "List of experiment to opt into. If empty, user is assigned the default experiment groups. See https://github.com/microsoft/vscode-python/wiki/Experiments for more details.",
     "python.experiments.optOutFrom.description": "List of experiment to opt out of. If empty, user is assigned the default experiment groups. See https://github.com/microsoft/vscode-python/wiki/Experiments for more details.",
-    "python.formatting.autopep8Args.description":"Arguments passed in. Each argument is a separate item in the array.",
+    "python.formatting.autopep8Args.description": "Arguments passed in. Each argument is a separate item in the array.",
     "python.formatting.autopep8Path.description": "Path to autopep8, you can use a custom version of autopep8 by modifying this setting to include the full path.",
     "python.formatting.blackArgs.description": "Arguments passed in. Each argument is a separate item in the array.",
     "python.formatting.blackPath.description": "Path to Black, you can use a custom version of Black by modifying this setting to include the full path.",

pythonFiles/create_conda.py

@@ -0,0 +1,128 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import argparse
+import os
+import pathlib
+import subprocess
+import sys
+from typing import Optional, Sequence, Union
+
+CONDA_ENV_NAME = ".conda"
+CWD = pathlib.PurePath(os.getcwd())
+
+
+class VenvError(Exception):
+    pass
+
+
+def parse_args(argv: Sequence[str]) -> argparse.Namespace:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--python",
+        action="store",
+        help="Python version to install in the virtual environment.",
+        default=f"{sys.version_info.major}.{sys.version_info.minor}",
+    )
+    parser.add_argument(
+        "--install",
+        action="store_true",
+        default=False,
+        help="Install packages into the virtual environment.",
+    )
+    parser.add_argument(
+        "--git-ignore",
+        action="store_true",
+        default=False,
+        help="Add .gitignore to the newly created virtual environment.",
+    )
+    parser.add_argument(
+        "--name",
+        default=CONDA_ENV_NAME,
+        type=str,
+        help="Name of the virtual environment.",
+        metavar="NAME",
+        action="store",
+    )
+    return parser.parse_args(argv)
+
+
+def file_exists(path: Union[str, pathlib.PurePath]) -> bool:
+    return os.path.exists(path)
+
+
+def conda_env_exists(name: Union[str, pathlib.PurePath]) -> bool:
+    return os.path.exists(CWD / name)
+
+
+def run_process(args: Sequence[str], error_message: str) -> None:
+    try:
+        print("Running: " + " ".join(args))
+        subprocess.run(args, cwd=os.getcwd(), check=True)
+    except subprocess.CalledProcessError:
+        raise VenvError(error_message)
+
+
+def get_conda_env_path(name: str) -> str:
+    return os.fspath(CWD / name)
+
+
+def install_packages(env_path: str) -> None:
+    yml = os.fspath(CWD / "environment.yml")
+    if file_exists(yml):
+        print(f"CONDA_INSTALLING_YML: {yml}")
+        run_process(
+            [
+                sys.executable,
+                "-m",
+                "conda",
+                "env",
+                "update",
+                "--prefix",
+                env_path,
+                "--file",
+                yml,
+            ],
+            "CREATE_CONDA.FAILED_INSTALL_YML",
+        )
+
+
+def add_gitignore(name: str) -> None:
+    git_ignore = os.fspath(CWD / name / ".gitignore")
+    if not file_exists(git_ignore):
+        print(f"Creating: {git_ignore}")
+        with open(git_ignore, "w") as f:
+            f.write("*")
+
+
+def main(argv: Optional[Sequence[str]] = None) -> None:
+    if argv is None:
+        argv = []
+    args = parse_args(argv)
+
+    if not conda_env_exists(args.name):
+        run_process(
+            [
+                sys.executable,
+                "-m",
+                "conda",
+                "create",
+                "--yes",
+                "--prefix",
+                args.name,
+                f"python={args.python}",
+            ],
+            "CREATE_CONDA.ENV_FAILED_CREATION",
+        )
+        if args.git_ignore:
+            add_gitignore(args.name)
+
+    env_path = get_conda_env_path(args.name)
+    print(f"CREATED_CONDA_ENV:{env_path}")
+
+    if args.install:
+        install_packages(env_path)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

pythonFiles/create_venv.py

@@ -0,0 +1,130 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import argparse
+import importlib.util as import_util
+import os
+import pathlib
+import subprocess
+import sys
+from typing import Optional, Sequence, Union
+
+VENV_NAME = ".venv"
+CWD = pathlib.PurePath(os.getcwd())
+
+
+class VenvError(Exception):
+    pass
+
+
+def parse_args(argv: Sequence[str]) -> argparse.Namespace:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--install",
+        action="store_true",
+        default=False,
+        help="Install packages into the virtual environment.",
+    )
+    parser.add_argument(
+        "--git-ignore",
+        action="store_true",
+        default=False,
+        help="Add .gitignore to the newly created virtual environment.",
+    )
+    parser.add_argument(
+        "--name",
+        default=VENV_NAME,
+        type=str,
+        help="Name of the virtual environment.",
+        metavar="NAME",
+        action="store",
+    )
+    return parser.parse_args(argv)
+
+
+def is_installed(module: str) -> bool:
+    return import_util.find_spec(module) is not None
+
+
+def file_exists(path: Union[str, pathlib.PurePath]) -> bool:
+    return os.path.exists(path)
+
+
+def venv_exists(name: str) -> bool:
+    return os.path.exists(CWD / name)
+
+
+def run_process(args: Sequence[str], error_message: str) -> None:
+    try:
+        print("Running: " + " ".join(args))
+        subprocess.run(args, cwd=os.getcwd(), check=True)
+    except subprocess.CalledProcessError:
+        raise VenvError(error_message)
+
+
+def get_venv_path(name: str) -> str:
+    # See `venv` doc here for more details on binary location:
+    # https://docs.python.org/3/library/venv.html#creating-virtual-environments
+    if sys.platform == "win32":
+        return os.fspath(CWD / name / "Scripts" / "python.exe")
+    else:
+        return os.fspath(CWD / name / "bin" / "python")
+
+
+def install_packages(venv_path: str) -> None:
+    if not is_installed("pip"):
+        raise VenvError("CREATE_VENV.PIP_NOT_FOUND")
+
+    requirements = os.fspath(CWD / "requirements.txt")
+    pyproject = os.fspath(CWD / "pyproject.toml")
+
+    run_process(
+        [venv_path, "-m", "pip", "install", "--upgrade", "pip"],
+        "CREATE_VENV.PIP_UPGRADE_FAILED",
+    )
+
+    if file_exists(requirements):
+        print(f"VENV_INSTALLING_REQUIREMENTS: {requirements}")
+        run_process(
+            [venv_path, "-m", "pip", "install", "-r", requirements],
+            "CREATE_VENV.PIP_FAILED_INSTALL_REQUIREMENTS",
+        )
+    elif file_exists(pyproject):
+        print(f"VENV_INSTALLING_PYPROJECT: {pyproject}")
+        run_process(
+            [venv_path, "-m", "pip", "install", "-e", ".[extras]"],
+            "CREATE_VENV.PIP_FAILED_INSTALL_PYPROJECT",
+        )
+
+
+def add_gitignore(name: str) -> None:
+    git_ignore = CWD / name / ".gitignore"
+    if not file_exists(git_ignore):
+        print("Creating: " + os.fspath(git_ignore))
+        with open(git_ignore, "w") as f:
+            f.write("*")
+
+
+def main(argv: Optional[Sequence[str]] = None) -> None:
+    if argv is None:
+        argv = []
+    args = parse_args(argv)
+
+    if is_installed("venv"):
+        if not venv_exists(args.name):
+            run_process(
+                [sys.executable, "-m", "venv", args.name],
+                "CREATE_VENV.VENV_FAILED_CREATION",
+            )
+            if args.git_ignore:
+                add_gitignore(args.name)
+        venv_path = get_venv_path(args.name)
+        print(f"CREATED_VENV:{venv_path}")
+        if args.install:
+            install_packages(venv_path)
+    else:
+        raise VenvError("CREATE_VENV.VENV_NOT_FOUND")
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

pythonFiles/tests/test_create_conda.py

@@ -0,0 +1,72 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import importlib
+import sys
+
+import create_conda
+import pytest
+
+
+@pytest.mark.parametrize("env_exists", [True, False])
+@pytest.mark.parametrize("git_ignore", [True, False])
+@pytest.mark.parametrize("install", [True, False])
+@pytest.mark.parametrize("python", [True, False])
+def test_create_env(env_exists, git_ignore, install, python):
+    importlib.reload(create_conda)
+    create_conda.conda_env_exists = lambda _n: env_exists
+
+    install_packages_called = False
+
+    def install_packages(_name):
+        nonlocal install_packages_called
+        install_packages_called = True
+
+    create_conda.install_packages = install_packages
+
+    run_process_called = False
+
+    def run_process(args, error_message):
+        nonlocal run_process_called
+        run_process_called = True
+        version = (
+            "12345" if python else f"{sys.version_info.major}.{sys.version_info.minor}"
+        )
+        if not env_exists:
+            assert args == [
+                sys.executable,
+                "-m",
+                "conda",
+                "create",
+                "--yes",
+                "--prefix",
+                create_conda.CONDA_ENV_NAME,
+                f"python={version}",
+            ]
+            assert error_message == "CREATE_CONDA.ENV_FAILED_CREATION"
+
+    create_conda.run_process = run_process
+
+    add_gitignore_called = False
+
+    def add_gitignore(_name):
+        nonlocal add_gitignore_called
+        add_gitignore_called = True
+
+    create_conda.add_gitignore = add_gitignore
+
+    args = []
+    if git_ignore:
+        args.append("--git-ignore")
+    if install:
+        args.append("--install")
+    if python:
+        args.extend(["--python", "12345"])
+    create_conda.main(args)
+    assert install_packages_called == install
+
+    # run_process is called when the venv does not exist
+    assert run_process_called != env_exists
+
+    # add_gitignore is called when new venv is created and git_ignore is True
+    assert add_gitignore_called == (not env_exists and git_ignore)