Add uninstall subcommand #112

marcoesters · 2024-11-13T00:21:57Z

Description

Uninstalling distributions for conda currently only has incomplete solutions with files and broken auto-run/initializer scripts left behind (see conda/constructor#642, conda/constructor#588, and conda/constructor#572). A clean uninstallation is currently not available without manually running a series of commands that are still not 100% safe - e.g., conda init --reverse --all will remove initialization of conda, no matter what installation it is pointed to.

This PR introduces a cross-platform uninstallation subcommand that uses conda-internal features to perform the following tasks:

Uninstall all environments within a base environment or environments directory (such as a directory set by envs_dirs). This uninstalls all shortcuts, performs pre-unlink actions, and de-registers the environments from the environments.txt file.
Runs conda init reverse if a configuration file points to any of the environments that are removed.
Allows a user to remove .condarc files, either for the user, system-wide, or all.
Allows the user to run conda clean --all to remove package caches outside the installation directory.
Allows the user to remove cache directories, including the .conda file.

This is implemented in conda-standalone so that a single binary can be used on macOS and Linux. It also allows decoupling of the installer "front end" (built by constructor) from the installer "back end" (such as conda-standalone or micromamba), as outlined in the following issue: conda/constructor#549

Known gap: Soft links are currently not well supported: files are unlinked, but no efforts are made to ensure that this doesn't leave unused files behind.

Checklist - did you ...

Add a file to the news directory (using the template) for the next release's release notes?
Add / update necessary tests?
Add / update outdated documentation?

…llation

…the same as prefix

src/entry_point.py

jaimergp · 2024-11-19T18:35:33Z

src/entry_point.py

@@ -110,7 +116,7 @@ def __call__(self, parser, namespace, values, option_string=None):
        f"Defaults to {DEFAULT_NUM_PROCESSORS}.",
    )

-    g = p.add_mutually_exclusive_group(required=True)
+    g = p.add_mutually_exclusive_group()


We'd need to add checks to make this required manually if uninstall is not in the ARGV. Maybe an else clause in _constructor_main() (line 602, I think?).

I added that into the same function and created tests to check.

jaimergp · 2024-11-19T18:40:46Z

src/entry_point.py

+    # See: https://github.com/conda/conda/blob/475e6acbdc98122fcbef4733eb8cb8689324c1c8/conda/gateways/disk/create.py#L482-L488 # noqa
+    ENVS_DIR_MAGIC_FILE = ".conda_envs_dir_test"
+
+    uninstall_prefix = Path(uninstall_dir).expanduser().resolve()


Do we need to os.path.expandvars too or is that not expected?

Good call. I added it to where we parse args.prefix.

jaimergp · 2024-11-19T18:44:17Z

src/entry_point.py

+            _remove_file_directory(parent)
+            parent = parent.parent
+
+    def _remove_config_file_and_parents(file: Path):


There's precedent for users not liking this default behaviour, see conda/conda#13113. Not sure if we should delete empty parents recursively 🤔 Maybe just the config-containing one? Happy to have my mind changed here, though, so let me know.

That's what I was intending with rootdir, but it was still a little too aggressive. I changed the selection of which directories to remove. The only thing that might be controversial is the ~/.config directory. I think it's okay to delete if empty. I would at least argue that we should delete it on Windows where configs are stored in different places.

src/entry_point.py

jaimergp · 2024-11-19T18:47:14Z

src/entry_point.py

+        run_plan(plan)
+        run_plan_elevated(plan)


Hm, these functions do not raise errors? They just write to plan?

As far as I know, that's correct. There doesn't seem to be a "failed" state in the Results enum either.

I am printing the plan results at least so that users can check if they don't see the results they expect.

jaimergp · 2024-11-19T18:49:12Z

src/entry_point.py

+                continue
+            expected_files = [pkgs_dir / "urls", pkgs_dir / "urls.txt"]
+            if all(file in expected_files for file in pkgs_dir.iterdir()):
+                _remove_file_and_parents(pkgs_dir)


Same here about parents (and elsewhere), I don't think we need to recursively remove all parents.

I can get on board for the package cache, but for the binstar directory and the notices cache, we should remove the parents:

The anaconda-client token is either in a $BINSTAR_TOKEN_DIR/data or a binstar/ContinuumIO (Windows) or binstart directory and is created by conda via anaconda-client. I think we can remove the binstar directories at least. To be honest, the best solution would be to make anaconda-client a plug-in handle that directory when running conda remove. Right now, however, conda is the API that's creating that directory, so I decided to handle it here.

The notices cache is written into a specific conda cache directory, so we will not remove a user-created directory. Unfortunately, the subdirectories are different for Windows and Unix, but they are all called conda. So, I changed it to _remove_config_file_and_parents here.

jaimergp · 2024-11-19T18:50:58Z

README.md

