cli/env: handle removal of in-project venv

Resolves: python-poetry#2124

docs/managing-environments.md

@@ -160,3 +160,12 @@ poetry env remove --all
 ```
 
 If you remove the currently activated virtual environment, it will be automatically deactivated.
+
+{{% note %}}
+If you use the [`virtualenvs.in-project`]({{< relref "configuration#virtualenvsin-project" >}}) configuration, you
+can simply use the command as shown below.
+
+```bash
+poetry env remove
+```
+{{% /note %}}

src/poetry/console/commands/env/remove.py

@@ -7,6 +7,7 @@
 from cleo.helpers import option
 
 from poetry.console.commands.command import Command
+from poetry.utils._compat import is_relative_to
 
 
 if TYPE_CHECKING:
@@ -39,24 +40,30 @@ class EnvRemoveCommand(Command):
  def handle(self) -> int:
  from poetry.utils.env import EnvManager
 
+ is_in_project = self.poetry.config.get("virtualenvs.in-project")
+
  pythons = self.argument("python")
- all = self.option("all")
- if not (pythons or all):
+ remove_all_envs = self.option("all")
+
+ if not (pythons or remove_all_envs or is_in_project):
  self.line("No virtualenv provided.")
 
  manager = EnvManager(self.poetry)
  # TODO: refactor env.py to allow removal with one loop
  for python in pythons:
  venv = manager.remove(python)
  self.line(f"Deleted virtualenv: <comment>{venv.path}</comment>")
- if all:
+ if remove_all_envs or is_in_project:
  for venv in manager.list():
- manager.remove_venv(venv.path)
- self.line(f"Deleted virtualenv: <comment>{venv.path}</comment>")
+ if not is_in_project or is_relative_to(
+ venv.path, self.poetry.pyproject_path.parent
+ ):
+ manager.remove_venv(venv.path)
+ self.line(f"Deleted virtualenv: <comment>{venv.path}</comment>")
  # Since we remove all the virtualenvs, we can also remove the entry
  # in the envs file. (Strictly speaking, we should do this explicitly,
  # in case it points to a virtualenv that had been removed manually before.)
- if manager.envs_file.exists():
+ if remove_all_envs and manager.envs_file.exists():
  manager.envs_file.remove_section(manager.base_env_name)
 
  return 0

src/poetry/utils/_compat.py

@@ -3,6 +3,11 @@
 import sys
 
 from contextlib import suppress
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+ from pathlib import Path
 
 
 # TODO: use try/except ImportError when
@@ -50,10 +55,18 @@ def encode(string: str, encodings: list[str] | None = None) -> bytes:
  return string.encode(encodings[0], errors="ignore")
 
 
+def is_relative_to(this: Path, other: Path) -> bool:
+ with suppress(ValueError):
+ this.relative_to(other)
+ return True
+ return False
+
+
 __all__ = [
  "WINDOWS",
  "decode",
  "encode",
  "metadata",
  "tomllib",
+ "is_relative_to",
 ]

tests/console/commands/env/conftest.py

@@ -65,7 +65,8 @@ def venvs_in_project_dir(app: PoetryTestApplication) -> Iterator[Path]:
  try:
  yield venv_dir
  finally:
- venv_dir.rmdir()
+ if venv_dir.exists():
+ venv_dir.rmdir()
 
 
 @pytest.fixture

tests/console/commands/env/test_remove.py

@@ -137,3 +137,27 @@ def test_remove_multiple(
  for name in remaining_envs:
  assert (venv_cache / name).exists()
  assert set(tester.io.fetch_output().split("\n")) == expected
+
+
+def test_remove_in_project(tester: CommandTester, venvs_in_project_dir: Path) -> None:
+ assert venvs_in_project_dir.exists()
+
+ tester.execute()
+
+ assert not venvs_in_project_dir.exists()
+
+ expected = f"Deleted virtualenv: {venvs_in_project_dir}\n"
+ assert tester.io.fetch_output() == expected
+
+
+def test_remove_in_project_all(
+ tester: CommandTester, venvs_in_project_dir: Path
+) -> None:
+ assert venvs_in_project_dir.exists()
+
+ tester.execute("--all")
+
+ assert not venvs_in_project_dir.exists()
+
+ expected = f"Deleted virtualenv: {venvs_in_project_dir}\n"
+ assert tester.io.fetch_output() == expected