This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1580

setup: only write some autogenerated files if they change
ClosedPublic

Authored by indygreg on Dec 4 2017, 12:00 AM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHG61ff0d7d56fd: setup: only write some autogenerated files if they change
Summary

Without this change, setup.py always writes some files on every
invocation. This prevents some builds from being a no-op when they
should. And, since times can sneak into generated .pyc files,
this prevents file content from being deterministic between
builds.

As part of the refactor, we treat file content as bytes.

The only potential regression from this would be if some tool
is looking at mtimes of the changed files to determine if
further action should be taken. But I don't think anything
critically important is keyed off the mtimes of these specific files.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Dec 4 2017, 12:00 AM
yuja accepted this revision.Dec 5 2017, 6:56 AM
yuja added a subscriber: yuja.
yuja added inline comments.
setup.py
499

Made it bytes and queued, thanks.

This revision is now accepted and ready to land.Dec 5 2017, 6:56 AM
Closed by commit rHG61ff0d7d56fd: setup: only write some autogenerated files if they change (authored by indygreg). · Explain WhyDec 5 2017, 7:16 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Msetup.py (33 lines)

Diff 4089

setup.py

from distutils.errors import ( from distutils.errors import (
CCompilerError, CCompilerError,
DistutilsError, DistutilsError,
DistutilsExecError, DistutilsExecError,
) )
from distutils.sysconfig import get_python_inc, get_config_var from distutils.sysconfig import get_python_inc, get_config_var
from distutils.version import StrictVersion from distutils.version import StrictVersion
def write_if_changed(path, content):
"""Write content to a file iff the content hasn't changed."""
if os.path.exists(path):
with open(path, 'rb') as fh:
current = fh.read()
else:
current = ''
if current != content:
with open(path, 'wb') as fh:
fh.write(content)
scripts = ['hg'] scripts = ['hg']
if os.name == 'nt': if os.name == 'nt':
# We remove hg.bat if we are able to build hg.exe. # We remove hg.bat if we are able to build hg.exe.
scripts.append('contrib/win32/hg.bat') scripts.append('contrib/win32/hg.bat')
def cancompile(cc, code): def cancompile(cc, code):
tmpdir = tempfile.mkdtemp(prefix='hg-install-') tmpdir = tempfile.mkdtemp(prefix='hg-install-')
devnull = oldstderr = None devnull = oldstderr = None
if 'changessincelatesttag' in kw: if 'changessincelatesttag' in kw:
version = '%(latesttag)s+%(changessincelatesttag)s-%(node).12s' % kw version = '%(latesttag)s+%(changessincelatesttag)s-%(node).12s' % kw
else: else:
version = '%(latesttag)s+%(latesttagdistance)s-%(node).12s' % kw version = '%(latesttag)s+%(latesttagdistance)s-%(node).12s' % kw
else: else:
version = kw.get('node', '')[:12] version = kw.get('node', '')[:12]
if version: if version:
with open("mercurial/__version__.py", "w") as f: versionb = version
f.write('# this file is autogenerated by setup.py\n') if not isinstance(versionb, bytes):
f.write('version = "%s"\n' % version) versionb = versionb.encode('ascii')
write_if_changed('mercurial/__version__.py', b''.join([
b'# this file is autogenerated by setup.py\n'
b'version = "%s"\n' % versionb,
]))
try: try:
oldpolicy = os.environ.get('HGMODULEPOLICY', None) oldpolicy = os.environ.get('HGMODULEPOLICY', None)
os.environ['HGMODULEPOLICY'] = 'py' os.environ['HGMODULEPOLICY'] = 'py'
from mercurial import __version__ from mercurial import __version__
version = __version__.version version = __version__.version
except ImportError: except ImportError:
version = 'unknown' version = 'unknown'
if self.distribution.pure: if self.distribution.pure:
modulepolicy = 'py' modulepolicy = 'py'
elif self.build_lib == '.': elif self.build_lib == '.':
# in-place build should run without rebuilding C extensions # in-place build should run without rebuilding C extensions
modulepolicy = 'allow' modulepolicy = 'allow'
else: else:
modulepolicy = 'c' modulepolicy = 'c'
with open(os.path.join(basepath, '__modulepolicy__.py'), "w") as f:
f.write('# this file is autogenerated by setup.py\n') content = ''.join([
yujaUnsubmitted
Not Done

Made it bytes and queued, thanks.

yuja: Made it bytes and queued, thanks.
f.write('modulepolicy = b"%s"\n' % modulepolicy) '# this file is autogenerated by setup.py\n',
'modulepolicy = b"%s"\n' % modulepolicy,
])
write_if_changed(os.path.join(basepath, '__modulepolicy__.py'),
content)
build_py.run(self) build_py.run(self)
class buildhgextindex(Command): class buildhgextindex(Command):
description = 'generate prebuilt index of hgext (for frozen package)' description = 'generate prebuilt index of hgext (for frozen package)'
user_options = [] user_options = []
_indexfilename = 'hgext/__index__.py' _indexfilename = 'hgext/__index__.py'