Switch to invoke

Author: xavfernandez

pip/_vendor/README.rst

@@ -16,7 +16,7 @@ Policy
 
 * Any modifications made to libraries **MUST** be noted in
   ``pip/_vendor/README.rst`` and **MUST** be automatically applied via
-  ``tasks/re-vendor.py``.
+  ``tasks/vendoring.py``.
 
 
 Rationale
@@ -108,9 +108,9 @@ Modifications
 Automatic Vendoring
 -------------------
 
-Vendoring is automated via ``tasks/re-vendor.py`` from the content of
+Vendoring is automated via ``tasks/vendoring.py`` from the content of
 ``pip/_vendor/vendor.txt``. Special cases adaptation MUST be reported in the
-``tasks/re-vendor.py`` file.
+``tasks/vendoring.py`` file. Launch it via ``invoke vendoring.update``.
 
 
 Debundling

tasks/__init__.py

@@ -1,5 +1,6 @@
 import invoke
 
 from . import generate
+from . import vendoring
 
-ns = invoke.Collection(generate)
+ns = invoke.Collection(generate, vendoring)

tasks/generate.py

@@ -4,12 +4,12 @@
 
 
 @invoke.task
-def authors():
+def authors(ctx):
     print("[generate.authors] Generating AUTHORS")
 
     # Get our list of authors
     print("[generate.authors] Collecting author names")
-    r = invoke.run("git log --use-mailmap --format'=%aN <%aE>'", hide=True)
+    r = ctx.run("git log --use-mailmap --format'=%aN <%aE>'", hide=True)
     authors = []
     seen_authors = set()
     for author in r.stdout.splitlines():

tasks/re-vendor.py renamed to tasks/vendoring.py

@@ -3,10 +3,10 @@
 from pathlib import Path
 import re
 import shutil
-import subprocess
 
-import pip
+import invoke
 
+TASK_NAME = 'update'
 
 FILE_WHITE_LIST = (
     'Makefile',
@@ -104,14 +104,21 @@ def remove_all(paths):
             path.unlink()
 
 
-def clean_vendor(vendor_dir):
+def log(msg):
+    print('[vendoring.%s] %s' % (TASK_NAME, msg))
+
+
+def clean_vendor(ctx, vendor_dir):
     # Old _vendor cleanup
     remove_all(vendor_dir.glob('*.pyc'))
+    log('Cleaning %s' % vendor_dir)
     for item in vendor_dir.iterdir():
         if item.is_dir():
             shutil.rmtree(str(item))
         elif item.name not in FILE_WHITE_LIST:
             item.unlink()
+        else:
+            log('Skipping %s' % item)
 
 
 def rewrite_imports(package_dir, vendored_libs):
@@ -156,13 +163,13 @@ def apply_special_cases(vendor_dir, special_cases):
         patched_file.write_text(text)
 
 
-def vendor(vendor_dir):
-    pip.main([
-        'install',
-        '-t', str(vendor_dir),
-        '-r', str(vendor_dir / 'vendor.txt'),
-        '--no-compile',
-    ])
+def vendor(ctx, vendor_dir):
+    log('Reinstalling vendored libraries')
+    ctx.run(
+        'pip install -t {0} -r {0}/vendor.txt --no-compile'.format(
+            str(vendor_dir),
+        )
+    )
     remove_all(vendor_dir.glob('*.dist-info'))
     remove_all(vendor_dir.glob('*.egg-info'))
 
@@ -179,27 +186,28 @@ def vendor(vendor_dir):
             vendored_libs.append(item.name)
         elif item.name not in FILE_WHITE_LIST:
             vendored_libs.append(item.name[:-3])
-    print("Vendored lib: %s" % ", ".join(vendored_libs))
+    log("Detected vendored libraries: %s" % ", ".join(vendored_libs))
 
     # Global import rewrites
+    log("Rewriting all imports related to vendored libs")
     for item in vendor_dir.iterdir():
         if item.is_dir():
             rewrite_imports(item, vendored_libs)
         elif item.name not in FILE_WHITE_LIST:
             rewrite_file_imports(item, vendored_libs)
 
     # Special cases
+    log("Dealing with special cases")
     apply_special_cases(vendor_dir, SPECIAL_CASES)
 
 
-def main():
-    git_root = Path(subprocess.check_output(
-        ['git', 'rev-parse', '--show-toplevel']
-    ).decode().strip())
+@invoke.task(name=TASK_NAME)
+def main(ctx):
+    git_root = Path(
+        ctx.run('git rev-parse --show-toplevel', hide=True).stdout.strip()
+    )
     vendor_dir = git_root / 'pip' / '_vendor'
-    clean_vendor(vendor_dir)
-    vendor(vendor_dir)
-
-
-if __name__ == '__main__':
-    main()
+    log('Using vendor dir: %s' % vendor_dir)
+    clean_vendor(ctx, vendor_dir)
+    vendor(ctx, vendor_dir)
+    log('Revendoring complete')