D6091: packaging: extract py2exe functionality to own module

indygreg (Gregory Szorc) phabricator at mercurial-scm.org
Thu Mar 7 19:50:18 EST 2019


indygreg created this revision.
Herald added subscribers: mercurial-devel, mjpieters.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  py2exe builds are shared between Inno Setup and WIX. We'll
  want the logic for performing py2exe builds to be reusable
  across the code for both installers.
  
  This commit extracts the py2exe-specific functionality into
  its own module.
  
  There's definitely room to customize things further. This will
  be done in future commits, as necessary. (I'm not even sure what
  customizations WIX will require yet. Presumably a lot.)

REPOSITORY
  rHG Mercurial

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

AFFECTED FILES
  contrib/packaging/hgpackaging/inno.py
  contrib/packaging/hgpackaging/py2exe.py
  tests/test-check-code.t

CHANGE DETAILS

diff --git a/tests/test-check-code.t b/tests/test-check-code.t
--- a/tests/test-check-code.t
+++ b/tests/test-check-code.t
@@ -14,6 +14,7 @@
   > | sed 's-\\-/-g' | "$check_code" --warnings --per-file=0 - || false
   Skipping contrib/packaging/hgpackaging/downloads.py it has no-che?k-code (glob)
   Skipping contrib/packaging/hgpackaging/inno.py it has no-che?k-code (glob)
+  Skipping contrib/packaging/hgpackaging/py2exe.py it has no-che?k-code (glob)
   Skipping contrib/packaging/hgpackaging/util.py it has no-che?k-code (glob)
   Skipping contrib/packaging/inno/build.py it has no-che?k-code (glob)
   Skipping i18n/polib.py it has no-che?k-code (glob)
diff --git a/contrib/packaging/hgpackaging/inno.py b/contrib/packaging/hgpackaging/py2exe.py
copy from contrib/packaging/hgpackaging/inno.py
copy to contrib/packaging/hgpackaging/py2exe.py
--- a/contrib/packaging/hgpackaging/inno.py
+++ b/contrib/packaging/hgpackaging/py2exe.py
@@ -1,4 +1,4 @@
-# inno.py - Inno Setup functionality.
+# py2exe.py - Functionality for performing py2exe builds.
 #
 # Copyright 2019 Gregory Szorc <gregory.szorc at gmail.com>
 #
@@ -9,34 +9,29 @@
 
 import os
 import pathlib
-import shutil
 import subprocess
 
 from .downloads import (
     download_entry,
 )
 from .util import (
     extract_tar_to_directory,
     extract_zip_to_directory,
-    find_vc_runtime_files,
     python_exe_info,
 )
 
 
