Cleaning up stale installed files in setup()

[jdemeyer]

This part of src/setup.py should be moved inside some distutils command:

#########################################################
### Clean
#########################################################

print('Cleaning up stale installed files....')
t = time.time()
from sage_setup.clean import clean_install_dir
output_dirs = SITE_PACKAGES + glob.glob(os.path.join(SAGE_SRC, 'build', 'lib*'))
for output_dir in output_dirs:
    print('- cleaning {0}'.format(output_dir))
    clean_install_dir(output_dir, python_packages, python_modules,
            ext_modules, python_data_files)
print('Finished cleaning, time: %.2f seconds.' % (time.time() - t))

Depends on #21480

CC: @mkoeppe

Component: build

Author: Jeroen Demeyer

Branch/Commit: 5ba95ed

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/21604

[jdemeyer]

Branch: u/jdemeyer/cleaning_up_stale_installed_files_in_setup__

[jdemeyer]

New commits:

274d8b3

Clean up stale installed files in install command

[jdemeyer]

Commit: 274d8b3

[mkoeppe]

comment:3

Could you add a few lines of comments to the patch that explain what "stale installed files" are?

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

e50f978

Add some documentation

[sagetrac-git]

Changed commit from 274d8b3 to e50f978

[jdemeyer]

Dependencies: #21580

[jdemeyer]

Changed dependencies from #21580 to #21480

[sagetrac-git]

Changed commit from e50f978 to 5ba95ed

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:

751bd0f	Reword TODO item
3a8cc0e	Fix typo in comment
0dd9c50	Respect environment variable MAKE
17f90d8	beautification
e5f9065	More comments
7791cd9	Remove --buildbase code
74169e7	Pass SAGE_SRC to generate_py_source.mk
0394333	Add new file to MANIFEST.in
fdedb02	Install SAGE_LOCAL/bin/sage instead of SAGE_ROOT/sage as Jupyter kernel
5ba95ed	Clean up stale installed files in install command

[jdemeyer]

comment:8

Rebased on top of #21480.

[mkoeppe]

Reviewer: Matthias Koeppe

[embray]

comment:10

As I wrote in #21600 this makes sense, but I think this should happen prior to any "build" command, not just at install time, since this is really an issue of keeping around a build/ dir from a previous build and expecting to be able to reuse it for a new build. I can appreciate the need for that, I would just move this step earlier, maybe even as a sub-command of build. If you don't mind, I can update this with what I have in mind.

[jdemeyer]

comment:11

Replying to @embray:

As I wrote in #21600 this makes sense, but I think this should happen prior to any "build" command, not just at install time, since this is really an issue of keeping around a build/ dir from a previous build and expecting to be able to reuse it for a new build. I can appreciate the need for that, I would just move this step earlier, maybe even as a sub-command of build. If you don't mind, I can update this with what I have in mind.

Couldn't this be done as follow-up ticket? Otherwise we will never make progress.

What you say makes sense, but the changes made in this ticket also make sense.

[mkoeppe]

comment:12

I agree with Jeroen.
This ticket is an important step, moving the "clean" part inside of setup. So, for example, setup.py --help no longer invokes cleaning.
A follow-up ticket (please make one) should disentangle the cleaning of the build directory and the cleaning of the install directory.

[mkoeppe]

comment:14

I've created the follow-up ticket at #21654.

[vbraun]

Changed branch from u/jdemeyer/cleaning_up_stale_installed_files_in_setup__ to 5ba95ed