+> This can cause files to be left behind.
+
+> [!WARNING]
+> Support for softlinks is still limited.


Can you elaborate? Are errors expected, or undefined behavior?

We only unlink softlinks and do not do anything with the underlying files. I made that more explicit.

jaimergp · 2024-11-19T18:54:32Z

src/entry_point.py

+        ),
+    )
+    uninstall_subcommand.add_argument(
+        "--remove-caches",


Suggested change

"--remove-caches",

"--remove-additional-caches",

The term is a bit convoluted with pkgs/ and pkgs/cache being taken care of in conda-clean, but this argument targets ~/.conda and anaconda-client stuff.

Yes, unfortunately, conda overloads the term "cache". I changed it to --remove-conda-caches because it's more descriptive than --remove-additional-caches.

src/entry_point.py

marcoesters added 30 commits September 26, 2024 11:00

Add uninstall subcommand.

90fadd4

Add support for removing environment directories

7a4d162

Create _is_subdir function

b4e7eb3

Specify which .condarc files to remove

ac8e86f

Clean parent directories of config files

1526e7e

Rename ambiguous --clean to --conda-clean

db47628

Add doc strings

a30ba13

Clarify use of user and home in --remove-condarcs

562b4a1

Use target path to detect Windows reg keys

5ab526b

Improve HKEY handling

2449882

Do not support environment directories (menuinst may cause problems

a70059e

Run menuinst separately from conda remove

b81fd1a

Add support for environments directories

4d1a801

Determine base prefix for menuinst

526cafc

Use CONDA_ROOT_PREFIX instead of MENUINST_BASE_PREFIX

93bc961

Merge branch 'main' of github.com:conda/conda-standalone into uninsta…

b8b1b51

…llation

Change homedir to Path.home()

ca69e06

Replace deprecated native_path_to_unix with win_path_to_unix

5548c81

Remove empty parent directories of pkgs_dirs and cache directories

70caa8f

Consolidate parent removal functions

dc88b7b

Add tests

9161f57

Fix sentinel string for csh and tcsh

023612f

Remove pkgs directory when only urls files are present

736fa6d

Check that parent directories are removed for init reverse tests

2684f52

Merge branch 'main' of github.com:conda/conda-standalone into uninsta…

dba344e

…llation

Unset CONDA_ROOT_PREFIX during environment removal is root prefix is …

74b22e2

…the same as prefix

Pre-create directories for menuinst on Windows

0201b2c

Force mocking user cache directory

0deff77

Skip LongPathsEnabled registry key

6ee8519

Add conda to recipe test requirements

ecef02a

marcoesters added 11 commits November 18, 2024 09:17

Use removeprefix

f75a5ec

Check for directory before checking for file/symlink

ef04ccf

Ensure that ON_CI=False for CI="0"

c817c49

Patch HOMEDRIVE and HOMEPATH

e5550e5

Use conda environment fixtures

43dfc51

Add test_uninstallation_keep_config_dir

03d3973

Set MENUINST_BASE_PREFIX for menuinst test

07f55ff

Simplify _is_subdir function

2426e49

Warn about limited softlink support

75f64fe

Do not resolve paths in _remove_config_file_and_parents

cdd46cc

Do not use conda fixtures for menuinst tests

91f6fb1

marcoesters requested a review from jaimergp November 19, 2024 17:55

jaimergp reviewed Nov 19, 2024

View reviewed changes

src/entry_point.py Outdated Show resolved Hide resolved

jaimergp reviewed Nov 19, 2024

View reviewed changes

src/entry_point.py Show resolved Hide resolved

jaimergp reviewed Nov 19, 2024

View reviewed changes

src/entry_point.py Outdated Show resolved Hide resolved

marcoesters added 6 commits November 19, 2024 12:12

Elaborate on lack of symlink support.

9a6221a

Rename --remove-caches to --remove-conda-caches

8647a1b

Expand variables for args.prefix

457f11e

Ensure that mutually exclusive group is required without a subcommand

f45c70c

Clarify how --prefix is enforced

496992d

Remove empty parents only when created by conda

ab47b6c

marcoesters requested a review from jaimergp November 19, 2024 23:57

Return earlier when removing parents of config files

16b13c6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add uninstall subcommand #112

Add uninstall subcommand #112

marcoesters commented Nov 13, 2024 •

edited

Loading

jaimergp Nov 19, 2024 •

edited

Loading

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

jaimergp Nov 19, 2024

marcoesters Nov 19, 2024

Add uninstall subcommand #112

Are you sure you want to change the base?

Add uninstall subcommand #112

Conversation

marcoesters commented Nov 13, 2024 • edited Loading

Description

Checklist - did you ...

jaimergp Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoesters commented Nov 13, 2024 •

edited

Loading

jaimergp Nov 19, 2024 •

edited

Loading