Trac #34490: sage --package clean command to remove outdated source tarballs

The `$SAGE_ROOT/upstream/` accumulates tarballs over the time. The
proposed `sage --package clean` command cleans that directory and keeps
only tarballs that are currently needed (i.e. only the versions
indicated in `$SAGE_ROOT/build/pkgs/*/package-version.txt` are kept).

URL: https://trac.sagemath.org/34490
Reported by: tmonteil
Ticket author(s): Thierry Monteil
Reviewer(s): David Coudert

Author: Release Manager

build/sage_bootstrap/app.py

@@ -1,6 +1,11 @@
 # -*- coding: utf-8 -*-
 """
 Controller for the commandline actions
+
+AUTHORS:
+
+    - Volker Braun (2016): initial version
+    - Thierry Monteil (2022): clean option to remove outdated source tarballs
 """
 
 
@@ -26,6 +31,7 @@
 from sage_bootstrap.pypi import PyPiVersion, PyPiNotFound, PyPiError
 from sage_bootstrap.fileserver import FileServer
 from sage_bootstrap.expand_class import PackageClass
+from sage_bootstrap.env import SAGE_DISTFILES
 
 
 class Application(object):
@@ -303,3 +309,23 @@ def create(self, package_name, version=None, tarball=None, pkg_type=None, upstre
             else:
                 update = ChecksumUpdater(package_name)
             update.fix_checksum()
+
+    def clean(self):
+        """
+        Remove outdated source tarballs from the upstream/ directory
+
+        $ sage --package clean
+        42 files were removed from the .../upstream directory
+        """
+        log.debug('Cleaning upstream/ directory')
+        package_names = PackageClass(':all:').names
+        keep = [Package(package_name).tarball.filename for package_name in package_names]
+        count = 0
+        for filename in os.listdir(SAGE_DISTFILES):
+            if filename not in keep:
+                filepath = os.path.join(SAGE_DISTFILES, filename)
+                if os.path.isfile(filepath):
+                    log.debug('Removing file {}'.format(filepath))
+                    os.remove(filepath)
+                    count += 1
+        print('{} files were removed from the {} directory'.format(count, SAGE_DISTFILES))

build/sage_bootstrap/cmdline.py

@@ -4,6 +4,11 @@
 
 This module handles the main "sage-package" commandline utility, which
 is also exposed as "sage --package".
+
+AUTHORS:
+
+    - Volker Braun (2016): initial version
+    - Thierry Monteil (2022): clean option to remove outdated source tarballs
 """
 
 # ****************************************************************************
@@ -174,6 +179,16 @@
     Creating new package "foo"
 """
 
+epilog_clean = \
+"""
+Remove outdated source tarballs from the upstream/ directory
+
+EXAMPLE:
+
+    $ sage --package clean
+    42 files were removed from the .../upstream directory
+"""
+
 
 def make_parser():
     """
@@ -316,6 +331,11 @@ def make_parser():
         '--pypi', action="store_true",
         help='Create a package for a Python package available on PyPI')
 
+    parser_clean = subparsers.add_parser(
+        'clean', epilog=epilog_clean,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        help='Remove outdated source tarballs from the upstream/ directory')
+
     return parser
 
 
@@ -356,6 +376,8 @@ def run():
         app.upload_cls(args.package_name)
     elif args.subcommand == 'fix-checksum':
         app.fix_checksum_cls(*args.package_class)
+    elif args.subcommand == 'clean':
+        app.clean()
     else:
         raise RuntimeError('unknown subcommand: {0}'.format(args))