env: make pip/setuptools/wheel configurable

This change introduces the following configuration options:

- `virtualenvs.options.no-pip` (Default: `false`)
- `virtualenvs.options.no-wheel` (Default: `false`)
- `virtualenvs.options.no-setuptools` (Default: `false`)

With these options, we allow, the user to control the inclusion of
`pip`, `wheel` and `setuptools` packages in new virtual environments.
The defaults used retain existing behaviour as of `1.1.5`.

In addition the following now holds true.

- projects can define `pip`, `wheel` and `setuptools` as dependencies
- if any of these packages are in the project's dependency tree, poetry
  will manage their versions
- all poetry internal commands will use pip embedded in virtualenv
  irrespective of pip beig available in the environment
- if `poetry run pip` is executed, pip installed in the virtualenv will
  be prioritsed
- `poetry install --remove-untracked` will ignore these packages if
  they are not present in the project's dependency tree

Relates-to: python-poetry#2826
Relates-to: python-poetry#3916

poetry/config/config.py

@@ -33,7 +33,13 @@ class Config:
             "create": True,
             "in-project": None,
             "path": os.path.join("{cache-dir}", "virtualenvs"),
-            "options": {"always-copy": False, "system-site-packages": False},
+            "options": {
+                "always-copy": False,
+                "system-site-packages": False,
+                "no-pip": False,
+                "no-setuptools": False,
+                "no-wheel": False,
+            },
         },
         "experimental": {"new-installer": True},
         "installer": {"parallel": True},
@@ -139,6 +145,9 @@ def _get_normalizer(self, name: str) -> Callable:
             "virtualenvs.in-project",
             "virtualenvs.options.always-copy",
             "virtualenvs.options.system-site-packages",
+            "virtualenvs.options.no-pip",
+            "virtualenvs.options.no-wheel",
+            "virtualenvs.options.no-setuptools",
             "installer.parallel",
         }:
             return boolean_normalizer

poetry/console/commands/config.py

@@ -72,6 +72,21 @@ def unique_config_values(self) -> Dict[str, Tuple[Any, Any, Any]]:
                 boolean_normalizer,
                 False,
             ),
+            "virtualenvs.options.no-pip": (
+                boolean_validator,
+                boolean_normalizer,
+                False,
+            ),
+            "virtualenvs.options.no-setuptools": (
+                boolean_validator,
+                boolean_normalizer,
+                False,
+            ),
+            "virtualenvs.options.no-wheel": (
+                boolean_validator,
+                boolean_normalizer,
+                False,
+            ),
             "virtualenvs.path": (
                 str,
                 lambda val: str(Path(val)),

poetry/console/commands/debug/resolve.py

@@ -84,7 +84,14 @@ def handle(self) -> Optional[int]:
 
         pool = self.poetry.pool
 
-        solver = Solver(package, pool, Repository(), Repository(), self._io)
+        solver = Solver(
+            package,
+            pool,
+            Repository(),
+            Repository(),
+            self._io,
+            config=self.poetry.config,
+        )
 
         ops = solver.solve()
 
@@ -121,7 +128,9 @@ def handle(self) -> Optional[int]:
 
             pool.add_repository(locked_repository)
 
-            solver = Solver(package, pool, Repository(), Repository(), NullIO())
+            solver = Solver(
+                package, pool, Repository(), Repository(), NullIO(), poetry=self.poetry
+            )
             with solver.use_environment(env):
                 ops = solver.solve()
 

poetry/console/commands/show.py

@@ -90,6 +90,7 @@ def handle(self) -> Optional[int]:
             installed=Repository(),
             locked=locked_repo,
             io=NullIO(),
+            config=self.poetry.config,
         )
         solver.provider.load_deferred(False)
         with solver.use_environment(self.env):

poetry/installation/installer.py

@@ -74,6 +74,7 @@ def __init__(
             installed = self._get_installed()
 
         self._installed_repository = installed
+        self._poetry_config = config
 
     @property
     def executor(self) -> Executor:
@@ -209,6 +210,7 @@ def _do_refresh(self) -> int:
             locked_repository,
             locked_repository,
             self._io,
+            config=self._poetry_config,
         )
 
         ops = solver.solve(use_latest=[])
@@ -247,6 +249,7 @@ def _do_install(self, local_repo: Repository) -> int:
                 locked_repository,
                 self._io,
                 remove_untracked=self._remove_untracked,
+                config=self._poetry_config,
             )
 
             ops = solver.solve(use_latest=self._whitelist)
@@ -316,6 +319,7 @@ def _do_install(self, local_repo: Repository) -> int:
             locked_repository,
             NullIO(),
             remove_untracked=self._remove_untracked,
+            config=self._poetry_config,
         )
         # Everything is resolved at this point, so we no longer need
         # to load deferred dependencies (i.e. VCS, URL and path dependencies)

poetry/puzzle/solver.py

@@ -31,6 +31,7 @@
 
 
 if TYPE_CHECKING:
+    from poetry.config.config import Config
     from poetry.core.packages.dependency import Dependency
     from poetry.core.packages.directory_dependency import DirectoryDependency
     from poetry.core.packages.file_dependency import FileDependency
