This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9531

hg: add user-site to `sys.path` on Windows to allow pip-installed extensions
ClosedPublic

Authored by mharbison72 on Dec 6 2020, 9:27 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG7740d5102760: hg: add user-site to `sys.path` on Windows to allow pip-installed extensions
rHGfeae6f6d214c: hg: add user-site to `sys.path` on Windows to allow pip-installed extensions
Summary

This has been in the TortoiseHg builds for several cycles now on Windows, and
even longer on macOS. It allows an extension to be configured with ext =
syntax, instead of requiring the full path to be specified. It's confusing for
a user to be hit with messages about not being able to load extensions, based
solely on which hg.exe is being run.

This only applies to py2exe binaries, since wrapper.exe already sees into the
user site area. There are no frozen binaries on other platforms (that I'm aware
of), and an equivalent change will need to be made to dispatch.py in order to
work with PyOxidizer, since it bypasses this module completely. (It also has
the ability to use the site module, so it will look completely different.)

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.

Revision Contents
Changeset List

PathPackages
Mhg (11 lines)

Diff 24073

hg

if libdir != '@' 'LIBDIR' '@': if libdir != '@' 'LIBDIR' '@':
if not os.path.isabs(libdir): if not os.path.isabs(libdir):
libdir = os.path.join( libdir = os.path.join(
os.path.dirname(os.path.realpath(__file__)), libdir os.path.dirname(os.path.realpath(__file__)), libdir
) )
libdir = os.path.abspath(libdir) libdir = os.path.abspath(libdir)
sys.path.insert(0, libdir) sys.path.insert(0, libdir)
# Make `pip install --user ...` packages available to the official Windows
# build. Most py2 packaging installs directly into the system python
# environment, so no changes are necessary for other platforms. The Windows
# py2 package uses py2exe, which lacks a `site` module. Hardcode it according
# to the documentation.
if getattr(sys, 'frozen', None) == 'console_exe':
vi = sys.version_info
sys.path.append(os.path.join(os.environ['APPDATA'], 'Python',
'Python%d%d' % (vi[0], vi[1]),
'site-packages'))
from hgdemandimport import tracing from hgdemandimport import tracing
with tracing.log('hg script'): with tracing.log('hg script'):
# enable importing on demand to reduce startup time # enable importing on demand to reduce startup time
try: try:
if sys.version_info[0] < 3 or sys.version_info >= (3, 6): if sys.version_info[0] < 3 or sys.version_info >= (3, 6):
import hgdemandimport import hgdemandimport