D6189: py2exe: add workaround to allow bundling of hgext3rd.* extensions

[durin42 (Augie Fackler)]

durin42 created this revision.
durin42 added a reviewer: indygreg.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  py2exe doesn't know how to handle namespace packages *at all*, so it treats
  them like normal packages. As a result, if we try and bundle hgext3rd.evolve
  in a py2exe build, it won't work if we install evolve into the virtualenv. In
  order to work around this, tortoisehg installs hgext3rd.evolve etc into its
  staged hg directory, since it doesn't use a virtualenv. As a workaround for us,
  we'll just allow any extra packages users want bundled are part of hg during
  the pseudo-install phase that py2exe uses. I'm not happy about this, but it
  *works*.
  
  As a sample of how you'd make an MSI with evolve bundled:
  
    import os
    import shutil
    import subprocess
    import tempfile
    
    def stage_evolve(version):
      """Stage evolve for inclusion in py2exe binary."""
      with tempfile.TemporaryDirectory() as temp:
        evolve = os.path.join(temp, "evolve")
        subprocess.check_call([
            "hg.exe",
            "clone",
            "https://www.mercurial-scm.org/repo/evolve/",
            "--update",
            version,
            evolve,
        ])
        dest = os.path.join('..', 'hgext3rd', 'evolve')
        if os.path.exists(dest):
            shutil.rmtree(dest)
        shutil.copytree(os.path.join(evolve, "hgext3rd", "evolve"), dest)
    
    
    def main():
      stage_evolve('tip')
      print("\0")
      print("hgext3rd")
      print("hgext3rd.evolve")
      print("hgext3rd.evolve.hack")
      print("hgext3rd.evolve.thirdparty")
    
    
    if __name__ == "__main__":
      main()
  
  is a script you can pass to the wix/build.py as --extra-packages-script,
  and the resulting .msi will have an hg binary with evolve baked in. users
  will still need to enable evolve in their hgrc, so you'd probably also
  want to bundle configs in your msi for an enterprise environment, but that's
  already easy to do with the support for extra features and wxs files in the
  wix build process.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6189

AFFECTED FILES
  contrib/packaging/hgpackaging/py2exe.py
  setup.py

CHANGE DETAILS

diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -975,6 +975,12 @@
     packages.extend(['mercurial.thirdparty.concurrent',
                      'mercurial.thirdparty.concurrent.futures'])
 
+if 'HG_PY2EXE_EXTRA_INSTALL_PACKAGES' in os.environ:
+    # py2exe can't cope with namespace packages very well, so we have to
+    # install any hgext3rd.* extensions that we want in the final py2exe
+    # image here. This is gross, but you gotta do what you gotta do.
+    packages.extend(os.environ['HG_PY2EXE_EXTRA_INSTALL_PACKAGES'].split(' '))
+
 common_depends = ['mercurial/bitmanipulation.h',
                   'mercurial/compat.h',
                   'mercurial/cext/util.h']
diff --git a/contrib/packaging/hgpackaging/py2exe.py b/contrib/packaging/hgpackaging/py2exe.py
--- a/contrib/packaging/hgpackaging/py2exe.py
+++ b/contrib/packaging/hgpackaging/py2exe.py
@@ -118,6 +118,10 @@
 
     if extra_packages:
         env['HG_PY2EXE_EXTRA_PACKAGES'] = ' '.join(sorted(extra_packages))
+        hgext3rd_extras = sorted(
+            e for e in extra_packages if e.startswith('hgext3rd.'))
+        if hgext3rd_extras:
+            env['HG_PY2EXE_EXTRA_INSTALL_PACKAGES'] = ' '.join(hgext3rd_extras)
     if extra_excludes:
         env['HG_PY2EXE_EXTRA_EXCLUDES'] = ' '.join(sorted(extra_excludes))
     if extra_dll_excludes:



To: durin42, indygreg, #hg-reviewers
Cc: mercurial-devel