@@ -49,6 +50,7 @@ def __init__(
         io: IO,
         remove_untracked: bool = False,
         provider: Optional[Provider] = None,
+        config: Optional["Config"] = None,
     ):
         self._package = package
         self._pool = pool
@@ -63,10 +65,30 @@ def __init__(
         self._overrides = []
         self._remove_untracked = remove_untracked
 
+        self._poetry_config = config
+        self._preserved_package_names = None
+
     @property
     def provider(self) -> Provider:
         return self._provider
 
+    @property
+    def preserved_package_names(self):
+        if self._preserved_package_names is None:
+            self._preserved_package_names = {
+                self._package.name,
+                *Provider.UNSAFE_PACKAGES,
+            }
+            if self._poetry_config is not None:
+                deps = {package.name for package in self._locked.packages}
+
+                for name in {"pip", "wheel", "setuptools"}:
+                    if not self._poetry_config.get(f"virtualenvs.options.no-{name}"):
+                        if name not in deps:
+                            self._preserved_package_names.add(name)
+
+        return self._preserved_package_names
+
     @contextmanager
     def use_environment(self, env: Env) -> None:
         with self.provider.use_environment(env):
@@ -190,11 +212,9 @@ def solve(self, use_latest: List[str] = None) -> List["OperationTypes"]:
             locked_names = {locked.name for locked in self._locked.packages}
 
             for installed in self._installed.packages:
-                if installed.name == self._package.name:
-                    continue
-                if installed.name in Provider.UNSAFE_PACKAGES:
-                    # Never remove pip, setuptools etc.
+                if installed.name in self.preserved_package_names:
                     continue
+
                 if installed.name not in locked_names:
                     operations.append(Uninstall(installed))
 

poetry/utils/env.py

@@ -933,6 +933,12 @@ def build_venv(
     ) -> virtualenv.run.session.Session:
         flags = flags or {}
 
+        if flags:
+            # if flags are present and explicit parameters are false, use flag values
+            with_pip = with_pip or not flags.pop("no-pip", True)
+            with_setuptools = with_setuptools or not flags.pop("no-setuptools", True)
+            with_wheel = with_wheel or not flags.pop("no-wheel", True)
+
         if isinstance(executable, Path):
             executable = executable.resolve().as_posix()
 
@@ -1039,6 +1045,8 @@ def __init__(self, path: Path, base: Optional[Path] = None) -> None:
         self._platlib = None
         self._script_dirs = None
 
+        self._embedded_pip_path = None
+
     @property
     def path(self) -> Path:
         return self._path
@@ -1074,6 +1082,12 @@ def get_embedded_wheel(self, distribution):
             distribution, "{}.{}".format(self.version_info[0], self.version_info[1])
         ).path
 
+    @property
+    def pip_embedded(self) -> str:
+        if self._embedded_pip_path is None:
+            self._embedded_pip_path = str(self.get_embedded_wheel("pip") / "pip")
+        return self._embedded_pip_path
+
     @property
     def pip(self) -> str:
         """
@@ -1082,7 +1096,7 @@ def pip(self) -> str:
         # we do not use as_posix() here due to issues with windows pathlib2 implementation
         path = self._bin("pip")
         if not Path(path).exists():
-            return str(self.get_embedded_wheel("pip") / "pip")
+            return str(self.pip_embedded)
         return path
 
     @property
@@ -1187,7 +1201,7 @@ def get_python_implementation(self) -> str:
     def get_marker_env(self) -> Dict[str, Any]:
         raise NotImplementedError()
 
-    def get_pip_command(self) -> List[str]:
+    def get_pip_command(self, embedded: bool = False) -> List[str]:
         raise NotImplementedError()
 
     def get_supported_tags(self) -> List[Tag]:
@@ -1208,16 +1222,20 @@ def is_sane(self) -> bool:
         """
         return True
 
-    def run(self, bin: str, *args: str, **kwargs: Any) -> Union[str, int]:
+    def get_command_from_bin(self, bin: str) -> List[str]:
         if bin == "pip":
-            return self.run_pip(*args, **kwargs)
+            # when pip is required we need to ensure that we fallback to
+            # embedded pip when pip is not available in the environment
+            return self.get_pip_command()
 
-        bin = self._bin(bin)
-        cmd = [bin] + list(args)
+        return [self._bin(bin)]
+
+    def run(self, bin: str, *args: str, **kwargs: Any) -> Union[str, int]:
+        cmd = self.get_command_from_bin(bin) + list(args)
         return self._run(cmd, **kwargs)
 
     def run_pip(self, *args: str, **kwargs: Any) -> Union[int, str]:
-        pip = self.get_pip_command()
+        pip = self.get_pip_command(embedded=True)
         cmd = pip + list(args)
         return self._run(cmd, **kwargs)
 
@@ -1259,17 +1277,13 @@ def _run(self, cmd: List[str], **kwargs: Any) -> Union[int, str]:
         return decode(output)
 
     def execute(self, bin: str, *args: str, **kwargs: Any) -> Optional[int]:
-        if bin == "pip":
-            return self.run_pip(*args, **kwargs)
-
-        bin = self._bin(bin)
+        command = self.get_command_from_bin(bin) + list(args)
         env = kwargs.pop("env", {k: v for k, v in os.environ.items()})
 
         if not self._is_windows:
-            args = [bin] + list(args)
-            return os.execvpe(bin, args, env=env)
+            return os.execvpe(command[0], command, env=env)
         else:
-            exe = subprocess.Popen([bin] + list(args), env=env, **kwargs)
+            exe = subprocess.Popen([command[0]] + command[1:], env=env, **kwargs)
             exe.communicate()
             return exe.returncode
 
@@ -1337,10 +1351,10 @@ def get_version_info(self) -> Tuple[int]:
     def get_python_implementation(self) -> str:
         return platform.python_implementation()
 
-    def get_pip_command(self) -> List[str]:
+    def get_pip_command(self, embedded: bool = False) -> List[str]:
         # If we're not in a venv, assume the interpreter we're running on
         # has a pip and use that
-        return [sys.executable, self.pip]
+        return [sys.executable, self.pip_embedded if embedded else self.pip]
 
     def get_paths(self) -> Dict[str, str]:
         # We can't use sysconfig.get_paths() because
@@ -1444,10 +1458,10 @@ def get_version_info(self) -> Tuple[int]:
     def get_python_implementation(self) -> str:
         return self.marker_env["platform_python_implementation"]
 
-    def get_pip_command(self) -> List[str]:
+    def get_pip_command(self, embedded: bool = False) -> List[str]:
         # We're in a virtualenv that is known to be sane,
         # so assume that we have a functional pip
-        return [self._bin("python"), self.pip]
+        return [self._bin("python"), self.pip_embedded if embedded else self.pip]
 
     def get_supported_tags(self) -> List[Tag]:
         file_path = Path(packaging.tags.__file__)
@@ -1559,8 +1573,8 @@ def __init__(
         self._execute = execute
         self.executed = []
 
-    def get_pip_command(self) -> List[str]:
-        return [self._bin("python"), self.pip]
+    def get_pip_command(self, embedded: bool = False) -> List[str]:
+        return [self._bin("python"), self.pip_embedded if embedded else self.pip]
 
     def _run(self, cmd: List[str], **kwargs: Any) -> int:
         self.executed.append(cmd)

poetry/utils/pip.py

@@ -53,7 +53,7 @@ def pip_install(
                 executable=environment.python, with_pip=True, with_setuptools=True
             ) as env:
                 return environment.run(
-                    env._bin("pip"),
+                    *env.get_pip_command(),
                     *args,
                     env={**os.environ, "PYTHONPATH": str(env.purelib)},
                 )

tests/console/commands/env/test_use.py

@@ -54,7 +54,13 @@ def test_activate_activates_non_existing_virtualenv_no_envs_file(
     mock_build_env.assert_called_with(
         venv_py37,
         executable="python3.7",
-        flags={"always-copy": False, "system-site-packages": False},
+        flags={
+            "always-copy": False,
+            "system-site-packages": False,
+            "no-pip": False,
+            "no-wheel": False,
+            "no-setuptools": False,
+        },
     )
 
     envs_file = TOMLFile(venv_cache / "envs.toml")

tests/console/commands/test_config.py

@@ -32,6 +32,9 @@ def test_list_displays_default_value_if_not_set(tester, config, config_cache_dir
 virtualenvs.create = true
 virtualenvs.in-project = null
 virtualenvs.options.always-copy = false
+virtualenvs.options.no-pip = false
+virtualenvs.options.no-setuptools = false
+virtualenvs.options.no-wheel = false
 virtualenvs.options.system-site-packages = false
 virtualenvs.path = {path}  # {virtualenvs}
 """.format(
@@ -54,6 +57,9 @@ def test_list_displays_set_get_setting(tester, config, config_cache_dir):
 virtualenvs.create = false
 virtualenvs.in-project = null
 virtualenvs.options.always-copy = false
+virtualenvs.options.no-pip = false
+virtualenvs.options.no-setuptools = false
+virtualenvs.options.no-wheel = false
 virtualenvs.options.system-site-packages = false
 virtualenvs.path = {path}  # {virtualenvs}
 """.format(
@@ -98,6 +104,9 @@ def test_list_displays_set_get_local_setting(tester, config, config_cache_dir):
 virtualenvs.create = false
 virtualenvs.in-project = null
 virtualenvs.options.always-copy = false
+virtualenvs.options.no-pip = false
+virtualenvs.options.no-setuptools = false
+virtualenvs.options.no-wheel = false
 virtualenvs.options.system-site-packages = false
 virtualenvs.path = {path}  # {virtualenvs}
 """.format(

tests/inspection/test_info.py

@@ -217,7 +217,7 @@ def test_info_setup_missing_mandatory_should_trigger_pep517(
     except PackageInfoError:
         assert spy.call_count == 3
     else:
-        assert spy.call_count == 1
+        assert spy.call_count == 2
 
 
 def test_info_prefer_poetry_config_over_egg_info():