This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6092

setup: configure py2exe config via environment variables
ClosedPublic

Authored by indygreg on Mar 8 2019, 1:49 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG260305e8ddbd: setup: configure py2exe config via environment variables
Summary

The Inno Setup and WiX installers ship a different set of packages
with py2exe builds. And there are multiple WiX installer variants
(e.g. TortoiseHG).

Since there are multiple variants of py2exe configs and they
can be defined by entities not in our repository, let's
provide a mechanism for setup.py to supplement behavior via
environment variables. This is slighly less hacky than a setup.cfg
file IMO since the caller doesn't need to worry about mutating
global state of the source directory.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Mar 8 2019, 1:49 PM
Closed by commit rHG260305e8ddbd: setup: configure py2exe config via environment variables (authored by indygreg). · Explain WhyMar 9 2019, 8:51 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 14447

contrib/packaging/hgpackaging/inno.py

from .py2exe import ( from .py2exe import (
build_py2exe, build_py2exe,
) )
from .util import ( from .util import (
find_vc_runtime_files, find_vc_runtime_files,
) )
EXTRA_PACKAGES = {
'dulwich',
'keyring',
'pygments',
'win32ctypes',
}
def build(source_dir: pathlib.Path, build_dir: pathlib.Path, def build(source_dir: pathlib.Path, build_dir: pathlib.Path,
python_exe: pathlib.Path, iscc_exe: pathlib.Path, python_exe: pathlib.Path, iscc_exe: pathlib.Path,
version=None): version=None):
"""Build the Inno installer. """Build the Inno installer.
Build files will be placed in ``build_dir``. Build files will be placed in ``build_dir``.
py2exe's setup.py doesn't use setuptools. It doesn't have modern logic 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 for finding the Python 2.7 toolchain. So, we require the environment
to already be configured with an active toolchain. to already be configured with an active toolchain.
""" """
if not iscc_exe.exists(): if not iscc_exe.exists():
raise Exception('%s does not exist' % iscc_exe) raise Exception('%s does not exist' % iscc_exe)
vc_x64 = r'\x64' in os.environ.get('LIB', '') vc_x64 = r'\x64' in os.environ.get('LIB', '')
requirements_txt = (source_dir / 'contrib' / 'packaging' / requirements_txt = (source_dir / 'contrib' / 'packaging' /
'inno' / 'requirements.txt') 'inno' / 'requirements.txt')
build_py2exe(source_dir, build_dir, python_exe, 'inno', build_py2exe(source_dir, build_dir, python_exe, 'inno',
requirements_txt) requirements_txt, extra_packages=EXTRA_PACKAGES)
# hg.exe depends on VC9 runtime DLLs. Copy those into place. # hg.exe depends on VC9 runtime DLLs. Copy those into place.
for f in find_vc_runtime_files(vc_x64): for f in find_vc_runtime_files(vc_x64):
if f.name.endswith('.manifest'): if f.name.endswith('.manifest'):
basename = 'Microsoft.VC90.CRT.manifest' basename = 'Microsoft.VC90.CRT.manifest'
else: else:
basename = f.name basename = f.name

contrib/packaging/hgpackaging/py2exe.py

extract_tar_to_directory, extract_tar_to_directory,
extract_zip_to_directory, extract_zip_to_directory,
python_exe_info, python_exe_info,
) )
def build_py2exe(source_dir: pathlib.Path, build_dir: pathlib.Path, def build_py2exe(source_dir: pathlib.Path, build_dir: pathlib.Path,
python_exe: pathlib.Path, build_name: str, python_exe: pathlib.Path, build_name: str,
venv_requirements_txt: pathlib.Path): venv_requirements_txt: pathlib.Path,
extra_packages=None, extra_excludes=None,
extra_dll_excludes=None):
"""Build Mercurial with py2exe. """Build Mercurial with py2exe.
Build files will be placed in ``build_dir``. Build files will be placed in ``build_dir``.
py2exe's setup.py doesn't use setuptools. It doesn't have modern logic 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 for finding the Python 2.7 toolchain. So, we require the environment
to already be configured with an active toolchain. to already be configured with an active toolchain.
""" """
check=True) check=True)
# Force distutils to use VC++ settings from environment, which was # Force distutils to use VC++ settings from environment, which was
# validated above. # validated above.
env = dict(os.environ) env = dict(os.environ)
env['DISTUTILS_USE_SDK'] = '1' env['DISTUTILS_USE_SDK'] = '1'
env['MSSdk'] = '1' env['MSSdk'] = '1'
if extra_packages:
env['HG_PY2EXE_EXTRA_PACKAGES'] = ' '.join(sorted(extra_packages))
if extra_excludes:
env['HG_PY2EXE_EXTRA_EXCLUDES'] = ' '.join(sorted(extra_excludes))
if extra_dll_excludes:
env['HG_PY2EXE_EXTRA_DLL_EXCLUDES'] = ' '.join(
sorted(extra_dll_excludes))
py2exe_py_path = venv_path / 'Lib' / 'site-packages' / 'py2exe' py2exe_py_path = venv_path / 'Lib' / 'site-packages' / 'py2exe'
if not py2exe_py_path.exists(): if not py2exe_py_path.exists():
print('building py2exe') print('building py2exe')
subprocess.run([str(venv_python), 'setup.py', 'install'], subprocess.run([str(venv_python), 'setup.py', 'install'],
cwd=py2exe_source_path, cwd=py2exe_source_path,
env=env, env=env,
check=True) check=True)