-def build(source_dir: pathlib.Path, build_dir: pathlib.Path,
-          python_exe: pathlib.Path, iscc_exe: pathlib.Path,
-          version=None):
-    """Build the Inno installer.
+def build_py2exe(source_dir: pathlib.Path, build_dir: pathlib.Path,
+                 python_exe: pathlib.Path, build_name: str,
+                 venv_requirements_txt: pathlib.Path):
+    """Build Mercurial with py2exe.
 
     Build files will be placed in ``build_dir``.
 
     py2exe's setup.py doesn't use setuptools. It doesn't have modern logic
     for finding the Python 2.7 toolchain. So, we require the environment
     to already be configured with an active toolchain.
     """
-    if not iscc_exe.exists():
-        raise Exception('%s does not exist' % iscc_exe)
-
     if 'VCINSTALLDIR' not in os.environ:
         raise Exception('not running from a Visual C++ build environment; '
                         'execute the "Visual C++ <version> Command Prompt" '
@@ -67,7 +62,8 @@
     virtualenv_pkg, virtualenv_entry = download_entry('virtualenv', build_dir)
     py2exe_pkg, py2exe_entry = download_entry('py2exe', build_dir)
 
-    venv_path = build_dir / ('venv-inno-%s' % ('x64' if vc_x64 else 'x86'))
+    venv_path = build_dir / ('venv-%s-%s' % (build_name,
+                                             'x64' if vc_x64 else 'x86'))
 
     gettext_root = build_dir / (
         'gettext-win-%s' % gettext_entry['version'])
@@ -98,9 +94,7 @@
     venv_python = venv_path / 'Scripts' / 'python.exe'
     venv_pip = venv_path / 'Scripts' / 'pip.exe'
 
-    requirements_txt = (source_dir / 'contrib' / 'packaging' /
-                        'inno' / 'requirements.txt')
-    subprocess.run([str(venv_pip), 'install', '-r', str(requirements_txt)],
+    subprocess.run([str(venv_pip), 'install', '-r', str(venv_requirements_txt)],
                    check=True)
 
     # Force distutils to use VC++ settings from environment, which was
@@ -129,30 +123,3 @@
         cwd=str(source_dir),
         env=env,
         check=True)
-
-    # hg.exe depends on VC9 runtime DLLs. Copy those into place.
-    for f in find_vc_runtime_files(vc_x64):
-        if f.name.endswith('.manifest'):
-            basename = 'Microsoft.VC90.CRT.manifest'
-        else:
-            basename = f.name
-
-        dest_path = source_dir / 'dist' / basename
-
-        print('copying %s to %s' % (f, dest_path))
-        shutil.copyfile(f, dest_path)
-
-    print('creating installer')
-
-    args = [str(iscc_exe)]
-
-    if vc_x64:
-        args.append('/dARCH=x64')
-
-    if version:
-        args.append('/dVERSION=%s' % version)
-
-    args.append('/Odist')
-    args.append('contrib/packaging/inno/mercurial.iss')
-
-    subprocess.run(args, cwd=str(source_dir), check=True)
diff --git a/contrib/packaging/hgpackaging/inno.py b/contrib/packaging/hgpackaging/inno.py
--- a/contrib/packaging/hgpackaging/inno.py
+++ b/contrib/packaging/hgpackaging/inno.py
@@ -12,14 +12,11 @@
 import shutil
 import subprocess
 
-from .downloads import (
-    download_entry,
+from .py2exe import (
+    build_py2exe,
 )
 from .util import (
-    extract_tar_to_directory,
-    extract_zip_to_directory,
     find_vc_runtime_files,
-    python_exe_info,
 )
 
 
@@ -37,98 +34,13 @@
     if not iscc_exe.exists():
         raise Exception('%s does not exist' % iscc_exe)
 
-    if 'VCINSTALLDIR' not in os.environ:
-        raise Exception('not running from a Visual C++ build environment; '
-                        'execute the "Visual C++ <version> Command Prompt" '
-                        'application shortcut or a vcsvarsall.bat file')
-
-    # Identity x86/x64 and validate the environment matches the Python
-    # architecture.
-    vc_x64 = r'\x64' in os.environ['LIB']
-
-    py_info = python_exe_info(python_exe)
-
-    if vc_x64:
-        if py_info['arch'] != '64bit':
-            raise Exception('architecture mismatch: Visual C++ environment '
-                            'is configured for 64-bit but Python is 32-bit')
-    else:
-        if py_info['arch'] != '32bit':
-            raise Exception('architecture mismatch: Visual C++ environment '
-                            'is configured for 32-bit but Python is 64-bit')
-
-    if py_info['py3']:
-        raise Exception('Only Python 2 is currently supported')
-
-    build_dir.mkdir(exist_ok=True)
-
-    gettext_pkg, gettext_entry = download_entry('gettext', build_dir)
-    gettext_dep_pkg = download_entry('gettext-dep', build_dir)[0]
-    virtualenv_pkg, virtualenv_entry = download_entry('virtualenv', build_dir)
-    py2exe_pkg, py2exe_entry = download_entry('py2exe', build_dir)
-
-    venv_path = build_dir / ('venv-inno-%s' % ('x64' if vc_x64 else 'x86'))
-
-    gettext_root = build_dir / (
-        'gettext-win-%s' % gettext_entry['version'])
-
-    if not gettext_root.exists():
-        extract_zip_to_directory(gettext_pkg, gettext_root)
-        extract_zip_to_directory(gettext_dep_pkg, gettext_root)
-
-    # This assumes Python 2. We don't need virtualenv on Python 3.
-    virtualenv_src_path = build_dir / (
-        'virtualenv-%s' % virtualenv_entry['version'])
-    virtualenv_py = virtualenv_src_path / 'virtualenv.py'
-
-    if not virtualenv_src_path.exists():
-        extract_tar_to_directory(virtualenv_pkg, build_dir)
-
-    py2exe_source_path = build_dir / ('py2exe-%s' % py2exe_entry['version'])
-
-    if not py2exe_source_path.exists():
-        extract_zip_to_directory(py2exe_pkg, build_dir)
-
-    if not venv_path.exists():
-        print('creating virtualenv with dependencies')
-        subprocess.run(
-            [str(python_exe), str(virtualenv_py), str(venv_path)],
-            check=True)
-
-    venv_python = venv_path / 'Scripts' / 'python.exe'
-    venv_pip = venv_path / 'Scripts' / 'pip.exe'
+    vc_x64 = r'\x64' in os.environ.get('LIB', '')
 
     requirements_txt = (source_dir / 'contrib' / 'packaging' /
                         'inno' / 'requirements.txt')
-    subprocess.run([str(venv_pip), 'install', '-r', str(requirements_txt)],
-                   check=True)
 
-    # Force distutils to use VC++ settings from environment, which was
-    # validated above.
-    env = dict(os.environ)
-    env['DISTUTILS_USE_SDK'] = '1'
-    env['MSSdk'] = '1'
-
-    py2exe_py_path = venv_path / 'Lib' / 'site-packages' / 'py2exe'
-    if not py2exe_py_path.exists():
-        print('building py2exe')
-        subprocess.run([str(venv_python), 'setup.py', 'install'],
-                       cwd=py2exe_source_path,
-                       env=env,
-                       check=True)
-
-    # Register location of msgfmt and other binaries.
-    env['PATH'] = '%s%s%s' % (
-        env['PATH'], os.pathsep, str(gettext_root / 'bin'))
-
-    print('building Mercurial')
-    subprocess.run(
-        [str(venv_python), 'setup.py',
-         'py2exe', '-b', '3' if vc_x64 else '2',
-         'build_doc', '--html'],
-        cwd=str(source_dir),
-        env=env,
-        check=True)
+    build_py2exe(source_dir, build_dir, python_exe, 'inno',
+                 requirements_txt)
 
     # hg.exe depends on VC9 runtime DLLs. Copy those into place.
     for f in find_vc_runtime_files(vc_x64):



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


More information about the Mercurial-devel mailing list