##// END OF EJS Templates
wireprotov2: don't emit empty frames...
wireprotov2: don't emit empty frames Staring at logs revealed the presence of empty frames that should have contained payload. Let's stop that from happening. Differential Revision: https://phab.mercurial-scm.org/D4925

File last commit:

r39294:331ab85e default
r40171:3a6d6c54 default
Show More
extensions.py
823 lines | 27.3 KiB | text/x-python | PythonLexer
Matt Mackall
Create a separate module for managing extensions
r4544 # extensions.py - extension handling for mercurial
#
Thomas Arendsen Hein
Updated copyright notices and add "and others" to "hg version"
r4635 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
Matt Mackall
Create a separate module for managing extensions
r4544 #
Martin Geisler
updated license to be explicit about GPL version 2
r8225 # This software may be used and distributed according to the terms of the
Matt Mackall
Update license to GPLv2+
r10263 # GNU General Public License version 2 or any later version.
Matt Mackall
Create a separate module for managing extensions
r4544
Gregory Szorc
extensions: use absolute_import
r25946 from __future__ import absolute_import
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 import ast
import collections
Jun Wu
wrapfunction: use functools.partial if possible...
r34089 import functools
Gregory Szorc
extensions: use absolute_import
r25946 import imp
Augie Fackler
extensions: use inspect module instead of func_code.co_argcount...
r31263 import inspect
Gregory Szorc
extensions: use absolute_import
r25946 import os
from .i18n import (
_,
gettext,
)
from . import (
cmdutil,
configitems: add an official API for extensions to register config item...
r33127 configitems,
Gregory Szorc
extensions: use absolute_import
r25946 error,
Pulkit Goyal
py3: use pycompat.sysstr() in __import__()...
r30570 pycompat,
Gregory Szorc
extensions: use absolute_import
r25946 util,
)
Matt Mackall
Create a separate module for managing extensions
r4544
Yuya Nishihara
stringutil: bulk-replace call sites to point to new module...
r37102 from .utils import (
stringutil,
)
Matt Mackall
Create a separate module for managing extensions
r4544 _extensions = {}
liscju
help: show content for explicitly disabled extension (issue5228)
r29895 _disabledextensions = {}
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065 _aftercallbacks = {}
Alexis S. L. Carvalho
Move cmdtable and reposetup handling out of extensions.py...
r5192 _order = []
Boris Feld
extensions: expand the builtins extensions declaration...
r33526 _builtin = {
'hbisect',
'bookmarks',
Boris Feld
color: drop the now useless color extension...
r33527 'color',
Boris Feld
extensions: expand the builtins extensions declaration...
r33526 'parentrevspec',
'progress',
'interhg',
'inotify',
'hgcia'
}
Alexis S. L. Carvalho
Move cmdtable and reposetup handling out of extensions.py...
r5192
FUJIWARA Katsunori
extensions: list up only enabled extensions, if "ui" is specified...
r19777 def extensions(ui=None):
if ui:
def enabled(name):
for format in ['%s', 'hgext.%s']:
conf = ui.config('extensions', format % name)
if conf is not None and not conf.startswith('!'):
return True
else:
enabled = lambda name: True
Alexis S. L. Carvalho
Move cmdtable and reposetup handling out of extensions.py...
r5192 for name in _order:
module = _extensions[name]
FUJIWARA Katsunori
extensions: list up only enabled extensions, if "ui" is specified...
r19777 if module and enabled(name):
Alexis S. L. Carvalho
Move cmdtable and reposetup handling out of extensions.py...
r5192 yield name, module
Matt Mackall
Create a separate module for managing extensions
r4544
def find(name):
'''return module with given extension name'''
Idan Kamara
extensions: raise when trying to find an extension that failed to load...
r14415 mod = None
Matt Mackall
Create a separate module for managing extensions
r4544 try:
timeless
cleanup: remove superfluous space after space after equals (python)
r27637 mod = _extensions[name]
Matt Mackall
Create a separate module for managing extensions
r4544 except KeyError:
for k, v in _extensions.iteritems():
Matt Mackall
extensions: fix lookup of hgext.foo modules
r4560 if k.endswith('.' + name) or k.endswith('/' + name):
Idan Kamara
extensions: raise when trying to find an extension that failed to load...
r14415 mod = v
break
if not mod:
Matt Mackall
Create a separate module for managing extensions
r4544 raise KeyError(name)
Idan Kamara
extensions: raise when trying to find an extension that failed to load...
r14415 return mod
Matt Mackall
Create a separate module for managing extensions
r4544
Alexander Solovyov
ability to load hooks from arbitrary python module
r7916 def loadpath(path, module_name):
module_name = module_name.replace('.', '_')
Ed Morley
extensions: use normpath to allow trailing '\' on Windows (issue4187)...
r20645 path = util.normpath(util.expandpath(path))
Pulkit Goyal
py3: use pycompat.fsdecode() to pass to imp.* functions...
r30575 module_name = pycompat.fsdecode(module_name)
path = pycompat.fsdecode(path)
Alexander Solovyov
ability to load hooks from arbitrary python module
r7916 if os.path.isdir(path):
# module/__init__.py style
Ed Morley
extensions: use normpath to allow trailing '\' on Windows (issue4187)...
r20645 d, f = os.path.split(path)
Alexander Solovyov
ability to load hooks from arbitrary python module
r7916 fd, fpath, desc = imp.find_module(f, [d])
return imp.load_module(module_name, fd, fpath, desc)
else:
Simon Heimberg
hooks: print out more information when loading a python hook fails...
r17217 try:
return imp.load_source(module_name, path)
Gregory Szorc
global: mass rewrite to use modern exception syntax...
r25660 except IOError as exc:
Simon Heimberg
hooks: print out more information when loading a python hook fails...
r17217 if not exc.filename:
exc.filename = path # python does not fill this
raise
Alexander Solovyov
ability to load hooks from arbitrary python module
r7916
Pierre-Yves David
extensions: extract the 'importh' closure as normal function...
r28505 def _importh(name):
"""import and return the <name> module"""
Pulkit Goyal
py3: use pycompat.sysstr() in __import__()...
r30570 mod = __import__(pycompat.sysstr(name))
Pierre-Yves David
extensions: extract the 'importh' closure as normal function...
r28505 components = name.split('.')
for comp in components[1:]:
mod = getattr(mod, comp)
return mod
Jun Wu
extensions: move the "import" logic out from "load"...
r30058 def _importext(name, path=None, reportfunc=None):
if path:
# the module will be loaded in sys.modules
# choose an unique name so that it doesn't
# conflicts with other modules
mod = loadpath(path, 'hgext.%s' % name)
else:
try:
mod = _importh("hgext.%s" % name)
except ImportError as err:
if reportfunc:
reportfunc(err, "hgext.%s" % name, "hgext3rd.%s" % name)
try:
mod = _importh("hgext3rd.%s" % name)
except ImportError as err:
if reportfunc:
reportfunc(err, "hgext3rd.%s" % name, name)
mod = _importh(name)
return mod
Pierre-Yves David
extensions: factor import error reporting out...
r28506 def _reportimporterror(ui, err, failed, next):
Pierre-Yves David
extensions: add a note about debug output during extensions search...
r30028 # note: this ui.debug happens before --debug is processed,
# Use --config ui.debug=1 to see them.
Boris Feld
debug: move extensions debug behind a dedicated flag...
r38750 if ui.configbool('devel', 'debug.extensions'):
Martijn Pieters
extensions: add detailed loading information...
r38834 ui.debug('debug.extensions: - could not import %s (%s): trying %s\n'
Boris Feld
debug: move extensions debug behind a dedicated flag...
r38750 % (failed, stringutil.forcebytestr(err), next))
if ui.debugflag:
ui.traceback()
Pierre-Yves David
extensions: factor import error reporting out...
r28506
Yuya Nishihara
extensions: reject any unicode strings in tables before loading...
r36283 def _rejectunicode(name, xs):
if isinstance(xs, (list, set, tuple)):
for x in xs:
_rejectunicode(name, x)
elif isinstance(xs, dict):
for k, v in xs.items():
_rejectunicode(name, k)
Yuya Nishihara
stringutil: bulk-replace call sites to point to new module...
r37102 _rejectunicode(b'%s.%s' % (name, stringutil.forcebytestr(k)), v)
Yuya Nishihara
extensions: reject any unicode strings in tables before loading...
r36283 elif isinstance(xs, type(u'')):
raise error.ProgrammingError(b"unicode %r found in %s" % (xs, name),
hint="use b'' to make it byte string")
Yuya Nishihara
extensions: prohibit registration of command without using @command (API)...
r32342 # attributes set by registrar.command
_cmdfuncattrs = ('norepo', 'optionalrepo', 'inferrepo')
Yuya Nishihara
extensions: show deprecation warning for the use of cmdutil.command...
r32343 def _validatecmdtable(ui, cmdtable):
Yuya Nishihara
extensions: prohibit registration of command without using @command (API)...
r32342 """Check if extension commands have required attributes"""
for c, e in cmdtable.iteritems():
f = e[0]
missing = [a for a in _cmdfuncattrs if not util.safehasattr(f, a)]
if not missing:
continue
raise error.ProgrammingError(
'missing attributes: %s' % ', '.join(missing),
hint="use @command decorator to register '%s'" % c)
Yuya Nishihara
extensions: reject any unicode strings in tables before loading...
r36283 def _validatetables(ui, mod):
"""Sanity check for loadable tables provided by extension module"""
for t in ['cmdtable', 'colortable', 'configtable']:
_rejectunicode(t, getattr(mod, t, {}))
for t in ['filesetpredicate', 'internalmerge', 'revsetpredicate',
'templatefilter', 'templatefunc', 'templatekeyword']:
o = getattr(mod, t, None)
if o:
_rejectunicode(t, o._table)
_validatecmdtable(ui, getattr(mod, 'cmdtable', {}))
Boris Feld
extension: add a summary of total loading time per extension...
r39547 def load(ui, name, path, log=lambda *a: None, loadingtime=None):
Benoit Boissinot
Do not try to load extensions twice (issue811)
r7011 if name.startswith('hgext.') or name.startswith('hgext/'):
Bryan O'Sullivan
extensions: don't get confused by aliasing between "foo" and "hgext.foo"
r5031 shortname = name[6:]
else:
shortname = name
Bryan O'Sullivan
extensions: rename _ignore to _builtin, add descriptive comment...
r27111 if shortname in _builtin:
Matt Mackall
extensions: add an ignore list for old extensions
r13349 return None
Bryan O'Sullivan
extensions: don't get confused by aliasing between "foo" and "hgext.foo"
r5031 if shortname in _extensions:
Erik Zielke
extensions.load: return module...
r12779 return _extensions[shortname]
Martijn Pieters
extensions: add detailed loading information...
r38834 log(' - loading extension: %r\n', shortname)
Brendan Cully
Cache extension load failures....
r5087 _extensions[shortname] = None
Augie Fackler
cleanup: make all uses of timedcm specify what they're timing...
r39294 with util.timedcm('load extension %r', shortname) as stats:
Martijn Pieters
extensions: add detailed loading information...
r38834 mod = _importext(name, path, bind(_reportimporterror, ui))
log(' > %r extension loaded in %s\n', shortname, stats)
Boris Feld
extension: add a summary of total loading time per extension...
r39547 if loadingtime is not None:
loadingtime[shortname] += stats.elapsed
Gregory Szorc
extensions: refuse to load extensions if minimum hg version not met...
r27142
# Before we do anything with the extension, check against minimum stated
# compatibility. This gives extension authors a mechanism to have their
# extensions short circuit when loaded with a known incompatible version
# of Mercurial.
minver = getattr(mod, 'minimumhgversion', None)
if minver and util.versiontuple(minver, 2) > util.versiontuple(n=2):
ui.warn(_('(third party extension %s requires version %s or newer '
'of Mercurial; disabling)\n') % (shortname, minver))
return
Martijn Pieters
extensions: add detailed loading information...
r38834 log(' - validating extension tables: %r\n', shortname)
Yuya Nishihara
extensions: reject any unicode strings in tables before loading...
r36283 _validatetables(ui, mod)
Gregory Szorc
extensions: refuse to load extensions if minimum hg version not met...
r27142
Bryan O'Sullivan
extensions: don't get confused by aliasing between "foo" and "hgext.foo"
r5031 _extensions[shortname] = mod
Alexis S. L. Carvalho
Move cmdtable and reposetup handling out of extensions.py...
r5192 _order.append(shortname)
Martijn Pieters
extensions: add detailed loading information...
r38834 log(' - invoking registered callbacks: %r\n', shortname)
Augie Fackler
cleanup: make all uses of timedcm specify what they're timing...
r39294 with util.timedcm('callbacks extension %r', shortname) as stats:
Martijn Pieters
extensions: add detailed loading information...
r38834 for fn in _aftercallbacks.get(shortname, []):
fn(loaded=True)
log(' > callbacks completed in %s\n', stats)
Erik Zielke
extensions.load: return module...
r12779 return mod
Matt Mackall
Create a separate module for managing extensions
r4544
Jun Wu
extensions: move uisetup and extsetup to standalone functions...
r29461 def _runuisetup(name, ui):
uisetup = getattr(_extensions[name], 'uisetup', None)
if uisetup:
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 try:
uisetup(ui)
except Exception as inst:
Martin von Zweigbergk
extensions: always include traceback when extension setup fails...
r34846 ui.traceback(force=True)
Yuya Nishihara
stringutil: bulk-replace call sites to point to new module...
r37102 msg = stringutil.forcebytestr(inst)
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg))
return False
return True
Jun Wu
extensions: move uisetup and extsetup to standalone functions...
r29461
def _runextsetup(name, ui):
extsetup = getattr(_extensions[name], 'extsetup', None)
if extsetup:
try:
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 try:
extsetup(ui)
except TypeError:
Augie Fackler
py3: introduce and use pycompat.getargspec...
r36196 if pycompat.getargspec(extsetup).args:
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 raise
extsetup() # old extsetup with no ui argument
except Exception as inst:
Martin von Zweigbergk
extensions: always include traceback when extension setup fails...
r34846 ui.traceback(force=True)
Yuya Nishihara
stringutil: bulk-replace call sites to point to new module...
r37102 msg = stringutil.forcebytestr(inst)
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg))
return False
return True
Jun Wu
extensions: move uisetup and extsetup to standalone functions...
r29461
Jun Wu
extensions: allow loading a whitelisted subset of extensions...
r32416 def loadall(ui, whitelist=None):
Martijn Pieters
extensions: add detailed loading information...
r38834 if ui.configbool('devel', 'debug.extensions'):
log = lambda msg, *values: ui.debug('debug.extensions: ',
msg % values, label='debug.extensions')
else:
log = lambda *a, **kw: None
Boris Feld
extension: add a summary of total loading time per extension...
r39547 loadingtime = collections.defaultdict(int)
Matt Mackall
extensions: pull extension-aware bits out of ui
r4617 result = ui.configitems("extensions")
Jun Wu
profiling: allow loading profiling extension before everything else...
r32417 if whitelist is not None:
Jun Wu
extensions: allow loading a whitelisted subset of extensions...
r32416 result = [(k, v) for (k, v) in result if k in whitelist]
Martin Geisler
extensions: load and configure extensions in well-defined phases...
r9410 newindex = len(_order)
Martijn Pieters
extensions: add detailed loading information...
r38834 log('loading %sextensions\n', 'additional ' if newindex else '')
log('- processing %d entries\n', len(result))
Augie Fackler
cleanup: make all uses of timedcm specify what they're timing...
r39294 with util.timedcm('load all extensions') as stats:
Martijn Pieters
extensions: add detailed loading information...
r38834 for (name, path) in result:
Jesse Glick
When failing to load an extension, show where Hg tried to load it from.
r6204 if path:
Martijn Pieters
extensions: add detailed loading information...
r38834 if path[0:1] == '!':
if name not in _disabledextensions:
log(' - skipping disabled extension: %r\n', name)
_disabledextensions[name] = path[1:]
continue
try:
Boris Feld
extension: add a summary of total loading time per extension...
r39547 load(ui, name, path, log, loadingtime)
Martijn Pieters
extensions: add detailed loading information...
r38834 except Exception as inst:
msg = stringutil.forcebytestr(inst)
if path:
ui.warn(_("*** failed to import extension %s from %s: %s\n")
% (name, path, msg))
else:
ui.warn(_("*** failed to import extension %s: %s\n")
% (name, msg))
if isinstance(inst, error.Hint) and inst.hint:
ui.warn(_("*** (%s)\n") % inst.hint)
ui.traceback()
log('> loaded %d extensions, total time %s\n',
len(_order) - newindex, stats)
Boris Feld
extensions: register config item early...
r34188 # list of (objname, loadermod, loadername) tuple:
# - objname is the name of an object in extension module,
# from which extra information is loaded
# - loadermod is the module where loader is placed
# - loadername is the name of the function,
# which takes (ui, extensionname, extraobj) arguments
#
# This one is for the list of item that must be run before running any setup
earlyextraloaders = [
('configtable', configitems, 'loadconfigtable'),
]
Martijn Pieters
extensions: add detailed loading information...
r38834
log('- loading configtable attributes\n')
Boris Feld
extensions: register config item early...
r34188 _loadextra(ui, newindex, earlyextraloaders)
Matt Mackall
Create a separate module for managing extensions
r4544
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 broken = set()
Martijn Pieters
extensions: add detailed loading information...
r38834 log('- executing uisetup hooks\n')
Boris Feld
extensions: trace the total time of running all uisetup callbacks...
r39544 with util.timedcm('all uisetup') as alluisetupstats:
for name in _order[newindex:]:
log(' - running uisetup for %r\n', name)
with util.timedcm('uisetup %r', name) as stats:
if not _runuisetup(name, ui):
log(' - the %r extension uisetup failed\n', name)
broken.add(name)
log(' > uisetup for %r took %s\n', name, stats)
Boris Feld
extension: add a summary of total loading time per extension...
r39547 loadingtime[name] += stats.elapsed
Boris Feld
extensions: trace the total time of running all uisetup callbacks...
r39544 log('> all uisetup took %s\n', alluisetupstats)
Martin Geisler
extensions: load and configure extensions in well-defined phases...
r9410
Martijn Pieters
extensions: add detailed loading information...
r38834 log('- executing extsetup hooks\n')
Boris Feld
extensions: trace the total time of running all extsetup callbacks...
r39545 with util.timedcm('all extsetup') as allextetupstats:
for name in _order[newindex:]:
if name in broken:
continue
log(' - running extsetup for %r\n', name)
with util.timedcm('extsetup %r', name) as stats:
if not _runextsetup(name, ui):
log(' - the %r extension extsetup failed\n', name)
broken.add(name)
log(' > extsetup for %r took %s\n', name, stats)
Boris Feld
extension: add a summary of total loading time per extension...
r39547 loadingtime[name] += stats.elapsed
Boris Feld
extensions: trace the total time of running all extsetup callbacks...
r39545 log('> all extsetup took %s\n', allextetupstats)
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724
for name in broken:
Martijn Pieters
extensions: add detailed loading information...
r38834 log(' - disabling broken %r extension\n', name)
Augie Fackler
extensions: catch uisetup and extsetup failures and don't let them break hg...
r32724 _extensions[name] = None
Yuya Nishihara
extensions: changed to call extsetup() from extensions.loadall()...
r9660
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065 # Call aftercallbacks that were never met.
Martijn Pieters
extensions: add detailed loading information...
r38834 log('- executing remaining aftercallbacks\n')
Augie Fackler
cleanup: make all uses of timedcm specify what they're timing...
r39294 with util.timedcm('aftercallbacks') as stats:
Martijn Pieters
extensions: add detailed loading information...
r38834 for shortname in _aftercallbacks:
if shortname in _extensions:
continue
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065
Martijn Pieters
extensions: add detailed loading information...
r38834 for fn in _aftercallbacks[shortname]:
log(' - extension %r not loaded, notify callbacks\n',
shortname)
fn(loaded=False)
log('> remaining aftercallbacks completed in %s\n', stats)
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065
Gregory Szorc
extensions: clear aftercallbacks after execution (issue4646)...
r24950 # loadall() is called multiple times and lingering _aftercallbacks
# entries could result in double execution. See issue4646.
_aftercallbacks.clear()
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 # delay importing avoids cyclic dependency (especially commands)
from . import (
color,
commands,
FUJIWARA Katsunori
filemerge: move decorator definition for internal merge tools to registrar...
r33663 filemerge,
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 fileset,
revset,
templatefilters,
Yuya Nishihara
templater: split template functions to new module...
r36940 templatefuncs,
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 templatekw,
)
# list of (objname, loadermod, loadername) tuple:
# - objname is the name of an object in extension module,
# from which extra information is loaded
# - loadermod is the module where loader is placed
# - loadername is the name of the function,
# which takes (ui, extensionname, extraobj) arguments
Martijn Pieters
extensions: add detailed loading information...
r38834 log('- loading extension registration objects\n')
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 extraloaders = [
('cmdtable', commands, 'loadcmdtable'),
('colortable', color, 'loadcolortable'),
('filesetpredicate', fileset, 'loadpredicate'),
FUJIWARA Katsunori
filemerge: move decorator definition for internal merge tools to registrar...
r33663 ('internalmerge', filemerge, 'loadinternalmerge'),
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 ('revsetpredicate', revset, 'loadpredicate'),
('templatefilter', templatefilters, 'loadfilter'),
Yuya Nishihara
templater: split template functions to new module...
r36940 ('templatefunc', templatefuncs, 'loadfunction'),
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 ('templatekeyword', templatekw, 'loadkeyword'),
]
Augie Fackler
cleanup: make all uses of timedcm specify what they're timing...
r39294 with util.timedcm('load registration objects') as stats:
Martijn Pieters
extensions: add detailed loading information...
r38834 _loadextra(ui, newindex, extraloaders)
log('> extension registration object loading took %s\n', stats)
Boris Feld
extension: add a summary of total loading time per extension...
r39547
# Report per extension loading time (except reposetup)
for name in sorted(loadingtime):
extension_msg = '> extension %s take a total of %s to load\n'
log(extension_msg, name, util.timecount(loadingtime[name]))
Martijn Pieters
extensions: add detailed loading information...
r38834 log('extension loading complete\n')
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052
Boris Feld
extensions: factor extra data loading out...
r34187 def _loadextra(ui, newindex, extraloaders):
FUJIWARA Katsunori
extensions: register functions always at loading extension (issue5601)...
r33052 for name in _order[newindex:]:
module = _extensions[name]
if not module:
continue # loading this module failed
for objname, loadermod, loadername in extraloaders:
extraobj = getattr(module, objname, None)
if extraobj is not None:
getattr(loadermod, loadername)(ui, name, extraobj)
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065 def afterloaded(extension, callback):
'''Run the specified function after a named extension is loaded.
If the named extension is already loaded, the callback will be called
immediately.
If the named extension never loads, the callback will be called after
all extensions have been loaded.
The callback receives the named argument ``loaded``, which is a boolean
indicating whether the dependent extension actually loaded.
'''
if extension in _extensions:
Adam Simpkins
extensions: call afterloaded() with loaded=False for disabled extensions...
r33014 # Report loaded as False if the extension is disabled
loaded = (_extensions[extension] is not None)
callback(loaded=loaded)
Gregory Szorc
extensions: support callbacks after another extension loads...
r24065 else:
_aftercallbacks.setdefault(extension, []).append(callback)
Eric Sumner
extensions: extract partial application into a bind() function...
r24734 def bind(func, *args):
'''Partial function application
Returns a new function that is the partial application of args and kwargs
to func. For example,
f(1, 2, bar=3) === bind(f, 1)(2, bar=3)'''
assert callable(func)
def closure(*a, **kw):
return func(*(args + a), **kw)
return closure
Jun Wu
extensions: set attributes to wrappers so we can trace them back...
r29763 def _updatewrapper(wrap, origfn, unboundwrapper):
'''Copy and add some useful attributes to wrapper'''
Yuya Nishihara
extensions: fix wrapcommand/function of class instance...
r34130 try:
wrap.__name__ = origfn.__name__
except AttributeError:
pass
Yuya Nishihara
extensions: extract function that copies function attributes to wrapper...
r28310 wrap.__module__ = getattr(origfn, '__module__')
wrap.__doc__ = getattr(origfn, '__doc__')
Yuya Nishihara
extensions: copy extra __dict__ of original function...
r28312 wrap.__dict__.update(getattr(origfn, '__dict__', {}))
Jun Wu
extensions: set attributes to wrappers so we can trace them back...
r29763 wrap._origfunc = origfn
wrap._unboundwrapper = unboundwrapper
Yuya Nishihara
extensions: extract function that copies function attributes to wrapper...
r28310
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124 def wrapcommand(table, command, wrapper, synopsis=None, docstring=None):
Dan Villiom Podlaski Christiansen
extensions: add docstring for wrapcommand().
r11519 '''Wrap the command named `command' in table
Replace command in the command table with wrapper. The wrapped command will
be inserted into the command table specified by the table argument.
The wrapper will be called like
wrapper(orig, *args, **kwargs)
where orig is the original (wrapped) function, and *args, **kwargs
are the arguments passed to it.
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124
Optionally append to the command synopsis and docstring, used for help.
For example, if your extension wraps the ``bookmarks`` command to add the
flags ``--remote`` and ``--all`` you might call this function like so:
synopsis = ' [-a] [--remote]'
docstring = """
The ``remotenames`` extension adds the ``--remote`` and ``--all`` (``-a``)
flags to the bookmarks command. Either flag will show the remote bookmarks
Mads Kiilerich
spelling: trivial spell checking
r26781 known to the repository; ``--remote`` will also suppress the output of the
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124 local bookmarks.
"""
extensions.wrapcommand(commands.table, 'bookmarks', exbookmarks,
synopsis, docstring)
Dan Villiom Podlaski Christiansen
extensions: add docstring for wrapcommand().
r11519 '''
Augie Fackler
extensions: restore use of callable() since it was readded in Python 3.2
r21795 assert callable(wrapper)
Matt Mackall
extensions: add wrapping functions
r7215 aliases, entry = cmdutil.findcmd(command, table)
for alias, e in table.iteritems():
if e is entry:
key = alias
break
origfn = entry[0]
Jun Wu
wrapcommand: use functools.partial...
r34090 wrap = functools.partial(util.checksignature(wrapper),
util.checksignature(origfn))
Jun Wu
extensions: set attributes to wrappers so we can trace them back...
r29763 _updatewrapper(wrap, origfn, wrapper)
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124 if docstring is not None:
Yuya Nishihara
extensions: extract function that copies function attributes to wrapper...
r28310 wrap.__doc__ += docstring
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124
Matt Mackall
extensions: add wrapping functions
r7215 newentry = list(entry)
newentry[0] = wrap
Ryan McElroy
extensions: allow extending command synopsis and docstring...
r24124 if synopsis is not None:
newentry[2] += synopsis
Matt Mackall
extensions: add wrapping functions
r7215 table[key] = tuple(newentry)
return entry
Augie Fackler
extensions: move wrapfilecache function from fsmonitor...
r32722 def wrapfilecache(cls, propname, wrapper):
"""Wraps a filecache property.
These can't be wrapped using the normal wrapfunction.
"""
Augie Fackler
extensions: if on py3 and propname is a bytestr, convert to sysstr...
r33835 propname = pycompat.sysstr(propname)
Augie Fackler
extensions: move wrapfilecache function from fsmonitor...
r32722 assert callable(wrapper)
for currcls in cls.__mro__:
if propname in currcls.__dict__:
origfn = currcls.__dict__[propname].func
assert callable(origfn)
def wrap(*args, **kwargs):
return wrapper(origfn, *args, **kwargs)
currcls.__dict__[propname].func = wrap
break
if currcls is object:
Augie Fackler
extensions: don't give AttributeError bytes message on Python 3...
r33836 raise AttributeError(r"type '%s' has no property '%s'" % (
cls, propname))
Augie Fackler
extensions: move wrapfilecache function from fsmonitor...
r32722
Martin von Zweigbergk
extensions: add wrappedfunction() context manager...
r34016 class wrappedfunction(object):
'''context manager for temporarily wrapping a function'''
def __init__(self, container, funcname, wrapper):
assert callable(wrapper)
self._container = container
self._funcname = funcname
self._wrapper = wrapper
def __enter__(self):
wrapfunction(self._container, self._funcname, self._wrapper)
def __exit__(self, exctype, excvalue, traceback):
unwrapfunction(self._container, self._funcname, self._wrapper)
Matt Mackall
extensions: add wrapping functions
r7215 def wrapfunction(container, funcname, wrapper):
Greg Ward
extensions: recommend against using wrapfunction for repo methods...
r11402 '''Wrap the function named funcname in container
Dan Villiom Podlaski Christiansen
extensions: improve language for wrapfunction() docstring.
r11520 Replace the funcname member in the given container with the specified
wrapper. The container is typically a module, class, or instance.
Greg Ward
extensions: recommend against using wrapfunction for repo methods...
r11402
The wrapper will be called like
wrapper(orig, *args, **kwargs)
where orig is the original (wrapped) function, and *args, **kwargs
are the arguments passed to it.
Wrapping methods of the repository object is not recommended since
it conflicts with extensions that extend the repository by
subclassing. All extensions that need to extend methods of
localrepository should use this subclassing trick: namely,
reposetup() should look like
def reposetup(ui, repo):
class myrepo(repo.__class__):
def whatever(self, *args, **kwargs):
[...extension stuff...]
super(myrepo, self).whatever(*args, **kwargs)
[...extension stuff...]
repo.__class__ = myrepo
In general, combining wrapfunction() with subclassing does not
work. Since you cannot control what other extensions are loaded by
your end users, you should play nicely with others by using the
subclass trick.
'''
Augie Fackler
extensions: restore use of callable() since it was readded in Python 3.2
r21795 assert callable(wrapper)
Matt Mackall
extensions: add wrapping functions
r7215
origfn = getattr(container, funcname)
Augie Fackler
extensions: restore use of callable() since it was readded in Python 3.2
r21795 assert callable(origfn)
Jun Wu
wrapfunction: use functools.partial if possible...
r34089 if inspect.ismodule(container):
# origfn is not an instance or class method. "partial" can be used.
# "partial" won't insert a frame in traceback.
wrap = functools.partial(wrapper, origfn)
else:
# "partial" cannot be safely used. Emulate its effect by using "bind".
# The downside is one more frame in traceback.
wrap = bind(wrapper, origfn)
Jun Wu
extensions: set attributes to wrappers so we can trace them back...
r29763 _updatewrapper(wrap, origfn, wrapper)
Yuya Nishihara
extensions: copy attributes to wrapper by wrapfunction()...
r28311 setattr(container, funcname, wrap)
Matt Mackall
extensions: add wrapping functions
r7215 return origfn
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871
Jun Wu
extensions: add unwrapfunction to undo wrapfunction...
r29765 def unwrapfunction(container, funcname, wrapper=None):
'''undo wrapfunction
If wrappers is None, undo the last wrap. Otherwise removes the wrapper
from the chain of wrappers.
Return the removed wrapper.
Raise IndexError if wrapper is None and nothing to unwrap; ValueError if
wrapper is not None but is not found in the wrapper chain.
'''
chain = getwrapperchain(container, funcname)
origfn = chain.pop()
if wrapper is None:
wrapper = chain[0]
chain.remove(wrapper)
setattr(container, funcname, origfn)
for w in reversed(chain):
wrapfunction(container, funcname, w)
return wrapper
Jun Wu
extensions: add getwrapperchain to get a list of wrappers...
r29764 def getwrapperchain(container, funcname):
'''get a chain of wrappers of a function
Return a list of functions: [newest wrapper, ..., oldest wrapper, origfunc]
The wrapper functions are the ones passed to wrapfunction, whose first
argument is origfunc.
'''
result = []
fn = getattr(container, funcname)
while fn:
assert callable(fn)
result.append(getattr(fn, '_unboundwrapper', fn))
fn = getattr(fn, '_origfunc', None)
return result
Yuya Nishihara
extensions: remove strip_init=True from _disabledpaths()...
r38181 def _disabledpaths():
'''find paths of disabled extensions. returns a dict of {name: path}'''
Dirkjan Ochtman
extensions: simplify by selecting primary hgext
r8872 import hgext
Pulkit Goyal
py3: use pycompat.fsencode() to convert __file__ to bytes...
r31074 extpath = os.path.dirname(
os.path.abspath(pycompat.fsencode(hgext.__file__)))
Cédric Duval
extensions: catch OSError when hgext is not accessible (issue1708)...
r8964 try: # might not be a filesystem path
files = os.listdir(extpath)
except OSError:
Brodie Rao
extensions: refactor disabled()
r10363 return {}
Cédric Duval
extensions: catch OSError when hgext is not accessible (issue1708)...
r8964
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871 exts = {}
Cédric Duval
extensions: catch OSError when hgext is not accessible (issue1708)...
r8964 for e in files:
Dirkjan Ochtman
extensions: simplify by selecting primary hgext
r8872 if e.endswith('.py'):
name = e.rsplit('.', 1)[0]
path = os.path.join(extpath, e)
else:
name = e
path = os.path.join(extpath, e, '__init__.py')
Cédric Duval
extensions: check for path existence only when necessary
r8877 if not os.path.exists(path):
continue
Brodie Rao
extensions: refactor disabled()
r10363 if name in exts or name in _order or name == '__init__':
continue
exts[name] = path
Martin von Zweigbergk
dispatch: fix typo suggestion for disabled extension...
r33327 for name, path in _disabledextensions.iteritems():
# If no path was provided for a disabled extension (e.g. "color=!"),
# don't replace the path we already found by the scan above.
if path:
exts[name] = path
Brodie Rao
extensions: refactor disabled()
r10363 return exts
Dirkjan Ochtman
extensions: simplify by selecting primary hgext
r8872
Matt Mackall
extensions: move moduledoc to break import loop with help
r14317 def _moduledoc(file):
'''return the top-level python documentation for the given file
Loosely inspired by pydoc.source_synopsis(), but rewritten to
handle triple quotes and to return the whole text instead of just
the synopsis'''
result = []
line = file.readline()
while line[:1] == '#' or not line.strip():
line = file.readline()
if not line:
break
start = line[:3]
if start == '"""' or start == "'''":
line = line[3:]
while line:
if line.rstrip().endswith(start):
line = line.split(start)[0]
if line:
result.append(line)
break
elif not line:
return None # unmatched delimiter
result.append(line)
line = file.readline()
else:
return None
return ''.join(result)
Brodie Rao
extensions: refactor disabled()
r10363 def _disabledhelp(path):
'''retrieve help synopsis of a disabled extension (without importing)'''
try:
Yuya Nishihara
extensions: use context manger for open()
r38363 with open(path, 'rb') as src:
doc = _moduledoc(src)
Brodie Rao
extensions: refactor disabled()
r10363 except IOError:
return
if doc: # extracting localized synopsis
Pulkit Goyal
help: show help for disabled extensions (issue5228)...
r30306 return gettext(doc)
Brodie Rao
extensions: refactor disabled()
r10363 else:
return _('(no help text available)')
def disabled():
Yuya Nishihara
extensions: update doc of enabled() and disabled() according to d5b525697ddb
r14530 '''find disabled extensions from hgext. returns a dict of {name: desc}'''
Yuya Nishihara
extensions: make disabled()/disabledext() load prebuilt index if available...
r14539 try:
from hgext import __index__
return dict((name, gettext(desc))
for name, desc in __index__.docs.iteritems()
if name not in _order)
Thomas Arendsen Hein
setup.py, make: avoid problems with outdated, existing hgext/__index__.py*...
r21229 except (ImportError, AttributeError):
Yuya Nishihara
extensions: make disabled()/disabledext() load prebuilt index if available...
r14539 pass
Brodie Rao
extensions: refactor disabled()
r10363 paths = _disabledpaths()
if not paths:
Augie Fackler
extensions.disabled: return {} instead of None no extensions are disabled
r16709 return {}
Brodie Rao
extensions: refactor disabled()
r10363
exts = {}
for name, path in paths.iteritems():
doc = _disabledhelp(path)
Matt Mackall
extensions: drop maxlength from enabled and disabled...
r14316 if doc:
Pulkit Goyal
help: show help for disabled extensions (issue5228)...
r30306 exts[name] = doc.splitlines()[0]
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871
Matt Mackall
extensions: drop maxlength from enabled and disabled...
r14316 return exts
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364 def disabledext(name):
'''find a specific disabled extension from hgext. returns desc'''
Yuya Nishihara
extensions: make disabled()/disabledext() load prebuilt index if available...
r14539 try:
from hgext import __index__
if name in _order: # enabled
return
else:
return gettext(__index__.docs.get(name))
Thomas Arendsen Hein
setup.py, make: avoid problems with outdated, existing hgext/__index__.py*...
r21229 except (ImportError, AttributeError):
Yuya Nishihara
extensions: make disabled()/disabledext() load prebuilt index if available...
r14539 pass
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364 paths = _disabledpaths()
if name in paths:
return _disabledhelp(paths[name])
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 def _walkcommand(node):
"""Scan @command() decorators in the tree starting at node"""
todo = collections.deque([node])
while todo:
node = todo.popleft()
if not isinstance(node, ast.FunctionDef):
todo.extend(ast.iter_child_nodes(node))
continue
for d in node.decorator_list:
if not isinstance(d, ast.Call):
continue
if not isinstance(d.func, ast.Name):
continue
if d.func.id != r'command':
continue
yield d
def _disabledcmdtable(path):
"""Construct a dummy command table without loading the extension module
This may raise IOError or SyntaxError.
"""
with open(path, 'rb') as src:
root = ast.parse(src.read(), path)
cmdtable = {}
for node in _walkcommand(root):
if not node.args:
continue
a = node.args[0]
if isinstance(a, ast.Str):
name = pycompat.sysbytes(a.s)
elif pycompat.ispy3 and isinstance(a, ast.Bytes):
name = a.s
else:
continue
cmdtable[name] = (None, [], b'')
return cmdtable
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995 def _finddisabledcmd(ui, cmd, name, path, strict):
try:
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 cmdtable = _disabledcmdtable(path)
except (IOError, SyntaxError):
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995 return
try:
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 aliases, entry = cmdutil.findcmd(cmd, cmdtable, strict)
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995 except (error.AmbiguousCommand, error.UnknownCommand):
return
for c in aliases:
if c.startswith(cmd):
cmd = c
break
else:
cmd = aliases[0]
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 doc = _disabledhelp(path)
Yuya Nishihara
help: load module doc of disabled extension in extensions.disabledcmd()...
r37996 return (cmd, name, doc)
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995
Mads Kiilerich
extensions: warn about invalid extensions when listing disabled commands...
r13191 def disabledcmd(ui, cmd, strict=False):
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 '''find cmd from disabled extensions without importing.
Yuya Nishihara
help: load module doc of disabled extension in extensions.disabledcmd()...
r37996 returns (cmdname, extname, doc)'''
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364
Yuya Nishihara
extensions: peek command table of disabled extensions without importing...
r38180 paths = _disabledpaths()
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364 if not paths:
raise error.UnknownCommand(cmd)
Martin Geisler
extensions: don't suggest commands from deprecated extensions
r16667 ext = None
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364 # first, search for an extension with the same name as the command
path = paths.pop(cmd, None)
if path:
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995 ext = _finddisabledcmd(ui, cmd, cmd, path, strict=strict)
Martin Geisler
extensions: don't suggest commands from deprecated extensions
r16667 if not ext:
# otherwise, interrogate each extension until there's a match
for name, path in paths.iteritems():
Yuya Nishihara
extensions: extract closure that looks for commands from disabled module...
r37995 ext = _finddisabledcmd(ui, cmd, name, path, strict=strict)
Martin Geisler
extensions: don't suggest commands from deprecated extensions
r16667 if ext:
break
Yuya Nishihara
extensions: drop dead code trying to exclude deprecated disabled commands...
r37994 if ext:
Martin Geisler
extensions: don't suggest commands from deprecated extensions
r16667 return ext
Brodie Rao
dispatch: provide help for disabled extensions and commands...
r10364
raise error.UnknownCommand(cmd)
FUJIWARA Katsunori
help: use full name of extensions to look up them for keyword search...
r19769 def enabled(shortname=True):
Yuya Nishihara
extensions: update doc of enabled() and disabled() according to d5b525697ddb
r14530 '''return a dict of {name: desc} of extensions'''
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871 exts = {}
for ename, ext in extensions():
doc = (gettext(ext.__doc__) or _('(no help text available)'))
FUJIWARA Katsunori
help: use full name of extensions to look up them for keyword search...
r19769 if shortname:
ename = ename.split('.')[-1]
Nicolas Dumazet
for calls expecting bool args, pass bool instead of int...
r9136 exts[ename] = doc.splitlines()[0].strip()
Cédric Duval
extensions: move extensions listing functions from mercurial.help...
r8871
Matt Mackall
extensions: drop maxlength from enabled and disabled...
r14316 return exts
anatoly techtonik
version: show enabled extensions (issue4209)...
r21848
Jun Wu
extensions: add notloaded method to return extensions failed to load...
r28155 def notloaded():
'''return short names of extensions that failed to load'''
return [name for name, mod in _extensions.iteritems() if mod is None]
anatoly techtonik
version: show enabled extensions (issue4209)...
r21848 def moduleversion(module):
'''return version information from given module as a string'''
if (util.safehasattr(module, 'getversion')
and callable(module.getversion)):
version = module.getversion()
elif util.safehasattr(module, '__version__'):
version = module.__version__
else:
version = ''
if isinstance(version, (list, tuple)):
Pulkit Goyal
py3: use pycompat.bytestr() instead of str() in extensions.py...
r38040 version = '.'.join(pycompat.bytestr(o) for o in version)
anatoly techtonik
version: show enabled extensions (issue4209)...
r21848 return version
liscju
version: verbose list internal and external extension source (issue4731)
r27990
def ismoduleinternal(module):
exttestedwith = getattr(module, 'testedwith', None)
Augie Fackler
extensions: change magic "shipped with hg" string...
r29841 return exttestedwith == "ships-with-hg-core"