setup.py

'email', 'email',
# implicitly imported per module policy # implicitly imported per module policy
# (cffi wouldn't be used as a frozen exe) # (cffi wouldn't be used as a frozen exe)
'mercurial.cext', 'mercurial.cext',
#'mercurial.cffi', #'mercurial.cffi',
'mercurial.pure', 'mercurial.pure',
] ]
py2exeexcludes = []
py2exedllexcludes = []
if issetuptools: if issetuptools:
extra['python_requires'] = supportedpy extra['python_requires'] = supportedpy
if py2exeloaded: if py2exeloaded:
extra['console'] = [ extra['console'] = [
{'script':'hg', {'script':'hg',
'copyright':'Copyright (C) 2005-2019 Matt Mackall and others', 'copyright':'Copyright (C) 2005-2019 Matt Mackall and others',
'product_version':version}] 'product_version':version}]
# sub command of 'build' because 'py2exe' does not handle sub_commands # sub command of 'build' because 'py2exe' does not handle sub_commands
build.sub_commands.insert(0, ('build_hgextindex', None)) build.sub_commands.insert(0, ('build_hgextindex', None))
# put dlls in sub directory so that they won't pollute PATH # put dlls in sub directory so that they won't pollute PATH
extra['zipfile'] = 'lib/library.zip' extra['zipfile'] = 'lib/library.zip'
try: # We allow some configuration to be supplemented via environment
import dulwich # variables. This is better than setup.cfg files because it allows
dulwich.__version__ # supplementing configs instead of replacing them.
py2exepackages.append('dulwich') extrapackages = os.environ.get('HG_PY2EXE_EXTRA_PACKAGES')
except ImportError: if extrapackages:
pass py2exepackages.extend(extrapackages.split(' '))
try: excludes = os.environ.get('HG_PY2EXE_EXTRA_EXCLUDES')
import keyring if excludes:
keyring.util py2exeexcludes.extend(excludes.split(' '))
py2exepackages.append('keyring')
except ImportError: dllexcludes = os.environ.get('HG_PY2EXE_EXTRA_DLL_EXCLUDES')
pass if dllexcludes:
py2exedllexcludes.extend(dllexcludes.split(' '))
try:
import pygments
pygments.__version__
py2exepackages.append('pygments')
except ImportError:
pass
try:
import win32ctypes
win32ctypes.__version__
py2exepackages.append('win32ctypes')
except ImportError:
pass
if os.name == 'nt': if os.name == 'nt':
# Windows binary file versions for exe/dll files must have the # Windows binary file versions for exe/dll files must have the
# form W.X.Y.Z, where W,X,Y,Z are numbers in the range 0..65535 # form W.X.Y.Z, where W,X,Y,Z are numbers in the range 0..65535
setupversion = setupversion.split(r'+', 1)[0] setupversion = setupversion.split(r'+', 1)[0]
if sys.platform == 'darwin' and os.path.exists('/usr/bin/xcodebuild'): if sys.platform == 'darwin' and os.path.exists('/usr/bin/xcodebuild'):
version = runcmd(['/usr/bin/xcodebuild', '-version'], {})[1].splitlines() version = runcmd(['/usr/bin/xcodebuild', '-version'], {})[1].splitlines()
packages=packages, packages=packages,
ext_modules=extmodules, ext_modules=extmodules,
data_files=datafiles, data_files=datafiles,
package_data=packagedata, package_data=packagedata,
cmdclass=cmdclass, cmdclass=cmdclass,
distclass=hgdist, distclass=hgdist,
options={ options={
'py2exe': { 'py2exe': {
'dll_excludes': py2exedllexcludes,
'excludes': py2exeexcludes,
'packages': py2exepackages, 'packages': py2exepackages,
}, },
'bdist_mpkg': { 'bdist_mpkg': {
'zipdist': False, 'zipdist': False,
'license': 'COPYING', 'license': 'COPYING',
'readme': 'contrib/packaging/macosx/Readme.html', 'readme': 'contrib/packaging/macosx/Readme.html',
'welcome': 'contrib/packaging/macosx/Welcome.html', 'welcome': 'contrib/packaging/macosx/Welcome.html',
}, },
}, },
**extra) **extra)