comparison mercurial/extensions.py @ 27142:060f83d219b9

extensions: refuse to load extensions if minimum hg version not met As the author of several 3rd party extensions, I frequently see bug reports from users attempting to run my extension with an old version of Mercurial that I no longer support in my extension. Oftentimes, the extension will import just fine. But as soon as we run extsetup(), reposetup(), or get into the guts of a wrapped function, we encounter an exception and abort. Today, Mercurial will print a message about extensions that don't have a "testedwith" declaring explicit compatibility with the current version. The existing mechanism is a good start. But it isn't as robust as I would like. Specifically, Mercurial assumes compatibility by default. This means extension authors must perform compatibility checking in their extsetup() or we wait and see if we encounter an abort at runtime. And, compatibility checking can involve a lot of code and lots of error checking. It's a lot of effort for extension authors. Oftentimes, extension authors know which versions of Mercurial there extension works on and more importantly where it is broken. This patch introduces a magic "minimumhgversion" attribute in extensions. When found, the extension loading mechanism will compare the declared version against the current Mercurial version. If the extension explicitly states we require a newer Mercurial version, a warning is printed and the extension isn't loaded beyond importing the Python module. This causes a graceful failure while alerting the user of the compatibility issue. I would be receptive to the idea of making the failure more fatal. However, care would need to be taken to not criple every hg command. e.g. the user may use `hg config` to fix the hgrc and if we aborted trying to run that, the user would effectively be locked out of `hg`! A potential future improvement to this functionality would be to catch ImportError for the extension/module and parse the source code for "minimumhgversion = 'XXX'" and do similar checking. This way we could give more information about why the extension failed to load.
author Gregory Szorc <gregory.szorc@gmail.com>
date Tue, 24 Nov 2015 15:16:25 -0800
parents 0214cc0a0e97
children b502138f5faa
comparison
equal deleted inserted replaced
27141:a4e3dec3010e 27142:060f83d219b9
99 ui.debug('could not import hgext.%s (%s): trying %s\n' 99 ui.debug('could not import hgext.%s (%s): trying %s\n'
100 % (name, err, name)) 100 % (name, err, name))
101 if ui.debugflag: 101 if ui.debugflag:
102 ui.traceback() 102 ui.traceback()
103 mod = importh(name) 103 mod = importh(name)
104
105 # Before we do anything with the extension, check against minimum stated
106 # compatibility. This gives extension authors a mechanism to have their
107 # extensions short circuit when loaded with a known incompatible version
108 # of Mercurial.
109 minver = getattr(mod, 'minimumhgversion', None)
110 if minver and util.versiontuple(minver, 2) > util.versiontuple(n=2):
111 ui.warn(_('(third party extension %s requires version %s or newer '
112 'of Mercurial; disabling)\n') % (shortname, minver))
113 return
114
104 _extensions[shortname] = mod 115 _extensions[shortname] = mod
105 _order.append(shortname) 116 _order.append(shortname)
106 for fn in _aftercallbacks.get(shortname, []): 117 for fn in _aftercallbacks.get(shortname, []):
107 fn(loaded=True) 118 fn(loaded=True)
108 return mod 119 return mod