Mercurial > hg
view contrib/hgfixes/fix_bytesmod.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 | d20817ac628a |
children |
line wrap: on
line source
"""Fixer that changes bytes % whatever to a function that actually formats it.""" from lib2to3 import fixer_base from lib2to3.fixer_util import is_tuple, Call, Comma, Name, touch_import # XXX: Implementing a blacklist in 2to3 turned out to be more troublesome than # blacklisting some modules inside the fixers. So, this is what I came with. blacklist = ['mercurial/demandimport.py', 'mercurial/py3kcompat.py', 'mercurial/i18n.py', ] def isnumberremainder(formatstr, data): try: if data.value.isdigit(): return True except AttributeError: return False class FixBytesmod(fixer_base.BaseFix): # XXX: There's one case (I suppose) I can't handle: when a remainder # operation like foo % bar is performed, I can't really know what the # contents of foo and bar are. I believe the best approach is to "correct" # the to-be-converted code and let bytesformatter handle that case in # runtime. PATTERN = ''' term< formatstr=STRING '%' data=STRING > | term< formatstr=STRING '%' data=atom > | term< formatstr=NAME '%' data=any > | term< formatstr=any '%' data=any > ''' def transform(self, node, results): for bfn in blacklist: if self.filename.endswith(bfn): return if not self.filename.endswith('mercurial/py3kcompat.py'): touch_import('mercurial', 'py3kcompat', node=node) formatstr = results['formatstr'].clone() data = results['data'].clone() formatstr.prefix = '' # remove spaces from start if isnumberremainder(formatstr, data): return # We have two possibilities: # 1- An identifier or name is passed, it is going to be a leaf, thus, we # just need to copy its value as an argument to the formatter; # 2- A tuple is explicitly passed. In this case, we're gonna explode it # to pass to the formatter # TODO: Check for normal strings. They don't need to be translated if is_tuple(data): args = [formatstr, Comma().clone()] + \ [c.clone() for c in data.children[:]] else: args = [formatstr, Comma().clone(), data] call = Call(Name('bytesformatter', prefix=' '), args) return call